fix: sticky notes validation - eliminate false positives in workflow updates (#350)

Fixed critical bug where sticky notes (UI-only annotation nodes) incorrectly
triggered "disconnected node" validation errors when updating workflows via
MCP tools (n8n_update_partial_workflow, n8n_update_full_workflow).

Problem:
- Workflows with sticky notes failed validation with "Node is disconnected" errors
- n8n-validation.ts lacked sticky note exclusion logic
- workflow-validator.ts had correct logic but as private method
- Code duplication led to divergent behavior

Solution:
1. Created shared utility module (src/utils/node-classification.ts)
   - isStickyNote(): Identifies all sticky note type variations
   - isTriggerNode(): Identifies trigger nodes
   - isNonExecutableNode(): Identifies UI-only nodes
   - requiresIncomingConnection(): Determines connection requirements

2. Updated n8n-validation.ts to use shared utilities
   - Fixed disconnected nodes check to skip non-executable nodes
   - Added validation for workflows with only sticky notes
   - Fixed multi-node connection check to exclude sticky notes

3. Updated workflow-validator.ts to use shared utilities
   - Removed private isStickyNote() method (8 locations)
   - Eliminated code duplication

Testing:
- Created comprehensive test suites (54 new tests, 100% coverage)
- Tested with n8n-mcp-tester agent using real n8n instance
- All test scenarios passed including regression tests
- Validated against real workflows with sticky notes

Impact:
- Sticky notes no longer block workflow updates
- Matches n8n UI behavior exactly
- Zero regressions in existing validation
- All MCP workflow tools now work correctly with annotated workflows

Files Changed:
- NEW: src/utils/node-classification.ts
- NEW: tests/unit/utils/node-classification.test.ts (44 tests)
- NEW: tests/unit/services/n8n-validation-sticky-notes.test.ts (10 tests)
- MODIFIED: src/services/n8n-validation.ts (lines 198-259)
- MODIFIED: src/services/workflow-validator.ts (8 locations)
- MODIFIED: tests/unit/validation-fixes.test.ts
- MODIFIED: CHANGELOG.md (v2.20.8 entry)
- MODIFIED: package.json (version bump to 2.20.8)

Test Results:
- Unit tests: 54 new tests passing, 100% coverage on utilities
- Integration tests: All 10 sticky notes validation tests passing
- Regression tests: Zero failures in existing test suite
- Real-world testing: 4 test workflows validated successfully

Conceived by Romuald Członkowski - www.aiadvisors.pl/en
This commit is contained in:
Romuald Członkowski
2025-10-22 17:58:13 +02:00
committed by GitHub
parent 7300957d13
commit c76ffd9fb1
9 changed files with 1054 additions and 35 deletions

View File

@@ -11,6 +11,7 @@ import { NodeSimilarityService, NodeSuggestion } from './node-similarity-service
import { NodeTypeNormalizer } from '../utils/node-type-normalizer';
import { Logger } from '../utils/logger';
import { validateAISpecificNodes, hasAINodes } from './ai-node-validator';
import { isNonExecutableNode } from '../utils/node-classification';
const logger = new Logger({ prefix: '[WorkflowValidator]' });
interface WorkflowNode {
@@ -85,17 +86,8 @@ export class WorkflowValidator {
this.similarityService = new NodeSimilarityService(nodeRepository);
}
/**
* Check if a node is a Sticky Note or other non-executable node
*/
private isStickyNote(node: WorkflowNode): boolean {
const stickyNoteTypes = [
'n8n-nodes-base.stickyNote',
'nodes-base.stickyNote',
'@n8n/n8n-nodes-base.stickyNote'
];
return stickyNoteTypes.includes(node.type);
}
// Note: isStickyNote logic moved to shared utility: src/utils/node-classification.ts
// Use isNonExecutableNode(node.type) instead
/**
* Validate a complete workflow
@@ -146,7 +138,7 @@ export class WorkflowValidator {
}
// Update statistics after null check (exclude sticky notes from counts)
const executableNodes = Array.isArray(workflow.nodes) ? workflow.nodes.filter(n => !this.isStickyNote(n)) : [];
const executableNodes = Array.isArray(workflow.nodes) ? workflow.nodes.filter(n => !isNonExecutableNode(n.type)) : [];
result.statistics.totalNodes = executableNodes.length;
result.statistics.enabledNodes = executableNodes.filter(n => !n.disabled).length;
@@ -356,7 +348,7 @@ export class WorkflowValidator {
profile: string
): Promise<void> {
for (const node of workflow.nodes) {
if (node.disabled || this.isStickyNote(node)) continue;
if (node.disabled || isNonExecutableNode(node.type)) continue;
try {
// Validate node name length
@@ -632,7 +624,7 @@ export class WorkflowValidator {
// Check for orphaned nodes (exclude sticky notes)
for (const node of workflow.nodes) {
if (node.disabled || this.isStickyNote(node)) continue;
if (node.disabled || isNonExecutableNode(node.type)) continue;
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(node.type);
const isTrigger = normalizedType.toLowerCase().includes('trigger') ||
@@ -877,7 +869,7 @@ export class WorkflowValidator {
// Build node type map (exclude sticky notes)
workflow.nodes.forEach(node => {
if (!this.isStickyNote(node)) {
if (!isNonExecutableNode(node.type)) {
nodeTypeMap.set(node.name, node.type);
}
});
@@ -945,7 +937,7 @@ export class WorkflowValidator {
// Check from all executable nodes (exclude sticky notes)
for (const node of workflow.nodes) {
if (!this.isStickyNote(node) && !visited.has(node.name)) {
if (!isNonExecutableNode(node.type) && !visited.has(node.name)) {
if (hasCycleDFS(node.name)) return true;
}
}
@@ -964,7 +956,7 @@ export class WorkflowValidator {
const nodeNames = workflow.nodes.map(n => n.name);
for (const node of workflow.nodes) {
if (node.disabled || this.isStickyNote(node)) continue;
if (node.disabled || isNonExecutableNode(node.type)) continue;
// Skip expression validation for langchain nodes
// They have AI-specific validators and different expression rules
@@ -1111,7 +1103,7 @@ export class WorkflowValidator {
// Check node-level error handling properties for ALL executable nodes
for (const node of workflow.nodes) {
if (!this.isStickyNote(node)) {
if (!isNonExecutableNode(node.type)) {
this.checkNodeErrorHandling(node, workflow, result);
}
}