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

@@ -1,5 +1,6 @@
import { z } from 'zod';
import { WorkflowNode, WorkflowConnection, Workflow } from '../types/n8n-api';
import { isNonExecutableNode, isTriggerNode } from '../utils/node-classification';
// Zod schemas for n8n API validation
@@ -194,6 +195,14 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
errors.push('Workflow must have at least one node');
}
// Check if workflow has only non-executable nodes (sticky notes)
if (workflow.nodes && workflow.nodes.length > 0) {
const hasExecutableNodes = workflow.nodes.some(node => !isNonExecutableNode(node.type));
if (!hasExecutableNodes) {
errors.push('Workflow must have at least one executable node. Sticky notes alone cannot form a valid workflow.');
}
}
if (!workflow.connections) {
errors.push('Workflow connections are required');
}
@@ -211,13 +220,15 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
// Check for disconnected nodes in multi-node workflows
if (workflow.nodes && workflow.nodes.length > 1 && workflow.connections) {
// Filter out non-executable nodes (sticky notes) when counting nodes
const executableNodes = workflow.nodes.filter(node => !isNonExecutableNode(node.type));
const connectionCount = Object.keys(workflow.connections).length;
// First check: workflow has no connections at all
if (connectionCount === 0) {
const nodeNames = workflow.nodes.slice(0, 2).map(n => n.name);
// First check: workflow has no connections at all (only check if there are multiple executable nodes)
if (connectionCount === 0 && executableNodes.length > 1) {
const nodeNames = executableNodes.slice(0, 2).map(n => n.name);
errors.push(`Multi-node workflow has no connections between nodes. Add a connection using: {type: 'addConnection', source: '${nodeNames[0]}', target: '${nodeNames[1]}', sourcePort: 'main', targetPort: 'main'}`);
} else {
} else if (connectionCount > 0 || executableNodes.length > 1) {
// Second check: detect disconnected nodes (nodes with no incoming or outgoing connections)
const connectedNodes = new Set<string>();
@@ -236,19 +247,20 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
}
});
// Find disconnected nodes (excluding webhook triggers which can be source-only)
const webhookTypes = new Set([
'n8n-nodes-base.webhook',
'n8n-nodes-base.webhookTrigger',
'n8n-nodes-base.manualTrigger'
]);
// Find disconnected nodes (excluding non-executable nodes and triggers)
// Non-executable nodes (sticky notes) are UI-only and don't need connections
// Trigger nodes only need outgoing connections
const disconnectedNodes = workflow.nodes.filter(node => {
const isConnected = connectedNodes.has(node.name);
const isWebhookOrTrigger = webhookTypes.has(node.type);
// Skip non-executable nodes (sticky notes, etc.) - they're UI-only annotations
if (isNonExecutableNode(node.type)) {
return false;
}
// Webhook/trigger nodes only need outgoing connections
if (isWebhookOrTrigger) {
const isConnected = connectedNodes.has(node.name);
const isTrigger = isTriggerNode(node.type);
// Trigger nodes only need outgoing connections
if (isTrigger) {
return !workflow.connections?.[node.name]; // Disconnected if no outgoing connections
}

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);
}
}

View File

@@ -0,0 +1,121 @@
/**
* Node Classification Utilities
*
* Provides shared classification logic for workflow nodes.
* Used by validators to consistently identify node types across the codebase.
*
* This module centralizes node type classification to ensure consistent behavior
* between WorkflowValidator and n8n-validation.ts, preventing bugs like sticky
* notes being incorrectly flagged as disconnected nodes.
*/
/**
* Check if a node type is a sticky note (documentation-only node)
*
* Sticky notes are UI-only annotation nodes that:
* - Do not participate in workflow execution
* - Never have connections (by design)
* - Should be excluded from connection validation
* - Serve purely as visual documentation in the workflow canvas
*
* Example sticky note types:
* - 'n8n-nodes-base.stickyNote' (standard format)
* - 'nodes-base.stickyNote' (normalized format)
* - '@n8n/n8n-nodes-base.stickyNote' (scoped format)
*
* @param nodeType - The node type to check (e.g., 'n8n-nodes-base.stickyNote')
* @returns true if the node is a sticky note, false otherwise
*/
export function isStickyNote(nodeType: string): boolean {
const stickyNoteTypes = [
'n8n-nodes-base.stickyNote',
'nodes-base.stickyNote',
'@n8n/n8n-nodes-base.stickyNote'
];
return stickyNoteTypes.includes(nodeType);
}
/**
* Check if a node type is a trigger node
*
* Trigger nodes:
* - Start workflow execution
* - Only need outgoing connections (no incoming connections required)
* - Include webhooks, manual triggers, schedule triggers, etc.
* - Are the entry points for workflow execution
*
* Examples:
* - Webhooks: Listen for HTTP requests
* - Manual triggers: Started manually by user
* - Schedule/Cron triggers: Run on a schedule
*
* @param nodeType - The node type to check
* @returns true if the node is a trigger, false otherwise
*/
export function isTriggerNode(nodeType: string): boolean {
const triggerTypes = [
'n8n-nodes-base.webhook',
'n8n-nodes-base.webhookTrigger',
'n8n-nodes-base.manualTrigger',
'n8n-nodes-base.cronTrigger',
'n8n-nodes-base.scheduleTrigger'
];
return triggerTypes.includes(nodeType);
}
/**
* Check if a node type is non-executable (UI-only)
*
* Non-executable nodes:
* - Do not participate in workflow execution
* - Serve documentation/annotation purposes only
* - Should be excluded from all execution-related validation
* - Should be excluded from statistics like "total executable nodes"
* - Should be excluded from connection validation
*
* Currently includes: sticky notes
*
* Future: May include other annotation/comment nodes if n8n adds them
*
* @param nodeType - The node type to check
* @returns true if the node is non-executable, false otherwise
*/
export function isNonExecutableNode(nodeType: string): boolean {
return isStickyNote(nodeType);
// Future: Add other non-executable node types here
// Example: || isCommentNode(nodeType) || isAnnotationNode(nodeType)
}
/**
* Check if a node type requires incoming connections
*
* Most nodes require at least one incoming connection to receive data,
* but there are two categories of exceptions:
*
* 1. Trigger nodes: Only need outgoing connections
* - They start workflow execution
* - They generate their own data
* - Examples: webhook, manualTrigger, scheduleTrigger
*
* 2. Non-executable nodes: Don't need any connections
* - They are UI-only annotations
* - They don't participate in execution
* - Examples: stickyNote
*
* @param nodeType - The node type to check
* @returns true if the node requires incoming connections, false otherwise
*/
export function requiresIncomingConnection(nodeType: string): boolean {
// Non-executable nodes don't need any connections
if (isNonExecutableNode(nodeType)) {
return false;
}
// Trigger nodes only need outgoing connections
if (isTriggerNode(nodeType)) {
return false;
}
// Regular nodes need incoming connections
return true;
}