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

Wire up VDI client #549

Merged
merged 78 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from 66 commits
Commits
Show all changes
78 commits
Select commit Hold shift + click to select a range
076261e
Initial VDI client commit
jernestmyers Sep 29, 2023
7de5b01
Add a rough addDataset API method
jernestmyers Oct 3, 2023
9af6ee7
Ignore DS_Store files
jernestmyers Oct 6, 2023
80a7347
Talk to vdi service in client
jernestmyers Oct 6, 2023
bd3f1bb
Render preliminarily dataset list and dataset details pages
jernestmyers Oct 12, 2023
18b7b32
Add more VDI endpoints, tweak types, tweak outputs
jernestmyers Oct 12, 2023
590319b
Wire up addDataset form upload with VDI
jernestmyers Oct 13, 2023
ff72e81
Route to dataset details when user uploads dataset
jernestmyers Oct 16, 2023
dee7f61
Add back projectIDs to dataset type, clean up code
jernestmyers Oct 17, 2023
e0ce6e6
Clean up code and types
jernestmyers Oct 17, 2023
01a7752
Merge branch 'main' into feature/vdi-client-work
jernestmyers Oct 18, 2023
fab8e64
Wire up request to download VDI files
jernestmyers Oct 18, 2023
1e82cc9
Improve vdi file download implementation
jernestmyers Oct 19, 2023
c0e00ee
Wire up dataset sharing w/ VDI, preliminarily
jernestmyers Oct 20, 2023
bd77767
Remove date and email from sharedWith list
jernestmyers Oct 20, 2023
50b6b2b
Finish migrating all userDatasetServiceWrappers to VDI
jernestmyers Oct 20, 2023
fb81aae
Allow sharing dataset with multiple users
jernestmyers Oct 20, 2023
9303da8
Refactor dataset download tables to include uploaded and processed zi…
jernestmyers Oct 23, 2023
c0ed647
Clean up vdi-to-legacy data transform, refactor statuses, implement u…
jernestmyers Oct 23, 2023
82449d4
Use userID in dataset details sharing
jernestmyers Oct 23, 2023
7457b4b
Disable recent uploads workspace tab and route
jernestmyers Oct 24, 2023
08e69a3
Hardcode accepted file types and disable more legacy UD endpoints
jernestmyers Oct 24, 2023
b8bf93c
Begin status details overhaul
jernestmyers Oct 25, 2023
b10da4d
Replace fully legacy UD wrappers, assert vdiWdkService, remove ts-ign…
jernestmyers Oct 25, 2023
0108e0a
Resolve TS errors in genomics wdkService
jernestmyers Oct 25, 2023
1d7d7af
Rough-in file listing endpoint and prep download UI changes
jernestmyers Oct 25, 2023
c18f754
Refactor status details to reflect VDI statuses
jernestmyers Oct 26, 2023
5acf69c
Sync compatibility verbiage with status details
jernestmyers Oct 26, 2023
f171a24
Remove isInstalled and isCompatible types from UserDataset
jernestmyers Oct 26, 2023
7645686
Update datasetTypes for VDI
jernestmyers Oct 26, 2023
da8dcd9
Fix unsharing bug and clean up types
jernestmyers Oct 26, 2023
99609cc
Incorporate VDI api changes into client
jernestmyers Oct 30, 2023
c33772b
Clean up types and simplify vdi service assertion
jernestmyers Oct 31, 2023
9e4bf3f
Improve api method name
jernestmyers Oct 31, 2023
256fab2
Update compatibility to reflect dataset's status properties
jernestmyers Oct 31, 2023
b5880c3
Clean up VDI dataset details re: deps, status, download status, compa…
jernestmyers Nov 1, 2023
8d01938
Change datetime string from toISOString to toLocaleString
jernestmyers Nov 2, 2023
6adcbf4
Address most PR feedback
jernestmyers Nov 9, 2023
31e4313
Refactor questions logic to render "Available searches"
jernestmyers Nov 9, 2023
eb50265
Update GBrowseUrls for VDI response and new question for longest sequ…
jernestmyers Nov 10, 2023
c40f296
Replace use of var in variable declarations
jernestmyers Nov 16, 2023
51b18ba
Merge branch 'main' into feature/vdi-client-work
dmfalke Dec 8, 2023
a3e4d5a
Merge remote-tracking branch 'origin/main' into feature/vdi-client-work
dmfalke Dec 12, 2023
50b1048
VDI: Allow vdi service url to be configured by deployment environment…
dmfalke Dec 13, 2023
585e786
Merge remote-tracking branch 'origin/main' into feature/vdi-client-work
dmfalke Dec 13, 2023
e8ff0b9
Properly extend state of parent class
dmfalke Dec 14, 2023
9dc6f61
Update wdkService wrappers in mbio and clinepi
dmfalke Dec 14, 2023
7ec4308
Merge remote-tracking branch 'origin/main' into feature/vdi-client-work
dmfalke Dec 20, 2023
6c05bf7
Create user-datasets-legacy package
jernestmyers Jan 3, 2024
a74c2e6
Merge branch 'main' into feature/vdi-client-work
dmfalke Jan 4, 2024
5416b4e
Merge branch 'main' into maintain-legacy-UDs-as-needed
dmfalke Jan 4, 2024
48a7285
Merge branch 'maintain-legacy-UDs-as-needed' into feature/vdi-client-…
jernestmyers Jan 5, 2024
627ce97
Configure EDA sites for user-datasets-legacy
jernestmyers Jan 5, 2024
0145be1
Merge branch 'maintain-legacy-UDs-as-needed' of github.com:VEuPathDB/…
jernestmyers Jan 5, 2024
4e4feaa
Configure legacy UDs in EDA sites
jernestmyers Jan 5, 2024
a49deaa
Add missing dependency to web-common
dmfalke Jan 9, 2024
f229344
Merge branch 'main' into feature/vdi-client-work
dmfalke Jan 12, 2024
f28272e
Add type guards against undefined dataStatus
jernestmyers Jan 16, 2024
f49094e
Merge pull request #752 from VEuPathDB/configure-legacy-UDs-in-EDA-sites
jernestmyers Jan 24, 2024
4f088ac
Merge branch 'main' into feature/vdi-client-work
dmfalke Jan 25, 2024
34b42d9
fix imports re Mesa move
dmfalke Jan 25, 2024
3ca3e92
fix imports re Mesa move
dmfalke Jan 25, 2024
ed13aaf
Add VDI upload progress feedback to UI
jernestmyers Jan 31, 2024
eb4a818
Use modal for upload progress thereby blocking navigation
jernestmyers Feb 1, 2024
d477274
Remove setTimeout hack from submitForm's xhr logic
jernestmyers Feb 1, 2024
0542cab
Refactor logic for dataset status and dataset compatibility statements
jernestmyers Feb 2, 2024
003fac2
Refactor upload progress API changes
jernestmyers Feb 5, 2024
a08e666
Fix addUserDataset endpoint path
jernestmyers Feb 6, 2024
6082f0a
Address feedback in dataset status and compatibility
jernestmyers Feb 6, 2024
d2a40d8
Merge remote-tracking branch 'origin/main' into feature/vdi-client-work
dmfalke Feb 19, 2024
9051786
Merge remote-tracking branch 'origin/feature/vdi-client-work' into fe…
jernestmyers Feb 20, 2024
66e4ead
Merge branch 'main' into feature/vdi-client-work
dmfalke Feb 28, 2024
d968ef0
Use URLSearchParams for more flexibility
dmfalke Feb 29, 2024
9c347bf
Merge branch 'main' into feature/vdi-client-work
dmfalke Mar 12, 2024
2a31641
Port changes from legacy datasets
dmfalke Mar 12, 2024
19d844a
Merge remote-tracking branch 'origin/main' into feature/vdi-client-work
dmfalke Mar 25, 2024
6a313e7
Merge main and resolve conflicts
jernestmyers Apr 2, 2024
3d92b84
Merge branch 'main' into feature/vdi-client-work
jernestmyers Apr 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,5 @@ dist
!.yarn/releases
!.yarn/sdks
!.yarn/versions

