refactor(server): align route-span attrs with OTel semantic conventions (#23198)

This commit is contained in:
Kit Langton
2026-04-17 19:29:33 -04:00
committed by opencode
parent 7b98f544ff
commit eafbe5c57c
2 changed files with 48 additions and 11 deletions

View File

@@ -1,5 +1,5 @@
import { describe, expect, test } from "bun:test"
import { requestAttributes } from "../../src/server/routes/instance/trace"
import { paramToAttributeKey, requestAttributes } from "../../src/server/routes/instance/trace"
function fakeContext(method: string, url: string, params: Record<string, string>) {
return {
@@ -11,6 +11,25 @@ function fakeContext(method: string, url: string, params: Record<string, string>
}
}
describe("paramToAttributeKey", () => {
test("converts fooID to foo.id", () => {
expect(paramToAttributeKey("sessionID")).toBe("session.id")
expect(paramToAttributeKey("messageID")).toBe("message.id")
expect(paramToAttributeKey("partID")).toBe("part.id")
expect(paramToAttributeKey("projectID")).toBe("project.id")
expect(paramToAttributeKey("providerID")).toBe("provider.id")
expect(paramToAttributeKey("ptyID")).toBe("pty.id")
expect(paramToAttributeKey("permissionID")).toBe("permission.id")
expect(paramToAttributeKey("requestID")).toBe("request.id")
expect(paramToAttributeKey("workspaceID")).toBe("workspace.id")
})
test("namespaces non-ID params under opencode.", () => {
expect(paramToAttributeKey("name")).toBe("opencode.name")
expect(paramToAttributeKey("slug")).toBe("opencode.slug")
})
})
describe("requestAttributes", () => {
test("includes http method and path", () => {
const attrs = requestAttributes(fakeContext("GET", "http://localhost/session", {}))
@@ -23,7 +42,7 @@ describe("requestAttributes", () => {
expect(attrs["http.path"]).toBe("/file/search")
})
test("tags route params with opencode.<param> prefix", () => {
test("emits OTel-style <domain>.id for ID-shaped route params", () => {
const attrs = requestAttributes(
fakeContext("GET", "http://localhost/session/ses_abc/message/msg_def/part/prt_ghi", {
sessionID: "ses_abc",
@@ -31,22 +50,27 @@ describe("requestAttributes", () => {
partID: "prt_ghi",
}),
)
expect(attrs["opencode.sessionID"]).toBe("ses_abc")
expect(attrs["opencode.messageID"]).toBe("msg_def")
expect(attrs["opencode.partID"]).toBe("prt_ghi")
expect(attrs["session.id"]).toBe("ses_abc")
expect(attrs["message.id"]).toBe("msg_def")
expect(attrs["part.id"]).toBe("prt_ghi")
// No camelCase leftovers:
expect(attrs["opencode.sessionID"]).toBeUndefined()
expect(attrs["opencode.messageID"]).toBeUndefined()
expect(attrs["opencode.partID"]).toBeUndefined()
})
test("produces no param attributes when no params are matched", () => {
const attrs = requestAttributes(fakeContext("POST", "http://localhost/config", {}))
expect(Object.keys(attrs).filter((k) => k.startsWith("opencode."))).toEqual([])
expect(Object.keys(attrs).filter((k) => k !== "http.method" && k !== "http.path")).toEqual([])
})
test("handles non-ID params (e.g. mcp :name) without mangling", () => {
test("namespaces non-ID params under opencode. (e.g. mcp :name)", () => {
const attrs = requestAttributes(
fakeContext("POST", "http://localhost/mcp/exa/connect", {
name: "exa",
}),
)
expect(attrs["opencode.name"]).toBe("exa")
expect(attrs["name"]).toBeUndefined()
})
})