-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathhandlers-workflow-diff.ts
More file actions
776 lines (724 loc) · 31.3 KB
/
Copy pathhandlers-workflow-diff.ts
File metadata and controls
776 lines (724 loc) · 31.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
/**
* MCP Handler for Partial Workflow Updates
* Handles diff-based workflow modifications
*/
import { z } from 'zod';
import { randomUUID } from 'crypto';
import { McpToolResponse } from '../types/n8n-api';
import { WorkflowDiffRequest, WorkflowDiffOperation, WorkflowDiffValidationError } from '../types/workflow-diff';
import { WorkflowDiffEngine } from '../services/workflow-diff-engine';
import { getN8nApiClient } from './handlers-n8n-manager';
import { N8nApiError, getUserFriendlyErrorMessage } from '../utils/n8n-errors';
import { logger } from '../utils/logger';
import { InstanceContext, getInstanceScopeId } from '../types/instance-context';
import { validateWorkflowStructure } from '../services/n8n-validation';
import { NodeRepository } from '../database/node-repository';
import { WorkflowVersioningService } from '../services/workflow-versioning-service';
import { WorkflowValidator } from '../services/workflow-validator';
import { EnhancedConfigValidator } from '../services/enhanced-config-validator';
import {
normalizeMcpJsonValue,
normalizeMcpWorkflowNode,
normalizeMcpWorkflowPosition,
} from '../utils/mcp-input-normalizer';
// Cached validator instance to avoid recreating on every mutation
let cachedValidator: WorkflowValidator | null = null;
// Detect whether a fetched workflow has moved past the snapshot we hold.
// Tries versionId first (most reliable), then versionCounter (n8n 1.118.1+),
// then updatedAt. Returns 'unknown' when no comparable field is present on
// both sides; caller falls back to attempting rollback so the safety net
// is preserved on older n8n versions.
type VersionCompare = 'same' | 'changed' | 'unknown';
function compareVersions(
a: { versionId?: string; versionCounter?: number; updatedAt?: string },
b: { versionId?: string; versionCounter?: number; updatedAt?: string },
): VersionCompare {
if (a.versionId !== undefined && b.versionId !== undefined) {
return a.versionId === b.versionId ? 'same' : 'changed';
}
if (a.versionCounter !== undefined && b.versionCounter !== undefined) {
return a.versionCounter === b.versionCounter ? 'same' : 'changed';
}
if (a.updatedAt !== undefined && b.updatedAt !== undefined) {
return a.updatedAt === b.updatedAt ? 'same' : 'changed';
}
return 'unknown';
}
/**
* Get or create cached workflow validator instance
* Reuses the same validator to avoid redundant NodeSimilarityService initialization
*/
function getValidator(repository: NodeRepository): WorkflowValidator {
if (!cachedValidator) {
cachedValidator = new WorkflowValidator(repository, EnhancedConfigValidator);
}
return cachedValidator;
}
// Operation types that identify nodes by nodeId/nodeName
const NODE_TARGETING_OPERATIONS = new Set([
'updateNode', 'removeNode', 'moveNode', 'enableNode', 'disableNode', 'patchNodeField'
]);
// Zod schema for the diff request
const workflowDiffSchema = z.object({
id: z.string(),
operations: z.preprocess(normalizeMcpJsonValue, z.array(z.object({
type: z.string(),
description: z.string().optional(),
// Node operations
node: z.preprocess(normalizeMcpWorkflowNode, z.any()).optional(),
nodeId: z.string().optional(),
nodeName: z.string().optional(),
updates: z.preprocess(normalizeMcpJsonValue, z.any()).optional(),
fieldPath: z.string().optional(),
patches: z.preprocess(normalizeMcpJsonValue, z.any()).optional(),
position: z.preprocess(normalizeMcpWorkflowPosition, z.tuple([z.number(), z.number()])).optional(),
// Connection operations
source: z.string().optional(),
target: z.string().optional(),
from: z.string().optional(), // For rewireConnection
to: z.string().optional(), // For rewireConnection
sourceOutput: z.union([z.string(), z.number()]).transform(String).optional(),
targetInput: z.union([z.string(), z.number()]).transform(String).optional(),
sourceIndex: z.number().optional(),
targetIndex: z.number().optional(),
// Smart parameters (Phase 1 UX improvement)
branch: z.enum(['true', 'false']).optional(),
case: z.number().optional(),
ignoreErrors: z.boolean().optional(),
// Connection cleanup operations
dryRun: z.boolean().optional(),
connections: z.preprocess(normalizeMcpJsonValue, z.any()).optional(),
// Metadata operations
settings: z.preprocess(normalizeMcpJsonValue, z.any()).optional(),
name: z.string().optional(),
tag: z.string().optional(),
// Transfer operation
destinationProjectId: z.string().min(1).optional(),
// Aliases: LLMs often use "id" instead of "nodeId" — accept both
id: z.string().optional(),
}).transform((op) => {
// Normalize common field aliases for node-targeting operations:
// - "name" → "nodeName" (LLMs confuse the updateName "name" field with node identification)
// - "id" → "nodeId" (natural alias)
if (NODE_TARGETING_OPERATIONS.has(op.type)) {
if (!op.nodeName && !op.nodeId && op.name) {
op.nodeName = op.name;
op.name = undefined;
}
if (!op.nodeId && op.id) {
op.nodeId = op.id;
op.id = undefined;
}
}
return op;
}))),
validateOnly: z.boolean().optional(),
continueOnError: z.boolean().optional(),
createBackup: z.boolean().optional(),
intent: z.string().optional(),
});
export async function handleUpdatePartialWorkflow(
args: unknown,
repository: NodeRepository,
context?: InstanceContext
): Promise<McpToolResponse> {
const startTime = Date.now();
// Correlation ID for telemetry. Use a CSPRNG (crypto.randomUUID) rather
// than Math.random so two concurrent mutations can't collide on a
// predictable suffix — addresses CodeQL js/insecure-randomness.
const sessionId = `mutation_${Date.now()}_${randomUUID()}`;
let workflowBefore: any = null;
let validationBefore: any = null;
let validationAfter: any = null;
try {
// Debug logging (only in debug mode)
if (process.env.DEBUG_MCP === 'true') {
logger.debug('Workflow diff request received', {
argsType: typeof args,
hasWorkflowId: args && typeof args === 'object' && 'workflowId' in args,
operationCount: args && typeof args === 'object' && 'operations' in args ?
(args as any).operations?.length : 0
});
}
// Validate input
const input = workflowDiffSchema.parse(args);
// Get API client
const client = getN8nApiClient(context);
if (!client) {
return {
success: false,
error: 'n8n API not configured. Please set N8N_API_URL and N8N_API_KEY environment variables.'
};
}
// Fetch current workflow
let workflow;
try {
workflow = await client.getWorkflow(input.id);
// Store original workflow for telemetry
workflowBefore = JSON.parse(JSON.stringify(workflow));
// Validate workflow BEFORE mutation (for telemetry)
try {
const validator = getValidator(repository);
validationBefore = await validator.validateWorkflow(workflowBefore, {
validateNodes: true,
validateConnections: true,
validateExpressions: true,
profile: 'runtime'
});
} catch (validationError) {
logger.debug('Pre-mutation validation failed (non-blocking):', validationError);
// Don't block mutation on validation errors
validationBefore = {
valid: false,
errors: [{ type: 'validation_error', message: 'Validation failed' }]
};
}
} catch (error) {
if (error instanceof N8nApiError) {
return {
success: false,
error: getUserFriendlyErrorMessage(error),
code: error.code
};
}
throw error;
}
// Create backup before modifying workflow (default: true)
if (input.createBackup !== false && !input.validateOnly) {
try {
const versioningService = new WorkflowVersioningService(repository, client, getInstanceScopeId(context));
const backupResult = await versioningService.createBackup(input.id, workflow, {
trigger: 'partial_update',
operations: input.operations
});
logger.info('Workflow backup created', {
workflowId: input.id,
versionId: backupResult.versionId,
versionNumber: backupResult.versionNumber,
pruned: backupResult.pruned
});
} catch (error: any) {
logger.warn('Failed to create workflow backup', {
workflowId: input.id,
error: error.message
});
// Continue with update even if backup fails (non-blocking)
}
}
// Apply diff operations
const diffEngine = new WorkflowDiffEngine();
const diffRequest = input as WorkflowDiffRequest;
const diffResult = await diffEngine.applyDiff(workflow, diffRequest);
// Check if this is a complete failure or partial success in continueOnError mode
if (!diffResult.success) {
// In continueOnError mode, partial success is still valuable
if (diffRequest.continueOnError && diffResult.workflow && diffResult.operationsApplied && diffResult.operationsApplied > 0) {
logger.info(`continueOnError mode: Applying ${diffResult.operationsApplied} successful operations despite ${diffResult.failed?.length || 0} failures`);
// Continue to update workflow with partial changes
} else {
// Complete failure - return error
return {
success: false,
saved: false,
error: 'Failed to apply diff operations',
operationsApplied: diffResult.operationsApplied,
details: {
errors: diffResult.errors,
warnings: diffResult.warnings,
applied: diffResult.applied,
failed: diffResult.failed
}
};
}
}
// Validate final workflow structure after applying all operations BEFORE the
// validateOnly early-return. Pre-fix the early-return ran first and `validateOnly: true`
// always reported `valid: true`, but `validateOnly: false` then ran structural validation
// and could fail — the two paths disagreed on validity. Now both paths see the same
// structural result. (#744)
//
// Validation can be skipped for specific integration tests that need to test
// n8n API behavior with edge case workflows by setting SKIP_WORKFLOW_VALIDATION=true.
// When skipping, both paths treat the workflow as valid so they continue to agree.
const skipValidation = process.env.SKIP_WORKFLOW_VALIDATION === 'true';
const structureErrors = !skipValidation && diffResult.workflow
? validateWorkflowStructure(diffResult.workflow)
: [];
// If validateOnly, return the same structural-validity verdict the apply path would.
// operationsToApply reflects what would actually be applied, including continueOnError
// partial success (some operations may have failed during simulation).
if (input.validateOnly) {
const operationsToApply = diffResult.operationsApplied ?? input.operations.length;
return {
success: true,
message: diffResult.message,
data: {
valid: structureErrors.length === 0,
operationsToApply,
...(structureErrors.length > 0 ? { structureErrors } : {})
},
details: {
warnings: diffResult.warnings
}
};
}
// Apply path: surface structural errors as a blocking save failure.
// This prevents creating workflows that pass operation-level validation
// but fail workflow-level validation (e.g., UI can't render them).
// structureErrors is empty when SKIP_WORKFLOW_VALIDATION=true (computed above).
if (diffResult.workflow) {
if (structureErrors.length > 0) {
logger.warn('Workflow structure validation failed after applying diff operations', {
workflowId: input.id,
errors: structureErrors
});
// Analyze error types to provide targeted recovery guidance
const errorTypes = new Set<string>();
structureErrors.forEach(err => {
if (err.includes('operator') || err.includes('singleValue')) errorTypes.add('operator_issues');
if (err.includes('connection') || err.includes('referenced')) errorTypes.add('connection_issues');
if (err.includes('Missing') || err.includes('missing')) errorTypes.add('missing_metadata');
if (err.includes('branch') || err.includes('output')) errorTypes.add('branch_mismatch');
});
// Build recovery guidance based on error types
const recoverySteps = [];
if (errorTypes.has('operator_issues')) {
recoverySteps.push('Operator structure issue detected. Use validate_node to check specific nodes.');
recoverySteps.push('Binary operators (equals, contains, greaterThan, etc.) must NOT have singleValue:true');
recoverySteps.push('Unary operators (empty, notEmpty, true, false) REQUIRE singleValue:true');
}
if (errorTypes.has('connection_issues')) {
recoverySteps.push('Connection validation failed. Check all node connections reference existing nodes.');
recoverySteps.push('Use cleanStaleConnections operation to remove connections to non-existent nodes.');
}
if (errorTypes.has('missing_metadata')) {
recoverySteps.push('Missing metadata detected. Ensure filter-based nodes (IF v2.2+, Switch v3.2+) have complete conditions.options.');
recoverySteps.push('Required options: {version: 2, leftValue: "", caseSensitive: true, typeValidation: "strict"}');
}
if (errorTypes.has('branch_mismatch')) {
recoverySteps.push('Branch count mismatch. Ensure Switch nodes have outputs for all rules (e.g., 3 rules = 3 output branches).');
}
// Add generic recovery steps if no specific guidance
if (recoverySteps.length === 0) {
recoverySteps.push('Review the validation errors listed above');
recoverySteps.push('Fix issues using updateNode or cleanStaleConnections operations');
recoverySteps.push('Run validate_workflow again to verify fixes');
}
const errorMessage = structureErrors.length === 1
? `Workflow validation failed: ${structureErrors[0]}`
: `Workflow validation failed with ${structureErrors.length} structural issues`;
// structureErrors is only populated when SKIP_WORKFLOW_VALIDATION is unset,
// so we can unconditionally block the save here.
return {
success: false,
saved: false,
error: errorMessage,
details: {
errors: structureErrors,
errorCount: structureErrors.length,
operationsApplied: diffResult.operationsApplied,
applied: diffResult.applied,
recoveryGuidance: recoverySteps,
note: 'Operations were applied but created an invalid workflow structure. The workflow was NOT saved to n8n to prevent UI rendering errors.',
autoSanitizationNote: 'Auto-sanitization runs on modified nodes during updates to fix operator structures and add missing metadata. However, it cannot fix all issues (e.g., broken connections, branch mismatches). Use the recovery guidance above to resolve remaining issues.'
}
};
}
}
// Update workflow via API
try {
// Rollback-on-error: if the PUT fails, n8n may have persisted the body
// before failing (e.g. an unsupported typeVersion trips the activation
// step within the same PUT, but the body is already saved). Re-PUT the
// workflowBefore snapshot in that case to restore prior state. The
// snapshot is captured earlier in this handler for telemetry and is
// safe to reuse here.
//
// To distinguish persist-then-fail from pre-save rejection, GET the
// server state after the failed PUT and compare versionId (or
// versionCounter / updatedAt — whichever the running n8n exposes). If
// unchanged, the body never persisted and rolling back would be both
// a wasted PUT and a misleading "(restored to prior state)" message.
let updatedWorkflow;
try {
updatedWorkflow = await client.updateWorkflow(input.id, diffResult.workflow!);
} catch (updateError) {
if (workflowBefore && !input.validateOnly) {
let serverState: any = null;
try {
serverState = await client.getWorkflow(input.id);
} catch (getErr) {
logger.debug('Post-failure GET failed; falling back to best-effort rollback', getErr);
}
// Only skip rollback when we KNOW the body never persisted.
// If serverState is missing or we can't compare versions, attempt
// rollback as a safety net — the bug class in #770 is silent
// corruption, and a redundant PUT is far less harmful than a
// missed rollback.
const versionState = serverState
? compareVersions(serverState, workflowBefore)
: 'unknown';
if (versionState === 'same') {
// Pre-save rejection: nothing to roll back.
logger.debug('PUT failed before persisting; skipping rollback', {
workflowId: input.id,
});
if (updateError instanceof N8nApiError) {
throw new N8nApiError(
updateError.message,
updateError.statusCode,
updateError.code,
{
...((updateError.details as Record<string, unknown>) ?? {}),
rollbackPerformed: false,
},
);
}
throw updateError;
}
// Either persist-then-fail OR couldn't determine — attempt rollback.
let rollbackPerformed = false;
let rollbackErrorMessage: string | undefined;
try {
await client.updateWorkflow(input.id, workflowBefore);
rollbackPerformed = true;
logger.warn('updateWorkflow failed; rolled back to prior state', {
workflowId: input.id,
originalError: updateError instanceof Error ? updateError.message : String(updateError),
});
} catch (rollbackErr) {
rollbackErrorMessage = rollbackErr instanceof Error ? rollbackErr.message : String(rollbackErr);
logger.error('updateWorkflow failed AND rollback failed', {
workflowId: input.id,
originalError: updateError instanceof Error ? updateError.message : String(updateError),
rollbackError: rollbackErrorMessage,
});
}
// Re-throw with rollback context attached so the outer N8nApiError
// catch (below) surfaces it with the user-friendly formatting.
if (updateError instanceof N8nApiError) {
const augmentedDetails: Record<string, unknown> = {
...((updateError.details as Record<string, unknown>) ?? {}),
rollbackPerformed,
...(rollbackErrorMessage ? { rollbackError: rollbackErrorMessage } : {}),
...(workflowBefore.versionId ? { priorVersionId: workflowBefore.versionId } : {}),
};
const suffix = rollbackPerformed
? ' (workflow restored to prior state)'
: (rollbackErrorMessage
? ' (rollback also failed; workflow may be in a broken state — try n8n_workflow_versions for a backup)'
: '');
throw new N8nApiError(
`${updateError.message}${suffix}`,
updateError.statusCode,
updateError.code,
augmentedDetails,
);
}
}
throw updateError;
}
// Handle tag operations via dedicated API (#599)
let tagWarnings: string[] = [];
if (diffResult.tagsToAdd?.length || diffResult.tagsToRemove?.length) {
try {
// Get existing tags from the updated workflow
const existingTags: Array<{ id: string; name: string }> = Array.isArray(updatedWorkflow.tags)
? updatedWorkflow.tags.map((t: any) => typeof t === 'object' ? { id: t.id, name: t.name } : { id: '', name: t })
: [];
// Resolve tag names to IDs
const allTags = await client.listTags();
const tagMap = new Map<string, string>();
for (const t of allTags.data) {
if (t.id) tagMap.set(t.name.toLowerCase(), t.id);
}
// Create any tags that don't exist yet
for (const tagName of (diffResult.tagsToAdd || [])) {
if (!tagMap.has(tagName.toLowerCase())) {
try {
const newTag = await client.createTag({ name: tagName });
if (newTag.id) tagMap.set(tagName.toLowerCase(), newTag.id);
} catch (createErr) {
tagWarnings.push(`Failed to create tag "${tagName}": ${createErr instanceof Error ? createErr.message : 'Unknown error'}`);
}
}
}
// Compute final tag set — resolve string-type tags via tagMap
const currentTagIds = new Set<string>();
for (const et of existingTags) {
if (et.id) {
currentTagIds.add(et.id);
} else {
const resolved = tagMap.get(et.name.toLowerCase());
if (resolved) currentTagIds.add(resolved);
}
}
for (const tagName of (diffResult.tagsToAdd || [])) {
const tagId = tagMap.get(tagName.toLowerCase());
if (tagId) currentTagIds.add(tagId);
}
for (const tagName of (diffResult.tagsToRemove || [])) {
const tagId = tagMap.get(tagName.toLowerCase());
if (tagId) currentTagIds.delete(tagId);
}
// Update workflow tags via dedicated API
await client.updateWorkflowTags(input.id, Array.from(currentTagIds));
} catch (tagError) {
tagWarnings.push(`Tag update failed: ${tagError instanceof Error ? tagError.message : 'Unknown error'}`);
logger.warn('Tag operations failed (non-blocking)', tagError);
}
}
// Handle project transfer if requested (before activation so workflow is in target project first)
let transferMessage = '';
if (diffResult.transferToProjectId) {
try {
await client.transferWorkflow(input.id, diffResult.transferToProjectId);
transferMessage = ` Workflow transferred to project ${diffResult.transferToProjectId}.`;
} catch (transferError) {
logger.error('Failed to transfer workflow to project', transferError);
return {
success: false,
saved: true,
error: 'Workflow updated successfully but project transfer failed',
details: {
workflowUpdated: true,
transferError: transferError instanceof Error ? transferError.message : 'Unknown error'
}
};
}
}
// Handle activation/deactivation if requested
let finalWorkflow = updatedWorkflow;
let activationMessage = '';
// Validate workflow AFTER mutation (for telemetry)
try {
const validator = getValidator(repository);
validationAfter = await validator.validateWorkflow(finalWorkflow, {
validateNodes: true,
validateConnections: true,
validateExpressions: true,
profile: 'runtime'
});
} catch (validationError) {
logger.debug('Post-mutation validation failed (non-blocking):', validationError);
// Don't block on validation errors
validationAfter = {
valid: false,
errors: [{ type: 'validation_error', message: 'Validation failed' }]
};
}
if (diffResult.shouldActivate) {
try {
finalWorkflow = await client.activateWorkflow(input.id);
activationMessage = ' Workflow activated.';
} catch (activationError) {
logger.error('Failed to activate workflow after update', activationError);
return {
success: false,
saved: true,
error: 'Workflow updated successfully but activation failed',
details: {
workflowUpdated: true,
activationError: activationError instanceof Error ? activationError.message : 'Unknown error'
}
};
}
} else if (diffResult.shouldDeactivate) {
try {
finalWorkflow = await client.deactivateWorkflow(input.id);
activationMessage = ' Workflow deactivated.';
} catch (deactivationError) {
logger.error('Failed to deactivate workflow after update', deactivationError);
return {
success: false,
saved: true,
error: 'Workflow updated successfully but deactivation failed',
details: {
workflowUpdated: true,
deactivationError: deactivationError instanceof Error ? deactivationError.message : 'Unknown error'
}
};
}
}
// Track successful mutation
if (workflowBefore && !input.validateOnly) {
void trackWorkflowMutation({
sessionId,
toolName: 'n8n_update_partial_workflow',
userIntent: input.intent || 'Partial workflow update',
operations: input.operations,
workflowBefore,
workflowAfter: finalWorkflow,
validationBefore,
validationAfter,
mutationSuccess: true,
durationMs: Date.now() - startTime,
}).catch(err => {
logger.debug('Failed to track mutation telemetry:', err);
});
}
return {
success: true,
saved: true,
data: {
id: finalWorkflow.id,
name: finalWorkflow.name,
active: finalWorkflow.active,
nodeCount: finalWorkflow.nodes?.length || 0,
operationsApplied: diffResult.operationsApplied
},
message: `Workflow "${finalWorkflow.name}" updated successfully. Applied ${diffResult.operationsApplied} operations.${transferMessage}${activationMessage} Use n8n_get_workflow with mode 'structure' to verify current state.`,
details: {
applied: diffResult.applied,
failed: diffResult.failed,
errors: diffResult.errors,
warnings: mergeWarnings(diffResult.warnings, tagWarnings)
}
};
} catch (error) {
// Track failed mutation
if (workflowBefore && !input.validateOnly) {
void trackWorkflowMutation({
sessionId,
toolName: 'n8n_update_partial_workflow',
userIntent: input.intent || 'Partial workflow update',
operations: input.operations,
workflowBefore,
workflowAfter: workflowBefore, // No change since it failed
validationBefore,
validationAfter: validationBefore, // Same as before since mutation failed
mutationSuccess: false,
mutationError: error instanceof Error ? error.message : 'Unknown error',
durationMs: Date.now() - startTime,
}).catch(err => {
logger.warn('Failed to track mutation telemetry for failed operation:', err);
});
}
if (error instanceof N8nApiError) {
return {
success: false,
error: getUserFriendlyErrorMessage(error),
code: error.code,
details: error.details as Record<string, unknown> | undefined
};
}
throw error;
}
} catch (error) {
if (error instanceof z.ZodError) {
return {
success: false,
error: 'Invalid input',
details: {
errors: error.errors.map(e => `${e.path.join('.')}: ${e.message}`)
}
};
}
logger.error('Failed to update partial workflow', error);
return {
success: false,
error: error instanceof Error ? error.message : 'Unknown error occurred'
};
}
}
/**
* Merge diff engine warnings with tag operation warnings into a single array.
* Returns undefined when there are no warnings to keep the response clean.
*/
function mergeWarnings(
diffWarnings: WorkflowDiffValidationError[] | undefined,
tagWarnings: string[]
): WorkflowDiffValidationError[] | undefined {
const merged: WorkflowDiffValidationError[] = [
...(diffWarnings || []),
...tagWarnings.map(w => ({ operation: -1, message: w }))
];
return merged.length > 0 ? merged : undefined;
}
/**
* Infer intent from operations when not explicitly provided
*/
function inferIntentFromOperations(operations: any[]): string {
if (!operations || operations.length === 0) {
return 'Partial workflow update';
}
const opTypes = operations.map((op) => op.type);
const opCount = operations.length;
// Single operation - be specific
if (opCount === 1) {
const op = operations[0];
switch (op.type) {
case 'addNode':
return `Add ${op.node?.type || 'node'}`;
case 'removeNode':
return `Remove node ${op.nodeName || op.nodeId || ''}`.trim();
case 'updateNode':
return `Update node ${op.nodeName || op.nodeId || ''}`.trim();
case 'patchNodeField':
return `Patch field on node ${op.nodeName || op.nodeId || ''}`.trim();
case 'addConnection':
return `Connect ${op.source || 'node'} to ${op.target || 'node'}`;
case 'removeConnection':
return `Disconnect ${op.source || 'node'} from ${op.target || 'node'}`;
case 'rewireConnection':
return `Rewire ${op.source || 'node'} from ${op.from || ''} to ${op.to || ''}`.trim();
case 'updateName':
return `Rename workflow to "${op.name || ''}"`;
case 'activateWorkflow':
return 'Activate workflow';
case 'deactivateWorkflow':
return 'Deactivate workflow';
case 'transferWorkflow':
return `Transfer workflow to project ${op.destinationProjectId || ''}`.trim();
default:
return `Workflow ${op.type}`;
}
}
// Multiple operations - summarize pattern
const typeSet = new Set(opTypes);
const summary: string[] = [];
if (typeSet.has('addNode')) {
const count = opTypes.filter((t) => t === 'addNode').length;
summary.push(`add ${count} node${count > 1 ? 's' : ''}`);
}
if (typeSet.has('removeNode')) {
const count = opTypes.filter((t) => t === 'removeNode').length;
summary.push(`remove ${count} node${count > 1 ? 's' : ''}`);
}
if (typeSet.has('updateNode')) {
const count = opTypes.filter((t) => t === 'updateNode').length;
summary.push(`update ${count} node${count > 1 ? 's' : ''}`);
}
if (typeSet.has('patchNodeField')) {
const count = opTypes.filter((t) => t === 'patchNodeField').length;
summary.push(`patch ${count} field${count > 1 ? 's' : ''}`);
}
if (typeSet.has('addConnection') || typeSet.has('rewireConnection')) {
summary.push('modify connections');
}
if (typeSet.has('updateName') || typeSet.has('updateSettings')) {
summary.push('update metadata');
}
return summary.length > 0
? `Workflow update: ${summary.join(', ')}`
: `Workflow update: ${opCount} operations`;
}
/**
* Track workflow mutation for telemetry
*/
async function trackWorkflowMutation(data: any): Promise<void> {
try {
// Enhance intent if it's missing or generic
if (
!data.userIntent ||
data.userIntent === 'Partial workflow update' ||
data.userIntent.length < 10
) {
data.userIntent = inferIntentFromOperations(data.operations);
}
const { telemetry } = await import('../telemetry/telemetry-manager.js');
await telemetry.trackWorkflowMutation(data);
} catch (error) {
logger.debug('Telemetry tracking failed:', error);
}
}