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.

Sign up for GitHub

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

Jump to bottom

[ENG-4671] Implement submit-to-boa flow for file list and file detail page #2034

Merged

cslzchen merged 11 commits into CenterForOpenScience:feature/boa-addon from felliott:feature/boa-addon

Nov 8, 2023

Member

felliott commented Oct 19, 2023 •

edited

Loading

To be filled out.

Ticket: https://openscience.atlassian.net/browse/ENG-4671
Feature flag: n/a

Purpose

Add "Submit to Boa" action to file pages for .boa files

Summary of Changes

Screenshot(s)

Side Effects

QA Notes

felliott changed the title ~~[WIP] first stab at Boa addon ux~~ [WIP][ENG-4671] first stab at Boa addon ux

felliott force-pushed the feature/boa-addon branch from 822c9a3 to 3bc882d Compare

October 23, 2023 13:51

coveralls commented Oct 23, 2023 •

edited

Loading

Pull Request Test Coverage Report for Build 6747699034

12 of 31 (38.71%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.08%) to 70.575%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
app/packages/files/file.ts	0	2	0.0%
lib/osf-components/addon/components/file-actions-menu/component.ts	1	4	25.0%
lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts	1	15	6.67%

Totals
Change from base Build 6642409593:	-0.08%
Covered Lines:	5965
Relevant Lines:	8225

💛 - Coveralls

felliott force-pushed the feature/boa-addon branch 2 times, most recently from 2f8aa7b to a05145b Compare

October 27, 2023 16:38

futa-ikeda reviewed

View reviewed changes

Contributor

futa-ikeda left a comment

Leaving a quick review. Just some small embery notations/quirks that I see that could be implemented

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts Outdated Show resolved Hide resolved

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/template.hbs Outdated Show resolved Hide resolved

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts Outdated Show resolved Hide resolved

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts Outdated Show resolved Hide resolved

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts Outdated Show resolved Hide resolved


          [WIP] first stab at Boa addon ux

f5d1b93

 * make boa modal findable
 * save WIP on dataset select
 * futa wisdom attained/accepted
 * add action; fetch parents properly
 * enabled addons enabled
 * cleanups; fix closemodal

felliott force-pushed the feature/boa-addon branch from 8ed34ec to f5d1b93 Compare

November 1, 2023 04:52

futa-ikeda and others added 6 commits

November 2, 2023 17:26


          Add mirage support for BoA files

de8b28b


          Type updates

d4fde0e


          authenticate addon endpoint request

ff4b06f


          Add a bit of error handling to mirage

9888b8e


          Change logic to populate a node addons

1e327c8


          Disable submit to boa if no dataset selected

e312dd0

cslzchen changed the title ~~[WIP][ENG-4671] first stab at Boa addon ux~~ [ENG-4642] [ENG-4671] Boa Add-on Project PR - Ember Part

cslzchen mentioned this pull request

[ENG-4642] Boa Add-on Project PR - OSF Part CenterForOpenScience/osf.io#10469

Merged


          Add qp to boa upload link

613d7cc

cslzchen changed the base branch from develop to feature/boa-addon

November 3, 2023 19:52

cslzchen changed the title ~~[ENG-4642] [ENG-4671] Boa Add-on Project PR - Ember Part~~ [ENG-4671] Implement submit-to-boa flow for file list and file detail page

futa-ikeda added 2 commits

November 6, 2023 11:12


          Add placeholder message to dataset select

ebf1b4c


          Update toast messages

90c7468

futa-ikeda reviewed

View reviewed changes

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts

