fix(selectors): refresh caches after copilot secret updates

Author: Bill Leoutsakos

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

@@ -15,8 +15,11 @@ vi.mock(
   () => ({ invalidateResourceQueries: vi.fn() })
 )
 
+import { SetEnvironmentVariables } from '@/lib/copilot/generated/tool-catalog-v1'
 import type { PersistedStreamEventEnvelope } from '@/lib/copilot/request/session/contract'
 import type { FilePreviewSession } from '@/lib/copilot/request/session/file-preview-session-contract'
+import { environmentKeys } from '@/hooks/queries/environment'
+import { environmentDependentSelectorKeys } from '@/hooks/selectors/cache-invalidation'
 import { dispatchStreamEvent } from './dispatch-stream-event'
 import { createStreamLoopContext, type StreamLoopContext } from './stream-context'
 import { makeStreamLoopDeps, ref } from './stream-test-helpers'
@@ -38,7 +41,7 @@ function toolEnv(payload: Record<string, unknown>): PersistedStreamEventEnvelope
 const toolCall = (id: string, name = 'my_tool') =>
   toolEnv({ phase: 'call', executor: 'go', mode: 'sync', toolCallId: id, toolName: name })
 
-const toolResult = (id: string, success: boolean, name = 'my_tool') =>
+const toolResult = (id: string, success: boolean, name = 'my_tool', output?: unknown) =>
   toolEnv({
     phase: 'result',
     executor: 'go',
@@ -47,6 +50,7 @@ const toolResult = (id: string, success: boolean, name = 'my_tool') =>
     toolName: name,
     success,
     status: success ? 'success' : 'error',
+    ...(output === undefined ? {} : { output }),
   })
 
 const workspaceFileCall = (id: string) =>
@@ -110,6 +114,61 @@ describe('tool events (dispatch → model + side effects)', () => {
     expect(toolNode(ctx, 'tc-3').status).toBe('error')
   })
 
+  it.each([
+    {
+      scope: 'personal',
+      output: { scope: 'personal' },
+      environmentQueryKey: environmentKeys.personal(),
+    },
+    {
+      scope: 'workspace',
+      output: { scope: 'workspace', workspaceId: 'workspace-from-result' },
+      environmentQueryKey: environmentKeys.workspace('workspace-from-result'),
+    },
+  ])(
+    'refreshes the $scope environment before selector caches after Copilot saves secrets',
+    async ({ output, environmentQueryKey }) => {
+      const deps = makeStreamLoopDeps()
+      const invalidateQueries = vi.mocked(deps.queryClient.invalidateQueries)
+      invalidateQueries.mockResolvedValue(undefined)
+      const ctx = createStreamLoopContext(deps)
+
+      dispatchStreamEvent(ctx, toolCall('environment-1', SetEnvironmentVariables.id))
+      dispatchStreamEvent(
+        ctx,
+        toolResult('environment-1', true, SetEnvironmentVariables.id, output)
+      )
+
+      await vi.waitFor(() => expect(invalidateQueries).toHaveBeenCalledTimes(5))
+      expect(invalidateQueries.mock.calls.map(([filters]) => filters?.queryKey)).toEqual([
+        environmentQueryKey,
+        environmentDependentSelectorKeys.primary,
+        environmentDependentSelectorKeys.dynamicDetails,
+        environmentDependentSelectorKeys.workflowDetails,
+        environmentDependentSelectorKeys.workflowReplacementOptions,
+      ])
+    }
+  )
+
+  it('does not refresh environment or selector caches when Copilot secret storage fails', async () => {
+    const deps = makeStreamLoopDeps()
+    const invalidateQueries = vi.mocked(deps.queryClient.invalidateQueries)
+    invalidateQueries.mockResolvedValue(undefined)
+    const ctx = createStreamLoopContext(deps)
+
+    dispatchStreamEvent(ctx, toolCall('environment-failed', SetEnvironmentVariables.id))
+    dispatchStreamEvent(
+      ctx,
+      toolResult('environment-failed', false, SetEnvironmentVariables.id, {
+        scope: 'workspace',
+        workspaceId: 'workspace-from-result',
+      })
+    )
+    await Promise.resolve()
+
+    expect(invalidateQueries).not.toHaveBeenCalled()
+  })
+
   // The client starts terminal/browser/workflow tools straight off the call
   // frame rather than waiting for the server to dispatch them, so a permission
   // gate that only held the server would let the command run behind the prompt.

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

@@ -4,7 +4,11 @@ import {
   MothershipStreamV1ToolPhase,
   MothershipStreamV1ToolStatus,
 } from '@/lib/copilot/generated/mothership-stream-v1'
-import { ApplyFileEdit, PrepareFileEdit } from '@/lib/copilot/generated/tool-catalog-v1'
+import {
+  ApplyFileEdit,
+  PrepareFileEdit,
+  SetEnvironmentVariables,
+} from '@/lib/copilot/generated/tool-catalog-v1'
 import type { PersistedStreamEventEnvelope } from '@/lib/copilot/request/session/contract'
 import {
   extractResourcesFromToolResult,
@@ -26,8 +30,10 @@ import {
   type ToolNode,
 } from '@/app/workspace/[workspaceId]/home/hooks/stream/turn-model'
 import { deploymentKeys } from '@/hooks/queries/deployments'
+import { environmentKeys } from '@/hooks/queries/environment'
 import { folderKeys } from '@/hooks/queries/utils/folder-keys'
 import { invalidateWorkflowLists } from '@/hooks/queries/utils/invalidate-workflow-lists'
+import { invalidateEnvironmentDependentSelectorQueries } from '@/hooks/selectors/cache-invalidation'
 
 type ToolEvent = Extract<PersistedStreamEventEnvelope, { type: 'tool' }>
 
@@ -71,6 +77,23 @@ function runToolResultSideEffects(ctx: StreamLoopContext, node: ToolNode): void
     void invalidateWorkflowLists(deps.queryClient, deps.workspaceId, ['active', 'archived'])
   }
 
+  if (name === SetEnvironmentVariables.id && isSuccess) {
+    const out = output as Record<string, unknown> | undefined
+    const isPersonal = out?.scope === 'personal'
+    const workspaceId = typeof out?.workspaceId === 'string' ? out.workspaceId : deps.workspaceId
+
+    void (async () => {
+      if (isPersonal) {
+        await deps.queryClient.invalidateQueries({ queryKey: environmentKeys.personal() })
+      } else {
+        await deps.queryClient.invalidateQueries({
+          queryKey: environmentKeys.workspace(workspaceId),
+        })
+      }
+      await invalidateEnvironmentDependentSelectorQueries(deps.queryClient)
+    })()
+  }
+
   const extractedResources =
     isSuccess && isResourceToolName(name)
       ? extractResourcesFromToolResult(name, params, output)