chore: import upstream snapshot with attribution

apps/sim/hooks/queries/utils/optimistic-mutation.ts

@@ -0,0 +1,77 @@
+import { createLogger } from '@sim/logger'
+import type { QueryClient } from '@tanstack/react-query'
+
+const logger = createLogger('OptimisticMutation')
+
+export interface OptimisticMutationConfig<TData, TVariables, TItem, TContext> {
+  name: string
+  getQueryKey: (variables: TVariables) => readonly unknown[]
+  getSnapshot: (variables: TVariables) => Record<string, TItem>
+  generateTempId: (variables: TVariables) => string
+  createOptimisticItem: (variables: TVariables, tempId: string) => TItem
+  applyOptimisticUpdate: (tempId: string, item: TItem) => void
+  replaceOptimisticEntry: (tempId: string, data: TData) => void
+  rollback: (snapshot: Record<string, TItem>, variables: TVariables) => void
+  onSuccessExtra?: (data: TData, variables: TVariables) => void
+}
+
+export interface OptimisticMutationContext<TItem> {
+  tempId: string
+  previousState: Record<string, TItem>
+}
+
+export function createOptimisticMutationHandlers<TData, TVariables, TItem>(
+  queryClient: QueryClient,
+  config: OptimisticMutationConfig<TData, TVariables, TItem, OptimisticMutationContext<TItem>>
+) {
+  const {
+    name,
+    getQueryKey,
+    getSnapshot,
+    generateTempId,
+    createOptimisticItem,
+    applyOptimisticUpdate,
+    replaceOptimisticEntry,
+    rollback,
+    onSuccessExtra,
+  } = config
+
+  return {
+    onMutate: async (variables: TVariables): Promise<OptimisticMutationContext<TItem>> => {
+      const queryKey = getQueryKey(variables)
+      await queryClient.cancelQueries({ queryKey })
+      const previousState = getSnapshot(variables)
+      const tempId = generateTempId(variables)
+      const optimisticItem = createOptimisticItem(variables, tempId)
+      applyOptimisticUpdate(tempId, optimisticItem)
+      logger.info(`[${name}] Added optimistic entry: ${tempId}`)
+      return { tempId, previousState }
+    },
+
+    onSuccess: (data: TData, variables: TVariables, context: OptimisticMutationContext<TItem>) => {
+      logger.info(`[${name}] Success, replacing temp entry ${context.tempId}`)
+      replaceOptimisticEntry(context.tempId, data)
+      onSuccessExtra?.(data, variables)
+    },
+
+    onError: (
+      error: Error,
+      _variables: TVariables,
+      context: OptimisticMutationContext<TItem> | undefined
+    ) => {
+      logger.error(`[${name}] Failed:`, error)
+      if (context?.previousState) {
+        rollback(context.previousState, _variables)
+        logger.info(`[${name}] Rolled back to previous state`)
+      }
+    },
+
+    onSettled: (_data: TData | undefined, _error: Error | null, variables: TVariables) => {
+      return queryClient.invalidateQueries({ queryKey: getQueryKey(variables) })
+    },
+  }
+}
+
+export function generateTempId(prefix: string): string {
+  return `${prefix}-${Date.now()}`
+}