Refactor (packages/app/src/components/updater-action.ts): Function with many returns - #81
Open
Marnilla-Metwaly wants to merge 1 commit into
Open
Marnilla-Metwaly wants to merge 1 commit into
Marnilla-Metwaly wants to merge 1 commit into
Conversation
Marnilla-Metwaly
force-pushed
the
refactor-updater-action
branch
from
September 5, 2026 16:41
760f559 to
3e8e270
Compare
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
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
Link to the associated GitHub issue:
#73
Full path to the refactored file:
packages/app/src/components/updater-action.ts
What do you think this file does?
This file selects the label and action shown for each updater state. It also provides a hook that checks for updates or installs an available update.
What is the scope of your refactoring within that file?
I refactored the updaterAction() function by adding the UpdaterAction type and the updaterActions mapping. I also updated updater-action.test.ts to test every updater status and the undefined case.
Which Qlty‑reported issue did you address?
I addressed “Function with many returns (count = 7)” in updaterAction().
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The multiple return branches made it harder to review how each updater status was mapped to an action. Some labels were also repeated in different branches.
What changes did you make to resolve the issue?
I replaced the switch statement and its multiple returns with a typed Record that maps each updater status to an action. The function now selects the correct entry and uses one return statement.
How do your changes improve maintainability? Did you consider alternatives?
The mapping keeps all statuses and actions together, while TypeScript checks that every status has an entry. I considered assigning a result inside the switch and returning it at the end, but the mapping was simpler and avoided a mutable variable.
3. Validation
How did you validate that the change is correct?
The tests in packages/app/src/components/updater-action.test.ts exercise undefined and every UpdaterState status, so they cover every entry in the new mapping and the refactored return statement. I also ran the focused Bun tests, the complete app test command, bun typecheck, bun lint, and Qlty successfully.
bun lintcompleted with 0 warnings and 0 errors.The complete app test suite passed with 41 tests and 0 failures.

The focused updaterAction tests passed with 3 tests and 0 failures.

Attach a screenshot of the test coverage showing the lines were executed by the tests.
All executable lines changed in updaterAction have positive hit counts. The uncovered lines belong to the unchanged useUpdaterAction function.

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
After