Forward per-stem name/description from song_info to consumers#41
Conversation
feedpak 1.16.0 (spec §5.3) added optional presentational fields to a
stems[] entry — `name` (display label) and `description` (free text) —
and core now passes them through the song_info stems payloads
(feedback#1013). Carry them from load to state so consumer plugins can
display them:
- loadStems keeps name/description on its result rows, stemState keeps
them on the live stem objects
- the stems:state provider-ready event gains `stems: [{id, name?,
description?}]` alongside `stemIds`, which stays a plain string array
so existing listeners are untouched
- window.stems.getState() rows gain name/description (undefined when
the pack or core predates the fields)
Purely additive; this plugin's own chip UI still renders ids. Display
work lands in stem_mixer. 53/53 node tests + manifest contract pass.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: topkoa <topkoa@gmail.com>
|
Warning Review limit reached
Next review available in: 4 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds support for forwarding per-stem presentational metadata (name/description) from song_info through this plugin’s internal stem state and outward-facing consumer surfaces, aligning with feedpak spec §5.3 and enabling downstream UIs (e.g. stem_mixer) to display friendly labels.
Changes:
- Extend decoded stem result rows and live
S.stemStateentries to retainname/description. - Augment the
stems:stateprovider-readypayload with astems: [{id, name?, description?}]array while keepingstemIdsunchanged. - Update
window.stems.getState()to includename/description, and bump plugin/package versions to0.9.0with a changelog entry.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/main.js | Propagates per-stem name/description through load/state, adds stems metadata payload to provider-ready, and extends getState() output. |
| plugin.json | Bumps plugin version to 0.9.0. |
| package.json | Aligns npm package version to 0.9.0. |
| CHANGELOG.md | Documents the addition of forwarded per-stem display metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot review: stemState carried raw manifest values while the provider-ready payload filtered to non-empty strings, so getState() could expose a different type than the event for the same stem. Fold both through presentationalString() at the loadStems boundary — a non-blank string passes, everything else (missing, blank, non-string) becomes undefined — so every surface exposes `string | undefined` consistently. The changelog no longer implies core passthrough already ships everywhere; it names the core change (feedback#1013) and the older-core behaviour (fields undefined, nothing changes). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: topkoa <topkoa@gmail.com>
The conditional-on-core rewording left the original continuation ("the
stems:state provider-ready event gains...") dangling as a lowercase
fragment after a full stop. One bullet again: what a passing core gets,
what an older core sees, how values are normalized.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: topkoa <topkoa@gmail.com>
The early-return for an archive / stem-less sloppak announced only
{ stemCount: 0 }, so the payload shape depended on which path fired: a
listener could not tell "song with 0 stems" from "old plugin that never
sent stemIds/stems at all". Emit both as empty arrays there — same
contract on every provider-ready. (stemIds was already missing on this
path before this branch; fixed while the contract is being extended.)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: topkoa <topkoa@gmail.com>
The PR bumps plugin.json/package.json to 0.9.0 but its entries sat under [Unreleased]. Retitle the block as "## [0.9.0] — Per-stem display metadata (name/description)" and leave a fresh empty [Unreleased] above, matching the file's versioned-section convention. The block also folds in the items accumulated since [0.8.1] (the full-mix rename, the ES-module migration steps) — 0.9.0 is the release that ships them. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: topkoa <topkoa@gmail.com>
Part 2 of 3 for per-stem display metadata (feedpak 1.16.0, spec §5.3
name/description).Depends on core passthrough got-feedBack/feedBack#1013; harmless without it (fields just stay
undefined).
What
loadStemsresult rows and the livestemStateobjects keepname/descriptionfromsong_infostems.stems:stateprovider-ready event gainsstems: [{id, name?, description?}]—stemIdsstays a plain string array so existing listeners are untouched.
window.stems.getState()rows gainname/description(undefined when pack/core predatesthe fields). API doc comment updated.
Purely additive; this plugin's own chip UI still renders ids. Display work lands in
stem_mixer (part 3).
Verification
node --test tests/*.mjs— 53 passpytest tests/test_manifest.py— 10 passnode --check src/main.js— clean🤖 Generated with Claude Code