feat(variables): multiplayer variables through sockets, persist server side by waleedlatif1 · Pull Request #933 · simstudioai/sim

waleedlatif1 · 2025-08-11T04:08:11Z

Summary

multiplayer variables through sockets, persist server side

Type of Change

Bug fix

Testing

Tested manually.

Checklist

Code follows project style guidelines
Self-reviewed my changes
Tests added/updated and passing
No new warnings introduced
I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Screenshots/Videos

Screen.Recording.2025-08-10.at.8.44.00.PM.mov

…r side

vercel · 2025-08-11T04:08:17Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sim	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 11, 2025 4:08am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
docs	⬜️ Skipped (Inspect)			Aug 11, 2025 4:08am

greptile-apps

Greptile Summary

This PR implements a comprehensive multiplayer variables system for the workflow application, enabling real-time collaborative editing of workflow variables across multiple users. The changes transform the variables system from a local-only state management approach to a fully collaborative, server-side persisted architecture.

The key architectural changes include:

Socket-based Real-time Synchronization: Added WebSocket handlers (setupVariablesHandlers) to manage variable operations (add, update, delete, duplicate) with immediate broadcasting to all connected users in the same workflow room.
Server-side Persistence: Implemented database operations in handleVariableOperationTx that directly manipulate the workflow.variables JSON field, ensuring all variable changes are persisted before being broadcast to other clients.
Collaborative Operation Queue: Extended the existing operation queue system with variable-specific debouncing (25ms timeout), cleanup mechanisms, and cancellation capabilities to handle rapid updates efficiently.
Unified Variable Management: Modified the variables store to support predetermined IDs (providedId parameters) for consistent state across clients while removing local persistence middleware in favor of socket-based synchronization.
Component Integration: Updated the Variables React component to use collaborative functions (collaborativeAddVariable, collaborativeUpdateVariable, etc.) instead of direct store mutations, ensuring all user interactions trigger socket events.

The implementation follows the established patterns used for collaborative blocks and subblocks, maintaining consistency with the existing multiplayer architecture. Variables are now loaded during workflow fetching and synchronized through the same socket infrastructure used for other workflow elements, providing a seamless collaborative experience where multiple users can create, edit, and manage variables simultaneously with instant visual feedback.

Confidence score: 3/5

This PR implements complex multiplayer functionality with potential race conditions and data consistency issues
Score reflects concerns about type safety in validation schemas, JSON field manipulation, and transaction handling
Pay close attention to socket-server/handlers/variables.ts and socket-server/database/operations.ts for data integrity validation

_{12 files reviewed, 11 comments}

_{Edit Code Review Bot Settings | Greptile}

greptile-apps · 2025-08-11T04:08:43Z

apps/sim/socket-server/handlers/operations.ts

        return // Early return for position updates
      }

