Refactor (packages/opencode/src/provider/error.ts): Function with many returns - #65
Open
lilyqin7 wants to merge 4 commits into
Open
Refactor (packages/opencode/src/provider/error.ts): Function with many returns#65lilyqin7 wants to merge 4 commits into
lilyqin7 wants to merge 4 commits into
Conversation
lilyqin7
marked this pull request as ready for review
September 5, 2026 22:45
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:
#28
Full path to the refactored file:
packages/opencode/src/provider/error.ts
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
This file turns provider failures into consistent error infromation that OpenCode can display.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
parseStreamError
This function reads error messages and classifies the messages appropriately.
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
Function with many returns (count = 7): parseStreamError
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
Having multiple return statements in parseStreamError means that any future shared processing, such as logging or normalizing results, may need to be added to several exit points. Using a result variable and a final return provides one place for that processing. However, multiple returns are not inherently harder to maintain: direct returns make each switch case self-contained and prevent fallthrough. The refactor introduces a need for correct variable initialization and break statements.
What changes did you make to resolve the issue?
I used a variable that stores the final result instead of having multiple return statements for each result possibility.
How do your changes improve maintainability? Did you consider alternatives?
My changes give
parseStreamErrora single return point, making it easier to add shared processing, such as logging or normalization, in the future.3. Validation
How did you validate that the change is correct?
bun lintandbun testran without additional errors. Additionally, I ranqlty smells --no-snippets packages/opencode/src/provider/error.tsto ensure the many returns error went away and no new errors were introduced. Forbun test, I identified that the tests that coveredparseStreamErrorare intest/session/message-v2.test.ts. I did not add to the tests in this suite since they were already covering all ofparseStreamError.Attach a screenshot of the test coverage showing the lines were executed by the tests.

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.