![Open(-ish)
Source
[2001]](https://image.slidesharecdn.com/pluginarchitecture-150326200935-conversion-gate01/85/Rewriting-a-Plugin-Architecture-3-Times-to-Harness-the-API-Economy-18-320.jpg)
!["name": "Hello World", "description": "âŠ",
"key": "com.example.myaddon", "apiVersion": 1,
"baseUrl": "http://example.com/myaddon",
"modules": {
"generalPages": [{
"name": { "value": "Greeting" }, "key": "hello-world",
"location": "system.top.navigation.bar",
"url": "/helloworld.html"
}]
},
"scopes": [ "read", "write" ],
"authentication": { "type": "jwt" },
"lifecycle": { "installed": "/add-on-installed-callback" }
where it is hosted
which modules it uses
which scopes it needs
recognize the user](https://image.slidesharecdn.com/pluginarchitecture-150326200935-conversion-gate01/85/Rewriting-a-Plugin-Architecture-3-Times-to-Harness-the-API-Economy-98-320.jpg)
![Example JIRA WebHooks
âą HTTP callback to a URL
âą Filtered by JQL
âą When speciïŹc event occurs
"modules": {
"webhooks": [{
"event": "jira:issue_created",
"url": "/issue-created"
}]
}](https://image.slidesharecdn.com/pluginarchitecture-150326200935-conversion-gate01/85/Rewriting-a-Plugin-Architecture-3-Times-to-Harness-the-API-Economy-102-320.jpg)
Rewriting a Plugin Architecture 3 Times to Harness the API Economy
- 2. Rewriting a Plugin Architecture 3 Times to Harness the API Economy
- 3. A couple of Atlassians who are passionate about plugins Tim Pettersen Developer Provocateur @kannonboy Ian Buchanan Developer Partisan @devpartisan
- 4. API Economy
- 5. Economy
- 6. $50,000,000 *Paid to ISVs to date.
- 8. $1,000,000,000 *Paid to ISVs in 2013. http://www.partner-path.com/2013/12/salesforce-partner-ecosystem/
- 10. API Economy SPI
- 13. P2 (2008)
- 19. Why itâs awesome! Customers can âscratch their own itchâ Atlassian devs can focus on the 90% Customization == stickier product Devs who customize, evangelize
- 20. Why it sucks.. Developer support load Poor plugin UX == poor product perception Pain to build the entire product Massive barrier to upgrade
- 22. JIRA 3.0
- 23. How? Wherever there is a collection of type FOO, let the end user inject their own implementations of FOO.
- 25. <ul> </ul> <li><a href=â/dashboard.jspaâ>Home</a></li> <li><a href=â/project.jspaâ>Browse Project</a></li> <!-- ⊠--> <li><a href=â/admin.jspaâ>Administration</a></li>
- 26. interface WebItem { String getHref(); String getText(); } class FooWebLink implements WebItem { } public String getHref() { return âhttp://foo.comâ; } public String getText() { return âFooâ; }
- 28. <li><a href=â/dashboard.jspaâ>Home</a></li> <li><a href=â/project.jspaâ>Browse Project</a></li> <!-- ⊠--> <li><a href=â/admin.jspaâ>Administration</a></li> <ul> </ul> <% for (WebItem wi : pluginAccessor.getModules()) { %> <li> <a href=â<% wi.getHref() %>â> <% wi.getText() %> </a> </li> <% } %>
- 29. Plugins promote abstraction and enforce modular architecture!
- 30. Two plugins looks great! 3+ plugins.. not so hot.
- 31. Every (pluggable) collection is now potentially infinitely large.
- 33. public void transitionIssue(Issue issue, Transition tn) { // update issue state // .. // send email to watchers for (User watcher : issue.getWatchers()) { issue.emailTo(watcher); } }
- 34. public void transitionIssue(Issue issue, Transition tn) { // update issue state // .. } public static interface PostFn { void onTransition(Issue issue); } public class EmailFn implements PostFn { public void onTransition(issue) { for (User watcher : issue.getWatchers()) { issue.emailTo(watcher); } } }
- 35. public void transitionIssue(Issue issue, Transition tn) { // update issue state // .. // trigger post functions for (PostFn fn : pluginAccessor.get(PostFn.class)) { fn.onTransition(issue); } } public class EmailFn implements PostFn { public void onTransition(issue) { for (User watcher : issue.getWatchers()) { issue.emailTo(watcher); } } }
- 36. Adding a new âplugin pointâ is easy if you already have good abstraction!
- 37. You SHOULD make âpluginizingâ a feature as simple & quick as possible. Otherwise if thereâs a crunch for time, it wonât happen. Spike it Make it work Test it Add an API / SPI Ship it
- 38. for (PostFn fn : pluginAccessor.get(PostFn.class)) { fn.onTransition(issue); } ArithmeticException StackOverflowError while (true) {} OutOfMemoryError ClassNotFoundException ClassCastException
- 39. Murphyâs law: If a plugin can fail, it will. Horrifically.
- 40. for (PostFn fn : pluginAccessor.get(PostFn.class)) { fn.onTransition(issue); } Code defensively try { } catch (Exception e) { log.error(âPlugin post-function failedâ, e); } log.debug(âInvoking â + fn);
- 41. Corollary: If an API is public, it will be used. Often incorrectly.
- 42. public void publicApiMethod(List<?> list) .. } Show them the way if (list == null) throw new NullPointerException( âlist must not be nullâ ); if (list.isEmpty()) throw new IllegalArgumentException( âlist must not be emptyâ ) ); /** * @param list a non-null, non-empty list */
- 43. Backend âą Custom fields âą JQL functions âą Workflows (post-functions, conditions) generic âą Servlets âą Filters âą Event listeners
- 44. https://bitbucket.org/atlassian/atlassian-plugins Source (BSD 3-clause licensed) Embedding Guide http://bit.ly/embedding-plugins Atlassian Plugins
- 45. âą Host application exposes some âplugin pointâ interfaces public static interface PostFn { void onTransition(Issue issue); } âą Plugin developer provides concrete implementations public class EmailFn implements PostFn { // send email to watchers for (User watcher : issue.getWatchers()) { issue.emailTo(watcher); } } How it works (1 of 3)
- 46. âą Plugin developer adds an XML descriptor (remember itâs 2004) <post-function class=âcom.foo.EmailFnâ weight=â10â /> âą Developer packages up the class and XML in a JAR and puts it on the classpath atlassian-jira/WEB-INF/lib/my-cool-plugin-1.0.jar/ How it works (2 of 3) atlassian-plugin.xml com/foo/EmailFn.class
- 47. âą On startup, plugin system parses the XML and instantiates classes with Spring DI âą The PluginAccessor is injected into other components and used to look up modules. âą Because the class path is static, the PluginAccessor caches plugins very aggressively. How it works (3 of 3)
- 49. Why itâs awesome! Easier customization by end-users Smoother upgrades Improved customization UX Architectural benefits Simple to implement
- 50. Why it sucks.. Totally bespoke, non-standard Need to restart to install plugins No API delineation Shared classpath
- 51. Re-architecting as plugins a bunch of work
- 52. Dogfooding APIs?
- 53. product manager
- 54. âPM friendlyâ benefits! Release plugins out of band Ship âdark featuresâ Customers can turn stuff off Release paid plugins ($$$) Architecture == velocity
- 55. Make sure your plugin system works. Nothing turns off a plugin developer like a broken API or an unstable platform.
- 56. P2 (2008)
- 57. P2 (2008)
- 58. Why plugins suck.. Totally bespoke, non-standard Need to restart to install plugins No API delineation Shared classpath
- 59. OSGi
- 62. Why it sucks.. Totally bespoke, non-standard Need to restart to install plugins No API delineation Shared classpath
- 63. Why it sucks.. OSGi is pretty complicated
- 64. 175Kb of text JIRA Agileâs MANIFEST.MF
- 65. P1 P2 <post-function class=âcom.foo.EmailFnâ weight=â10â /> public class EmailFn implements PostFn {..} + = a working plugin <post-function class=âcom.foo.EmailFnâ weight=â10â /> public class EmailFn implements PostFn {..} Import-Package: com.atlassian.jira;version=â5.0â, Export-Package: org.apache;version=â3.3â <component> .. </component> + + + = a working plugin ⊠maybe
- 66. Abstracting OSGi and a few other things..( )
- 67. C nsPr s âą Less upgrade pain âą Easy onboarding for new users âą Startup time âą Leaky abstraction âą Non-standard use of standard tech âą Proxies all the way down âą Complexities
- 69. Supporting your ecosystem Photo: Nicholas A. Tonelli
- 71. Good for devs! Paint-by-numbers marketing Pricing & licensing APIs Feedback Tracking & analytics
- 72. Good for customers! Central authority for add-ons Less fragmented UX Ratings & reviews Unified billing
- 73. Focus shifts from user to vendor customization
- 74. Building a marketplace is non-trivial
- 76. Timâs top tip for dev docs Keep your documentation as close to the code as possible.
- 77. Bind the code..
- 78. ..to the docs!
- 80. Code talks! Make sure you have a simple process for open sourcing and liberally licensing example add-ons.
- 81. Meta-Developer Tools Photo: Biser Todorov
- 82. SDK Fully automate plugin ALM Spin up products in âdeveloper modeâ Tight development loop Provide realistic test data Dogfood it! FREE
- 83. /stash/projects
- 86. /stash/projects
- 89. Developer Mode Trim out dev speed killers (websudo, etc) Expose logs & debug info Release your own internal productivity tools Add in custom âdev modeâ plugins
- 90. (2014)
- 91. What is Atlassian Connect? Remote Plugins REST API âą Drive the product via its REST API WebHooks âą Receive notiïŹcations from the product via WebHooks âą Inject content into the product UI via iframes UI Atlassian âš Product Plugin Service Add-ons
- 92. Why? Atlassian Cloud (SaaS) Run 3rd party code out-of-process Improved customization UX (yet again) Architectural benefits
- 94. âą Connect is a new layer on top of the older plugin model. âą Same Marketplace serves up Connect plugins. âą Same plugins still available in the Marketplace. âą Same REST APIs still available for both Server and Cloud. âą Connect adds a new mode of integration. Building up http://housebeauty.net/dressy-modern-townhouse-design-with-rooftop-garden-and-glass-walls/eye-catching-green- roofed-penthouse-apartment-rooftop-garden-with-deck-surrounded-by-glass-balustrades/#image-1
- 95. How? Wherever a module is called, âš let a third-party inject a new feature. remember web fragments
- 97. âą Declare plugin with a descriptor. âą Extend the Atlassian application UI with modules. âą Request appropriate scopes. âą Recognize the user. âą Call the Atlassian application's REST API. âą Respond to the Atlassian application's webhooks. âą Register on the Atlassian Marketplace. âą Respect plugin licensing. How to author a Connect Plugin
- 98. "name": "Hello World", "description": "âŠ", "key": "com.example.myaddon", "apiVersion": 1, "baseUrl": "http://example.com/myaddon", "modules": { "generalPages": [{ "name": { "value": "Greeting" }, "key": "hello-world", "location": "system.top.navigation.bar", "url": "/helloworld.html" }] }, "scopes": [ "read", "write" ], "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/add-on-installed-callback" } where it is hosted which modules it uses which scopes it needs recognize the user
- 99. Example Scopes for JIRA PROJECT_ADMIN DELETEWRITE ADMIN READ
- 100. GET /myaddon?jwt=<jwt-token> http/1.1 POST /jira/rest/api/2/issue/AC-1/attachments http/1.1 Authorization: JWT <jwt-token> Recognizing the user with JWT
- 101. Example REST API for Confluence âą URLs for resources âą HTTP verbs âą Parmeters ïŹlter collections âą JSON data âą HAL(ish) links (newer APIs)
- 102. Example JIRA WebHooks âą HTTP callback to a URL âą Filtered by JQL âą When speciïŹc event occurs "modules": { "webhooks": [{ "event": "jira:issue_created", "url": "/issue-created" }] }
- 103. Register on the Atlassian Marketplace âą Find: in context catalog of add-ons âą Try: manage leads âą Buy: manage sales and licensing
- 104. âą Vagrant Box for local development âą JSON descriptor validator âą JWT decoder âą Marketplace wizard to create a Connect listing âą Access Token model for private plugins âą Webhook Inspector Developer Tools for Atlassian Connect
- 105. C nsPr s âą Code in any language âą Use any build & dev tools âą Use anything: databases, search indexes, caching services, etc âą Host and scale a service âą No automated devloop (P2 SDK) âą Provide everything: databases, search indexes, caching services, etc
- 106. Why itâs awesome! BYOS (Bring your own stack) More services, than products Sandboxing UI Design Aligned with microservice thinking
- 107. Why it sucks.. Complex to troubleshoot Harder to create concrete examples More developer tools, not just docs More interfaces must be stable
- 108. Remember SPIs?
- 110. Whatâs Next? Consolidate and expand Vendor add-on âą Extend Bitbucket and HipChat âą Build complex vertical apps: powered by Atlassian âą Build integrations between Atlassian applications Atlassian add-on
- 111. Questions?
- 112. A couple of Atlassians who are passionate about plugins Tim Pettersen Developer Provocateur @kannonboy Ian Buchanan Developer Partisan @devpartisan