Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix MSA viz, new dependency specification options. #18760

Merged
merged 11 commits into from
Sep 5, 2024

Conversation

dannon
Copy link
Member

@dannon dannon commented Sep 3, 2024

Primary driver was fixing the deployed MSA application on main -- this has been deployed to main in the usegalaxy branch as of last week and is working well to resolve our issues w/ msa. Specifying node package dependencies and relying on prebuilt visualization plugins (as implemented here) is going to make a huge difference in reliability moving forward.

In short, visualizations should prebuild and publish a static directory with whatever they need to run.

In package.json, that's this new part:

    "files": [
        "static"
    ],

Then the viz is published to npm like so: https://www.npmjs.com/@galaxyproject/msa

And then in the viz xml, we specify a particular version (or range, as appropriate) of plugin the viz is compatible with, like so:

    <requirements>
        <requirement type="package" version="0.2.1" package="@galaxyproject/msa"/>
    </requirements>

These requirements will all get staged to the Galaxy server's static file serving without a build process required, avoiding all of the issues we've had with differing node versions on novel and/or archaic systems.

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@dannon dannon marked this pull request as ready for review September 3, 2024 16:02
@github-actions github-actions bot added this to the 24.2 milestone Sep 3, 2024
@mvdbeek
Copy link
Member

mvdbeek commented Sep 4, 2024

Are there any docs that would need updating ?

@dannon
Copy link
Member Author

dannon commented Sep 4, 2024

@mvdbeek Yes, and I'll add that to the list -- we'll want to update GTN tutorials, etc., though we may want to shift those to using a template Sam has been working on as a base visualization.

@dannon dannon merged commit 3e8f65e into galaxyproject:dev Sep 5, 2024
50 of 53 checks passed
Copy link

github-actions bot commented Sep 5, 2024

This PR was merged without a "kind/" label, please correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants