ai-workspace-services/opencode
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(core): add session metadata support (#23068)

Browse Source 
Co-authored-by: Aiden Cline <aidenpcline@gmail.com>
This commit is contained in:
Shantur Rathore 2026-05-30 22:58:11 +01:00 committed by GitHub
parent ac8e686f33
commit ddc30cd151
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 1707 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/opencode/migration/20260511173437_session-metadata/migration.sql Normal file
View File

@ -0,0 +1 @@
ALTER TABLE `session` ADD `metadata` text;

1500
packages/opencode/migration/20260511173437_session-metadata/snapshot.json Normal file
View File

File diff suppressed because it is too large Load Diff

1
packages/opencode/src/server/routes/instance/httpapi/groups/session.ts
View File

@ -45,6 +45,7 @@ export const MessagesQuery = Schema.Struct({
export const StatusMap = Schema.Record(Schema.String, SessionStatus.Info)
export const UpdatePayload = Schema.Struct({
title: Schema.optional(Schema.String),
metadata: Schema.optional(Session.Metadata),
permission: Schema.optional(Permission.Ruleset),
time: Schema.optional(
Schema.Struct({

8
packages/opencode/src/server/routes/instance/httpapi/handlers/session.ts
View File

@ -185,6 +185,9 @@ export const sessionHandlers = HttpApiBuilder.group(InstanceHttpApi, "session",
if (ctx.payload.title !== undefined) {
yield* session.setTitle({ sessionID: ctx.params.sessionID, title: ctx.payload.title })
}
if (ctx.payload.metadata !== undefined) {
yield* session.setMetadata({ sessionID: ctx.params.sessionID, metadata: ctx.payload.metadata })
}
if (ctx.payload.permission !== undefined) {
yield* session.setPermission({
sessionID: ctx.params.sessionID,
@ -202,7 +205,10 @@ export const sessionHandlers = HttpApiBuilder.group(InstanceHttpApi, "session",
payload?: typeof ForkPayload.Type
}) {
return yield* SessionError.mapStorageNotFound(
session.fork({ sessionID: ctx.params.sessionID, messageID: ctx.payload?.messageID }),
session.fork({
sessionID: ctx.params.sessionID,
messageID: ctx.payload?.messageID,
}),
)
})

1
packages/opencode/src/session/projectors.ts
View File

@ -79,6 +79,7 @@ export function toPartialRow(info: DeepPartial<Session.Info>) {
summary_deletions: grab(info, "summary", (v) => grab(v, "deletions")),
summary_files: grab(info, "summary", (v) => grab(v, "files")),
summary_diffs: grab(info, "summary", (v) => grab(v, "diffs")),
metadata: grab(info, "metadata"),
cost: grab(info, "cost"),
tokens_input: grab(info, "tokens", (v) => grab(v, "input")),
tokens_output: grab(info, "tokens", (v) => grab(v, "output")),

1
packages/opencode/src/session/session.sql.ts
View File

@ -33,6 +33,7 @@ export const SessionTable = sqliteTable(
summary_deletions: integer(),
summary_files: integer(),
summary_diffs: text({ mode: "json" }).$type<Snapshot.FileDiff[]>(),
metadata: text({ mode: "json" }).$type<Record<string, unknown>>(),
cost: real().notNull().default(0),
tokens_input: integer().notNull().default(0),
tokens_output: integer().notNull().default(0),

23
packages/opencode/src/session/session.ts
View File

@ -100,6 +100,7 @@ export function fromRow(row: SessionRow): Info {
},
},
share,
metadata: row.metadata ?? undefined,
revert,
permission: row.permission ? [...row.permission] : undefined,
time: {
@ -129,6 +130,7 @@ export function toRow(info: Info) {
summary_deletions: info.summary?.deletions,
summary_files: info.summary?.files,
summary_diffs: info.summary?.diffs,
metadata: info.metadata,
cost: info.cost ?? 0,
tokens_input: (info.tokens ?? EmptyTokens).input,
tokens_output: (info.tokens ?? EmptyTokens).output,
@ -205,6 +207,8 @@ const Model = Schema.Struct({
variant: optionalOmitUndefined(Schema.String),
})
export const Metadata = Schema.Record(Schema.String, Schema.Any)
export const Info = Schema.Struct({
id: SessionID,
slug: Schema.String,
@ -221,6 +225,7 @@ export const Info = Schema.Struct({
agent: optionalOmitUndefined(Schema.String),
model: optionalOmitUndefined(Model),
version: Schema.String,
metadata: optionalOmitUndefined(Metadata),
time: Time,
permission: optionalOmitUndefined(Permission.Ruleset),
revert: optionalOmitUndefined(Revert),
@ -246,6 +251,7 @@ export const CreateInput = Schema.optional(
title: Schema.optional(Schema.String),
agent: Schema.optional(Schema.String),
model: Schema.optional(Model),
metadata: Schema.optional(Metadata),
permission: Schema.optional(Permission.Ruleset),
workspaceID: Schema.optional(WorkspaceID),
}),
@ -264,6 +270,10 @@ export const SetArchivedInput = Schema.Struct({
sessionID: SessionID,
time: Schema.optional(ArchivedTimestamp),
})
export const SetMetadataInput = Schema.Struct({
sessionID: SessionID,
metadata: Metadata,
})
export const SetPermissionInput = Schema.Struct({
sessionID: SessionID,
permission: Permission.Ruleset,
@ -320,6 +330,7 @@ const UpdatedInfo = Schema.Struct({
agent: Schema.optional(Schema.NullOr(Schema.String)),
model: Schema.optional(Schema.NullOr(Model)),
version: Schema.optional(Schema.NullOr(Schema.String)),
metadata: Schema.optional(Schema.NullOr(Metadata)),
time: Schema.optional(UpdatedTime),
permission: Schema.optional(Schema.NullOr(Permission.Ruleset)),
revert: Schema.optional(Schema.NullOr(Revert)),
@ -455,6 +466,7 @@ export interface Interface {
title?: string
agent?: string
model?: Schema.Schema.Type<typeof Model>
metadata?: typeof Metadata.Type
permission?: Permission.Ruleset
workspaceID?: WorkspaceID
}) => Effect.Effect<Info>
@ -463,6 +475,7 @@ export interface Interface {
readonly get: (id: SessionID) => Effect.Effect<Info, NotFound>
readonly setTitle: (input: { sessionID: SessionID; title: string }) => Effect.Effect<void>
readonly setArchived: (input: { sessionID: SessionID; time?: number }) => Effect.Effect<void>
readonly setMetadata: (input: typeof SetMetadataInput.Type) => Effect.Effect<void>
readonly setPermission: (input: { sessionID: SessionID; permission: Permission.Ruleset }) => Effect.Effect<void>
readonly setRevert: (input: {
sessionID: SessionID
@ -529,6 +542,7 @@ export const layer: Layer.Layer<
workspaceID?: WorkspaceID
directory: string
path?: string
metadata?: typeof Metadata.Type
permission?: Permission.Ruleset
}) {
const ctx = yield* InstanceState.context
@ -544,6 +558,7 @@ export const layer: Layer.Layer<
title: input.title ?? createDefaultTitle(!!input.parentID),
agent: input.agent,
model: input.model,
metadata: input.metadata,
permission: input.permission ? [...input.permission] : undefined,
cost: 0,
tokens: EmptyTokens,
@ -659,6 +674,7 @@ export const layer: Layer.Layer<
title?: string
agent?: string
model?: Schema.Schema.Type<typeof Model>
metadata?: typeof Metadata.Type
permission?: Permission.Ruleset
workspaceID?: WorkspaceID
}) {
@ -671,6 +687,7 @@ export const layer: Layer.Layer<
title: input?.title,
agent: input?.agent,
model: input?.model,
metadata: input?.metadata,
permission: input?.permission,
workspaceID: input?.workspaceID ?? workspace,
})
@ -685,6 +702,7 @@ export const layer: Layer.Layer<
path: sessionPath(ctx.worktree, ctx.directory),
workspaceID: original.workspaceID,
title,
metadata: structuredClone(original.metadata),
})
const msgs = yield* messages({ sessionID: input.sessionID })
const idMap = new Map<string, MessageID>()
@ -732,6 +750,10 @@ export const layer: Layer.Layer<
yield* patch(input.sessionID, { time: { archived: input.time } })
})
const setMetadata = Effect.fn("Session.setMetadata")(function* (input: typeof SetMetadataInput.Type) {
yield* patch(input.sessionID, { metadata: input.metadata, time: { updated: Date.now() } })
})
const setPermission = Effect.fn("Session.setPermission")(function* (input: {
sessionID: SessionID
permission: Permission.Ruleset
@ -844,6 +866,7 @@ export const layer: Layer.Layer<
get,
setTitle,
setArchived,
setMetadata,
setPermission,
setRevert,
clearRevert,

79
packages/opencode/test/server/session-actions.test.ts
View File

@ -16,6 +16,85 @@ afterEach(async () => {
})
describe("session action routes", () => {
it.instance(
"session routes expose metadata on create, update, get, and fork",
() =>
Effect.gen(function* () {
const test = yield* TestInstance
const app = Server.Default().app
const headers = { "Content-Type": "application/json", "x-opencode-directory": test.directory }
const created = yield* Effect.promise(() =>
Promise.resolve(
app.request("/session", {
method: "POST",
headers,
body: JSON.stringify({
title: "meta-session",
metadata: { source: "sdk", trace: { id: "abc" } },
}),
}),
),
)
expect(created.status).toBe(200)
const session = (yield* Effect.promise(() => created.json())) as SessionNs.Info
expect(session.metadata).toEqual({ source: "sdk", trace: { id: "abc" } })
const updated = yield* Effect.promise(() =>
Promise.resolve(
app.request(`/session/${session.id}`, {
method: "PATCH",
headers,
body: JSON.stringify({ metadata: { source: "sdk", trace: { id: "def" }, tags: ["one"] } }),
}),
),
)
expect(updated.status).toBe(200)
const next = (yield* Effect.promise(() => updated.json())) as SessionNs.Info
expect(next.metadata).toEqual({ source: "sdk", trace: { id: "def" }, tags: ["one"] })
const fetched = yield* Effect.promise(() =>
Promise.resolve(
app.request(`/session/${session.id}`, { headers: { "x-opencode-directory": test.directory } }),
),
)
expect(fetched.status).toBe(200)
expect(((yield* Effect.promise(() => fetched.json())) as SessionNs.Info).metadata).toEqual(next.metadata)
const forked = yield* Effect.promise(() =>
Promise.resolve(
app.request(`/session/${session.id}/fork`, {
method: "POST",
headers,
body: JSON.stringify({}),
}),
),
)
expect(forked.status).toBe(200)
const fork = (yield* Effect.promise(() => forked.json())) as SessionNs.Info
expect(fork.metadata).toEqual(next.metadata)
const reset = yield* Effect.promise(() =>
Promise.resolve(
app.request(`/session/${session.id}`, {
method: "PATCH",
headers,
body: JSON.stringify({ metadata: {} }),
}),
),
)
expect(reset.status).toBe(200)
expect(((yield* Effect.promise(() => reset.json())) as SessionNs.Info).metadata).toEqual({})
yield* SessionNs.Service.use((svc) => svc.remove(fork.id).pipe(Effect.ignore))
yield* SessionNs.Service.use((svc) => svc.remove(session.id).pipe(Effect.ignore))
}),
{ git: true },
)
it.instance(
"abort route returns success",
() =>

16
packages/opencode/test/server/session-list.test.ts
View File

@ -227,4 +227,20 @@ describe("session.list", () => {
}),
{ git: true },
)
it.instance(
"includes metadata in listed sessions",
() =>
Effect.gen(function* () {
const meta = { source: "sdk", trace: { id: "abc" } }
const created = yield* withSession({ title: "meta-session", metadata: meta })
const listed = (yield* SessionNs.Service.use((session) => session.list({ search: "meta-session" }))).find(
(item) => item.id === created.id,
)
expect(listed?.metadata).toEqual(meta)
}),
{ git: true },
)
})

2
packages/opencode/test/session/schema-decoding.test.ts
View File

@ -64,6 +64,7 @@ describe("Session.Info", () => {
share: { url: "https://share.example.com/s/1" },
title: "Full session",
version: "1.0.0",
metadata: { source: "test" },
time: { created: 100, updated: 200, compacting: 150, archived: 300 },
permission: [{ action: "allow" as const, pattern: "*", permission: "read" }],
revert: {
@ -157,6 +158,7 @@ describe("Session input schemas", () => {
const populated = {
parentID: sessionID,
title: "child",
metadata: { source: "test" },
permission: [{ action: "ask" as const, pattern: "*", permission: "bash" }],
workspaceID,
}

31
packages/opencode/test/session/session.test.ts
View File

@ -184,4 +184,35 @@ describe("Session", () => {
expect(Exit.isFailure(getExit)).toBe(true)
}),
)
it.instance("persists metadata and copies it on fork by default", () =>
Effect.gen(function* () {
const session = yield* SessionNs.Service
const meta = { source: "sdk", trace: { id: "abc" } }
const created = yield* Effect.acquireRelease(session.create({ title: "with-meta", metadata: meta }), (info) =>
session.remove(info.id).pipe(Effect.ignore),
)
const saved = yield* session.get(created.id)
const fork = yield* Effect.acquireRelease(session.fork({ sessionID: created.id }), (info) =>
session.remove(info.id).pipe(Effect.ignore),
)
expect(saved.metadata).toEqual(meta)
expect(fork.metadata).toEqual(meta)
expect(fork.metadata).not.toBe(meta)
}),
)
it.instance("omits metadata when not provided", () =>
Effect.gen(function* () {
const session = yield* SessionNs.Service
const created = yield* Effect.acquireRelease(session.create({ title: "empty-meta" }), (info) =>
session.remove(info.id).pipe(Effect.ignore),
)
const saved = yield* session.get(created.id)
expect(created.metadata).toBeUndefined()
expect(saved.metadata).toBeUndefined()
}),
)
})

8
packages/sdk/js/src/v2/gen/sdk.gen.ts
View File

@ -3100,6 +3100,9 @@ export class Session2 extends HeyApiClient {
providerID: string
variant?: string
}
metadata?: {
[key: string]: unknown
}
permission?: PermissionRuleset
workspaceID?: string
},
@ -3116,6 +3119,7 @@ export class Session2 extends HeyApiClient {
{ in: "body", key: "title" },
{ in: "body", key: "agent" },
{ in: "body", key: "model" },
{ in: "body", key: "metadata" },
{ in: "body", key: "permission" },
{ in: "body", key: "workspaceID" },
],
@ -3239,6 +3243,9 @@ export class Session2 extends HeyApiClient {
directory?: string
workspace?: string
title?: string
metadata?: {
[key: string]: unknown
}
permission?: PermissionRuleset
time?: {
archived?: number
@ -3255,6 +3262,7 @@ export class Session2 extends HeyApiClient {
{ in: "query", key: "directory" },
{ in: "query", key: "workspace" },
{ in: "body", key: "title" },
{ in: "body", key: "metadata" },
{ in: "body", key: "permission" },
{ in: "body", key: "time" },
],

15
packages/sdk/js/src/v2/gen/types.gen.ts
View File

@ -780,6 +780,9 @@ export type Session = {
variant?: string
}
version: string
metadata?: {
[key: string]: unknown
}
time: {
created: number
updated: number
@ -1516,6 +1519,9 @@ export type GlobalSession = {
variant?: string
}
version: string
metadata?: {
[key: string]: unknown
}
time: {
created: number
updated: number
@ -2086,6 +2092,9 @@ export type SyncEventSessionUpdated = {
variant?: string
} | null
version?: string | null
metadata?: {
[key: string]: unknown
} | null
time?: {
created?: number | null
updated?: number | null
@ -6093,6 +6102,9 @@ export type SessionCreateData = {
providerID: string
variant?: string
}
metadata?: {
[key: string]: unknown
}
permission?: PermissionRuleset
workspaceID?: string
}
@ -6223,6 +6235,9 @@ export type SessionGetResponse = SessionGetResponses[keyof SessionGetResponses]
export type SessionUpdateData = {
body?: {
title?: string
metadata?: {
[key: string]: unknown
}
permission?: PermissionRuleset
time?: {
archived?: number

22
packages/sdk/openapi.json
View File

@ -5185,6 +5185,9 @@
"required": ["id", "providerID"],
"additionalProperties": false
},
"metadata": {
"type": "object"
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
@ -5509,6 +5512,9 @@
"title": {
"type": "string"
},
"metadata": {
"type": "object"
},
"permission": {
"$ref": "#/components/schemas/PermissionRuleset"
},
@ -12819,6 +12825,9 @@
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
@ -14912,6 +14921,9 @@
"version": {
"type": "string"
},
"metadata": {
"type": "object"
},
"time": {
"type": "object",
"properties": {
@ -16758,6 +16770,16 @@
}
]
},
"metadata": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"time": {
"type": "object",
"properties": {