Skip to content

Refactor (packages/app/src/components/updater-action.ts): Function with many returns - #81

Open
Marnilla-Metwaly wants to merge 1 commit into
CMU-17313Q:mainfrom
Marnilla-Metwaly:refactor-updater-action
Open

Marnilla-Metwaly wants to merge 1 commit into
CMU-17313Q:mainfrom
Marnilla-Metwaly:refactor-updater-action

Conversation

@Marnilla-Metwaly

@Marnilla-Metwaly Marnilla-Metwaly commented Sep 5, 2026

Copy link
Copy Markdown

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 lint completed with 0 warnings and 0 errors.
Screenshot 2026-09-05 161735

The complete app test suite passed with 41 tests and 0 failures.
Screenshot 2026-09-05 190027

The focused updaterAction tests passed with 3 tests and 0 failures.
Screenshot 2026-09-05 155648

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.
Screenshot 2026-09-05 185711

Attach a screenshot showing the tests that cover the change passing during CI
image

Attach a screenshot of qlty smells --no-snippets <full/path/to/file.ts> showing fewer reported issues after the changes.
BeforeScreenshot 2026-09-05 151444
AfterScreenshot 2026-09-05 161748

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.

1 participant