feat(core): add session metadata support by shantur · Pull Request #23068 · anomalyco/opencode

shantur · 2026-04-17T10:27:20Z

Issue for this PR

Closes #

Type of change

Bug fix
New feature
Refactor / code improvement
Documentation

What does this PR do?

Introduces a metadata field in sessions that can be used with SDK to persist client controlled JSON metadata for session. This is simlar to metadata available in Message.Parts
Session APIs and SDK exposes metadata for create, get, update, list, and fork operations.

Support full metadata replacement on session update, add copyMetadata to session forks with default copy behavior,

If you paste a large clearly AI generated description here your PR may be IGNORED or CLOSED!

How did you verify your code works?

Added tests and manual testing.

Screenshots / recordings

If this is a UI change, please include a screenshot or recording.

Checklist

I have tested my changes locally
I have not included unrelated changes in this PR

If you do not follow this template your PR will be automatically rejected.

Persist session metadata in the session store and expose it across the session APIs and SDK so clients can round-trip metadata during create, get, update, list, and fork operations. Add a JSON metadata column to the session table, thread metadata through the session model/projectors, and normalize empty metadata responses to {}. Support full metadata replacement on session update, add copyMetadata to session forks with default copy behavior, regenerate the session SDK surface, and cover the behavior with server/session tests plus a migration for existing databases.

rekram1-node · 2026-05-11T19:24:01Z

/review

github-actions · 2026-05-11T19:31:19Z

