Support prefetching plugins metadata from an http api #5887
Conversation
✅ Deploy Preview for nextflow-docs-staging canceled.
|
modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy
Outdated
Show resolved
Hide resolved
modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy
Outdated
Show resolved
Hide resolved
tom-seqera
force-pushed
the
plugin-metadata-prefetch
branch
from
71fa033 to
db98839
Compare
modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy
Outdated
Show resolved
Hide resolved
tom-seqera
force-pushed
the
plugin-metadata-prefetch
branch
from
db98839 to
ba28c09
Compare
|
Added unit tests |
| def split = specs.split { plugin -> isEmbedded() && defaultPlugins.hasPlugin(plugin.id) } | ||
| def (skip, toStart) = [split[0], split[1]] |
There was a problem hiding this comment.
Not sure to understand this logic, a comment to explain the need for splitting the list of plugins would help.
Also this method looks like an implementation detail, may not be needed to expose it as public
There was a problem hiding this comment.
This is just preserving the existing behaviour which doesn't start default plugins in embedded mode. The only change is that it used to check and start each plugin one-by-one but now we need to get a list of all the plugins in one go so that we can call prefetch()
There was a problem hiding this comment.
If you could add it could help to keep track of this rationale
Signed-off-by: Tom Sellman <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Tom Sellman <[email protected]>
tom-seqera
force-pushed
the
plugin-metadata-prefetch
branch
from
46f1fac to
920ed83
Compare
|
I updated the warning to be clearer that using a custom index is currently experimental. The previous wording suggested that people should only use the main plugin index, but I think people will want the option to have alternative plugin indexes. |
|
Please revert 920ed83, the expected message is the previous commit |
This adds an implementation of p4fj's
UpdateRepositorywhich can download plugin metadata from an http api.It also adds a new interface
PrefetchUpdateRepositorywhich extends p4fj's interface to add aprefetch()method. When initialising plugins, Nextflow will call this prefetch method on any UpdateRepository which implements this interface, allowing the repository to optimise how it downloads plugin metadata (for example, only loading metadata for required plugins rather than for all plugins).Use of the new http update repository can be enabled with the new
NXF_PLUGINS_INDEX_URLenvironment variable. If set, this overrides the defaultindexUrllocation of theplugins.jsonmetadata file. If the supplied url ends in.jsonthen Nextflow will use the existing update repository implementation, otherwise it will use the new http api implementation.Unless this new env var is set, these changes should have no effect on Nextflow's behaviour.