fix(copilot): persist table view pin updates

Author: j15z

apps/sim/app/api/copilot/chat/resources/route.ts

@@ -17,6 +17,7 @@ import {
   createUnauthorizedResponse,
 } from '@/lib/copilot/request/http'
 import type { ChatResource } from '@/lib/copilot/resources/persistence'
+import type { MothershipResourceUpdate } from '@/lib/copilot/resources/types'
 import {
   canonicalizeDesktopSessionResource,
   mergeChatResource,
@@ -43,8 +44,10 @@ export const POST = withRouteHandler(async (req: NextRequest) => {
       }
     )
     if (!parsed.success) return parsed.response
-    const { chatId, resource: requestedResource } = parsed.data.body
+    const { chatId, resource: requestedResource, clearViewId } = parsed.data.body
     const resource = canonicalizeDesktopSessionResource(requestedResource)
+    const resourceUpdate: MothershipResourceUpdate =
+      clearViewId === true ? { ...resource, clearViewId: true } : resource
 
     // Ephemeral UI tab (client does not POST this; guard for old clients / bugs).
     if (resource.id === 'streaming-file') {
@@ -74,8 +77,10 @@ export const POST = withRouteHandler(async (req: NextRequest) => {
     const prev = existing.find((r) => `${r.type}:${r.id}` === key)
 
     const merged: ChatResource[] = prev
-      ? existing.map((r) => (`${r.type}:${r.id}` === key ? mergeChatResource(r, resource) : r))
-      : [...existing, resource]
+      ? existing.map((r) =>
+          `${r.type}:${r.id}` === key ? mergeChatResource(r, resourceUpdate) : r
+        )
+      : [...existing, mergeChatResource(undefined, resourceUpdate)]
 
     await db
       .update(copilotChats)

apps/sim/app/workspace/[workspaceId]/home/hooks/stream/handle-resource-event.test.ts

@@ -108,7 +108,11 @@ describe('handleResourceEvent removal', () => {
   })
 })
 
-function tableUpsertEvent(id: string, viewId?: string): PersistedStreamEventEnvelope {
+function tableUpsertEvent(
+  id: string,
+  viewId?: string,
+  clearViewId?: true
+): PersistedStreamEventEnvelope {
   return {
     type: 'resource',
     v: 1,
@@ -117,7 +121,13 @@ function tableUpsertEvent(id: string, viewId?: string): PersistedStreamEventEnve
     stream: { streamId: 's', cursor: '1' },
     payload: {
       op: 'upsert',
-      resource: { type: 'table', id, title: 'Invoices', ...(viewId ? { viewId } : {}) },
+      resource: {
+        type: 'table',
+        id,
+        title: 'Invoices',
+        ...(viewId ? { viewId } : {}),
+        ...(clearViewId ? { clearViewId } : {}),
+      },
     },
   } as PersistedStreamEventEnvelope
 }
@@ -188,4 +198,33 @@ describe('handleResourceEvent saved-view pins', () => {
     expect(deps.setResources).not.toHaveBeenCalled()
     expect(useTableViewPinStore.getState().pins['tbl-1']).toBeUndefined()
   })
+
+  it('clears the stored and pending pin when the agent deletes a saved view', () => {
+    const open: MothershipResource = {
+      type: 'table',
+      id: 'tbl-1',
+      title: 'Invoices',
+      viewId: 'view-1',
+    }
+    useTableViewPinStore.getState().pin('tbl-1', 'view-1')
+    const deps = makeStreamLoopDeps({
+      addResource: vi.fn(() => false),
+      resourcesRef: { current: [open] },
+    })
+    const ctx = { deps } as StreamLoopContext
+
+    handleResourceEvent(ctx, tableUpsertEvent('tbl-1', undefined, true))
+
+    expect(deps.addResource).toHaveBeenCalledWith({
+      type: 'table',
+      id: 'tbl-1',
+      title: 'Invoices',
+      clearViewId: true,
+    })
+    const updater = (deps.setResources as ReturnType<typeof vi.fn>).mock.calls[0][0] as (
+      current: MothershipResource[]
+    ) => MothershipResource[]
+    expect(updater([open])).toEqual([{ type: 'table', id: 'tbl-1', title: 'Invoices' }])
+    expect(useTableViewPinStore.getState().pins['tbl-1']).toBeUndefined()
+  })
 })

apps/sim/app/workspace/[workspaceId]/home/hooks/stream/handle-resource-event.ts

@@ -45,9 +45,12 @@ export function handleResourceEvent(ctx: StreamLoopContext, parsed: ResourceEven
   } = ctx.deps
   const onResourceEvent = onResourceEventRef.current
   const payload = parsed.payload
+  const shouldClearViewId =
+    payload.resource.type === 'table' && payload.resource.clearViewId === true
   // A saved view the agent just created or edited: the table opens on it, and
   // an already-open table switches to it.
   const pinnedViewId =
+    !shouldClearViewId &&
     payload.resource.type === 'table' &&
     typeof payload.resource.viewId === 'string' &&
     payload.resource.viewId.trim()
@@ -60,6 +63,7 @@ export function handleResourceEvent(ctx: StreamLoopContext, parsed: ResourceEven
       typeof payload.resource.title === 'string' ? payload.resource.title : payload.resource.id,
     ...(pinnedViewId ? { viewId: pinnedViewId } : {}),
   })
