Skip to content

Refactor (packages/http-recorder/src/socket.ts): Function with many parameters - #188

Open
bnajib1 wants to merge 3 commits into
CMU-313:mainfrom
bnajib1:recording-options
Open

Refactor (packages/http-recorder/src/socket.ts): Function with many parameters#188
bnajib1 wants to merge 3 commits into
CMU-313:mainfrom
bnajib1:recording-options

Conversation

@bnajib1

@bnajib1 bnajib1 commented Sep 8, 2026

Copy link
Copy Markdown

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.

Test coverage

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

CI tests

Attach a screenshot of qlty smells --no-snippets <full/path/to/file.ts> showing fewer reported issues after the changes.

Qlty before and after

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