Add auto DOI opt-out toggle for legacy and hosted workflows #2059

kathy-t · 2025-02-07T18:07:55Z

Description
I recommend reviewing this with "Hide whitespace" checked.

This PR adds a Automatic DOI Generation toggle to the Manage DOIs dialog so that users can opt out of auto DOI generation for legacy and hosted workflows. GitHub App workflow, tools, notebooks, and services also have this section except the toggle is not displayed (the ON/OFF status is still displayed though). There is a sentence telling the users to edit the .dockstore.yml, which is similar to what we do for the GitHub App manual topic.

Based on UI best practices, the slide toggle takes effect immediately if pressed and does not require the user to click Save to apply the new state. The Manage DOI dialog has radio buttons for DOI selection, and it feels like a confusing experience to have the user click Save to save this selection while the toggle takes effect immediately. Thus, I changed it so that the radio button selection is saved immediately when pressed. The Save button is now just a Done button that closes the dialog.

Note this PR requires dockstore/dockstore#6074 which allows authenticated users to call the PUT autodoigeneration endpoint to toggle the auto DOI setting.

Before

After

Manage DOIs dialog for legacy and hosted workflows have a slide toggle:

Manage DOIs dialog for GitHub App entries do not have a toggle. It displays On/Off and tells the user to edit the .dockstore.yml:

Review Instructions
On staging, for a legacy or hosted workflow, opt out of DOI selection by clicking Manage DOIs and clicking the toggle. Refresh the page and verify that the setting is Off.

For a GItHub App entry, click the Manage DOIs button and verify that the Automatic DOI Generation section displays On or Off without a slide toggle. Verify that it tells the user to edit their .dockstore.yml.

Issue
https://ucsc-cgl.atlassian.net/browse/SEAB-6807

Security
If there are any concerns that require extra attention from the security team, highlight them here.

Please make sure that you've checked the following before submitting your pull request. Thanks!

codecov · 2025-02-07T18:08:11Z

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 41.81%. Comparing base (a29f9a1) to head (80e86d0).
Report is 1 commits behind head on hotfix/2.13.4.

Files with missing lines	Patch %	Lines
...ntry/doi/manage-dois/manage-dois-dialog.service.ts	16.66%	5 Missing ⚠️
...ry/doi/manage-dois/manage-dois-dialog.component.ts	0.00%	2 Missing ⚠️

Additional details and impacted files

@@                Coverage Diff                @@
##           hotfix/2.13.4    #2059      +/-   ##
=================================================
- Coverage          41.84%   41.81%   -0.04%     
=================================================
  Files                394      394              
  Lines              12321    12330       +9     
  Branches            2959     2960       +1     
=================================================
  Hits                5156     5156              
- Misses              4845     4855      +10     
+ Partials            2320     2319       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

kathy-t · 2025-02-07T19:29:35Z

src/app/workflow/workflow.component.html

@@ -171,7 +171,7 @@ <h3>
          class="private-btn small-btn-structure ml-2"
          matTooltip="Manage DOIs"
          (click)="manageDois()"
-          [disabled]="!canWrite"
+          [disabled]="!canWrite || (isRefreshing$ | async)"


I noticed this button is not disabled when the page is loading after an action (ex: Publish) so I just added this. Same thing for the Manage labels button below

svonworl · 2025-02-12T01:13:24Z

src/app/shared/entry/doi/manage-dois/manage-dois-dialog.component.html

+      *ngIf="!isGitHubAppEntry"
+      [(ngModel)]="isAutoDoiEnabled"
+      (change)="toggleAutoDoiGeneration()"
+      labelPosition="before"


Recommend changing to "after" so it matches the positioning in the mockups (after the slider), just in case anyone was attached to that particular positioning.

svonworl · 2025-02-12T01:15:50Z

src/app/shared/entry/doi/manage-dois/manage-dois-dialog.service.ts

