Refactor (packages/web/src/components/Share.tsx:503): High complexity function fromV1 - #100
Open
slaman24 wants to merge 4 commits into
Open
Refactor (packages/web/src/components/Share.tsx:503): High complexity function fromV1#100slaman24 wants to merge 4 commits into
slaman24 wants to merge 4 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: #94
Full path to the refactored file: packages/web/src/components/Share.tsx
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
I believe this file displays a shared session on the web page. Specifically, the fromV1 function is responsible for converting old v1 message records into the new v2 format that the renderer expects.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
Refactored fromV1 by extracting its nested role/part-type/tool-state branching into five new helper functions: fromV1Assistant, toAssistantParts, toToolState, fromV1User, and toUserParts
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
High complexity (count = 32) in function fromV1
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The role → part-type → tool-state branching was packed all into one ~140-line function with 4 levels of nesting. This made the code harder to read and more challenging to safely modify one case without risking the others.
What changes did you make to resolve the issue?
I extracted each level of nested branching into its own small, named function, turning fromV1 from a ~140-line function to a 3-line one (with no behavior change).
How do your changes improve maintainability? Did you consider alternatives?
Each helper now handles exactly one concern and can be read and modified independently. I originally considered simplifying the nested branching but still keeping all of the code within fromV1, but I ultimately felt that dividing the code into helper functions would increase the overall readability.
3. Validation
How did you validate that the change is correct?
I wrote 7 unit tests that call fromV1 directly and cover every branch (both roles, all 3 tool-invocation states, both handled part types, the unhandled-part-type fallback, and both throw paths), confirmed 100% line coverage of the changed code, and ran
qlty smells --no-snippets packages/web/src/components/Share.tsxto confirm that the high complexity warning was gone with no new warnings introduced.Attach a screenshot of the test coverage showing the lines were executed by the tests.


Per-function line coverage for fromV1 and its extracted helpers. 139/139 lines (100%) executed by tests.
Running
bunx oxlinton the changed files shows 0 warnings and 0 errors.Attach a screenshot showing the tests that cover the change passing during CI

All 7 unit tests for fromV1 pass during CI.
Attach a screenshot of

qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.After implementing my code changes, running
qlty smells --no-snippets packages/web/src/components/Share.tsxno longer reports503 Function with high complexity (count = 32): fromV1