refactor(ui): reorganize shared/utils.ts
#13339
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agilgur5
commented
Jul 12, 2024
Comment on lines
-9
to
-24
| let isRunning = false; | ||
| let hasFailed = false; | ||
| conditions.map(condition => { | ||
| if (condition.status === 'False') { | ||
| hasFailed = true; | ||
| } else if (condition.status === 'Unknown') { | ||
| isRunning = true; | ||
| } | ||
| }); | ||
| if (hasFailed) { | ||
| classes = [icon, 'status-icon--failed']; | ||
| } else if (isRunning) { | ||
| classes = [icon, 'status-icon--spin']; | ||
| } else { | ||
| classes = [icon, 'status-icon--running']; | ||
| } |
There was a problem hiding this comment.
I simplified this quite a bit as the two flags, hasFailed and isRunning, are mutually exclusive (by the logic here but also by definition), so can just return as soon as one of them is hit
agilgur5
commented
Jul 16, 2024
added 3 commits
August 1, 2024 00:13
- its main purpose is for namespace manipulation, so rename to `shared/namespaces.ts`
- and rename `Utils` to `nsUtils` for explicitness as well
- this singleton may not be necessary in the future, but keeping it as-is right now for simpler diff
- generally speaking, "dumping grounds" are not good to have and organizing them when they get large is best practice
- several util functions were used in exactly one place, so just move them to that place
- `statusIconClasses` was only used in `phase-icon.tsx`
- `isWorkflowRunning`, `isWorkflowSuspended` were only used in `workflow-operations-map.tsx`
- some were only used together with exactly one component, so move to that component
- `getValueFromParameter` was only used with `ParametersInput`
- others were only used for one section of the UI, e.g. Events or Workflows
- so move them to a `utils.ts` file there; they are not shared between sections
- also `queryParams` was only used in `services/`
- also simplify some of these functions:
- with optional chaining
- by inverting unnecesarily nested conditionals
- by removing unnecessary singleton structures
- these changes also make these functions easier to unit test and give them proper encapsulation
- private functions are no longer exported
Signed-off-by: Anton Gilgur <[email protected]>
…eview Signed-off-by: Anton Gilgur <[email protected]>
Signed-off-by: Anton Gilgur <[email protected]>
agilgur5
force-pushed
the
refactor-ui-shared-utils
branch
from
0918598 to
2ab845e
Compare
Signed-off-by: Anton Gilgur <[email protected]>
isubasinghe
requested changes
Sep 9, 2024
|
Yea, looks like I accidentally added an extra new line during conflict resolution |
Signed-off-by: Anton Gilgur <[email protected]>
|
Should pass now |
isubasinghe
approved these changes
Sep 16, 2024
Same as I wrote in #12539 (comment), this logic applies to any refactor, so this is a strawman, as we ofc don't avoid refactors. |
MasonM
added a commit
to MasonM/argo-workflows
that referenced
this pull request
Oct 9, 2024
Attempting to build the UI on `main` currently fails with the following error: ``` ERROR in ./src/app/workflows/components/retry-workflow-node-panel.tsx 26:0-43 Module not found: Error: Can't resolve '../../shared/utils' in '/home/vscode/go/src/github.com/argoproj/argo-workflows/ui/src/app/workflows/components' ``` This is happening due to a merge conflict between argoproj#13343 and argoproj#13339. The latter was merged first and deleted `ui/src/app/shared/utils.ts`, which the former is importing. The reason the CI build didn't fail for the former PR is that the branch wasn't up-to-date with `main` at the time of merge. Signed-off-by: Mason Malone <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While writing various PRs, I've had some of these changes in a stash for a while. When working on some recent namespace fix PRs, this refactor felt particularly necessary given all the unrelated functions to namespaces in this file
Motivation
this file's main purpose is for namespace manipulation, so rename to
shared/namespaces.tsUtilstonsUtilsfor explicitness as wellthese changes also make these functions easier to unit test and give them proper encapsulation
Modifications
shared/utils.ts->shared/namespaces.tsUtils->nsUtilsseveral util functions were used in exactly one place, so just move them to that place
statusIconClasseswas only used inphase-icon.tsxisWorkflowRunning,isWorkflowSuspendedwere only used inworkflow-operations-map.tsxsome were only used together with exactly one component, so move to that component
getValueFromParameterwas only used withParametersInputothers were only used for one section of the UI, e.g. Events or Workflows
utils.tsfile there; they are not shared between sectionsqueryParamswas only used inservices/also simplify some of these functions:
Verification
yarn lint,test&buildall pass