Skip to content

Self-improving AI Employees for everyone

refactor(client): Phase 1 - move workflow list to TanStack Query

trohitgc3a7aa4706da
diff --git a/client/src/Dashboard.tsx b/client/src/Dashboard.tsx
index 7235e1fb..ed8500ba 100644
--- a/client/src/Dashboard.tsx
+++ b/client/src/Dashboard.tsx
@@ -55,6 +55,9 @@ import ErrorBoundary from './components/ui/ErrorBoundary';
import ConsolePanel from './components/ui/ConsolePanel';
import { useAppTheme } from './hooks/useAppTheme';
import { useWorkflowManagement } from './hooks/useWorkflowManagement';
+import { useWorkflowsQuery, WORKFLOWS_QUERY_KEY } from './hooks/useWorkflowsQuery';
+import { useQueryClient } from '@tanstack/react-query';
+import { workflowApi } from './services/workflowApi';
import { useDragAndDrop } from './hooks/useDragAndDrop';
import { useComponentPalette } from './hooks/useComponentPalette';
import { useReactFlowNodes } from './hooks/useReactFlowNodes';
@@ -290,11 +293,10 @@ const DashboardContent: React.FC = () => {
const {
currentWorkflow,
hasUnsavedChanges,
- savedWorkflows,
sidebarVisible,
componentPaletteVisible,
updateWorkflow,
- loadSavedWorkflows,
+ loadWorkflow,
createNewWorkflow,
saveWorkflow,
deleteWorkflow,
@@ -351,6 +353,10 @@ const DashboardContent: React.FC = () => {
const { saveNodeParameters, getAllNodeParameters, executeWorkflow, deployWorkflow, cancelDeployment, nodeStatuses, deploymentStatus, workflowLock, isConnected, sendRequest } = useWebSocket();
const applyUIDefaults = useAppStore((state) => state.applyUIDefaults);
+ // Workflows list: server-owned data, cached by TanStack Query.
+ const queryClient = useQueryClient();
+ const { data: savedWorkflows = [] } = useWorkflowsQuery();
+
// Scope deployment and lock to current workflow (n8n pattern)
// Only show as "running" or "locked" if it applies to the currently viewed workflow
const isCurrentWorkflowDeployed = deploymentStatus.isRunning &&
@@ -916,10 +922,28 @@ const DashboardContent: React.FC = () => {
currentWorkflowId: currentWorkflow?.id,
});
+ const fetchWorkflowsList = () => queryClient.fetchQuery({
+ queryKey: WORKFLOWS_QUERY_KEY,
+ queryFn: async () => {
+ const summaries = await workflowApi.getAllWorkflows();
+ return summaries.map(w => ({
+ id: w.id,
+ name: w.name,
+ nodeCount: w.nodeCount,
+ createdAt: new Date(w.createdAt),
+ lastModified: new Date(w.lastModified),
+ }));
+ },
+ });
+
const initWorkflows = async () => {
- await loadSavedWorkflows();
- // loadSavedWorkflows auto-loads the most recent workflow if none is set
- // Only create new if still no workflow after loading
+ const list = await fetchWorkflowsList();
+ if (list.length > 0) {
+ const mostRecent = [...list].sort(
+ (a, b) => b.lastModified.getTime() - a.lastModified.getTime()
+ )[0];
+ await loadWorkflow(mostRecent.id);
+ }
const state = useAppStore.getState();
if (!state.currentWorkflow) {
console.log('[Dashboard] No saved workflows found, creating new one');
@@ -933,9 +957,9 @@ const DashboardContent: React.FC = () => {
console.log('[Dashboard] Migrating current workflow');
migrateCurrentWorkflow();
hasMigrated.current = true;
- loadSavedWorkflows(); // Still load sidebar list
+ void fetchWorkflowsList(); // seed sidebar list cache
}
- }, [loadSavedWorkflows, currentWorkflow, createNewWorkflow, migrateCurrentWorkflow]);
+ }, [queryClient, currentWorkflow, loadWorkflow, createNewWorkflow, migrateCurrentWorkflow]);
// Sync workflow state → ReactFlow state (when loading workflows or data changes)
// Note: Database is the source of truth for parameters - node.data should NOT store parameters
diff --git a/client/src/hooks/useWorkflowManagement.ts b/client/src/hooks/useWorkflowManagement.ts
index bccfbd51..4019ee71 100644
--- a/client/src/hooks/useWorkflowManagement.ts
+++ b/client/src/hooks/useWorkflowManagement.ts
@@ -1,17 +1,19 @@
import { useCallback } from 'react';
import { useAppStore } from '../store/useAppStore';
+import { useWorkflowsQuery, type SavedWorkflow } from './useWorkflowsQuery';
export const useWorkflowManagement = () => {
const {
currentWorkflow,
hasUnsavedChanges,
- savedWorkflows,
updateWorkflow,
saveWorkflow,
loadWorkflow,
createNewWorkflow,
} = useAppStore();
+ const { data: savedWorkflows = [] } = useWorkflowsQuery();
+
const handleWorkflowNameChange = useCallback((name: string) => {
updateWorkflow({ name });
}, [updateWorkflow]);
@@ -28,7 +30,7 @@ export const useWorkflowManagement = () => {
// Workflow selection is handled by sidebar
}, []);
- const handleSelectWorkflow = useCallback((workflow: any) => {
+ const handleSelectWorkflow = useCallback((workflow: SavedWorkflow) => {
loadWorkflow(workflow.id);
}, [loadWorkflow]);
@@ -43,4 +45,4 @@ export const useWorkflowManagement = () => {
handleOpen,
handleSelectWorkflow,
};
-};
\ No newline at end of file
+};
diff --git a/client/src/hooks/useWorkflowsQuery.ts b/client/src/hooks/useWorkflowsQuery.ts
new file mode 100644
index 00000000..182f1fb1
--- /dev/null
+++ b/client/src/hooks/useWorkflowsQuery.ts
@@ -0,0 +1,96 @@
+/**
+ * Workflow list + single-workflow queries, and save/delete mutations.
+ *
+ * Server-owned data (the workflow list and individual workflow records)
+ * lives in the TanStack Query cache, not in Zustand. The Zustand store
+ * keeps only the mutable edit buffer (currentWorkflow). When a save or
+ * delete completes, these mutations invalidate `['workflows']` so any
+ * component consuming `useWorkflowsQuery()` re-renders with fresh data.
+ *
+ * Mirrors the ownership boundary established by `useCatalogueQuery.ts`.
+ */
+
+import {
+ useQuery,
+ useMutation,
+ useQueryClient,
+ type UseQueryResult,
+} from '@tanstack/react-query';
+import {
+ workflowApi,
+ type WorkflowSummary,
+ type WorkflowData as ApiWorkflowData,
+} from '../services/workflowApi';
+
+export const WORKFLOWS_QUERY_KEY = ['workflows'] as const;
+export const workflowQueryKey = (id: string) => ['workflow', id] as const;
+
+export interface SavedWorkflow {
+ id: string;
+ name: string;
+ nodeCount: number;
+ createdAt: Date;
+ lastModified: Date;
+}
+
+function toSavedWorkflow(w: WorkflowSummary): SavedWorkflow {
+ return {
+ id: w.id,
+ name: w.name,
+ nodeCount: w.nodeCount,
+ createdAt: new Date(w.createdAt),
+ lastModified: new Date(w.lastModified),
+ };
+}
+
+export function useWorkflowsQuery(): UseQueryResult<SavedWorkflow[], Error> {
+ return useQuery<SavedWorkflow[], Error>({
+ queryKey: WORKFLOWS_QUERY_KEY,
+ queryFn: async () => {
+ const list = await workflowApi.getAllWorkflows();
+ return list.map(toSavedWorkflow);
+ },
+ staleTime: 30_000,
+ });
+}
+
+export interface SaveWorkflowInput {
+ id: string;
+ name: string;
+ data: { nodes: any[]; edges: any[] };
+}
+
+export function useSaveWorkflowMutation() {
+ const qc = useQueryClient();
+ return useMutation<void, Error, SaveWorkflowInput>({
+ mutationFn: async ({ id, name, data }) => {
+ const ok = await workflowApi.saveWorkflow(id, name, data);
+ if (!ok) throw new Error('Failed to save workflow');
+ },
+ onSuccess: () => {
+ void qc.invalidateQueries({ queryKey: WORKFLOWS_QUERY_KEY });
+ },
+ });
+}
+
+export function useDeleteWorkflowMutation() {
+ const qc = useQueryClient();
+ return useMutation<void, Error, string>({
+ mutationFn: async (id) => {
+ const ok = await workflowApi.deleteWorkflow(id);
+ if (!ok) throw new Error('Failed to delete workflow');
+ },
+ onSuccess: () => {
+ void qc.invalidateQueries({ queryKey: WORKFLOWS_QUERY_KEY });
+ },
+ });
+}
+
+export function useWorkflowQuery(id: string | null | undefined) {
+ return useQuery<ApiWorkflowData | null, Error>({
+ queryKey: id ? workflowQueryKey(id) : ['workflow', 'none'],
+ queryFn: () => (id ? workflowApi.getWorkflow(id) : Promise.resolve(null)),
+ enabled: !!id,
+ staleTime: 30_000,
+ });
+}
diff --git a/client/src/lib/queryClient.ts b/client/src/lib/queryClient.ts
new file mode 100644
index 00000000..37817a5f
--- /dev/null
+++ b/client/src/lib/queryClient.ts
@@ -0,0 +1,22 @@
+import { QueryClient } from '@tanstack/react-query';
+
+/**
+ * Single app-wide QueryClient. Cache lives across route changes and modal
+ * open/close cycles, which is what makes warm-start persistence (e.g. the
+ * credentials catalogue) actually work. Exported as a module singleton so
+ * imperative code (Zustand actions, workflowApi mutations) can invalidate
+ * queries without needing React context.
+ *
+ * See docs-internal/credentials_scaling/architecture.md for cache shape.
+ */
+export const queryClient = new QueryClient({
+ defaultOptions: {
+ queries: {
+ // Most server data is push-driven via WebSocket, so queries should
+ // stay stable unless we explicitly invalidate them.
+ refetchOnWindowFocus: false,
+ refetchOnReconnect: false,
+ retry: 1,
+ },
+ },
+});
diff --git a/client/src/main.tsx b/client/src/main.tsx
index 247b1b6d..78d5e22a 100644
--- a/client/src/main.tsx
+++ b/client/src/main.tsx
@@ -1,28 +1,12 @@
import { StrictMode } from 'react'
import { createRoot } from 'react-dom/client'
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
+import { QueryClientProvider } from '@tanstack/react-query'
import './index.css'
import App from './App'
import { ThemeProvider } from './contexts/ThemeContext'
import { AuthProvider } from './contexts/AuthContext'
import { WebSocketProvider } from './contexts/WebSocketContext'
-
-// Single app-wide QueryClient. Cache lives across route changes and modal
-// open/close cycles, which is what makes the credentials catalogue warm
-// start (<50 ms on second visit) actually work. See
-// docs-internal/credentials_scaling/architecture.md for the full shape.
-const queryClient = new QueryClient({
- defaultOptions: {
- queries: {
- // Default is aggressive refetching; for this app most server data
- // is push-driven via WebSocket, so queries should stay stable
- // unless we explicitly invalidate them.
- refetchOnWindowFocus: false,
- refetchOnReconnect: false,
- retry: 1,
- },
- },
-})
+import { queryClient } from './lib/queryClient'
createRoot(document.getElementById('root')!).render(
<StrictMode>
diff --git a/client/src/store/useAppStore.ts b/client/src/store/useAppStore.ts
index f35c716a..9e7c10cd 100644
--- a/client/src/store/useAppStore.ts
+++ b/client/src/store/useAppStore.ts
@@ -1,6 +1,5 @@
import { create } from 'zustand';
import { Node, Edge } from 'reactflow';
-import { SavedWorkflow } from '../components/ui/WorkflowSidebar';
import { generateWorkflowId } from '../utils/workflow';
import { theme } from '../styles/theme';
import {
@@ -11,6 +10,12 @@ import {
} from '../utils/workflowExport';
import type { ImportedWorkflow } from '../utils/workflowExport';
import { workflowApi } from '../services/workflowApi';
+import { queryClient } from '../lib/queryClient';
+import { WORKFLOWS_QUERY_KEY } from '../hooks/useWorkflowsQuery';
+
+const invalidateWorkflowsList = (): void => {
+ void queryClient.invalidateQueries({ queryKey: WORKFLOWS_QUERY_KEY });
+};
export interface WorkflowData {
nodes: Node[];
@@ -46,16 +51,12 @@ interface AppStore {
proMode: boolean; // false = noob mode (only AI categories), true = pro mode (all categories)
renamingNodeId: string | null;
- // Saved workflows
- savedWorkflows: SavedWorkflow[];
-
// Workflow actions
setCurrentWorkflow: (workflow: WorkflowData) => void;
updateWorkflow: (updates: Partial<Omit<WorkflowData, 'id' | 'createdAt'>>) => void;
createNewWorkflow: () => void;
saveWorkflow: () => Promise<void>;
loadWorkflow: (id: string) => Promise<void>;
- loadSavedWorkflows: () => Promise<void>;
deleteWorkflow: (id: string) => Promise<boolean>;
migrateCurrentWorkflow: () => Promise<void>;
@@ -163,8 +164,7 @@ export const useAppStore = create<AppStore>((set, get) => ({
consolePanelVisible: loadBooleanFromStorage(STORAGE_KEYS.consolePanelVisible, false),
proMode: loadBooleanFromStorage(STORAGE_KEYS.proMode, false), // Default to noob mode
renamingNodeId: null,
- savedWorkflows: [],
-
+
// Workflow management
setCurrentWorkflow: (workflow) => {
set({ currentWorkflow: workflow, hasUnsavedChanges: false });
@@ -196,7 +196,7 @@ export const useAppStore = create<AppStore>((set, get) => ({
},
saveWorkflow: async () => {
- const { currentWorkflow, savedWorkflows } = get();
+ const { currentWorkflow } = get();
if (!currentWorkflow) return;
const updatedWorkflow = {
@@ -217,30 +217,11 @@ export const useAppStore = create<AppStore>((set, get) => ({
return;
}
- // Update local saved workflows list
- const existingIndex = savedWorkflows.findIndex(w => w.id === updatedWorkflow.id);
-
- const workflowSummary: SavedWorkflow = {
- id: updatedWorkflow.id,
- name: updatedWorkflow.name,
- createdAt: updatedWorkflow.createdAt,
- lastModified: updatedWorkflow.lastModified,
- nodeCount: updatedWorkflow.nodes.length,
- };
-
- let newSavedWorkflows: SavedWorkflow[];
- if (existingIndex >= 0) {
- newSavedWorkflows = [...savedWorkflows];
- newSavedWorkflows[existingIndex] = workflowSummary;
- } else {
- newSavedWorkflows = [workflowSummary, ...savedWorkflows];
- }
-
set({
currentWorkflow: updatedWorkflow,
- savedWorkflows: newSavedWorkflows,
hasUnsavedChanges: false,
});
+ invalidateWorkflowsList();
},
loadWorkflow: async (id) => {
@@ -267,31 +248,8 @@ export const useAppStore = create<AppStore>((set, get) => ({
}
},
- loadSavedWorkflows: async () => {
- const workflows = await workflowApi.getAllWorkflows();
- const savedWorkflows: SavedWorkflow[] = workflows.map(w => ({
- id: w.id,
- name: w.name,
- nodeCount: w.nodeCount,
- createdAt: new Date(w.createdAt),
- lastModified: new Date(w.lastModified),
- }));
- set({ savedWorkflows });
-
- // Auto-load the most recent workflow if no current workflow is set
- const { currentWorkflow } = get();
- if (!currentWorkflow && savedWorkflows.length > 0) {
- // Sort by lastModified descending and load the first one
- const sortedWorkflows = [...savedWorkflows].sort(
- (a, b) => b.lastModified.getTime() - a.lastModified.getTime()
- );
- const mostRecent = sortedWorkflows[0];
- await get().loadWorkflow(mostRecent.id);
- }
- },
-
deleteWorkflow: async (id) => {
- const { currentWorkflow, savedWorkflows } = get();
+ const { currentWorkflow } = get();
const success = await workflowApi.deleteWorkflow(id);
if (!success) {
@@ -299,22 +257,17 @@ export const useAppStore = create<AppStore>((set, get) => ({
return false;
}
- // Remove from saved workflows list
- const newSavedWorkflows = savedWorkflows.filter(w => w.id !== id);
-
// If deleting current workflow, create a new one
if (currentWorkflow?.id === id) {
const newWorkflow = createDefaultWorkflow();
set({
currentWorkflow: newWorkflow,
- savedWorkflows: newSavedWorkflows,
hasUnsavedChanges: false,
selectedNode: null,
});
- } else {
- set({ savedWorkflows: newSavedWorkflows });
}
+ invalidateWorkflowsList();
return true;
},
@@ -345,6 +298,7 @@ export const useAppStore = create<AppStore>((set, get) => ({
currentWorkflow: migratedWorkflow,
hasUnsavedChanges: false
});
+ invalidateWorkflowsList();
}
},