+    this.workflowsService.autoGenerateDois(entry.id, { autoGenerateDois: isAutoDoiEnabled }).subscribe(
+      (response) => {
+        this.alertService.detailedSuccess();
+        this.workflowService.setWorkflow({ ...this.workflowQuery.getActive(), autoGenerateDois: response });


After successfully toggling the slider, the "success" snackbar pops up below, but if you try to click "Dismiss" within the snackbar, the Manage DOIs dialog is dismissed. Also, when the "success" snackbar pops up, it's little distracting, imho. Would it be ok to simply not display it (on "success")? (Given that the mechanics of the "which doi" radio box have changed, and same thing happens when a radio box is clicked, same question for it, also.)

Changed it to simpleSuccess() so the snackbar doesn't pop up

svonworl · 2025-02-12T01:19:13Z

src/app/shared/entry/doi/manage-dois/manage-dois-dialog.component.html

+        >
+      </span>
+      <span *ngIf="isGitHubAppEntry">
+        Edit the enableAutoDoi field in the .dockstore.yml to change your Automatic DOI Generation preference.


In the isGitHubAppEntry true version, there are two "info" icons in this block of text. By itself, probably not a problem, but the spacing between the two icons and this text passage is equidistant, so it's hard to tell which icon belongs to which text passage. A little additional spacing on the left side of this text might help to set it off from the first icon, and group it better with the second...

Agreed, this was something I played around with for a bit and I wasn't completely satisfied with it.

How about instead, we add some new documentation to https://docs.dockstore.org/en/stable/end-user-topics/dois.html#automatic-dockstore-doi-generation about how to disable automatic DOIs? Then I can just keep a single info icon at the end of the description that links to https://docs.dockstore.org/en/stable/end-user-topics/dois.html#automatic-dockstore-doi-generation which contains all the needed info for automatic DOIs?

I went with this approach so there's only one info icon. I created https://ucsc-cgl.atlassian.net/browse/SEAB-6950 to update our documentation to include instructions on opting out

kathy-t · 2025-02-12T17:05:41Z

Updated screenshots

Legacy workflow with toggle:

GitHub App workflow without toggle:

hyunnaye · 2025-02-12T17:19:40Z

In the screenshot, does the toggle disappear when set to On?

kathy-t · 2025-02-12T17:21:26Z

In the screenshot, does the toggle disappear when set to On?

No, the first screenshot is for a legacy workflow which has a toggle and the second screenshot is for a GitHub App workflow which has no toggle. I'll update the description to be clearer 🙂

hyunnaye · 2025-02-12T17:22:19Z

In the screenshot, does the toggle disappear when set to On?

No, the first screenshot is for a legacy workflow which has a toggle and the second screenshot is for a GitHub App workflow which has no toggle. I'll update the description to be clearer 🙂

Thanks for clarifying. Looks good!

sonarqubecloud · 2025-02-12T17:29:52Z

Quality Gate failed

Failed conditions
10.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

kathy-t added 2 commits February 7, 2025 11:20

Add opt out toggle for legacy and hosted workflows

7f61fd1

Clean up

407bcb1

kathy-t self-assigned this Feb 7, 2025

kathy-t commented Feb 7, 2025

View reviewed changes

kathy-t requested review from svonworl, denis-yuen and hyunnaye February 7, 2025 19:30

svonworl reviewed Feb 12, 2025

View reviewed changes

PR feedback

60e1509

kathy-t requested a review from svonworl February 12, 2025 17:05

svonworl approved these changes Feb 12, 2025

View reviewed changes

hyunnaye approved these changes Feb 12, 2025

View reviewed changes

Merge branch 'hotfix/2.13.4' into seab-6807/legacy-doi-opt-out

80e86d0

kathy-t merged commit 9da6cbe into hotfix/2.13.4 Feb 12, 2025
14 of 19 checks passed

kathy-t deleted the seab-6807/legacy-doi-opt-out branch February 12, 2025 18:39

kathy-t mentioned this pull request Feb 14, 2025

Fix auto DOI opt out instruction typo and make it bold #2064

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add auto DOI opt-out toggle for legacy and hosted workflows #2059

Add auto DOI opt-out toggle for legacy and hosted workflows #2059

kathy-t commented Feb 7, 2025 •

edited

Loading

codecov bot commented Feb 7, 2025 •

edited

Loading

kathy-t Feb 7, 2025

svonworl Feb 12, 2025

svonworl Feb 12, 2025

kathy-t Feb 12, 2025

svonworl Feb 12, 2025

kathy-t Feb 12, 2025

kathy-t Feb 12, 2025 •

edited

Loading

kathy-t commented Feb 12, 2025 •

edited

Loading

hyunnaye commented Feb 12, 2025

kathy-t commented Feb 12, 2025

hyunnaye commented Feb 12, 2025

sonarqubecloud bot commented Feb 12, 2025

Add auto DOI opt-out toggle for legacy and hosted workflows #2059

Add auto DOI opt-out toggle for legacy and hosted workflows #2059

Conversation

kathy-t commented Feb 7, 2025 • edited Loading

codecov bot commented Feb 7, 2025 • edited Loading

Codecov Report

kathy-t Feb 7, 2025

Choose a reason for hiding this comment

svonworl Feb 12, 2025

Choose a reason for hiding this comment

svonworl Feb 12, 2025

Choose a reason for hiding this comment

kathy-t Feb 12, 2025

Choose a reason for hiding this comment

svonworl Feb 12, 2025

Choose a reason for hiding this comment

kathy-t Feb 12, 2025

Choose a reason for hiding this comment

kathy-t Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

kathy-t commented Feb 12, 2025 • edited Loading

hyunnaye commented Feb 12, 2025

kathy-t commented Feb 12, 2025

hyunnaye commented Feb 12, 2025

sonarqubecloud bot commented Feb 12, 2025

Quality Gate failed

kathy-t commented Feb 7, 2025 •

edited

Loading

codecov bot commented Feb 7, 2025 •

edited

Loading

kathy-t Feb 12, 2025 •

edited

Loading

kathy-t commented Feb 12, 2025 •

edited

Loading