+                  datasets?: string[];
+                  @tracked selectedDataset?: string;
+                  datasets = [

Contributor

futa-ikeda Nov 7, 2023

We will hard-code this list for now, and if/when Boa adds anything to this list, we will update it or fetch it from somewhere.

brianjgeiger requested changes

View reviewed changes

Contributor

brianjgeiger left a comment

Just a couple of comments and a couple of small things, mostly around an unnecessary mirage trait.

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts

Comment on lines +24 to +43

+                  datasets = [
+                      '2022 Jan/Java',
+                      '2022 Feb/Python',
+                      '2021 Method Chains',
+                      '2021 Aug/Python',
+                      '2021 Aug/Kotlin (small)',
+                      '2021 Aug/Kotlin',
+                      '2021 Jan/ML-Verse',
+                      '2020 August/Python-DS',
+                      '2019 October/GitHub (small)',
+                      '2019 October/GitHub (medium)',
+                      '2019 October/GitHub',
+                      '2015 September/GitHub',
+                      '2013 September/SF (small)',
+                      '2013 September/SF (medium)',
+                      '2013 September/SF',
+                      '2013 May/SF',
+                      '2013 February/SF',
+                      '2012 July/SF',
+                  ];

Contributor

brianjgeiger Nov 7, 2023

This is less than ideal, but I see it's been discussed already as part of the scope. Let's never update this list, and if it ever needs to change, we should use an endpoint to get the current list of datasets.

lib/osf-components/addon/components/file-actions-menu/submit-to-boa-modal/component.ts

+                          const fileModel = file.fileModel;
+                          const parentFolder = await fileModel.get('parentFolder');
+                          const grandparentFolder = await parentFolder.get('parentFolder');
+                          const endpoint = config.OSF.url + 'api/v1/project/' + fileModel.target.get('id') + '/boa/submit-job/';

Contributor

brianjgeiger Nov 7, 2023

/api/v1 url? Yuck!

Collaborator

cslzchen Nov 8, 2023

sadly true, it uses the existing add-on routes, might be something that will be totally refactored in the new add-on service?

lib/osf-components/addon/components/file-actions-menu/template.hbs Outdated

Comment on lines 113 to 116

+                      {{#if @item.currentUserCanDelete}}
+                          {{#if @item.providerIsOsfstorage}}
+                              {{#if @item.isBoaFile}}
+                                  {{#if this.isBoaEnabled}}

Contributor

brianjgeiger Nov 7, 2023

This is a lot of nested ifs. Probably fine, though might be better as a getter in the component ts.

Contributor

futa-ikeda Nov 7, 2023

Good point! I will distill this down to a getter on the component

mirage/factories/node.ts Outdated

Comment on lines 192 to 194

+                  hasBoaEnabled: trait<MirageNode>({
+                      boaEnabled: true,
+                  }),

Contributor

brianjgeiger Nov 7, 2023

Does this need to be a trait, or could we just set boaEnabled to true?

Contributor

futa-ikeda Nov 7, 2023

Ahh, I was going to have this trait do a bit more (e.g. add a .boa file to the node's OsfStorage), but maybe having a trait do all of that is a bit much. Will remove

Contributor

brianjgeiger Nov 7, 2023

If you're going to add a file, that does make sense for a trait. Either way.

mirage/scenarios/dashboard.ts Outdated

                       id: 'file5',
                       title: 'With some files',
                       currentUserPermissions: [Permission.Read, Permission.Write, Permission.Admin],
-                  }, 'withFiles', 'withStorage', 'withContributors', 'withAffiliatedInstitutions', 'withDoi', 'withLinkedByNodes');
+                  }, 'hasBoaEnabled', 'withFiles', 'withStorage', 'withContributors',

Contributor

brianjgeiger Nov 7, 2023

Yeah, should just be able to do boaEnabled: true above.

mirage/views/addons.ts

+              // This is the handler for the unofficial node/addons endpoint
+              // It is only being used by the file-action-menu component to determine if a node has the BoA addon enabled
+              // It is not being used by the official OSF API

Contributor

brianjgeiger Nov 7, 2023

Aside: this is probably going to change very soon with the addons project.


          CR feedback

0c0e306

brianjgeiger approved these changes

View reviewed changes

cslzchen approved these changes

View reviewed changes

cslzchen merged commit 61cd658 into CenterForOpenScience:feature/boa-addon

9 checks passed

futa-ikeda added this to the 23.14.0 milestone

cslzchen mentioned this pull request

[ENG-4642] Boa Add-on Project PR - Ember Part #2046

Merged

felliott deleted the feature/boa-addon branch

November 11, 2023 03:38

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

Labels

None yet