Skip to content

feat!(website): allow selecting fields to download in metadata and default to a shorter selection #3761

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

Merged
merged 50 commits into from
Mar 19, 2025

Conversation

theosanderson
Copy link
Member

@theosanderson theosanderson commented Feb 25, 2025

resolves #850, resolves #851, resolves #3695

preview URL: https://select-fields.loculus.org/ebola-sudan/search?

Summary

Adds the capacity to select fields to download and defaults to a configured set of fields rather than to the full list.

The form to select these is quite nice. I haven't tried to merge it with the form that's used for selecting fields for the search fields and columns (or I did briefly but didn't succeed), but we can make an issue to do that in the future.

Breaking changes

You need to select which fields should be selected by default by adding the includeInDownloadsByDefault: true property in the values yaml. We should decide what this should be for Pathoplexus and make a PR before we merge this.

I made a PR: pathoplexus/pathoplexus#404

Testing

I added integration tests to check the right number of columns are present. To achieve this I added a fixture. I would request relatively light touch reviewing on the integration tests.

Screenshot

image image

PR Checklist

  • All necessary documentation has been adapted.
  • The implemented feature is covered by appropriate, automated tests.
    I tested that the downloads looked good. There are also some unit tests and an integration test.

@theosanderson theosanderson added the preview Triggers a deployment to argocd label Feb 25, 2025
@theosanderson theosanderson changed the title wip: select fields to download feat!(website): allow selecting fields to download in metadata and default to a shorter selection Feb 25, 2025
@theosanderson theosanderson added the format_me Triggers github_actions to format website code on PR label Feb 26, 2025
@theosanderson theosanderson removed the preview Triggers a deployment to argocd label Mar 12, 2025
@theosanderson theosanderson added the preview Triggers a deployment to argocd label Mar 14, 2025
Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for implementing that! Quite useful.

I just have a few small remarks.

@theosanderson theosanderson requested a review from fhennig March 19, 2025 12:00
@theosanderson
Copy link
Member Author

Thanks for the review!

@theosanderson theosanderson merged commit c676ae4 into main Mar 19, 2025
21 checks passed
@theosanderson theosanderson deleted the select-fields branch March 19, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
format_me Triggers github_actions to format website code on PR preview Triggers a deployment to argocd
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow downloading a subset of fields Download panel: metadata field selection Download panel: default metadata fields
3 participants