@@ -33,6 +33,7 @@ export const SessionTable = sqliteTable(
    summary_deletions: integer(),
    summary_files: integer(),
    summary_diffs: text({ mode: "json" }).$type<Snapshot.FileDiff[]>(),


Suggestion (style): this new metadata type uses any, which the repo style guide asks us to avoid. Since this is client-controlled JSON and the generated SDK exposes unknown, consider carrying Record<string, unknown> through the storage/service types instead of Record<string, any>.

github-actions · 2026-05-11T19:31:24Z

 export type SessionUpdateData = {
  body?: {
    title?: string
+    metadata?: {


Suggestion: the update route accepts metadata: null to clear metadata, but the generated SDK type only allows an object here. That means SDK callers cannot type-safely use the clear path covered by the API/tests. Since this file is generated, the source fix may need to make the nullable schema survive generation so this becomes { [key: string]: unknown } | null.

# Conflicts: # packages/opencode/src/session/session.ts

rekram1-node · 2026-05-12T03:10:06Z

/review

github-actions · 2026-05-12T03:13:15Z

+const Metadata = Schema.Record(Schema.String, Schema.Any)
+
 export const Info = Schema.Struct({
  id: SessionID,


Suggestion for the human to consider: this new field introduces any, which is avoidable here and the PR describes this as JSON metadata. Using a JSON schema keeps service-level callers from passing non-serializable values that HTTP clients could never send.

Suggested change

id: SessionID,

const Metadata = Schema.Record(Schema.String, Schema.Json)

github-actions · 2026-05-12T03:13:15Z

 export type SessionUpdateData = {
  body?: {
    title?: string
+    metadata?: {


Suggestion for the human to consider: the server schema and new route test both allow PATCH /session/:id with metadata: null to clear metadata, but the generated SDK update payload does not include null. If clearing with null is intended to be public SDK behavior, this generated type should include | null after the source/schema change and SDK regeneration.

github-actions · 2026-05-12T03:13:15Z

    summary_deletions: integer(),
    summary_files: integer(),
    summary_diffs: text({ mode: "json" }).$type<Snapshot.FileDiff[]>(),
+    metadata: text({ mode: "json" }).$type<Record<string, any>>(),


Suggestion for the human to consider: this new DB type introduces any, which the style guide asks us to avoid. If the runtime schema is narrowed to JSON, this can also avoid widening the persisted shape to any here.

Suggested change

metadata: text({ mode: "json" }).$type<Record<string, any>>(),

metadata: text({ mode: "json" }).$type<Record<string, unknown>>(),

# Conflicts: # packages/opencode/src/session/projectors.ts # packages/opencode/src/session/session.sql.ts # packages/opencode/src/session/session.ts # packages/opencode/test/server/session-actions.test.ts # packages/opencode/test/server/session-list.test.ts # packages/opencode/test/session/session.test.ts

shantur · 2026-05-14T21:08:27Z

Addressed the latest session metadata review feedback in 2c9c3ac.

Changes made:

Default legacy imported sessions with missing metadata to {}, fixing the bun run dev import session-export.json missing-key failure.
Removed copyMetadata from the fork API and SDK; forks now keep the default copy behavior.
Kept PATCH /session/:id full metadata replacement and metadata: null clear behavior; SDK update payload now allows null.
Tightened the DB metadata type to Record<string, unknown>.
Verified locally:
bun test test/session/session.test.ts test/session/schema-decoding.test.ts test/server/session-actions.test.ts test/server/session-list.test.ts test/cli/import.test.ts test/cli/cmd/tui/notifications.test.ts from packages/opencode: 53 pass.
bun typecheck from packages/opencode: pass.
bun typecheck from packages/sdk/js: pass.
Push hook ran full bun turbo typecheck: pass.
Ran serve against an isolated temp SQLite DB and verified create/get/list/update/clear/default/fork metadata behavior with curl.
Reproduced legacy import payload without metadata against the temp DB and confirmed imported sessions default metadata to {}.

github-actions · 2026-05-17T22:19:10Z

Automated PR Cleanup

Thank you for contributing to opencode.

Due to the high volume of PRs from users and AI agents, we periodically close older PRs using automated criteria so maintainers can focus review time on the most active and community-supported contributions.

This PR was closed because it matched the following cleanup criteria:

The PR was created more than 1 month ago
The PR had fewer than 2 positive reactions
Positive reactions are counted as thumbs-up, heart, celebration, or rocket reactions on the PR

PRs created within the last month are not affected by this cleanup.

If you believe this PR was closed incorrectly, or if you are still actively working on it, please leave a comment explaining why it should be reopened. A maintainer can review and reopen it if appropriate.

Thanks again for taking the time to contribute.

rekram1-node · 2026-05-18T00:17:49Z

/review

github-actions · 2026-05-18T00:20:27Z

        path: sessionPath(ctx.worktree, ctx.directory),
        workspaceID: original.workspaceID,
        title,
+        metadata: structuredClone(original.metadata),


Suggestion: if copyMetadata is still intended for this feature, this always-copy behavior leaves no API/SDK path to opt out. The final fork schema only accepts messageID, and the generated SDK no longer includes copyMetadata, so clients cannot request the documented non-copying fork behavior. If that behavior was intentionally dropped, updating the PR/API expectation would avoid the mismatch.

shantur · 2026-05-29T21:02:46Z

@rekram1-node - Apologies for chasing but can this please be merged in?
If anything can expedite this please let me know

Match the optional treatment of every comparable schema field (Session.Info.permission, CreateInput, message-v2 parts). metadata is now optionalOmitUndefined and omitted when unset/cleared rather than materialized as {}. Lets unrelated session fixtures drop their forced metadata: {} entries.

github-actions Bot added Vouched contributor labels Apr 17, 2026

shantur added 2 commits May 11, 2026 18:41

test(core): align session metadata tests with latest dev

c3351cb

shantur force-pushed the session-metadata branch from 8c06b4f to c3351cb Compare May 11, 2026 18:09

github-actions Bot reviewed May 11, 2026

View reviewed changes

Merge branch 'dev' into session-metadata

253a16a

# Conflicts: # packages/opencode/src/session/session.ts

github-actions Bot reviewed May 12, 2026

View reviewed changes

rekram1-node and others added 3 commits May 13, 2026 23:27

Merge remote-tracking branch 'origin/dev' into session-metadata

d0cedea

fix(session): address metadata review feedback

2c9c3ac

github-actions Bot closed this May 17, 2026

github-actions Bot added the automated-pr-cleanup label May 17, 2026

rekram1-node reopened this May 18, 2026

github-actions Bot reviewed May 18, 2026

View reviewed changes

github-actions Bot mentioned this pull request May 18, 2026

📊 AI CLI 工具社区动态日报 2026-05-18 zx0828/big_model_radar#64

Open

chore: merge dev into session-metadata

a5836ba

rekram1-node added 4 commits May 29, 2026 21:54

chore: merge dev into session-metadata

c545d24

chore: generate

3f9f6a6

fix(core): drop null clear path for session metadata

9ec220c

test(core): reset session metadata via empty object instead of null

cb86732

rekram1-node merged commit ddc30cd into anomalyco:dev May 30, 2026
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add session metadata support#23068

feat(core): add session metadata support#23068
rekram1-node merged 12 commits into
anomalyco:devfrom
shantur:session-metadata

shantur commented Apr 17, 2026

Uh oh!

rekram1-node commented May 11, 2026

Uh oh!

github-actions Bot May 11, 2026

Uh oh!

github-actions Bot May 11, 2026

Uh oh!

rekram1-node commented May 12, 2026

Uh oh!

github-actions Bot May 12, 2026

Uh oh!

github-actions Bot May 12, 2026

Uh oh!

github-actions Bot May 12, 2026

Uh oh!

shantur commented May 14, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 17, 2026

Uh oh!

rekram1-node commented May 18, 2026

Uh oh!

github-actions Bot May 18, 2026

Uh oh!

shantur commented May 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	id: SessionID,
	const Metadata = Schema.Record(Schema.String, Schema.Json)

	metadata: text({ mode: "json" }).$type<Record<string, any>>(),
	metadata: text({ mode: "json" }).$type<Record<string, unknown>>(),

Conversation

shantur commented Apr 17, 2026

Issue for this PR

Type of change

What does this PR do?

How did you verify your code works?

Screenshots / recordings

Checklist

Uh oh!

rekram1-node commented May 11, 2026

Uh oh!

github-actions Bot May 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 11, 2026

Choose a reason for hiding this comment

Uh oh!

rekram1-node commented May 12, 2026

Uh oh!

github-actions Bot May 12, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 12, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 12, 2026

Choose a reason for hiding this comment

Uh oh!

shantur commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 17, 2026

Uh oh!

rekram1-node commented May 18, 2026

Uh oh!

github-actions Bot May 18, 2026

Choose a reason for hiding this comment

Uh oh!

shantur commented May 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shantur commented May 14, 2026 •

edited

Loading