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

[AN-160] Reorganize methods repository files #5155

Merged
merged 28 commits into from
Nov 5, 2024

Conversation

sam-schu
Copy link
Contributor

@sam-schu sam-schu commented Nov 1, 2024

Jira Ticket: https://broadworkbench.atlassian.net/browse/AN-160

Summary of changes:

Overview

  • Reorganized directory structures, renamed directories, and moved code files related to the Broad Methods Repository into different directories to better match their function and the overall organization of the Terra UI repository.
  • Reorganized/moved the contents of some utils and type files related to the Broad Methods Repository into different files to better match their function and the overall organization of the Terra UI repository.
    • Made some small typing improvements.

Desired directory structure

  • The src/pages/methods directory contains page-level component files for the methods repo. (The previous equivalent directory, src/pages/workflows, contained non-page-level components that should have been in the workflows functional area, src/workflows/..., instead.)
  • The src/workflows/methods directory is the subsection of the src/workflows functional area that contains reusable components for the methods repo.
  • Types corresponding to Orchestration or Agora schemas used for the body or response of Ajax calls relating to the methods repo are in src/libs/ajax/methods/methods-models.ts, not in utils files in the pages directory or in a functional area. src/workflows/methods/workflows-acl-utils.ts re-exports ACL types along with an existing ACL utility function, following the pattern from src/workspaces/acl-utils.ts.

Why

  • To make it easier to find and understand the purpose of files, components, and types related to the Broad Methods Repository by reorganizing the code according to existing conventions in the Terra UI repo.

Testing strategy

  • Ran existing unit tests
  • Manual smoke testing

@sam-schu
Copy link
Contributor Author

sam-schu commented Nov 4, 2024

Quality Gate Passed Quality Gate passed

Issues 2 New issues 0 Accepted issues

Measures 0 Security Hotspots 93.8% Coverage on New Code 0.0% Duplication on New Code

See analysis details on SonarCloud

These 2 issues are preexisting and out of the scope of this PR to fix.

Copy link

sonarcloud bot commented Nov 4, 2024

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.

Clearly an improvement and even if we rename user-visible stuff to "workflows", files can be called whatever IMO

@sam-schu sam-schu added this pull request to the merge queue Nov 5, 2024
Merged via the queue into dev with commit c41981c Nov 5, 2024
10 checks passed
@sam-schu sam-schu deleted the sts_AN-160_reorganize_methods_repo_files branch November 5, 2024 14:46
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