Refactor (packages/http-recorder/src/socket.ts): Function with many parameters - #188
Open
bnajib1 wants to merge 3 commits into
Open
Refactor (packages/http-recorder/src/socket.ts): Function with many parameters#188bnajib1 wants to merge 3 commits into
bnajib1 wants to merge 3 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:
#187
Full path to the refactored file:
packages/http-recorder/src/socket.ts
What do you think this file does?
It records WebSocket messages to files and replays them for tests.
What is the scope of your refactoring within that file?
makeRecordingSocket() and its call in recordingLayer().
Which Qlty-reported issue did you address?
Function with many parameters (count = 6) in makeRecordingSocket(), at line 119.
2. Refactoring
How did the specific issue you chose impact the codebase's maintainability?
The caller had to pass six values in the right order, which made the call harder to read and update.
What changes did you make to resolve the issue?
I replaced the six parameters with one typed object and updated the caller to pass that object.
How do your changes improve maintainability? Did you consider alternatives?
The call now names each argument, so their order no longer matters. Splitting the function would have been a larger change than this issue needed.
3. Validation
How did you validate that the change is correct?
All 33 tests in packages/http-recorder/test/record-replay.test.ts pass locally and in CI; the recording test checks frame order, metadata, redaction, and the original response. Coverage includes every changed executable line, and package typechecking and file linting pass (repo-wide bun lint still has two existing errors).
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.