Support prefetching plugins metadata from an http api #5887
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
pditommaso
requested changes
Mar 17, 2025
modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy
Outdated
Show resolved
Hide resolved
Signed-off-by: Tom Sellman <tom.sellman@seqera.io>
tom-seqera
force-pushed
the
plugin-metadata-prefetch
branch
from
71fa033 to
db98839
Compare
pditommaso
reviewed
Mar 20, 2025
| @@ -95,6 +98,28 @@ class PluginsFacade implements PluginStateListener { | |||
| } | |||
| } | |||
|
|
|||
| protected String getPluginsIndexUrl() { | |||
| final url = env.get('NXF_PLUGINS_INDEX_URL') | |||
| if( url ) { | |||
There was a problem hiding this comment.
Ideally there should not be any warning if the url is the current (github) index or the uri host is *.seqera.io
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.