Enhance MP3 Quick Cleanse ID3v2.3 metadata writing#39
Merged
ChrisAdamsdevelopment merged 1 commit intoMay 21, 2026
Merged
Conversation
Reviewer's GuideEnhances MP3 Quick Cleanse to write a richer but safe ID3v2.3 metadata set, adds frame-level tracking/reporting for attempted/written/skipped frames, and updates the app to provide expanded release metadata into the writer and surface a compact log summary of frame outcomes. Sequence diagram for updated MP3 metadata writing and loggingsequenceDiagram
actor User
participant App
participant writeMP3Metadata
participant writer
User->>App: Start Quick Cleanse
App->>writeMP3Metadata: writeMP3Metadata(file, metadata)
writeMP3Metadata->>writer: setFrame(TIT2, title)
writeMP3Metadata->>writer: setFrame(TPE1, [artist])
writeMP3Metadata->>writer: setFrame(TPE2, [albumArtist])
writeMP3Metadata->>writer: setFrame(TCON, [genre])
writeMP3Metadata->>writer: setFrame(COMM, comment)
writeMP3Metadata->>writer: setFrame(USLT, lyrics) [optional]
writeMP3Metadata->>writer: setFrame(TCOP, copyright) [optional]
writeMP3Metadata->>writer: setFrame(TPUB, [publisher]) [optional]
writeMP3Metadata->>writer: setFrame(TXXX, producer) [optional]
writeMP3Metadata-->>App: { blob, frameReport }
App->>App: addLog(itemId, frameReport summary)
App->>App: updateItem(itemId, downloadUrl, report)
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The hardcoded report message
'Core frames attempted: TIT2,TPE1,TPE2,TCON,COMM,USLT,TCOP'inAppis now out of sync with the actual set of frames attempted (e.g. TPUB, TXXX), so it may be worth deriving this summary fromframeReport.attemptedFramesinstead of maintaining a separate static list. - The new
console.infosummary andconsole.warncalls insidewriteMP3Metadatawill fire on every Quick Cleanse run and for all optional-frame failures; consider gating these logs behind a debug flag or reducing their frequency to avoid noisy consoles in production.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The hardcoded report message `'Core frames attempted: TIT2,TPE1,TPE2,TCON,COMM,USLT,TCOP'` in `App` is now out of sync with the actual set of frames attempted (e.g. TPUB, TXXX), so it may be worth deriving this summary from `frameReport.attemptedFrames` instead of maintaining a separate static list.
- The new `console.info` summary and `console.warn` calls inside `writeMP3Metadata` will fire on every Quick Cleanse run and for all optional-frame failures; consider gating these logs behind a debug flag or reducing their frequency to avoid noisy consoles in production.
## Individual Comments
### Comment 1
<location path="src/utils/metadata.js" line_range="211-213" />
<code_context>
+ if (publisher) safeSetFrame('TPUB', [publisher], { optional: true });
+ if (producer) safeSetFrame('TXXX', { description: 'Producer', value: producer }, { optional: true });
+
+ console.info('[quick-cleanse] mp3 metadata summary', {
+ hasLyrics: Boolean(lyrics),
+ hasComment: Boolean(commentText),
+ hasDescription: Boolean(description),
+ hasProducer: Boolean(producer),
</code_context>
<issue_to_address>
**suggestion:** The hasComment flag may not reflect whether a comment frame was actually written.
Since `finalComment` adds producer/tags to `commentText`, `hasComment` can be `false` even when a `COMM` frame is written (e.g., empty `commentText` but non-empty producer/tags). If this summary is for debugging/analytics, consider deriving it from `Boolean(finalComment)` or from whether `writtenFrames` includes `COMM` so it matches actual behavior.
Suggested implementation:
```javascript
console.info('[quick-cleanse] mp3 metadata summary', {
hasLyrics: Boolean(lyrics),
hasComment: Boolean(finalComment),
hasDescription: Boolean(description),
hasProducer: Boolean(producer),
attemptedFrames,
writtenFrames,
skippedFrames,
});
```
1. Ensure that `finalComment` is defined in this function and that it is the exact value used when calling `safeSetFrame('COMM', ...)` (e.g., `text: finalComment`).
2. If `finalComment` is not currently available in this scope, either:
- Plumb it through so it is, or
- Change the implementation to derive `hasComment` from whether the `COMM` frame was actually written, e.g. `hasComment: writtenFrames?.includes?.('COMM')`.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+211
to
+213
| console.info('[quick-cleanse] mp3 metadata summary', { | ||
| hasLyrics: Boolean(lyrics), | ||
| hasComment: Boolean(commentText), |
There was a problem hiding this comment.
suggestion: The hasComment flag may not reflect whether a comment frame was actually written.
Since finalComment adds producer/tags to commentText, hasComment can be false even when a COMM frame is written (e.g., empty commentText but non-empty producer/tags). If this summary is for debugging/analytics, consider deriving it from Boolean(finalComment) or from whether writtenFrames includes COMM so it matches actual behavior.
Suggested implementation:
console.info('[quick-cleanse] mp3 metadata summary', {
hasLyrics: Boolean(lyrics),
hasComment: Boolean(finalComment),
hasDescription: Boolean(description),
hasProducer: Boolean(producer),
attemptedFrames,
writtenFrames,
skippedFrames,
});- Ensure that
finalCommentis defined in this function and that it is the exact value used when callingsafeSetFrame('COMM', ...)(e.g.,text: finalComment). - If
finalCommentis not currently available in this scope, either:- Plumb it through so it is, or
- Change the implementation to derive
hasCommentfrom whether theCOMMframe was actually written, e.g.hasComment: writtenFrames?.includes?.('COMM').
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
1 participant
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.
Motivation
Description
src/utils/metadata.jswriteMP3Metadatato write safe ID3v2.3 frames and to trackattemptedFrames,writtenFrames, andskippedFrames.TIT2,TPE1,TPE2,TCON,COMM,USLT(optional), andTCOP, and optional attempts forTPUBandTXXX:Producerthat are skipped withconsole.warnif unsupported.albumArtistdefaults toartist,commentfalls back todescription,producer/tagsare folded intoCOMMif a producer frame is unsafe, andcopyrightdefaults to© CURRENT_YEAR <artist>when absent.app.tsxto expandReleaseMetadataand to pass the fuller metadata payload (title,artist,albumArtist,producer,copyright,genre,description,comment,lyrics,tags,publisher) intowriteMP3Metadata, and to log a compact frame write/skip summary.src/utils/metadata.js,app.tsx.Testing
TENC/TSSEare not written anywhere and that new safe frames (TIT2,TPE1,TPE2,TCON,COMM,USLT,TCOP,TPUB,TXXX) are present in the code.npm run build; the build failed in this container due to missing React/TypeScript environment dependencies unrelated to these metadata changes.writeMP3Metadatanow returns aframeReportsummarizingattemptedFrames,writtenFrames, andskippedFramesso unsupported optional frames cannot crash the cleanse.Codex Task
Summary by Sourcery
Enhance MP3 Quick Cleanse to write safer, richer ID3v2.3 metadata and surface a compact report of frame write outcomes.
New Features:
Enhancements: