Refactor (packages/app/src/components/updater-action.ts): Function with many returns - #167
Open
jktakeshi wants to merge 2 commits into
Open
Refactor (packages/app/src/components/updater-action.ts): Function with many returns#167jktakeshi wants to merge 2 commits into
jktakeshi wants to merge 2 commits into
Conversation
This file contains hidden or 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
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.
P1B: Starter Task: Refactoring PR
1. Issue
Link to the associated GitHub issue:
Issue #116
Full path to the refactored file: packages/app/src/components/updater-action.ts
What do you think this file does?
It converts updater states into UI labels and actions for checking or installing updates.
What is the scope of your refactoring within that file?
I refactored
updaterAction()without changinguseUpdaterAction(). I also expanded its unit tests and added the focused test to CI.Which Qlty‑reported issue did you address?
updaterAction() had “Function with many returns (count = 7).”
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The switch contained repeated return values and required adding more control-flow branches for new states.
What changes did you make to resolve the issue?
I replaced the switch cases with a typed state-to-action lookup table and a single return statement. This resulted in only one return instead of the original 7.
How do your changes improve maintainability? Did you consider alternatives?
The table makes each state’s behavior visible in one place and ensures all statuses are covered. I considered simplifying the switch, but the lookup table removed more repetition, and I believe makes the code cleaner.
3. Validation
How did you validate that the change is correct?
I added nine unit tests covering undefined and every
UpdaterStatestatus; all passed locally, and coverage showed that the refactoredupdaterAction()lines were executed. The app typecheck and focused lint pass, Qlty no longer reports the smell, and the focused test is included in.github/workflows/test.yml.Local lint and tests
Focused lint:

Local updater-action tests:

Attach a screenshot of the test coverage showing the lines were executed by the tests.

Focused coverage for updaterAction(): all nine tests passed. The only uncovered lines, 27–51, belong to the unchanged useUpdaterAction() function; the refactored lines 7–24 were covered.
Attach a screenshot showing the tests that cover the change passing during CI

Attach a screenshot of
qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.Before refactoring:

After refactoring:

Qlty reports no remaining smells in the selected file.