.DS_Store
11 changes: 11 additions & 0 deletions packages/libs/user-datasets-legacy/.env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
VEUPATHDB_LOGIN_USER=apidb
VEUPATHDB_LOGIN_PASS=**********

BASE_URL=https://qa.microbiomedb.org
WEBAPP=mbio

REACT_APP_WDK_SERVICE_URL=$BASE_URL/$WEBAPP/service

DATASET_IMPORT_SERVICE_URL=$BASE_URL/dataset-import

REACT_APP_AVAILABLE_UPLOAD_TYPES=biom
17 changes: 17 additions & 0 deletions packages/libs/user-datasets-legacy/.github/workflows/compile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Compile Check

on:
pull_request:

jobs:
compile:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14
- name: Check TypeScript compilation
run: |
yarn install
yarn tsc --noEmit
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Node.js Package

on:
push:
branches: [ main ]

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14
- name: Build NPM packages
run: |
yarn install
yarn build-npm-modules
- uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
access: public
25 changes: 25 additions & 0 deletions packages/libs/user-datasets-legacy/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build
/lib

# misc
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
24 changes: 24 additions & 0 deletions packages/libs/user-datasets-legacy/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build
/lib

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
201 changes: 201 additions & 0 deletions packages/libs/user-datasets-legacy/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
56 changes: 56 additions & 0 deletions packages/libs/user-datasets-legacy/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Getting Started with Create React App

This project was bootstrapped with https://github.com/facebook/create-react-app[Create React App], using the https://github.com/VEuPathDB/web-dev/packages/cra-template[`@veupathdb` template].

## Available Scripts

In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.
Open http://localhost:3000[http://localhost:3000] to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

You will be prompted to enter the VEuPathDB BRC Pre-Release Login credentials.

**Environment Variables**

- **`VEUPATHDB_LOGIN_USER`** VEuPathDB BRC prerelease user name (optional, but recommended)
- **`VEUPATHDB_LOGIN_PASS`** VEuPathDB BRC prerelease user password (optional, but recommended)
- **`REACT_APP_WDK_SERVICE_URL`** URL for a VEuPathDB service endpoint (required)
- **`DATASET_IMPORT_SERVICE_URL`** URL for a dataset import service endpoint (required)
- **`REACT_APP_AVAILABLE_UPLOAD_TYPES`** Comma-separated list of upload types which the local client will support (required)

### `yarn test`

Launches the test runner in the interactive watch mode.
See the section about https://facebook.github.io/create-react-app/docs/running-tests[running tests] for more information.

### `yarn build`

Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about https://facebook.github.io/create-react-app/docs/deployment[deployment] for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the https://facebook.github.io/create-react-app/docs/getting-started[Create React App documentation].

To learn React, check out the https://reactjs.org/[React documentation].
Loading