Feat/reduce plugins scope #41
Conversation
…ow-ui into feat/reduce-plugins-scope
| @@ -36,13 +36,13 @@ A basic plugin could be something like | |||
| <script src="MetaflowPluginAPI.js"></script> | |||
| <script> | |||
| (function () { | |||
| Metaflow.register('run-header', () => { | |||
| Metaflow.onReady((configuration, resource) => { | |||
There was a problem hiding this comment.
below it mentions There are two implemented plugin slots, run-headerandtask-details. The desired slot must be given as parameter to a plugin API register message. but here it removes run-header registry call - is there some equivalent of it?
There was a problem hiding this comment.
Updated to have mention about manifest.json
docs/plugin-system.md
Outdated
| @@ -59,24 +59,16 @@ This plugin is registered to be rendered in the run header section (path /FLOW_I | |||
|
|
|||
| ## Plugin slots | |||
|
|
|||
| There are three implemented plugin slots. `run-header`, `task-details`, and `headless`. The desired slot must be given as a parameter to a plugin API register message. | |||
| There are two implemented plugin slots, `run-header` and `task-details`. The desired slot must be given as parameter to a plugin API register message. | |||
There was a problem hiding this comment.
it should probably mention plugin-api/Examples/hello-world/manifest.json and the definition of the slot for clarity
| }); | ||
| Metaflow.setHeight(100) |
There was a problem hiding this comment.
trying to understand here why setHeight(100) was replaced by setHeight()?
There was a problem hiding this comment.
setHeight has optional fixedHeight parameter. When no parameter is given, API will try to find out the full height of document and use that. There wasn't really need for fixed height here.
plugin-api/MetaflowPluginAPI.js
Outdated
| @@ -1,145 +1,193 @@ | |||
| const VERSION_INFO = { | |||
| api: '0.13.0' | |||
| } | |||
| api: "0.14.0", | |||
There was a problem hiding this comment.
this seems to be a breaking change update, can we do a semantic version?
There was a problem hiding this comment.
Yes i imagine we should up it to 1.0.0
There was a problem hiding this comment.
lets do it and I think we can merge 1.0.0
Requirements for a pull request
Description of the Change
This PR reduces scope of the plugins systems to make it easier to maintain in the future.
Removes slots:
Removes exposed data
This PR also adds some feature to plugin system. Plugin slot will now provide available IDs from current URL to every plugin. Knowing flow_id, run_number or task_id might be useful for the plugin.
Other change this brings is that now plugins needs to define configurations in manifest.json instead of register function. register is replaced with onReady. It is recommended to use onReady to wrap plugin code but not absolute necessity.
Possible Drawbacks
Existing plugins using these slots or data must be updated to work with new API.