fix(workflows): sync sidebar after external mutations

Author: Bill Leoutsakos

apps/realtime/src/access-revalidation.ts

@@ -49,8 +49,8 @@ function fallbackRoleFor(type: RoomType): string {
 /**
  * Room types whose membership is mirrored in the room manager's (Redis) presence
  * state, and therefore need a presence removal + rebroadcast after an eviction.
- * The workspace-files / workspace-tables invalidation rooms carry no presence at
- * all, and a file-doc room's roster is pod-local in-memory state reconciled by its
+ * The workspace-files / workspace-tables / workspace-workflows invalidation rooms carry no
+ * presence at all, and a file-doc room's roster is pod-local in-memory state reconciled by its
  * registered eviction handler — neither has anything for the cleanup lane to do.
  */
 const PRESENCE_ROOM_TYPES: ReadonlySet<RoomType> = new Set<RoomType>([

apps/realtime/src/handlers/index.ts

@@ -20,6 +20,7 @@ export function setupAllHandlers(socket: AuthenticatedSocket, roomManager: IRoom
   // Presence-free, workspace-scoped live-list rooms (share one implementation).
   setupWorkspaceInvalidationRoom(socket, roomManager, ROOM_TYPES.WORKSPACE_FILES)
   setupWorkspaceInvalidationRoom(socket, roomManager, ROOM_TYPES.WORKSPACE_TABLES)
+  setupWorkspaceInvalidationRoom(socket, roomManager, ROOM_TYPES.WORKSPACE_WORKFLOWS)
   setupWorkspaceFileDocHandlers(socket, roomManager)
   setupTablesHandlers(socket, roomManager)
   setupConnectionHandlers(socket, roomManager)

apps/realtime/src/handlers/workspace-invalidation-room.test.ts

@@ -73,9 +73,15 @@ function createRoomManager(overrides?: Partial<IRoomManager>): IRoomManager {
   } as unknown as IRoomManager
 }
 
-// The two presence-free live-list rooms share one implementation; run the whole suite against both
-// so files and tables can never drift. Event names and room names derive from the room type.
-describe.each([ROOM_TYPES.WORKSPACE_FILES, ROOM_TYPES.WORKSPACE_TABLES] as const)(
+// The presence-free live-list rooms share one implementation; run the whole suite against all of
+// them so their authorization and lifecycle behavior cannot drift.
+const workspaceInvalidationRoomTypesCoveredBySharedLifecycle = [
+  ROOM_TYPES.WORKSPACE_FILES,
+  ROOM_TYPES.WORKSPACE_TABLES,
+  ROOM_TYPES.WORKSPACE_WORKFLOWS,
+] as const
+
+describe.each(workspaceInvalidationRoomTypesCoveredBySharedLifecycle)(
   'setupWorkspaceInvalidationRoom(%s)',
   (roomType) => {
     const joinEvent = `join-${roomType}`

apps/realtime/src/routes/http.test.ts

@@ -1,5 +1,6 @@
 import type { IncomingMessage, ServerResponse } from 'http'
 import { describe, expect, it, vi } from 'vitest'
+import { env } from '@/env'
 import type { IRoomManager } from '@/rooms'
 import { createHttpHandler } from '@/routes/http'
 
@@ -11,6 +12,7 @@ function createMocks(req: Partial<IncomingMessage>) {
   const roomManager = {
     getTotalActiveConnections: vi.fn().mockResolvedValue(0),
     isReady: vi.fn().mockReturnValue(true),
+    emitToRoom: vi.fn(),
   } as unknown as IRoomManager
 
   return {
@@ -20,6 +22,7 @@ function createMocks(req: Partial<IncomingMessage>) {
     setHeader,
     writeHead,
     end,
+    roomManager,
   }
 }
 
@@ -58,4 +61,29 @@ describe('createHttpHandler', () => {
 
     expect(writeHead).toHaveBeenCalledWith(200, { 'Content-Type': 'application/json' })
   })
+
+  it('fans workflow-tree changes out to the workspace workflows room', async () => {
+    const workspaceId = 'workspace-1'
+    const body = JSON.stringify({ workspaceId })
+    const request = {
+      method: 'POST',
+      url: '/api/workspace-workflows-changed',
+      headers: { 'x-api-key': env.INTERNAL_API_SECRET },
+      on(event: string, callback: (chunk?: Buffer) => void) {
+        if (event === 'data') callback(Buffer.from(body))
+        if (event === 'end') callback()
+        return this
+      },
+    } as unknown as IncomingMessage
+    const { handler, res, roomManager, writeHead } = createMocks(request)
+
+    await handler(request, res)
+
+    expect(roomManager.emitToRoom).toHaveBeenCalledWith(
+      { type: 'workspace-workflows', id: workspaceId },
+      'workspace-workflows-changed',
+      { workspaceId, timestamp: expect.any(Number) }
+    )
+    expect(writeHead).toHaveBeenCalledWith(200, { 'Content-Type': 'application/json' })
+  })
 })

apps/realtime/src/routes/http.ts

@@ -205,6 +205,26 @@ export function createHttpHandler(roomManager: IRoomManager, logger: Logger) {
       return
     }
 
+    // Fan out a workflow-tree change to everyone viewing a workspace's persistent sidebar.
+    // One signal invalidates both workflow and workflow-folder lists.
+    if (req.method === 'POST' && req.url === '/api/workspace-workflows-changed') {
+      try {
+        const body = await readRequestBody(req)
+        const { workspaceId } = JSON.parse(body)
+        if (!isNonEmptyString(workspaceId)) return sendError(res, 'Invalid workspaceId', 400)
+        roomManager.emitToRoom(
+          { type: ROOM_TYPES.WORKSPACE_WORKFLOWS, id: workspaceId },
+          'workspace-workflows-changed',
+          { workspaceId, timestamp: Date.now() }
+        )
+        sendSuccess(res)
+      } catch (error) {
+        logger.error('Error handling workspace workflows changed notification:', error)
+        sendError(res, 'Failed to process workflows change notification')
+      }
+      return
+    }
+
     // Merge a durable file write into a file's LIVE collaborative document so open editors reconcile to
     // it (Stage C) — this is the stream-end/durable reconcile, not token-by-token streaming (that is now
     // applied client-side by the open editor). Returns `{ applied }`: when false, no seeded live room

apps/sim/app/api/folders/[id]/duplicate/route.test.ts

@@ -29,6 +29,7 @@ const {
   mockDuplicateWorkflow,
   mockAcquireFolderMutationLock,
   mockWithFolderTreeLock,
+  mockNotifyWorkspace,
 } = vi.hoisted(() => ({
   mockLogger: {
     info: vi.fn(),
@@ -44,6 +45,7 @@ const {
   mockDuplicateWorkflow: vi.fn(),
   mockAcquireFolderMutationLock: vi.fn(),
   mockWithFolderTreeLock: vi.fn(),
+  mockNotifyWorkspace: vi.fn(),
 }))
 
 vi.mock('@sim/audit', () => auditMock)
@@ -62,6 +64,9 @@ vi.mock('@/lib/folders/naming', () => ({ deduplicateFolderName: mockDeduplicateF
 vi.mock('@/lib/workflows/persistence/duplicate', () => ({
   duplicateWorkflow: mockDuplicateWorkflow,
 }))
+vi.mock('@/lib/realtime/notify', () => ({
+  notifyWorkspaceWorkflowsChanged: mockNotifyWorkspace,
+}))
 
 import { POST } from '@/app/api/folders/[id]/duplicate/route'
 
@@ -141,6 +146,8 @@ describe('POST /api/folders/[id]/duplicate', () => {
 
     expect(response.status).toBe(201)
     await expect(response.json()).resolves.toMatchObject({ folder: { name: 'Copy' } })
+    expect(mockNotifyWorkspace).toHaveBeenCalledOnce()
+    expect(mockNotifyWorkspace).toHaveBeenCalledWith(WORKSPACE_ID)
   })
 
   it('refuses a single-folder duplicate once the workspace is at the ceiling', async () => {

apps/sim/app/api/folders/[id]/duplicate/route.ts

@@ -19,6 +19,7 @@ import { nextFolderSortOrder } from '@/lib/folders/orchestration'
 import { assertFolderCollectionHasRoom, toFolderApi } from '@/lib/folders/queries'
 import { folderMutationStatus } from '@/lib/folders/status'
 import { collectDescendantFolderIds } from '@/lib/folders/subtree'
+import { notifyWorkspaceWorkflowsChanged } from '@/lib/realtime/notify'
 import { duplicateWorkflow } from '@/lib/workflows/persistence/duplicate'
 import { getUserEntityPermissions } from '@/lib/workspaces/permissions/utils'
 
@@ -208,6 +209,7 @@ export const POST = withRouteHandler(
 
         return { newFolderId, folderMapping, workflowStats }
       })
+      await notifyWorkspaceWorkflowsChanged(targetWorkspaceId)
 
       const elapsed = Date.now() - startTime
       logger.info(

apps/sim/app/api/folders/reorder/route.test.ts

@@ -6,7 +6,7 @@
 import { authMockFns, createMockRequest, permissionsMock, permissionsMockFns } from '@sim/testing'
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
-const { mockLogger } = vi.hoisted(() => ({
+const { mockLogger, mockNotifyFolder } = vi.hoisted(() => ({
   mockLogger: {
     info: vi.fn(),
     warn: vi.fn(),
@@ -16,11 +16,13 @@ const { mockLogger } = vi.hoisted(() => ({
     fatal: vi.fn(),
     child: vi.fn(),
   },
+  mockNotifyFolder: vi.fn(),
 }))
 
 const mockGetUserEntityPermissions = permissionsMockFns.mockGetUserEntityPermissions
 
 vi.mock('@/lib/workspaces/permissions/utils', () => permissionsMock)
+vi.mock('@/lib/realtime/notify', () => ({ notifyFolderResourceChanged: mockNotifyFolder }))
 
 import { db } from '@sim/db'
 import { PUT } from '@/app/api/folders/reorder/route'
@@ -73,6 +75,7 @@ describe('PUT /api/folders/reorder', () => {
     expect(response.status).toBe(200)
     const data = await response.json()
     expect(data).toMatchObject({ success: true, updated: 1 })
+    expect(mockNotifyFolder).toHaveBeenCalledWith('workflow', 'workspace-123')
   })
 
   it('maps a sibling-name collision from a reparent to a 409', async () => {

apps/sim/app/api/folders/reorder/route.ts

@@ -12,6 +12,7 @@ import { withRouteHandler } from '@/lib/core/utils/with-route-handler'
 import { withTransactionRetry } from '@/lib/db/transaction'
 import { acquireFolderMutationLock } from '@/lib/folders/locks'
 import { folderResourceSupportsLocking } from '@/lib/folders/resource-traits'
+import { notifyFolderResourceChanged } from '@/lib/realtime/notify'
 import { getUserEntityPermissions } from '@/lib/workspaces/permissions/utils'
 
 const logger = createLogger('FolderReorderAPI')
@@ -38,7 +39,7 @@ export const PUT = withRouteHandler(async (req: NextRequest) => {
       return NextResponse.json({ error: 'Write access required' }, { status: 403 })
     }
 
-    return await withTransactionRetry(
+    const response = await withTransactionRetry(
       async (tx) => {
         await acquireFolderMutationLock(tx, workspaceId, resourceType)
         const folderIds = updates.map((u) => u.id)
@@ -178,6 +179,8 @@ export const PUT = withRouteHandler(async (req: NextRequest) => {
       },
       { label: 'reorder-folders' }
     )
+    if (response.ok) await notifyFolderResourceChanged(resourceType, workspaceId)
+    return response
   } catch (error) {
     if (error instanceof FolderLockedError) {
       return NextResponse.json({ error: error.message }, { status: error.status })

apps/sim/app/api/superuser/import-workflow/route.ts

@@ -11,6 +11,7 @@ import { loadCopilotChatMessages } from '@/lib/copilot/chat/lifecycle'
 import { appendCopilotChatMessages } from '@/lib/copilot/chat/messages-store'
 import { withRouteHandler } from '@/lib/core/utils/with-route-handler'
 import { verifyEffectiveSuperUser } from '@/lib/permissions/super-user'
+import { notifyWorkspaceWorkflowsChanged } from '@/lib/realtime/notify'
 import { parseWorkflowJson } from '@/lib/workflows/operations/import-export'
 import {
   loadWorkflowFromNormalizedTables,
@@ -163,6 +164,8 @@ export const POST = withRouteHandler(async (request: NextRequest) => {
       )
     }
 
+    await notifyWorkspaceWorkflowsChanged(targetWorkspaceId)
+
     // Copy copilot chats associated with the source workflow
     const sourceCopilotChats = await db
       .select({