+  const resourceUpdate = shouldClearViewId ? { ...resource, clearViewId: true as const } : resource
 
   if (payload.op === MothershipStreamV1ResourceOp.remove) {
     const resourceType = resource.type
@@ -109,7 +113,7 @@ export function handleResourceEvent(ctx: StreamLoopContext, parsed: ResourceEven
         !shouldAutoActivatePreviewSession(previewForResource)))
   const wasAdded = shouldSuppressFileResourceActivation
     ? !resourcesRef.current.some((r) => r.type === resource.type && r.id === resource.id)
-    : addResource(resource)
+    : addResource(resourceUpdate)
   if (shouldSuppressFileResourceActivation && wasAdded) {
     setResources((current) =>
       current.some((r) => r.type === resource.type && r.id === resource.id)
@@ -136,6 +140,17 @@ export function handleResourceEvent(ctx: StreamLoopContext, parsed: ResourceEven
     // Consumed by the embedded table once its views list carries the view —
     // which may be after the refetch below lands, or after the tab first opens.
     useTableViewPinStore.getState().pin(resource.id, pinnedViewId)
+  } else if (shouldClearViewId) {
+    setResources((current) =>
+      current.some((r) => r.type === 'table' && r.id === resource.id && r.viewId !== undefined)
+        ? current.map((r) => {
+            if (r.type !== 'table' || r.id !== resource.id) return r
+            const { viewId: _viewId, ...unpinned } = r
+            return unpinned
+          })
+        : current
+    )
+    useTableViewPinStore.getState().clear(resource.id)
   }
   invalidateResourceQueries(queryClient, workspaceId, resource.type, resource.id)
 

apps/sim/app/workspace/[workspaceId]/home/hooks/stream/stream-context.ts

@@ -5,6 +5,7 @@ import type { RevealedSimKeysByMessage } from '@/lib/copilot/chat/sim-key-redact
 import { captureRevealedSimKeys } from '@/lib/copilot/chat/sim-key-redaction'
 import type { SyntheticFilePreviewPayload } from '@/lib/copilot/request/session'
 import type { FilePreviewSession } from '@/lib/copilot/request/session/file-preview-session-contract'
+import type { MothershipResourceUpdate } from '@/lib/copilot/resources/types'
 import {
   createTurnModel,
   type TurnModel,
@@ -95,7 +96,7 @@ export interface StreamLoopDeps {
   setResources: Dispatch<SetStateAction<MothershipResource[]>>
   setActiveResourceId: Dispatch<SetStateAction<string | null>>
 
-  addResource: (resource: MothershipResource) => boolean
+  addResource: (resource: MothershipResourceUpdate) => boolean
   removeResource: (resourceType: MothershipResourceType, resourceId: string) => void
   startClientWorkflowTool: (id: string, name: string, args: Record<string, unknown>) => void
   startClientLocalFilesystemTool: (id: string, name: string, args: Record<string, unknown>) => void

apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts

@@ -70,6 +70,8 @@ import {
   BROWSER_SESSION_RESOURCE_ID,
   isAddressableResource,
   isEphemeralResource,
+  type MothershipResourceUpdate,
+  mergeChatResource,
   sanitizeChatResources,
   TERMINAL_SESSION_RESOURCE_ID,
 } from '@/lib/copilot/resources/types'
@@ -211,7 +213,7 @@ export interface UseChatReturn {
   resources: MothershipResource[]
   activeResourceId: string | null
   setActiveResourceId: (id: string | null) => void
-  addResource: (resource: MothershipResource) => boolean
+  addResource: (resource: MothershipResourceUpdate) => boolean
   removeResource: (resourceType: MothershipResourceType, resourceId: string) => void
   reorderResources: (resources: MothershipResource[]) => void
   messageQueue: QueuedMessage[]
@@ -1383,6 +1385,7 @@ export function useChat(
    */
   const undisplayableResourcesRef = useRef<MothershipResource[]>([])
   const pendingPersistResourceKeysRef = useRef<Set<string>>(new Set())
+  const pendingClearViewIdKeysRef = useRef<Set<string>>(new Set())
   const inFlightResourceAddsRef = useRef<Map<string, Promise<unknown>>>(new Map())
   const reorderNeededAfterFlushRef = useRef(false)
 
@@ -1642,6 +1645,7 @@ export function useChat(
     useTableViewPinStore.getState().reset()
     undisplayableResourcesRef.current = []
     pendingPersistResourceKeysRef.current.clear()
+    pendingClearViewIdKeysRef.current.clear()
     inFlightResourceAddsRef.current.clear()
     reorderNeededAfterFlushRef.current = false
     resetEphemeralPreviewState()
@@ -1679,9 +1683,18 @@ export function useChat(
       const key = `${resource.type}:${resource.id}`
       if (!pendingKeys.has(key)) continue
       pendingKeys.delete(key)
+      const shouldClearViewId = pendingClearViewIdKeysRef.current.has(key)
       const promise = requestJson(addMothershipChatResourceContract, {
-        body: { chatId, resource },
+        body: {
+          chatId,
+          resource,
+          ...(shouldClearViewId ? { clearViewId: true as const } : {}),
+        },
       })
+        .then((result) => {
+          if (shouldClearViewId) pendingClearViewIdKeysRef.current.delete(key)
+          return result
+        })
         .catch((err) => {
           pendingPersistResourceKeysRef.current.add(key)
           logger.warn('Failed to flush pending resource; will retry on next hydration', err)
@@ -1798,20 +1811,30 @@ export function useChat(
     const source = chatHistory?.messages.map(toDisplayMessage) ?? pendingMessages
     return source.map((m) => restoreRevealedSimKeysForMessage(m, revealedSimKeysRef.current))
   }, [chatHistory, pendingMessages])
-  const addResource = useCallback((resource: MothershipResource): boolean => {
+  const addResource = useCallback((resourceUpdate: MothershipResourceUpdate): boolean => {
     // The single fan-in for tab creation, so the invariant lives here.
-    if (!isAddressableResource(resource)) {
-      logger.warn('Ignored a resource with no id', { type: resource.type, title: resource.title })
+    if (!isAddressableResource(resourceUpdate)) {
+      logger.warn('Ignored a resource with no id', {
+        type: resourceUpdate.type,
+        title: resourceUpdate.title,
+      })
       return false
     }
-    if (resourcesRef.current.some((r) => r.type === resource.type && r.id === resource.id)) {
+    const existing = resourcesRef.current.find(
+      (r) => r.type === resourceUpdate.type && r.id === resourceUpdate.id
+    )
+    const resource = mergeChatResource(existing, resourceUpdate)
+    if (existing && resource === existing) {
       return false
     }
 
     setResources((prev) => {
-      const exists = prev.some((r) => r.type === resource.type && r.id === resource.id)
-      if (exists) return prev
-      return [...prev, resource]
+      const current = prev.find((r) => r.type === resource.type && r.id === resource.id)
+      if (!current) return [...prev, resource]
+      const merged = mergeChatResource(current, resourceUpdate)
+      return merged === current
+        ? prev
+        : prev.map((r) => (r.type === resource.type && r.id === resource.id ? merged : r))
     })
     // Synthetic result/preview panels are in-memory only. The browser tab
     // metadata is persisted even though its live page remains desktop-owned.
@@ -1821,19 +1844,34 @@ export function useChat(
 
     const persistChatId = chatIdRef.current ?? selectedChatIdRef.current
     const key = `${resource.type}:${resource.id}`
+    const shouldClearViewId = resourceUpdate.clearViewId === true
+    if (shouldClearViewId) {
+      pendingClearViewIdKeysRef.current.add(key)
+    } else if (resourceUpdate.viewId !== undefined) {
+      pendingClearViewIdKeysRef.current.delete(key)
+    }
     // `resourcesRef` is written during render, so adds of the same resource in
     // one tick all read the pre-render list and all pass the check above. State
     // converges (the updater is idempotent) but each fired its own POST — 5-6
     // per resource in production.
     const alreadyPersisting =
       inFlightResourceAddsRef.current.has(key) || pendingPersistResourceKeysRef.current.has(key)
     if (alreadyPersisting) {
-      return true
+      pendingPersistResourceKeysRef.current.add(key)
+      return existing === undefined
     }
     if (persistChatId) {
       const promise = requestJson(addMothershipChatResourceContract, {
-        body: { chatId: persistChatId, resource },
+        body: {
+          chatId: persistChatId,
+          resource,
+          ...(shouldClearViewId ? { clearViewId: true as const } : {}),
+        },
       })
+        .then((result) => {
+          if (shouldClearViewId) pendingClearViewIdKeysRef.current.delete(key)
+          return result
+        })
         .catch((err) => {
           pendingPersistResourceKeysRef.current.add(key)
           logger.warn('Failed to persist resource; will retry on next hydration', err)
@@ -1845,7 +1883,7 @@ export function useChat(
     } else {
       pendingPersistResourceKeysRef.current.add(key)
     }
-    return true
+    return existing === undefined
   }, [])
 
   const removeResource = useCallback((resourceType: MothershipResourceType, resourceId: string) => {
@@ -1856,6 +1894,7 @@ export function useChat(
     if (isEphemeralResource({ type: resourceType, id: resourceId, title: '' })) return
 
     const key = `${resourceType}:${resourceId}`
+    pendingClearViewIdKeysRef.current.delete(key)
     const wasPending = pendingPersistResourceKeysRef.current.delete(key)
     const inFlightAdd = inFlightResourceAddsRef.current.get(key)
     if (wasPending && !inFlightAdd) return
@@ -2344,6 +2383,7 @@ export function useChat(
     setActiveResourceId(null)
     useTableViewPinStore.getState().reset()
     pendingPersistResourceKeysRef.current.clear()
+    pendingClearViewIdKeysRef.current.clear()
     inFlightResourceAddsRef.current.clear()
     reorderNeededAfterFlushRef.current = false
     resetEphemeralPreviewState()

apps/sim/lib/api/contracts/copilot.ts

@@ -100,10 +100,29 @@ const copilotChatResourceItemSchema = z.object({
   viewId: z.string().min(1).optional(),
 })
 
-export const addCopilotChatResourceBodySchema = z.object({
-  chatId: z.string(),
-  resource: copilotChatResourceItemSchema,
-})
+export const addCopilotChatResourceBodySchema = z
+  .object({
+    chatId: z.string(),
+    resource: copilotChatResourceItemSchema,
+    clearViewId: z.literal(true).optional(),
+  })
+  .superRefine((body, ctx) => {
+    if (body.clearViewId !== true) return
+    if (body.resource.type !== 'table') {
+      ctx.addIssue({
+        code: 'custom',
+        path: ['clearViewId'],
+        message: 'clearViewId is only valid for table resources',
+      })
+    }
+    if (body.resource.viewId !== undefined) {
+      ctx.addIssue({
+        code: 'custom',
+        path: ['resource', 'viewId'],
+        message: 'viewId must be omitted when clearViewId is true',
+      })
+    }
+  })
 export type AddCopilotChatResourceBody = z.input<typeof addCopilotChatResourceBodySchema>
 
 export const removeCopilotChatResourceBodySchema = z.object({

apps/sim/lib/copilot/generated/mothership-stream-v1-schema.ts

@@ -363,6 +363,9 @@ export const MOTHERSHIP_STREAM_V1_SCHEMA: JsonSchema = {
     MothershipStreamV1ResourceDescriptor: {
       additionalProperties: false,
       properties: {
+        clearViewId: {
+          type: 'boolean',
+        },
         id: {
           type: 'string',
         },

apps/sim/lib/copilot/generated/mothership-stream-v1.ts

@@ -279,6 +279,7 @@ export interface MothershipStreamV1ResourceUpsertPayload {
   resource: MothershipStreamV1ResourceDescriptor
 }
 export interface MothershipStreamV1ResourceDescriptor {
+  clearViewId?: boolean
   id: string
   title?: string
   type: string

apps/sim/lib/copilot/request/session/contract.test.ts

@@ -255,4 +255,24 @@ describe('resource event view pins', () => {
 
     expect(isContractStreamEventEnvelope(event)).toBe(false)
   })
+
+  it('accepts an explicit pin clear and rejects a non-boolean directive', () => {
+    const event = {
+      ...BASE_ENVELOPE,
+      type: 'resource' as const,
+      payload: {
+        op: 'upsert' as const,
+        resource: { id: 'tbl-1', type: 'table', title: 'Invoices', clearViewId: true },
+      },
+    }
+
+    expect(isContractStreamEventEnvelope(event)).toBe(true)
+    expect(parsePersistedStreamEventEnvelope(event).ok).toBe(true)
+    expect(
+      isContractStreamEventEnvelope({
+        ...event,
+        payload: { ...event.payload, resource: { ...event.payload.resource, clearViewId: 'yes' } },
+      })
+    ).toBe(false)
+  })
 })