Don Brown, Atlassian Plugins 2.0: The overview

Confluence Team Hosted

JIRA Studio

Why do we need a new plugin framework?

One feature * five products = Dashboard

Multiple teams across the globe Gda ń sk, Poland San Francisco, USA Kuala Lumpur, Malaysia Sydney, Australia

Plugin development slow Write plugin code Build plugin Copy plugin to WEB-INF/lib Start app Discover bug Wash, rinse, repeat

Write plugin code

Build plugin

Copy plugin to WEB-INF/lib

Start app

Discover bug

Wash, rinse, repeat

Inconsistency between products . . . Constructor injection? Setter injection? Pico? Spring?

Plugins break on product upgrade Plugins have unrestricted access to application classes, objects, and configuration Broken plugins after a product upgrade make us look bad

Plugins have unrestricted access to application classes, objects, and configuration

Broken plugins after a product upgrade make us look bad

Plugins 2 gives you. . . Ability for plugins to depend on each other Ability for plugins to define their own extension points Consistent plugin development platform across products Better insulation of plugins from product changes

Ability for plugins to depend on each other

Ability for plugins to define their own extension points

Consistent plugin development platform across products

Better insulation of plugins from product changes

Backwards compatibility Version 1 plugins - 100% compatible WEB-INF/lib Confluence’s dynamic plugins Version 2 (OSGi-based) plugins Compatibility varies by product

Version 1 plugins - 100% compatible

WEB-INF/lib

Confluence’s dynamic plugins

Version 2 (OSGi-based) plugins

Compatibility varies by product

Which products? Crowd 1.5  FishEye 1.5  Crucible 1.5  Confluence 2.10  JIRA 4.0 Bamboo 2.3

Crowd 1.5 

FishEye 1.5 

Crucible 1.5 

Confluence 2.10 

JIRA 4.0

Bamboo 2.3

OSGi in one slide Bundles contain code, configuration, manifest metadata Runtime dependencies at Java package, service, and bundle levels Supports multiple versions of code Can share dynamic service objects Lifecycle: install, resolve, active, uninstall

Bundles contain code, configuration, manifest metadata

Runtime dependencies at Java package, service, and bundle levels

Supports multiple versions of code

Can share dynamic service objects

Lifecycle: install, resolve, active, uninstall

Goal - Minimal OSGi required Can we scale the learning curve to keep the easy plugins easy?

Can we scale the learning curve to keep the easy plugins easy?

Each team can “own” a bundle Only JAX-RS exposed Complete freedom to switch to another JAX-RS implementation Can run multiple versions of the bundle side-by-side

Only JAX-RS exposed

Complete freedom to switch to another JAX-RS implementation

Can run multiple versions of the bundle side-by-side

Features written once Example: OpenSocial-based dashboard as an OSGi plugin Written and owned by San Francisco team Contains UI, Shindig, internal services, SPI, and API

Example: OpenSocial-based dashboard as an OSGi plugin

Written and owned by San Francisco team

Contains UI, Shindig, internal services, SPI, and API

Dynamic deployment = faster dev cycle Without OSGi Code Compile Copy to WEB-INF/lib Restart application Test in browser With OSGi Code Build and push to running web application Test in browser . . . from code to browser in one or two seconds

Without OSGi

Code

Compile

Copy to WEB-INF/lib

Restart application

Test in browser

With OSGi

Code

Build and push to running web application

Test in browser

Standard plugin modules Servlet servlet servlet-filter servlet-listener servlet-context-param Component component component-import Web Items web-item web-section Misc module-type web-resource

Servlet

servlet

servlet-filter

servlet-listener

servlet-context-param

Component

component

component-import

Web Items

web-item

web-section

Misc

module-type

web-resource

Sandboxed plugins

DEMO: Using Atlassian Plugins

Plugins architecture

Plugin descriptor atlassian-plugin.xml < atlassian-plugin key = &quot;com.xyz.example&quot; name = &quot;Example Plugin ” plugins-version = “2” > < plugin-info > < description > A sample plugin </ description > < version > 1.0 </ version > </ plugin-info > < servlet key = ”test &quot; name = ”Test Servlet &quot; class = &quot;com.xyz.TestServlet&quot; > < description > An example servlet </ description > </ servlet > </ atlassian-plugin >

atlassian-plugin.xml

Plugin descriptor - Hidden OSGi atlassian-plugin.xml <atlassian-plugin key= &quot;com.xyz.example&quot; name= &quot;Example Plugin” plugins-version= “2” > … < component key = ”myComponent &quot; class = &quot;com.xyz.MyComponent” public = “true” > < interface > com.xyz.Component </ interface > < / component > < component-import key = ”otherComponent &quot; interface = &quot;com.abc.OtherComponent” /> </atlassian-plugin>

atlassian-plugin.xml

Plugin descriptor - Hidden OSGi Generates atlassian-plugin-spring.xml < beans … > < bean id = “myComponent class = “com.xyz.MyComponent” /> < osgi:service id = “myComponent_service” ref = “myComponent” interface = “com.xyz.Component” /> < osgi:reference id = “otherComponent &quot; interface = &quot;com.abc.OtherComponent” /> </ beans >

Generates atlassian-plugin-spring.xml

Plugin to bundle process Goal: Allow simple plugins with no OSGi knowledge Three types of plugins: Simple - no OSGi Moderate - OSGi via plugin descriptor Complex - OSGi via Spring XML directly

Goal: Allow simple plugins with no OSGi knowledge

Three types of plugins:

Simple - no OSGi

Moderate - OSGi via plugin descriptor

Complex - OSGi via Spring XML directly

Plugins 2 showcase

Atlassian Gadgets

Shared Access Layer (SAL) Plugin upgrade framework Plugin settings Job scheduling i18n Search HTTP calls . . . and much more

Plugin upgrade framework

Plugin settings

Job scheduling

i18n

Search

HTTP calls

. . . and much more

Atlassian REST Module Type Implemented as a dynamic module type Uses JAX-RS Can be extended by other plugins to add new data mappers GET rest/name/1.0/bob { &quot;firstName&quot;:”Bob&quot;, &quot;lastName&quot;:&quot;Smith&quot; }

Implemented as a dynamic module type

Uses JAX-RS

Can be extended by other plugins to add new data mappers

GET rest/name/1.0/bob

{

&quot;firstName&quot;:”Bob&quot;,

&quot;lastName&quot;:&quot;Smith&quot;

}

Plugin Exchange Client Uses REST plugin type for JSON, XML, and HTML

Uses REST plugin type for JSON, XML, and HTML

Confluence Widget Connector Widget types extendable via plugins

Widget types extendable via plugins

And many more. . . Applinks 2 Streams 2 Confluence Repository Client Template renderer Team Hosted plugins Studio plugins All Crucible and FishEye plugins All OSGi bundles

Applinks 2

Streams 2

Confluence Repository Client

Template renderer

Team Hosted plugins

Studio plugins

All Crucible and FishEye plugins

All OSGi bundles

Join the fun!

Questions