Austenem/CAT-983 MVP Bulk File Download

[austenem]

Summary

First iteration of the Bulk Download dialog, which adds a dialog to the Search, Publication, and Collection pages that generates a download manifest for files from selected datasets. An option to download the corresponding dataset metadata is also included.

In this iteration, all files from selected datasets must be downloaded; in an upcoming iteration, the dialog will include an "Advanced Selection" accordion that will allow users to select specific file types from centrally processed datasets.

Design Documentation/Original Tickets

CAT-983 Jira ticket

Figma mockups

Testing

Tested the following cases:

• General

  • Dialog is available for authenticated and non-authenticated users
  • Download manifest is formatted appropriately for CLT tool and contains relevant datasets
  • Metadata download option works and resulting file contains relevant datasets
  • One or more download options must be selected before download is permitted

• Search page

  • Select one or more dataset from each of the download options (centrally processed, externally processed, raw) - should show one download option, and no "select all" option
  • Select datasets from all three download options - should show all download options and a "select all" option
  • Select protected datasets - should show warning banner and not allow a download until the datasets are removed. If only protected datasets were selected and subsequently removed, a "no files to download" warning banner should appear.
  • Select no datasets - should include all datasets based on the current filters

• Collection pages

  • Open dialog and download datasets from table

• Publication pages

  • Open dialog and download datasets from table

Screenshots/Video

Search

Screen.Recording.2024-11-13.at.3.22.05.PM.mov

Collections

Publications

Error cases

No available files:

Protected datasets selected:

Download failure:

Checklist

• Code follows the project's coding standards
  • Lint checks pass locally
  • New CHANGELOG-your-feature-name-here.md is present in the root directory, describing the change(s) in full sentences.
• Unit tests covering the new feature have been added
• All existing tests pass
• Any relevant documentation in JIRA/Confluence has been updated to reflect the new feature
• Any new functionalities have appropriate analytics functionalities added

[NickAkhmetov]

Great work! Some minor notes to begin; I will pull the branch down to test more thoroughly tomorrow.

[NickAkhmetov]

It seems potentially worthwhile to put this into a useMemo to avoid recalculating it unless the uuids change.

This raised some other questions for me:

• Is there an upper bound to how many datasets can be selected for bulk download at once?
  • If so, are we communicating this to users?
• If the limit is higher than 1,000, could we increase the size to 10_000 to handle selections of >1,000 datasets? We could also use size: uuids.size().

[austenem]

This is a good point and I like the suggestion of using size: uuids.size() - in regard to an upper bound, we haven't discussed this as far as I know. The load time for the dialog is definitely noticeable after a few hundred datasets, so it seems like some additional messaging should be provided to users who have selected a large number of datasets (maybe an alert similar to the one used in the workspaces dialog) letting them know about the wait time. @tsliaw what do you think?

[NickAkhmetov]

One minor issue I noticed while testing: the "download" button as soon as the page loads shows a "files are not available" view:

Screen.Recording.2024-11-14.134655.mp4

Perhaps we could disable the "download" button and show a loading message on hover if

• All UUIDS have not yet loaded, and
• There is no selection