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

244 - Integration download dataset #256

Merged
merged 6 commits into from
Dec 15, 2023

Conversation

MellyGray
Copy link
Contributor

@MellyGray MellyGray commented Dec 12, 2023

What this PR does / why we need it:

This PR adds the integration to download the dataset using the Dataverse API. With this integration the user would be able to download the dataset both in original and archival formats using the Access Dataset button in the Dataset page.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Step 1: Run the development environment

  1. Run npm I
  2. cd packages/design-system && npm run build
  3. cd ../../
  4. Check that you have a .env file such as the .env.example, with the VITE_DATAVERSE_BACKEND_URL=http://localhost:8000 variable
  5. cd dev-env
  6. ./run-env.sh unstable
  7. To check the environment go to http://localhost:8000 and check your local dataverse installation

Step 2: Test Dataset View mode with the implemented changes to download the files

  1. Go to http://localhost:8000
  2. Login as admin using username: dataverseAdmin and password: admin1
  3. Create a new Dataset
  4. Upload some files to the dataset
  5. From the dataset view mode copy the search parameters from the url. Ex.: ?persistentId=doi:10.5072/FK2/LHGRHP&version=DRAFT
  6. Go to http://localhost:8000/spa/datasets and paste the search parameters. Ex.: http://localhost:8000/spa/datasets?persistentId=doi:10.5072/FK2/LHGRHP&version=DRAFT
  7. You are currently viewing the same dataset in the SPA. In the files table, locate the "Access Dataset" dropdown on the right of the page. Use the button to download the dataset and check that is working as expected.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No

Is there a release notes update needed for this change?:

No

Additional documentation:

@MellyGray MellyGray added Size: 3 A percentage of a sprint. 2.1 hours. integration Tasks involving the connection and interaction of UI features with the Dataverse API labels Dec 12, 2023
@MellyGray MellyGray marked this pull request as ready for review December 12, 2023 13:02
@coveralls
Copy link

coveralls commented Dec 12, 2023

Coverage Status

coverage: 98.222% (+0.05%) from 98.173%
when pulling ac81d82 on feature/244-integration-download-all-files
into c3c00ce on develop.

Base automatically changed from feature/188-dataset-download-options to develop December 12, 2023 16:47
@GPortas GPortas self-assigned this Dec 13, 2023
@MellyGray MellyGray linked an issue Dec 13, 2023 that may be closed by this pull request
@GPortas
Copy link
Contributor

GPortas commented Dec 13, 2023

@MellyGray Can you please resolve conflicts?

…into feature/244-integration-download-all-files
@MellyGray
Copy link
Contributor Author

@GPortas conflicts resolved

@MellyGray MellyGray removed their assignment Dec 13, 2023
}, // TODO Connect with JS dataset permissions for privateUrl when it is available in js-dataverse
[], // TODO Connect with JS dataset locks for privateUrl when it is available in js-dataverse
0, // TODO Connect with JS dataset filesTotalDownloadSize for privateUrl when it is available in js-dataverse
0 // TODO Connect with JS dataset filesTotalDownloadSize for privateUrl when it is available in js-dataverse
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we create an issue including all these TODOs related to private URLs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@GPortas GPortas left a comment

Choose a reason for hiding this comment

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

Looks good!

downloaddataset.mov

@GPortas
Copy link
Contributor

GPortas commented Dec 15, 2023

@MellyGray Can you please resolve merge conflicts?

…into feature/244-integration-download-all-files
@MellyGray
Copy link
Contributor Author

@GPortas conflicts resolved

@MellyGray MellyGray removed their assignment Dec 15, 2023
@MellyGray MellyGray requested a review from GPortas December 15, 2023 11:57
@GPortas GPortas merged commit 48c2521 into develop Dec 15, 2023
10 of 12 checks passed
@MellyGray MellyGray deleted the feature/244-integration-download-all-files branch February 1, 2024 14:13
jayanthkomarraju pushed a commit to jayanthkomarraju/dataverse-frontend that referenced this pull request May 31, 2024
…d-all-files

244 - Integration download dataset
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration Tasks involving the connection and interaction of UI features with the Dataverse API Size: 3 A percentage of a sprint. 2.1 hours.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Download all dataset files
3 participants