+      if (target === 'variable' && ['add', 'remove', 'duplicate'].includes(operation)) {


style: Consider using a more maintainable approach like a Set or constant array for operation types to make future additions easier

greptile-apps · 2025-08-11T04:08:43Z

apps/sim/socket-server/validation/schemas.ts

+      type: z.any(),
+      value: z.any(),


style: Using z.any() for type and value reduces type safety. Consider defining specific schemas for variable types.

Context Used: Context - Avoid using type assertions to 'any' in TypeScript. Instead, ensure proper type definitions are used to maintain type safety. (link)

greptile-apps · 2025-08-11T04:08:44Z

apps/sim/stores/workflows/registry/store.ts

+      if (variables && typeof variables === 'object') {
+        useVariablesStore.setState((state) => ({
+          variables: {
+            ...state.variables,
+            ...variables,
+          },
+        }))
+      }


logic: Potential variable conflict - this spreads all variables from DB into the store without checking workflowId. Variables from different workflows could overwrite each other if they have the same ID.

greptile-apps · 2025-08-11T04:08:44Z

apps/sim/socket-server/validation/schemas.ts

+  z.object({
+    operation: z.literal('duplicate'),
+    target: z.literal('variable'),
+    payload: z.object({
+      sourceVariableId: z.string(),
+      id: z.string(),
+    }),
+    timestamp: z.number(),
+    operationId: z.string().optional(),
+  }),


logic: Duplicate operation lacks name, type, value, and workflowId fields that may be needed for complete variable duplication.

greptile-apps · 2025-08-11T04:08:44Z

apps/sim/socket-server/handlers/operations.ts

+          userName: session.userName,
+          metadata: {
+            workflowId,
+            operationId: crypto.randomUUID(),


logic: The operationId from the original client request should be used instead of generating a new UUID for proper operation tracking

greptile-apps · 2025-08-11T04:08:47Z

apps/sim/socket-server/database/operations.ts

+    throw new Error(`Workflow ${workflowId} not found`)
+  }
+
+  const currentVariables = (workflowData[0].variables as Record<string, any>) || {}


style: Consider using a more specific type instead of Record<string, any> to improve type safety

Context Used: Context - Avoid using type assertions to 'any' in TypeScript. Instead, ensure proper type definitions are used to maintain type safety. (link)

greptile-apps · 2025-08-11T04:08:47Z

apps/sim/stores/operation-queue/store.ts

+    const operationsToCancel = state.operations.filter(
+      (op) =>
+        (op.operation.target === 'variable' && op.operation.payload?.variableId === variableId) ||
+        (op.operation.target === 'variable' &&
+          op.operation.payload?.sourceVariableId === variableId)
+    )


logic: The filter logic uses both variableId and sourceVariableId but only variableId is used in the debounce key generation above. Ensure consistency in how variable operations are identified.

greptile-apps · 2025-08-11T04:08:48Z

apps/sim/hooks/use-collaborative-workflow.ts

+  const collaborativeAddVariable = useCallback(
+    (variableData: { name: string; type: any; value: any; workflowId: string }) => {
+      const id = crypto.randomUUID()
+      variablesStore.addVariable(variableData, id)


logic: Local variable addition before queuing operation could create inconsistencies if the queue operation fails

greptile-apps · 2025-08-11T04:09:24Z

apps/sim/socket-server/handlers/variables.ts

+          return
+        }
+
+        const variables = (workflowRecord.variables as any) || {}


style: Using any type assertion loses type safety. Consider defining proper types for the variables structure.

Context Used: Context - Avoid using type assertions to 'any' in TypeScript. Instead, ensure proper type definitions are used to maintain type safety. (link)

greptile-apps · 2025-08-11T04:09:24Z

apps/sim/socket-server/handlers/variables.ts

+  const roomManager =
+    deps instanceof Object && 'roomManager' in deps ? deps.roomManager : (deps as RoomManager)


style: Type guard logic is overly complex. Consider extracting this pattern into a utility function since it's repeated across handlers.

icecrasher321 · 2025-08-11T23:29:33Z

apps/sim/stores/operation-queue/store.ts

    get().processNextOperation()
  },

+  cancelOperationsForVariable: (variableId: string) => {


what does this do? Is this for debouncing?

…r side (simstudioai#933) * feat(variables): multiplayer variables through sockets, persist server side * remove extraneous comments * breakout variables handler in sockets

waleedlatif1 added 3 commits August 10, 2025 20:36

feat(variables): multiplayer variables through sockets, persist serve…

33df6e3

…r side

remove extraneous comments

d561d96

breakout variables handler in sockets

93e598b

waleedlatif1 requested a review from icecrasher321 August 11, 2025 04:08

greptile-apps bot reviewed Aug 11, 2025

View reviewed changes

icecrasher321 reviewed Aug 11, 2025

View reviewed changes

icecrasher321 merged commit bc455d5 into staging Aug 11, 2025
5 checks passed

waleedlatif1 mentioned this pull request Aug 12, 2025

v0.3.23: multiplayer variables, api key fixes, kb improvements, triggers fixes #943

Merged

waleedlatif1 deleted the fix/variables branch August 15, 2025 17:03

		const roomManager =
		deps instanceof Object && 'roomManager' in deps ? deps.roomManager : (deps as RoomManager)

Conversation

waleedlatif1 commented Aug 11, 2025

Summary

Type of Change

Testing

Checklist

Screenshots/Videos

Uh oh!

vercel bot commented Aug 11, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Summary

Confidence score: 3/5

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

icecrasher321 Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

icecrasher321 Aug 11, 2025 •

edited

Loading