fix(copilot): capture prompt telemetry only once the turn is allowed to run

Author: waleedlatif1

apps/sim/lib/copilot/chat/post.test.ts

@@ -61,6 +61,41 @@ const {
   releaseChatSendClaim: vi.fn(),
 }))
 
+/**
+ * The root span, captured so a test can assert what a refused turn exported.
+ * `withCopilotSpan` is a pass-through here — the nesting it provides is not
+ * under test and a real tracer would need an exporter to observe.
+ */
+const { setInputMessages, setUserMessagePreview, startCopilotOtelRoot } = vi.hoisted(() => ({
+  setInputMessages: vi.fn(),
+  setUserMessagePreview: vi.fn(),
+  startCopilotOtelRoot: vi.fn(),
+}))
+
+vi.mock('@/lib/copilot/request/otel', async () => {
+  const { ROOT_CONTEXT, trace } = await import('@opentelemetry/api')
+  const span = () => trace.getTracer('post-test').startSpan('post-test')
+  startCopilotOtelRoot.mockImplementation(() => ({
+    span: span(),
+    context: ROOT_CONTEXT,
+    requestId: 'req-1',
+    finish: vi.fn(),
+    setUserMessagePreview,
+    setInputMessages,
+    setOutputMessages: vi.fn(),
+    setRequestShape: vi.fn(),
+  }))
+  return {
+    startCopilotOtelRoot,
+    withCopilotSpan: (
+      _name: string,
+      _attrs: Record<string, unknown> | undefined,
+      fn: (child: ReturnType<typeof span>) => unknown,
+      _context?: unknown
+    ) => fn(span()),
+  }
+})
+
 const resolvePermissionGroupConfig = permissionGroupScopeMockFns.mockResolvePermissionGroupConfig
 
 const getSession = authMockFns.mockGetSession
@@ -1068,6 +1103,38 @@ describe('handleUnifiedChatPost copilot.use capability gate', () => {
     expect(createSSEStream).toHaveBeenCalledTimes(1)
   })
 
