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

[WX-1857] Methods Repository workflow details page improvements #5108

Merged
merged 41 commits into from
Oct 1, 2024

Conversation

sam-schu
Copy link
Contributor

@sam-schu sam-schu commented Sep 26, 2024

Jira Ticket: https://broadworkbench.atlassian.net/browse/WX-1857

Summary of changes:

What

  • Added error handling for an invalid method namespace, method name, or snapshot ID in the URL for the method details page in the Broad Methods Repository.
    • If the namespace/name method path is invalid, a "Could not display method" error page is shown, with the option to return to the methods list. (Compare to the existing "Could not display workspace" error page.)
    • If the snapshot ID is invalid, but other snapshot(s) of the method are accessible by the user, a "Could not display snapshot" error page is shown, with the option to choose a different snapshot of the same method.
      • The "Export to Workspace" button and the snapshot action menu are disabled until the user chooses a valid snapshot.
      • Known limitation: The tab bar is not disableable, so clicking between the "Dashboard" and "WDL" tabs still works and makes Ajax calls for each click.
    • Previously, the loading spinner would continue spinning forever, with no error page appearing.
  • Added error handling for an unexpected error (e.g., a network error) while loading the list of snapshots for a method or the details of a particular snapshot.
    • Depending on which Ajax call fails, an error popup displaying "Error loading method" or "Error loading snapshot" is shown. (This is analogous to the "Error loading workspace" popup from the "Workspaces" section of Terra UI.)
    • Previously, the loading spinner would continue spinning forever, with no error message appearing.
  • Fixed the snapshot dropdown on the method details page so that every dropdown entry can now be clicked, regardless of whether there is a collapsible box header behind it.
  • Made the spinners used on the page consistent.
  • Added additional types to workflow details components and related files to facilitate the above work.

Why

  • To bring the user experience in this new section of Terra UI up to the same level as the rest of Terra UI and the methods repository section of Firecloud UI.

Testing strategy

  • Manual testing
  • Unit tests
    • Since the dropdown entries of the Select component do not render directly underneath the main dropdown box in a unit test environment, unit tests were not able to be written for the dropdown fix. This change was manually tested only.

Visual Aids

Invalid URL error handling and snapshot dropdown fix:

Screen.Recording.2024-09-30.at.1.29.12.PM.mov

Unexpected/network error while loading method snapshots list:
network error loading method snapshots image

Unexpected/network error while loading individual snapshot details:
network error loading snapshot details image

Note: The first 25 commits shown (up to 20214e9) are from the branch off of which this branch was made. The diff is accurate to the work done for this PR.

@sam-schu sam-schu changed the base branch from dev to mb-su-160 September 26, 2024 15:51
@sam-schu sam-schu changed the base branch from mb-su-160 to dev September 26, 2024 15:52
Copy link

sonarcloud bot commented Sep 30, 2024

@sam-schu sam-schu changed the title [DRAFT] workflow details fixes [WX-1857] Methods Repository workflow details page improvements Sep 30, 2024
@sam-schu sam-schu marked this pull request as ready for review September 30, 2024 18:10
Copy link
Contributor

@aednichols aednichols left a comment

Choose a reason for hiding this comment

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

Code looks good to me.

Tested on PR environment, the two issues that seem most likely to cause complaints; namely 404s now display a proper message and page elements no longer interfere with selecting snapshots.

@sam-schu sam-schu added this pull request to the merge queue Oct 1, 2024
Merged via the queue into dev with commit 3d98d01 Oct 1, 2024
10 checks passed
@sam-schu sam-schu deleted the sts_WX-1857_workflow_details_fixes branch October 1, 2024 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants