Refactor (packages/opencode/src/util/media.ts): Function with many returns - #175
Open
drek2991 wants to merge 1 commit into
Open
Refactor (packages/opencode/src/util/media.ts): Function with many returns#175drek2991 wants to merge 1 commit into
drek2991 wants to merge 1 commit 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:
#120
Full path to the refactored file:
packages/opencode/src/util/media.tsWhat do you think this file does?
This file provides utility functions for identifying and classifying media attachments based on their MIME types and file signature bytes.
What is the scope of your refactoring within that file?
I refactored the
sniffAttachmentMimefunction and added a small MIME signature structure used by that function. The existingisPdfAttachment,isMedia, andisImageAttachmentfunctions were also covered by new tests but were not refactored.Which Qlty-reported issue did you address?
I addressed the Qlty Function with many returns issue in
sniffAttachmentMime, which had 7 return statements before the refactoring.2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The multiple early returns made
sniffAttachmentMimemore difficult to extend and required adding another conditional branch for each new MIME signature.What changes did you make to resolve the issue?
I replaced the conditional return statements with a
MIME_SIGNATURESlist containing each supported MIME signature and a matching function, then used.find()to select the first matching signature and return its MIME type.How do your changes improve maintainability? Did you consider alternatives?
The new structure separates the MIME signatures from the detection logic, making the function shorter and making additional formats easier to add. I considered keeping the conditional structure but chose the signature list because it removes the Qlty issue while keeping the existing detection behavior.
3. Validation
How did you validate that the change is correct?
I added tests for PNG, JPEG, GIF, BMP, PDF, WebP, invalid WebP, and the fallback case, as well as tests for the existing media helper functions. The targeted media test suite passed with 11 tests passing and 0 failing, and the PR's CI checks also passed.
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.Screenshot of bun test and bun lint passing locally:
