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

Minor Entry Type Changes - SEAB-5365 #1761

Merged
merged 4 commits into from
Apr 27, 2023

Conversation

KimberleyChong
Copy link
Contributor

@KimberleyChong KimberleyChong commented Apr 25, 2023

Description
Fixes some minor entry type inconsistencies, some workflow styles were spilling into AppTool and Notebooks, and tools were missing some styles that workflows had. Now from the UI you really can't tell the difference between AppTools and a regular tool.

Ink Bars:

Ink bar colours for AppTools notebooks etc. would use the workflow green colour, altered for AppTools, Notebooks and Services to use their corresponding tab group colours (i.e. blue, purple, and orange):

Before After
image image

Mat-Dividers:

  • Mat-cards in the info tab for Tools were missing mat-dividers:
  • Before:
    image
  • After:
    image

Authors:

  • Workflows and AppTools have an author table like this, but tools do not have this table when it should:
    image

  • Tools Before:
    image

  • Tools After:
    image

  • The mat-card-title was also changed from "Tag Information" to "Tool Version Information" to match AppTools, Services, Notebooks and Workflows.

  • NOTE: For Workflow type entries, the ORCID ID for an author is retrieved using the workflows/{workflowId}/workflowVersions/{workflowVersionId}/orcidAuthors endpoint. There doesn't seem to be an equivilant endpoint for tools, so the ORCID ID column in the table displays empty always. This isn't a loss of functionality because we didn't display ORCID IDs previously, but if we didn't want to display an empty column we could remove orcid_id from the displayedColumns array until we implement this endpoint or just leave as so, let me know your opinions!

  • Example with orcid_id column hidden:
    image

Review Instructions
Ink bar colours should be the correct colour when viewing an entry, ie. green - workflows, blue - tools, purple - notebooks, orange - services. Tools should have the new author table and mat-dividers under the titles when viewing the info tab.

Issue
SEAB-5365

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!

  • Check that your code compiles by running npm run build
  • Ensure that the PR targets the correct branch. Check the milestone or fix version of the ticket.
  • If this is the first time you're submitting a PR or even if you just need a refresher, consider reviewing our style guide
  • Do not bypass Angular sanitization (bypassSecurityTrustHtml, etc.), or justify why you need to do so
  • If displaying markdown, use the markdown-wrapper component, which does extra sanitization
  • Do not use cookies, although this may change in the future
  • Run npm audit and ensure you are not introducing new vulnerabilities
  • Do due diligence on new 3rd party libraries, checking for CVEs
  • Don't allow user-uploaded images to be served from the Dockstore domain
  • If this PR is for a user-facing feature, create and link a documentation ticket for this feature (usually in the same milestone as the linked issue). Style points if you create a documentation PR directly and link that instead.
  • Check whether this PR disables tests. If it legitimately needs to disable a test, create a new ticket to re-enable it in a specific milestone.

@KimberleyChong KimberleyChong self-assigned this Apr 25, 2023
@KimberleyChong KimberleyChong marked this pull request as ready for review April 26, 2023 13:32
@denis-yuen
Copy link
Member

  • NOTE: For Workflow type entries, the ORCID ID for an author is retrieved using the workflows/{workflowId}/workflowVersions/{workflowVersionId}/orcidAuthors endpoint. There doesn't seem to be an equivilant endpoint for tools, so the ORCID ID column in the table displays empty always. This isn't a loss of functionality because we didn't display ORCID IDs previously, but if we didn't want to display an empty column we could remove orcid_id from the displayedColumns array until we implement this endpoint or just leave as so, let me know your opinions!

Thanks for catching this oversight, we should definitely implement a new endpoint. Do you happen to know if this affects apptools as well?

@kathy-t
Copy link
Contributor

kathy-t commented Apr 26, 2023

  • NOTE: For Workflow type entries, the ORCID ID for an author is retrieved using the workflows/{workflowId}/workflowVersions/{workflowVersionId}/orcidAuthors endpoint. There doesn't seem to be an equivilant endpoint for tools, so the ORCID ID column in the table displays empty always. This isn't a loss of functionality because we didn't display ORCID IDs previously, but if we didn't want to display an empty column we could remove orcid_id from the displayedColumns array until we implement this endpoint or just leave as so, let me know your opinions!

Thanks for catching this oversight, we should definitely implement a new endpoint. Do you happen to know if this affects apptools as well?

This doesn't affect apptools because it uses the workflow component. Example app tool with ORCID author:
image

I think Kimberley's referring to the legacy, non-GitHub app tools, in which case, legacy tools can't have ORCID authors because the ORCID authors are provided through the .dockstore.yml which is why legacy tools don't have an equivalent orcidAuthors endpoint.

For the legacy tools, I would recommend removing the ORCID iD column unless we plan on adding ORCID author functionality to legacy, non-GitHub app tools.

@KimberleyChong
Copy link
Contributor Author

I think Kimberley's referring to the legacy, non-GitHub app tools, in which case, legacy tools can't have ORCID authors because the ORCID authors are provided through the .dockstore.yml which is why legacy tools don't have an equivalent orcidAuthors endpoint.

Yep, exactly right, I probably should have been more specific when I said "workflow type" -> meaning entries that use workflow components (AppTools, Notebooks, Services)

For the legacy tools, I would recommend removing the ORCID iD column unless we plan on adding ORCID author functionality to legacy, non-GitHub app tools.

I agree in removing the column, let me know if any oppositions!

</span>
<span *ngIf="entryType === EntryType.Notebook" data-cy="notebook-icon">
<img src="../../assets/svg/notebook-circle.svg" alt="notebook icon" />
<span [attr.data-cy]="entryType + '-icon'">
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is much better!

@sonarqubecloud
Copy link

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
15.3% 15.3% Duplication

@KimberleyChong KimberleyChong merged commit dee4c47 into release/1.14 Apr 27, 2023
@KimberleyChong KimberleyChong deleted the SEAB-5365/entry-type-ui-fixes branch April 27, 2023 19:18
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.

5 participants