+  /**
+   * Prompt content is exported only once the turn is going to run. GenAI
+   * message capture is gated on whether capture is enabled at all, not on
+   * whether this caller may send, so capturing at span start exported the
+   * message of every turn the gate then refused.
+   */
+  it('exports no part of the prompt when the send is refused', async () => {
+    resolvePermissionGroupConfig.mockResolvedValue({
+      ...DEFAULT_PERMISSION_GROUP_CONFIG,
+      hideCopilot: true,
+    })
+
+    const response = await handleUnifiedChatPost(chatRequest({ createNewChat: true }))
+
+    expect(response.status).toBe(403)
+    expect(setInputMessages).not.toHaveBeenCalled()
+    expect(setUserMessagePreview).not.toHaveBeenCalled()
+    expect(startCopilotOtelRoot).toHaveBeenCalledWith(
+      expect.not.objectContaining({ userMessagePreview: expect.anything() })
+    )
+  })
+
+  it('captures the prompt once the send is allowed to run', async () => {
+    resolvePermissionGroupConfig.mockResolvedValue(DEFAULT_PERMISSION_GROUP_CONFIG)
+
+    const response = await handleUnifiedChatPost(chatRequest({ createNewChat: true }))
+
+    expect(response.status).toBe(200)
+    expect(setUserMessagePreview).toHaveBeenCalledWith('Hello')
+    expect(setInputMessages).toHaveBeenCalledWith({ userMessage: 'Hello' })
+  })
+
   /** A branch that lands in no workspace at all is governed by no group. */
   it('does not consult a permission group when the branch resolves no workspace', async () => {
     resolveWorkflowIdForUser.mockResolvedValue({

apps/sim/lib/copilot/chat/post.ts

@@ -1073,7 +1073,6 @@ export async function handleUnifiedChatPost(req: NextRequest) {
       executionId,
       runId,
       transport: CopilotTransport.Stream,
-      userMessagePreview: body.message,
     })
     if (otelRoot.requestId) {
       requestId = otelRoot.requestId
@@ -1088,10 +1087,6 @@ export async function handleUnifiedChatPost(req: NextRequest) {
     if (authenticatedUserEmail) {
       otelRoot.span.setAttribute(TraceAttr.UserEmail, authenticatedUserEmail)
     }
-    // `setInputMessages` is internally gated on
-    // OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT; safe to call.
-    otelRoot.setInputMessages({ userMessage: body.message })
-
     // Wrap the rest of the handler so nested spans attach to the
     // root via AsyncLocalStorage (otherwise they orphan into new traces).
     const activeOtelRoot = otelRoot
@@ -1160,6 +1155,17 @@ export async function handleUnifiedChatPost(req: NextRequest) {
         return capabilityRefusalResponse(chatCapability)
       }
 
+      /* Prompt content is captured only once the turn is going to run. Both
+         calls are internally gated on
+         OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT, but the gate is on
+         whether capture is enabled at all, not on whether this caller may send
+         — so stamping them at span start exported the message of every turn the
+         capability check above then refused. Every refusal ahead of this point
+         (a rejected branch, a withheld `copilot.use`) now records the shape of
+         the request and none of its content. */
+      activeOtelRoot.setUserMessagePreview(body.message)
+      activeOtelRoot.setInputMessages({ userMessage: body.message })
+
       let currentChat: ChatLoadResult['chat'] = null
       let conversationHistory: unknown[] = []
       let chatIsNew = false

apps/sim/lib/copilot/request/otel.ts

@@ -360,19 +360,13 @@ interface CopilotOtelScope {
   runId?: string
   streamId?: string
   transport: 'headless' | 'stream'
-  userMessagePreview?: string
 }
 
 // Dashboard-column width; long enough for triage disambiguation.
 const USER_MESSAGE_PREVIEW_MAX_CHARS = 500
 function buildAgentSpanAttributes(
   scope: CopilotOtelScope & { requestId: string }
 ): Record<string, string | number | boolean> {
-  // Gated behind the same env var as full GenAI message capture — a
-  // 500-char preview is still user prompt content.
-  const preview = isGenAIMessageCaptureEnabled()
-    ? truncateUserMessagePreview(scope.userMessagePreview)
-    : undefined
   return {
     [TraceAttr.GenAiAgentName]: 'mothership',
     [TraceAttr.GenAiAgentId]:
@@ -388,7 +382,6 @@ function buildAgentSpanAttributes(
     ...(scope.executionId ? { [TraceAttr.CopilotExecutionId]: scope.executionId } : {}),
     ...(scope.runId ? { [TraceAttr.RunId]: scope.runId } : {}),
     ...(scope.streamId ? { [TraceAttr.StreamId]: scope.streamId } : {}),
-    ...(preview ? { [TraceAttr.CopilotUserMessagePreview]: preview } : {}),
   }
 }
 
@@ -432,6 +425,15 @@ interface CopilotOtelRoot {
     error?: unknown,
     cancelReason?: CopilotRequestCancelReasonValue
   ) => void
+  /**
+   * Stamp the triage preview of the user's prompt.
+   *
+   * Gated behind the same env var as full GenAI message capture — a 500-char
+   * preview is still user prompt content — and separate from span creation so
+   * that a turn refused before it starts (a capability the caller's permission
+   * group withholds, a rejected branch) exports no part of the prompt.
+   */
+  setUserMessagePreview: (raw: string | undefined) => void
   setInputMessages: (input: CopilotAgentInputMessages) => void
   setOutputMessages: (output: CopilotAgentOutputMessages) => void
   setRequestShape: (shape: CopilotOtelRequestShape) => void
@@ -503,6 +505,11 @@ export function startCopilotOtelRoot(
     context: rootContext,
     requestId,
     finish,
+    setUserMessagePreview: (raw) => {
+      if (!isGenAIMessageCaptureEnabled()) return
+      const preview = truncateUserMessagePreview(raw)
+      if (preview) span.setAttribute(TraceAttr.CopilotUserMessagePreview, preview)
+    },
     setInputMessages: (input) => setAgentInputMessages(span, input),
     setOutputMessages: (output) => setAgentOutputMessages(span, output),
     setRequestShape: (shape) => applyRequestShape(span, shape),