feat(output): download sessions as .riffrec - #7
Open
kieranklaassen wants to merge 2 commits into
Open
Conversation
The downloaded bundle is still a standard ZIP archive — only the filename suffix and advertised MIME type change. Renaming back to .zip (or running unzip directly on the .riffrec file) reveals the same session.json / events.json / recording.webm layout.
Update README and the requirements doc to call the download artifact .riffrec instead of plain 'zip', with a brief parenthetical noting it's a standard zip with a custom extension. The public `method: 'filesystem' | 'zip'` discriminant is intentionally unchanged to avoid breaking host integrations. Also commits the plan file for this change.
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.
Summary
Session downloads from the zip-fallback path now produce
riffrec-<date>-<id>.riffrecinstead of…zip. The bundle is still a standard ZIP archive — the bytes are unchanged, so renaming back to.zip(or runningunzip foo.riffrecdirectly) reveals the samesession.json/events.json/recording.webmlayout. The point is brand identity at the file-system level: a.riffrecfile is unmistakably a Riffrec session.Public-API impact
RecordSessionResult.sessionPathnow ends in.riffrecfor the zip-fallback path. Hosts that switch on the suffix need to update their pattern.application/ziptoapplication/x-riffrec.RiffrecResult.methoddiscriminant ("filesystem" | "zip") is intentionally not renamed — it describes the internal mechanism, not the artifact, and several integrations may already key off it.Release note
This is a behavior change to a public API string value. A
1.1.0minor bump and aCHANGELOG.mdentry should accompany the next tag — release tagging is a separate decision and is not done in this PR.Deferred follow-up
The downstream
ce-riffrec-feedback-analysisskill (separate repo:compound-engineering-plugin) matchesriffrec-*.zipin its frontmatter description. A one-line update to also matchriffrec-*.riffrec(keep.zipfor back-compat) will land in a follow-up PR there. Until then, agents can still load the skill via the content-shape trigger (a bundle withsession.json+events.json+recording.webm+voice.webm).Test plan
npm testpasses (15/15, including a newZipWriter.writeSessionassertion locking the.riffrecsuffix anddownloadattribute).npm run typecheckpasses.totalBytes >= MAX_RECORDING_IN_ZIP_BYTES) is untested in this PR — pre-existing gap, not introduced here.Plan
docs/plans/2026-05-26-001-feat-riffrec-file-extension-plan.md