mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-01-30 14:32:04 +00:00
Compare commits
40 Commits
feature/au
...
v2.22.12
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eee52a7f53 | ||
|
|
a66cb18cce | ||
|
|
0e0f0998af | ||
|
|
08a4be8370 | ||
|
|
3578f2cc31 | ||
|
|
4d3b8fbc91 | ||
|
|
5688384113 | ||
|
|
346fa3c8d2 | ||
|
|
3d5ceae43f | ||
|
|
1834d474a5 | ||
|
|
a4ef1efaf8 | ||
|
|
65f51ad8b5 | ||
|
|
af6efe9e88 | ||
|
|
3f427f9528 | ||
|
|
18b8747005 | ||
|
|
749f1c53eb | ||
|
|
892c4ed70a | ||
|
|
590dc087ac | ||
|
|
ee7229b4db | ||
|
|
b6683b8381 | ||
|
|
b2300429fd | ||
|
|
b87f638e52 | ||
|
|
1f94427d54 | ||
|
|
2eb459c80c | ||
|
|
79ef853e8c | ||
|
|
2682be33b8 | ||
|
|
9f291154f2 | ||
|
|
bfff497020 | ||
|
|
e522aec08c | ||
|
|
817bf7d211 | ||
|
|
9a3520adb7 | ||
|
|
ced7fafcbf | ||
|
|
ad4b521402 | ||
|
|
b18f6ec7a4 | ||
|
|
95ea6ca0bb | ||
|
|
a4c7e097e8 | ||
|
|
0778c55d85 | ||
|
|
913ff31164 | ||
|
|
952a97ef73 | ||
|
|
56114f041b |
17
.github/workflows/release.yml
vendored
17
.github/workflows/release.yml
vendored
@@ -142,16 +142,13 @@ jobs:
|
||||
if [ -z "$PREVIOUS_TAG" ]; then
|
||||
echo "ℹ️ No previous tag found, this might be the first release"
|
||||
|
||||
# Get all commits up to current commit
|
||||
NOTES="### 🎉 Initial Release
|
||||
|
||||
This is the initial release of n8n-mcp v$CURRENT_VERSION.
|
||||
|
||||
---
|
||||
|
||||
**Release Statistics:**
|
||||
- Commit count: $(git rev-list --count HEAD)
|
||||
- First release setup"
|
||||
# Generate initial release notes using script
|
||||
if NOTES=$(node scripts/generate-initial-release-notes.js "$CURRENT_VERSION" 2>/dev/null); then
|
||||
echo "✅ Successfully generated initial release notes for version $CURRENT_VERSION"
|
||||
else
|
||||
echo "⚠️ Could not generate initial release notes for version $CURRENT_VERSION"
|
||||
NOTES="Initial release v$CURRENT_VERSION"
|
||||
fi
|
||||
|
||||
echo "has-notes=true" >> $GITHUB_OUTPUT
|
||||
|
||||
|
||||
735
CHANGELOG.md
735
CHANGELOG.md
@@ -7,6 +7,741 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [2.22.12] - 2025-01-08
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
**Issue #392: Helpful Error Messages for "changes" vs "updates" Parameter**
|
||||
|
||||
Fixed cryptic error message when users mistakenly use `changes` instead of `updates` in updateNode operations. AI agents now receive clear, educational error messages that help them self-correct immediately.
|
||||
|
||||
#### Problem
|
||||
|
||||
Users who mistakenly used `changes` instead of `updates` in `n8n_update_partial_workflow` updateNode operations encountered a cryptic error:
|
||||
|
||||
```
|
||||
Diff engine error: Cannot read properties of undefined (reading 'name')
|
||||
```
|
||||
|
||||
This error occurred because:
|
||||
1. The code tried to read `operation.updates.name` at line 406 of `workflow-diff-engine.ts`
|
||||
2. When users sent `changes` instead of `updates`, `operation.updates` was `undefined`
|
||||
3. Reading `.name` from `undefined` → unhelpful error message
|
||||
4. AI agents had no guidance on what went wrong or how to fix it
|
||||
|
||||
**Root Cause**: No early validation to detect this common parameter mistake before attempting to access properties.
|
||||
|
||||
#### Solution
|
||||
|
||||
Added early validation in `validateUpdateNode()` method to detect and provide helpful guidance:
|
||||
|
||||
**1. Parameter Validation** (`src/services/workflow-diff-engine.ts` lines 400-409):
|
||||
```typescript
|
||||
// Check for common parameter mistake: "changes" instead of "updates" (Issue #392)
|
||||
const operationAny = operation as any;
|
||||
if (operationAny.changes && !operation.updates) {
|
||||
return `Invalid parameter 'changes'. The updateNode operation requires 'updates' (not 'changes'). Example: {type: "updateNode", nodeId: "abc", updates: {name: "New Name", "parameters.url": "https://example.com"}}`;
|
||||
}
|
||||
|
||||
// Check for missing required parameter
|
||||
if (!operation.updates) {
|
||||
return `Missing required parameter 'updates'. The updateNode operation requires an 'updates' object containing properties to modify. Example: {type: "updateNode", nodeId: "abc", updates: {name: "New Name"}}`;
|
||||
}
|
||||
```
|
||||
|
||||
**2. Documentation Fix** (`docs/VS_CODE_PROJECT_SETUP.md` line 165):
|
||||
- Fixed outdated example that showed incorrect parameter name
|
||||
- Changed from: `{type: 'updateNode', nodeId: 'slack1', changes: {position: [100, 200]}}`
|
||||
- Changed to: `{type: 'updateNode', nodeId: 'slack1', updates: {position: [100, 200]}}`
|
||||
- Prevents AI agents from learning the wrong syntax
|
||||
|
||||
**3. Comprehensive Test Coverage** (`tests/unit/services/workflow-diff-engine.test.ts` lines 388-428):
|
||||
- Test for using `changes` instead of `updates` (validates helpful error message)
|
||||
- Test for missing `updates` parameter entirely
|
||||
- Both tests verify error message content includes examples
|
||||
|
||||
#### Error Messages
|
||||
|
||||
**Before Fix:**
|
||||
```
|
||||
Diff engine error: Cannot read properties of undefined (reading 'name')
|
||||
```
|
||||
|
||||
**After Fix:**
|
||||
```
|
||||
Missing required parameter 'updates'. The updateNode operation requires an 'updates'
|
||||
object containing properties to modify. Example: {type: "updateNode", nodeId: "abc",
|
||||
updates: {name: "New Name"}}
|
||||
```
|
||||
|
||||
#### Impact
|
||||
|
||||
**For AI Agents:**
|
||||
- ✅ **Clear Error Messages**: Explicitly states what's wrong ("Invalid parameter 'changes'")
|
||||
- ✅ **Educational**: Explains the correct parameter name ("requires 'updates'")
|
||||
- ✅ **Actionable**: Includes working example showing correct syntax
|
||||
- ✅ **Self-Correction**: AI agents can immediately fix their code based on the error
|
||||
|
||||
**Testing Results:**
|
||||
- Test Coverage: 85% confidence (production ready)
|
||||
- n8n-mcp-tester validation: All 3 test cases passed
|
||||
- Code Review: Approved with minor optional suggestions
|
||||
- Consistency: Follows existing patterns from Issue #249
|
||||
|
||||
**Production Impact:**
|
||||
- **Risk Level**: Very Low (only adds validation, no logic changes)
|
||||
- **Breaking Changes**: None (backward compatible)
|
||||
- **False Positive Rate**: 0% (validation is specific to the exact mistake)
|
||||
|
||||
#### Technical Details
|
||||
|
||||
**Files Modified (3 files):**
|
||||
- `src/services/workflow-diff-engine.ts` - Added early validation (10 lines)
|
||||
- `docs/VS_CODE_PROJECT_SETUP.md` - Fixed incorrect example (1 line)
|
||||
- `tests/unit/services/workflow-diff-engine.test.ts` - Added 2 comprehensive test cases (40 lines)
|
||||
|
||||
**Configuration (1 file):**
|
||||
- `package.json` - Version bump to 2.22.12
|
||||
|
||||
**Validation Flow:**
|
||||
1. Check if operation has `changes` property but no `updates` → Error with helpful message
|
||||
2. Check if operation is missing `updates` entirely → Error with example
|
||||
3. Continue with normal validation if `updates` is present
|
||||
|
||||
**Consistency:**
|
||||
- Pattern matches existing parameter validation in `validateAddConnection()` (lines 444-451)
|
||||
- Error message format consistent with existing errors (lines 461, 466, 469)
|
||||
- Uses same `as any` approach for detecting invalid properties
|
||||
|
||||
#### References
|
||||
|
||||
- **Issue**: #392 - "Diff engine error: Cannot read properties of undefined (reading 'name')"
|
||||
- **Reporter**: User Aldekein (via cmj-hub investigation)
|
||||
- **Test Coverage Assessment**: 85% confidence - SUFFICIENT for production
|
||||
- **Code Review**: APPROVE WITH COMMENTS - Well-implemented and ready to merge
|
||||
- **Related Issues**: None (this is a new validation feature)
|
||||
|
||||
Conceived by Romuald Członkowski - [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
|
||||
|
||||
## [2.22.11] - 2025-01-06
|
||||
|
||||
### ✨ New Features
|
||||
|
||||
**Issue #399: Workflow Activation via Diff Operations**
|
||||
|
||||
Added workflow activation and deactivation as diff operations in `n8n_update_partial_workflow`, using n8n's dedicated API endpoints.
|
||||
|
||||
#### Problem
|
||||
|
||||
The n8n API provides dedicated `POST /workflows/{id}/activate` and `POST /workflows/{id}/deactivate` endpoints, but these were not accessible through n8n-mcp. Users could not programmatically control workflow activation status, forcing manual activation through the n8n UI.
|
||||
|
||||
#### Solution
|
||||
|
||||
Implemented activation/deactivation as diff operations, following the established pattern of metadata operations like `updateSettings` and `updateName`. This keeps the tool count manageable (40 tools, not 42) and provides a consistent interface.
|
||||
|
||||
#### Changes
|
||||
|
||||
**API Client** (`src/services/n8n-api-client.ts`):
|
||||
- Added `activateWorkflow(id: string): Promise<Workflow>` method
|
||||
- Added `deactivateWorkflow(id: string): Promise<Workflow>` method
|
||||
- Both use POST requests to dedicated n8n API endpoints
|
||||
|
||||
**Diff Engine Types** (`src/types/workflow-diff.ts`):
|
||||
- Added `ActivateWorkflowOperation` interface
|
||||
- Added `DeactivateWorkflowOperation` interface
|
||||
- Added `shouldActivate` and `shouldDeactivate` flags to `WorkflowDiffResult`
|
||||
- Increased supported operations from 15 to 17
|
||||
|
||||
**Diff Engine** (`src/services/workflow-diff-engine.ts`):
|
||||
- Added validation for activation (requires activatable triggers)
|
||||
- Added operation application logic
|
||||
- Transfers activation intent from workflow object to result
|
||||
- Validates workflow has activatable triggers (webhook, schedule, etc.)
|
||||
- Rejects workflows with only `executeWorkflowTrigger` (cannot activate)
|
||||
|
||||
**Handler** (`src/mcp/handlers-workflow-diff.ts`):
|
||||
- Checks `shouldActivate` and `shouldDeactivate` flags after workflow update
|
||||
- Calls appropriate API methods
|
||||
- Includes activation status in response message and details
|
||||
- Handles activation/deactivation errors gracefully
|
||||
|
||||
**Documentation** (`src/mcp/tool-docs/workflow_management/n8n-update-partial-workflow.ts`):
|
||||
- Updated operation count from 15 to 17
|
||||
- Added "Workflow Activation Operations" section
|
||||
- Added activation tip to essentials
|
||||
|
||||
**Tool Registration** (`src/mcp/handlers-n8n-manager.ts`):
|
||||
- Removed "Cannot activate/deactivate workflows via API" from limitations
|
||||
|
||||
#### Usage
|
||||
|
||||
```javascript
|
||||
// Activate workflow
|
||||
n8n_update_partial_workflow({
|
||||
id: "workflow_id",
|
||||
operations: [{
|
||||
type: "activateWorkflow"
|
||||
}]
|
||||
})
|
||||
|
||||
// Deactivate workflow
|
||||
n8n_update_partial_workflow({
|
||||
id: "workflow_id",
|
||||
operations: [{
|
||||
type: "deactivateWorkflow"
|
||||
}]
|
||||
})
|
||||
|
||||
// Combine with other operations
|
||||
n8n_update_partial_workflow({
|
||||
id: "workflow_id",
|
||||
operations: [
|
||||
{type: "updateNode", nodeId: "abc", updates: {name: "Updated"}},
|
||||
{type: "activateWorkflow"}
|
||||
]
|
||||
})
|
||||
```
|
||||
|
||||
#### Validation
|
||||
|
||||
- **Activation**: Requires at least one enabled activatable trigger node
|
||||
- **Deactivation**: Always valid
|
||||
- **Error Handling**: Clear messages when activation fails due to missing triggers
|
||||
- **Trigger Detection**: Uses `isActivatableTrigger()` utility (Issue #351 compliance)
|
||||
|
||||
#### Benefits
|
||||
|
||||
- ✅ Consistent with existing architecture (metadata operations pattern)
|
||||
- ✅ Keeps tool count at 40 (not 42)
|
||||
- ✅ Atomic operations - activation happens after workflow update
|
||||
- ✅ Proper validation - prevents activation without triggers
|
||||
- ✅ Clear error messages - guides users on trigger requirements
|
||||
- ✅ Works with other operations - can update and activate in one call
|
||||
|
||||
#### Credits
|
||||
|
||||
- **@ArtemisAI** - Original investigation and API endpoint discovery
|
||||
- **@cmj-hub** - Implementation attempt and PR contribution
|
||||
- Architectural guidance from project maintainer
|
||||
|
||||
Resolves #399
|
||||
|
||||
Conceived by Romuald Członkowski - [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
|
||||
|
||||
## [2.22.10] - 2025-11-04
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
**sql.js Fallback: Fixed Database Health Check Crash**
|
||||
|
||||
Fixed critical startup crash when the server falls back to sql.js adapter (used when better-sqlite3 fails to load, such as Node.js version mismatches between build and runtime).
|
||||
|
||||
#### Problem
|
||||
|
||||
When Claude Desktop was configured to use a different Node.js version than the one used to build the project:
|
||||
- better-sqlite3 fails to load due to NODE_MODULE_VERSION mismatch (e.g., built with Node v22, running with Node v20)
|
||||
- System gracefully falls back to sql.js adapter (pure JavaScript, no native dependencies)
|
||||
- **BUT** the database health check crashed with "no such module: fts5" error
|
||||
- Server exits immediately after startup, preventing connection
|
||||
|
||||
**Error Details:**
|
||||
```
|
||||
[ERROR] Database health check failed: Error: no such module: fts5
|
||||
at e.handleError (sql-wasm.js:90:371)
|
||||
at e.prepare (sql-wasm.js:89:104)
|
||||
at SQLJSAdapter.prepare (database-adapter.js:202:30)
|
||||
at N8NDocumentationMCPServer.validateDatabaseHealth (server.js:251:42)
|
||||
```
|
||||
|
||||
**Root Cause:** The health check attempted to query the FTS5 (Full-Text Search) table, which is not available in sql.js. The error was not caught, causing the server to exit.
|
||||
|
||||
#### Solution
|
||||
|
||||
Wrapped the FTS5 health check in a try-catch block to handle sql.js gracefully:
|
||||
|
||||
```typescript
|
||||
// Check if FTS5 table exists (wrap in try-catch for sql.js compatibility)
|
||||
try {
|
||||
const ftsExists = this.db.prepare(`
|
||||
SELECT name FROM sqlite_master
|
||||
WHERE type='table' AND name='nodes_fts'
|
||||
`).get();
|
||||
|
||||
if (!ftsExists) {
|
||||
logger.warn('FTS5 table missing - search performance will be degraded...');
|
||||
} else {
|
||||
const ftsCount = this.db.prepare('SELECT COUNT(*) as count FROM nodes_fts').get();
|
||||
if (ftsCount.count === 0) {
|
||||
logger.warn('FTS5 index is empty - search will not work properly...');
|
||||
}
|
||||
}
|
||||
} catch (ftsError) {
|
||||
// FTS5 not supported (e.g., sql.js fallback) - this is OK, just warn
|
||||
logger.warn('FTS5 not available - using fallback search. For better performance, ensure better-sqlite3 is properly installed.');
|
||||
}
|
||||
```
|
||||
|
||||
#### Impact
|
||||
|
||||
**Before Fix:**
|
||||
- ❌ Server crashed immediately when using sql.js fallback
|
||||
- ❌ Claude Desktop connection failed with Node.js version mismatches
|
||||
- ❌ No way to use the MCP server without matching Node.js versions exactly
|
||||
|
||||
**After Fix:**
|
||||
- ✅ Server starts successfully with sql.js fallback
|
||||
- ✅ Works with any Node.js version (graceful degradation)
|
||||
- ✅ Clear warning about FTS5 unavailability in logs
|
||||
- ✅ Users can choose between sql.js (slower, works everywhere) or rebuilding better-sqlite3 (faster, requires matching Node version)
|
||||
|
||||
#### Performance Notes
|
||||
|
||||
When using sql.js fallback:
|
||||
- Full-text search (FTS5) is not available, falls back to LIKE queries
|
||||
- Slightly slower search performance (~10-30ms vs ~5ms with FTS5)
|
||||
- All other functionality works identically
|
||||
- Database operations work correctly
|
||||
|
||||
**Recommendation:** For best performance, ensure better-sqlite3 loads successfully by matching Node.js versions or rebuilding:
|
||||
```bash
|
||||
# If Node version mismatch, rebuild better-sqlite3
|
||||
npm rebuild better-sqlite3
|
||||
```
|
||||
|
||||
#### Files Changed
|
||||
|
||||
**Modified (1 file):**
|
||||
- `src/mcp/server.ts` (lines 299-317) - Added try-catch around FTS5 health check
|
||||
|
||||
#### Testing
|
||||
|
||||
- ✅ Tested with Node v20.17.0 (Claude Desktop version)
|
||||
- ✅ Tested with Node v22.17.0 (build version)
|
||||
- ✅ Server starts successfully in both cases
|
||||
- ✅ sql.js fallback works correctly with graceful FTS5 degradation
|
||||
- ✅ All 6 startup checkpoints pass
|
||||
- ✅ Database health check passes with warning
|
||||
|
||||
Conceived by Romuald Członkowski - [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
|
||||
|
||||
## [2.22.9] - 2025-11-04
|
||||
|
||||
### 🔄 Dependencies Update
|
||||
|
||||
**n8n Platform Update to 1.118.1**
|
||||
|
||||
Updated n8n and all related dependencies to the latest versions:
|
||||
|
||||
- **n8n**: 1.117.2 → 1.118.1
|
||||
- **n8n-core**: 1.116.0 → 1.117.0
|
||||
- **n8n-workflow**: 1.114.0 → 1.115.0
|
||||
- **@n8n/n8n-nodes-langchain**: 1.116.2 → 1.117.0
|
||||
|
||||
### 📊 Database Changes
|
||||
|
||||
- Rebuilt node database with **542 nodes**
|
||||
- 439 nodes from n8n-nodes-base
|
||||
- 103 nodes from @n8n/n8n-nodes-langchain
|
||||
- All node metadata synchronized with latest n8n release
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
**n8n 1.118.1+ Compatibility: Fixed versionCounter API Rejection**
|
||||
|
||||
Fixed integration test failures caused by n8n 1.118.1 API change where `versionCounter` property is returned in GET responses but rejected in PUT requests.
|
||||
|
||||
**Impact**:
|
||||
- Integration tests were failing with "request/body must NOT have additional properties" error
|
||||
- Workflow update operations via n8n API were failing
|
||||
|
||||
**Solution**:
|
||||
- Added `versionCounter` to property exclusion list in `cleanWorkflowForUpdate()` (src/services/n8n-validation.ts:136)
|
||||
- Added `versionCounter?: number` type definition to Workflow and WorkflowExport interfaces
|
||||
- Added test coverage to prevent regression
|
||||
|
||||
### ✅ Verification
|
||||
|
||||
- Database rebuild completed successfully
|
||||
- All node types validated
|
||||
- Documentation mappings updated
|
||||
|
||||
Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en
|
||||
|
||||
## [2.22.7] - 2025-10-26
|
||||
|
||||
### 📝 Documentation Fixes
|
||||
|
||||
**Issue #292: Corrected Array Property Removal Documentation in n8n_update_partial_workflow**
|
||||
|
||||
Fixed critical documentation error in property removal patterns that could have led users to write non-functional code.
|
||||
|
||||
#### Problem
|
||||
|
||||
The documentation incorrectly showed using array index notation `[0]` for removing array elements:
|
||||
```javascript
|
||||
// INCORRECT (doesn't work as shown)
|
||||
updates: { "parameters.headers[0]": undefined }
|
||||
```
|
||||
|
||||
**Root Cause**: The `setNestedProperty` implementation doesn't parse array index notation like `[0]`. It treats `headers[0]` as a literal object key, not an array index.
|
||||
|
||||
**Impact**: Users following the documentation would write code that doesn't behave as expected. The property `headers[0]` would be treated as an object key, not an array element reference.
|
||||
|
||||
#### Fixed
|
||||
|
||||
**Three documentation corrections in `src/mcp/tool-docs/workflow_management/n8n-update-partial-workflow.ts`:**
|
||||
|
||||
1. **Nested Property Removal Section** (lines 236-244):
|
||||
- Changed comment from `// Remove array element` to `// Remove entire array property`
|
||||
- Changed code from `"parameters.headers[0]": undefined` to `"parameters.headers": undefined`
|
||||
|
||||
2. **Example rm5** (line 340):
|
||||
- Changed comment from `// Remove array element` to `// Remove entire array property`
|
||||
- Changed code from `"parameters.headers[0]": undefined` to `"parameters.headers": undefined`
|
||||
|
||||
3. **Pitfalls Section** (line 405):
|
||||
- OLD: `'Array element removal with undefined removes the element at that index, which may shift subsequent indices'`
|
||||
- NEW: `'Array index notation (e.g., "parameters.headers[0]") is not supported - remove the entire array property instead'`
|
||||
|
||||
#### Correct Usage
|
||||
|
||||
**To remove an array property:**
|
||||
```javascript
|
||||
// Correct: Remove entire array
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_012",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "HTTP Request",
|
||||
updates: { "parameters.headers": undefined } // Remove entire headers array
|
||||
}]
|
||||
});
|
||||
```
|
||||
|
||||
**NOT:**
|
||||
```javascript
|
||||
// Incorrect: Array index notation doesn't work
|
||||
updates: { "parameters.headers[0]": undefined } // Treated as object key "headers[0]"
|
||||
```
|
||||
|
||||
#### Impact
|
||||
|
||||
- **Prevents User Confusion**: Clear documentation on what works vs. what doesn't
|
||||
- **Accurate Examples**: All examples now show correct, working patterns
|
||||
- **Better Error Prevention**: Pitfall warning helps users avoid this mistake
|
||||
- **No Code Changes**: This is purely a documentation fix - no implementation changes needed
|
||||
|
||||
#### Testing
|
||||
|
||||
- ✅ Documentation reviewed by code-reviewer agent
|
||||
- ✅ Tested by n8n-mcp-tester agent
|
||||
- ✅ All examples verified against actual implementation behavior
|
||||
- ✅ Pitfall accurately describes technical limitation
|
||||
|
||||
#### Files Changed
|
||||
|
||||
**Documentation (1 file)**:
|
||||
- `src/mcp/tool-docs/workflow_management/n8n-update-partial-workflow.ts` - Corrected 3 instances of array property removal documentation
|
||||
|
||||
**Configuration (2 files)**:
|
||||
- `package.json` - Version bump to 2.22.7
|
||||
- `package.runtime.json` - Version bump to 2.22.7
|
||||
|
||||
#### Related
|
||||
|
||||
- **Issue**: #292 - Missing documentation on how to remove node properties using `updateNode`
|
||||
- **PR**: #375 - Resolve GitHub Issue 292 in n8n-mcp
|
||||
- **Code Review**: Identified critical array index notation documentation error
|
||||
- **Root Cause**: Implementation doesn't parse array bracket notation `[N]`
|
||||
|
||||
Conceived by Romuald Członkowski - [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
|
||||
|
||||
## [2.22.6] - 2025-10-25
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
**Issue #228: Fix Docker Port Configuration Mismatch**
|
||||
|
||||
Fixed critical Docker configuration bug where custom PORT environment variable values were not properly mapped to container ports, causing connection failures in Docker deployments.
|
||||
|
||||
#### Problem
|
||||
- **docker-compose.yml**: Port mapping `"${PORT:-3000}:3000"` hardcoded container port to 3000
|
||||
- **docker-compose.yml**: Health check hardcoded to port 3000
|
||||
- **Dockerfile**: Health check hardcoded to port 3000
|
||||
- Impact: When PORT≠3000 (e.g., PORT=8080), Docker mapped host port to wrong container port
|
||||
|
||||
#### Solution
|
||||
- **docker-compose.yml line 44**: Changed port mapping to `"${PORT:-3000}:${PORT:-3000}"`
|
||||
- **docker-compose.yml line 56**: Updated health check to use dynamic port `$${PORT:-3000}`
|
||||
- **Dockerfile line 93**: Updated HEALTHCHECK to use dynamic port `${PORT:-3000}`
|
||||
- **Dockerfile line 85**: Added clarifying comment about PORT configurability
|
||||
|
||||
#### Testing
|
||||
- Verified with default PORT (3000)
|
||||
- Verified with custom PORT (8080)
|
||||
- Health checks work correctly in both scenarios
|
||||
|
||||
#### Related Issues
|
||||
- Fixes #228 (Docker Compose port error)
|
||||
- Likely fixes #109 (Configuration ignored in HTTP mode)
|
||||
- Likely fixes #84 (Can't access container)
|
||||
|
||||
Conceived by Romuald Członkowski - [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
|
||||
|
||||
## [2.22.3] - 2025-10-25
|
||||
|
||||
### 🔧 Code Quality Improvements
|
||||
|
||||
**Issue #349: Refactor n8n API Response Validation (PR #367)**
|
||||
|
||||
Improved code maintainability and added comprehensive test coverage for defensive response validation added in PR #367.
|
||||
|
||||
#### Refactoring
|
||||
|
||||
**1. Eliminated DRY Violation**
|
||||
- Extracted duplicated validation logic into `validateListResponse<T>()` helper method
|
||||
- Reduced code duplication from 88 lines to single reusable function
|
||||
- Impact: 75% reduction in validation code, easier maintenance
|
||||
|
||||
**2. Enhanced Error Handling**
|
||||
- Consistent error message format across all list operations
|
||||
- Limited error message verbosity (max 5 keys shown to prevent information exposure)
|
||||
- Added security protection against data structure exposure
|
||||
- Better error messages: `got object with keys: [data, items, total, hasMore, meta]`
|
||||
|
||||
**3. Improved Documentation**
|
||||
- Added JSDoc comments explaining backwards compatibility
|
||||
- Documented modern vs legacy response formats
|
||||
- Referenced issue #349 for context
|
||||
|
||||
#### Testing
|
||||
|
||||
**Added Comprehensive Unit Tests** (29 new test cases)
|
||||
- Legacy array format wrapping for all 4 methods
|
||||
- Null/undefined response handling
|
||||
- Primitive type rejection (string, number, boolean)
|
||||
- Invalid structure detection
|
||||
- Non-array data field validation
|
||||
- Error message truncation with many keys
|
||||
- 100% coverage of new validation logic
|
||||
|
||||
**Test Coverage Results**:
|
||||
- Before: 0% coverage of validation scenarios
|
||||
- After: 100% coverage (29/29 scenarios tested)
|
||||
- All validation paths exercised and verified
|
||||
|
||||
#### Impact
|
||||
|
||||
**Code Quality**:
|
||||
- ✅ DRY principle restored (no duplication)
|
||||
- ✅ Type safety improved with generics
|
||||
- ✅ Consistent error handling across all methods
|
||||
- ✅ Well-documented backwards compatibility
|
||||
|
||||
**Maintainability**:
|
||||
- ✅ Single source of truth for validation logic
|
||||
- ✅ Future bug fixes apply to all methods automatically
|
||||
- ✅ Easier to understand and modify
|
||||
|
||||
**Security**:
|
||||
- ✅ Limited information exposure in error messages
|
||||
- ✅ Protection against verbose error logs
|
||||
|
||||
**Testing**:
|
||||
- ✅ Full test coverage prevents regressions
|
||||
- ✅ All edge cases validated
|
||||
- ✅ Backwards compatibility verified
|
||||
|
||||
#### Files Modified
|
||||
|
||||
**Code (1 file)**:
|
||||
- `src/services/n8n-api-client.ts`
|
||||
- Added `validateListResponse<T>()` private helper method (44 lines)
|
||||
- Refactored listWorkflows, listExecutions, listCredentials, listTags (reduced from ~100 lines to ~20 lines)
|
||||
- Added JSDoc documentation to all 4 list methods
|
||||
- Net reduction: ~80 lines of code
|
||||
|
||||
**Tests (1 file)**:
|
||||
- `tests/unit/services/n8n-api-client.test.ts`
|
||||
- Added 29 comprehensive validation test cases (237 lines)
|
||||
- Coverage for all 4 list methods
|
||||
- Tests for legacy format, null responses, invalid structures, key truncation
|
||||
|
||||
**Configuration (1 file)**:
|
||||
- `package.json` - Version bump to 2.22.3
|
||||
|
||||
#### Technical Details
|
||||
|
||||
**Helper Method Signature**:
|
||||
```typescript
|
||||
private validateListResponse<T>(
|
||||
responseData: any,
|
||||
resourceType: string
|
||||
): { data: T[]; nextCursor?: string | null }
|
||||
```
|
||||
|
||||
**Error Message Example**:
|
||||
```
|
||||
Invalid response from n8n API for workflows: expected {data: [], nextCursor?: string},
|
||||
got object with keys: [items, total, hasMore, page, limit]...
|
||||
```
|
||||
|
||||
**Usage Example**:
|
||||
```typescript
|
||||
async listWorkflows(params: WorkflowListParams = {}): Promise<WorkflowListResponse> {
|
||||
try {
|
||||
const response = await this.client.get('/workflows', { params });
|
||||
return this.validateListResponse<Workflow>(response.data, 'workflows');
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Related
|
||||
|
||||
- **Issue**: #349 - Response validation for n8n API list operations
|
||||
- **PR**: #367 - Add defensive response validation (original implementation)
|
||||
- **Code Review**: Identified DRY violation and missing test coverage
|
||||
- **Testing**: Validated by n8n-mcp-tester agent
|
||||
- **Analysis**: Both agents confirmed functional correctness, recommended refactoring
|
||||
|
||||
Conceived by Romuald Członkowski - [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
|
||||
|
||||
---
|
||||
|
||||
### ✨ Enhancements
|
||||
|
||||
**Issue #361: Enhanced HTTP Request Node Validation Suggestions**
|
||||
|
||||
Added helpful suggestions for HTTP Request node best practices to prevent common production issues discovered through real-world workflow analysis.
|
||||
|
||||
#### What's New
|
||||
|
||||
1. **alwaysOutputData Suggestion**
|
||||
- Suggests adding `alwaysOutputData: true` at node level (not in parameters)
|
||||
- Prevents silent workflow failures when HTTP requests error
|
||||
- Ensures downstream error handling can process failed requests
|
||||
- Example suggestion: "Consider adding alwaysOutputData: true at node level for better error handling. This ensures the node produces output even when HTTP requests fail, allowing downstream error handling."
|
||||
|
||||
2. **responseFormat Suggestion for API Endpoints**
|
||||
- Suggests setting `options.response.response.responseFormat` for API endpoints
|
||||
- Prevents JSON parsing confusion
|
||||
- Triggered when URL contains `/api`, `/rest`, `supabase`, `firebase`, `googleapis`, or `.com/v` patterns
|
||||
- Example suggestion: "API endpoints should explicitly set options.response.response.responseFormat to 'json' or 'text' to prevent confusion about response parsing"
|
||||
|
||||
3. **Enhanced URL Protocol Validation**
|
||||
- Detects missing protocol in expression-based URLs
|
||||
- Warns about patterns like `=www.{{ $json.domain }}.com` (missing http://)
|
||||
- Warns about expressions without protocol: `={{ $json.domain }}/api/data`
|
||||
- Example warning: "URL expression appears to be missing http:// or https:// protocol"
|
||||
|
||||
#### Investigation Findings
|
||||
|
||||
This enhancement was developed after thorough investigation of issue #361:
|
||||
|
||||
**Key Discoveries:**
|
||||
- ✅ Mixed expression syntax `=literal{{ expression }}` **actually works in n8n** - the issue report's primary claim was incorrect
|
||||
- ✅ Real validation gaps identified: missing `alwaysOutputData` and `responseFormat` checks
|
||||
- ✅ Workflow analysis showed "?" icon in UI caused by missing required URL (already caught by validation)
|
||||
- ✅ Compared broken vs fixed workflows to identify actual production issues
|
||||
|
||||
**Testing Evidence:**
|
||||
- Analyzed workflow SwjKJsJhe8OsYfBk with mixed syntax - executions successful
|
||||
- Compared broken workflow (mBmkyj460i5rYTG4) with fixed workflow (hQI9pby3nSFtk4TV)
|
||||
- Identified that fixed workflow has `alwaysOutputData: true` and explicit `responseFormat: "json"`
|
||||
|
||||
#### Impact
|
||||
|
||||
- **Non-Breaking**: All changes are suggestions/warnings, not errors
|
||||
- **Profile-Aware**: Suggestions shown in all profiles for maximum helpfulness
|
||||
- **Actionable**: Clear guidance on how to implement best practices
|
||||
- **Production-Focused**: Addresses real workflow reliability concerns from actual broken workflows
|
||||
|
||||
#### Test Coverage
|
||||
|
||||
Added 8 new test cases covering:
|
||||
- alwaysOutputData suggestion for all HTTP Request nodes
|
||||
- responseFormat suggestion for API endpoint detection (various patterns)
|
||||
- responseFormat NOT suggested when already configured
|
||||
- URL protocol validation for expression-based URLs
|
||||
- Protocol warnings for missing http:// in expressions
|
||||
- No false positives when protocol is correctly included
|
||||
|
||||
#### Technical Details
|
||||
|
||||
**Files Modified:**
|
||||
- `src/services/enhanced-config-validator.ts` - Added `enhanceHttpRequestValidation()` implementation
|
||||
- `tests/unit/services/enhanced-config-validator.test.ts` - Added 8 comprehensive test cases
|
||||
|
||||
**Validation Flow:**
|
||||
1. Check for alwaysOutputData suggestion (all HTTP Request nodes)
|
||||
2. Detect API endpoints by URL patterns
|
||||
3. Check for explicit responseFormat configuration
|
||||
4. Validate expression-based URLs for protocol issues
|
||||
|
||||
#### Related
|
||||
|
||||
- **Issue**: #361 - validate_node_operation: Missing critical HTTP Request node configuration checks
|
||||
- **Analysis**: Deep investigation with @agent-Explore and @agent-n8n-mcp-tester
|
||||
- **Workflows Analyzed**:
|
||||
- SwjKJsJhe8OsYfBk (mixed syntax test)
|
||||
- mBmkyj460i5rYTG4 (broken workflow)
|
||||
- hQI9pby3nSFtk4TV (fixed workflow)
|
||||
|
||||
Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en
|
||||
|
||||
---
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
**Issue #360: Enhanced Warnings for If/Switch Node Connection Parameters**
|
||||
|
||||
Fixed issue where users could unintentionally place multiple If node connections on the same branch (TRUE/FALSE) when using `sourceIndex` parameter instead of the recommended `branch` parameter. The system now provides helpful warnings to guide users toward better practices.
|
||||
|
||||
#### What Was Fixed
|
||||
|
||||
1. **New Warning System**:
|
||||
- Warns when using `sourceIndex` with If nodes - suggests `branch="true"` or `branch="false"` instead
|
||||
- Warns when using `sourceIndex` with Switch nodes - suggests `case=N` instead
|
||||
- Explains the correct branch structure: `main[0]=TRUE branch, main[1]=FALSE branch`
|
||||
|
||||
2. **Enhanced Documentation**:
|
||||
- Added **CRITICAL** pitfalls to `n8n_update_partial_workflow` tool documentation
|
||||
- Clear guidance that using `sourceIndex=0` for multiple connections puts them ALL on the TRUE branch
|
||||
- Examples showing correct vs. incorrect usage
|
||||
|
||||
3. **Type System Improvements**:
|
||||
- Added `warnings` field to `WorkflowDiffResult` interface
|
||||
- Warnings are non-blocking (operations still succeed)
|
||||
- Differentiated from errors for better UX
|
||||
|
||||
#### Behavior
|
||||
|
||||
The existing `branch` parameter works correctly and has comprehensive test coverage:
|
||||
- `branch="true"` → routes to `main[0]` (TRUE path)
|
||||
- `branch="false"` → routes to `main[1]` (FALSE path)
|
||||
|
||||
The issue was that users who didn't know about the `branch` parameter would naturally use `sourceIndex`, which led to incorrect branch routing.
|
||||
|
||||
#### Example Warning
|
||||
|
||||
```
|
||||
Connection to If node "Check Condition" uses sourceIndex=0.
|
||||
Consider using branch="true" or branch="false" for better clarity.
|
||||
If node outputs: main[0]=TRUE branch, main[1]=FALSE branch.
|
||||
```
|
||||
|
||||
#### Test Coverage
|
||||
|
||||
- Added regression tests that reproduce the exact issue from #360
|
||||
- Verify warnings are generated for If and Switch nodes
|
||||
- Confirm existing smart parameter tests still pass
|
||||
|
||||
**Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en**
|
||||
|
||||
---
|
||||
|
||||
### ✨ New Features
|
||||
|
||||
**Auto-Update Node Versions with Smart Migration**
|
||||
|
||||
@@ -82,7 +82,7 @@ ENV IS_DOCKER=true
|
||||
# To opt-out, uncomment the following line:
|
||||
# ENV N8N_MCP_TELEMETRY_DISABLED=true
|
||||
|
||||
# Expose HTTP port
|
||||
# Expose HTTP port (default 3000, configurable via PORT environment variable at runtime)
|
||||
EXPOSE 3000
|
||||
|
||||
# Set stop signal to SIGTERM (default, but explicit is better)
|
||||
@@ -90,7 +90,7 @@ STOPSIGNAL SIGTERM
|
||||
|
||||
# Health check
|
||||
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
|
||||
CMD curl -f http://127.0.0.1:3000/health || exit 1
|
||||
CMD sh -c 'curl -f http://127.0.0.1:${PORT:-3000}/health || exit 1'
|
||||
|
||||
# Optimized entrypoint
|
||||
ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
|
||||
|
||||
@@ -1,5 +1,87 @@
|
||||
# n8n Update Process - Quick Reference
|
||||
|
||||
## ⚡ Recommended Fast Workflow (2025-11-04)
|
||||
|
||||
**CRITICAL FIRST STEP**: Check existing releases to avoid version conflicts!
|
||||
|
||||
```bash
|
||||
# 1. CHECK EXISTING RELEASES FIRST (prevents version conflicts!)
|
||||
gh release list | head -5
|
||||
# Look at the latest version - your new version must be higher!
|
||||
|
||||
# 2. Switch to main and pull
|
||||
git checkout main && git pull
|
||||
|
||||
# 3. Check for updates (dry run)
|
||||
npm run update:n8n:check
|
||||
|
||||
# 4. Run update and skip tests (we'll test in CI)
|
||||
yes y | npm run update:n8n
|
||||
|
||||
# 5. Create feature branch
|
||||
git checkout -b update/n8n-X.X.X
|
||||
|
||||
# 6. Update version in package.json (must be HIGHER than latest release!)
|
||||
# Edit: "version": "2.XX.X" (not the version from the release list!)
|
||||
|
||||
# 7. Update CHANGELOG.md
|
||||
# - Change version number to match package.json
|
||||
# - Update date to today
|
||||
# - Update dependency versions
|
||||
|
||||
# 8. Update README badge
|
||||
# Edit line 8: Change n8n version badge to new n8n version
|
||||
|
||||
# 9. Commit and push
|
||||
git add -A
|
||||
git commit -m "chore: update n8n to X.X.X and bump version to 2.XX.X
|
||||
|
||||
- Updated n8n from X.X.X to X.X.X
|
||||
- Updated n8n-core from X.X.X to X.X.X
|
||||
- Updated n8n-workflow from X.X.X to X.X.X
|
||||
- Updated @n8n/n8n-nodes-langchain from X.X.X to X.X.X
|
||||
- Rebuilt node database with XXX nodes (XXX from n8n-nodes-base, XXX from @n8n/n8n-nodes-langchain)
|
||||
- Updated README badge with new n8n version
|
||||
- Updated CHANGELOG with dependency changes
|
||||
|
||||
Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude <noreply@anthropic.com>"
|
||||
|
||||
git push -u origin update/n8n-X.X.X
|
||||
|
||||
# 10. Create PR
|
||||
gh pr create --title "chore: update n8n to X.X.X" --body "Updates n8n and all related dependencies to the latest versions..."
|
||||
|
||||
# 11. After PR is merged, verify release triggered
|
||||
gh release list | head -1
|
||||
# If the new version appears, you're done!
|
||||
# If not, the version might have already been released - bump version again and create new PR
|
||||
```
|
||||
|
||||
### Why This Workflow?
|
||||
|
||||
✅ **Fast**: Skip local tests (2-3 min saved) - CI runs them anyway
|
||||
✅ **Safe**: Unit tests in CI verify compatibility
|
||||
✅ **Clean**: All changes in one PR with proper tracking
|
||||
✅ **Automatic**: Release workflow triggers on merge if version is new
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Problem**: Release workflow doesn't trigger after merge
|
||||
**Cause**: Version number was already released (check `gh release list`)
|
||||
**Solution**: Create new PR bumping version by one patch number
|
||||
|
||||
**Problem**: Integration tests fail in CI with "unauthorized"
|
||||
**Cause**: n8n test instance credentials expired (infrastructure issue)
|
||||
**Solution**: Ignore if unit tests pass - this is not a code problem
|
||||
|
||||
**Problem**: CI takes 8+ minutes
|
||||
**Reason**: Integration tests need live n8n instance (slow)
|
||||
**Normal**: Unit tests (~2 min) + integration tests (~6 min) = ~8 min total
|
||||
|
||||
## Quick One-Command Update
|
||||
|
||||
For a complete update with tests and publish preparation:
|
||||
@@ -99,12 +181,14 @@ This command:
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Always run on main branch** - Make sure you're on main and it's clean
|
||||
2. **The update script is smart** - It automatically syncs all n8n dependencies to compatible versions
|
||||
3. **Tests are required** - The publish script now runs tests automatically
|
||||
4. **Database rebuild is automatic** - The update script handles this for you
|
||||
5. **Template sanitization is automatic** - Any API tokens in workflow templates are replaced with placeholders
|
||||
6. **Docker image builds automatically** - Pushing to GitHub triggers the workflow
|
||||
1. **ALWAYS check existing releases first** - Use `gh release list` to see what versions are already released. Your new version must be higher!
|
||||
2. **Release workflow only triggers on version CHANGE** - If you merge a PR with an already-released version (e.g., 2.22.8), the workflow won't run. You'll need to bump to a new version (e.g., 2.22.9) and create another PR.
|
||||
3. **Integration test failures in CI are usually infrastructure issues** - If unit tests pass but integration tests fail with "unauthorized", this is typically because the test n8n instance credentials need updating. The code itself is fine.
|
||||
4. **Skip local tests - let CI handle them** - Running tests locally adds 2-3 minutes with no benefit since CI runs them anyway. The fast workflow skips local tests.
|
||||
5. **The update script is smart** - It automatically syncs all n8n dependencies to compatible versions
|
||||
6. **Database rebuild is automatic** - The update script handles this for you
|
||||
7. **Template sanitization is automatic** - Any API tokens in workflow templates are replaced with placeholders
|
||||
8. **Docker image builds automatically** - Pushing to GitHub triggers the workflow
|
||||
|
||||
## GitHub Push Protection
|
||||
|
||||
@@ -115,11 +199,27 @@ As of July 2025, GitHub's push protection may block database pushes if they cont
|
||||
3. If push is still blocked, use the GitHub web interface to review and allow the push
|
||||
|
||||
## Time Estimate
|
||||
|
||||
### Fast Workflow (Recommended)
|
||||
- Local work: ~2-3 minutes
|
||||
- npm install and database rebuild: ~2-3 minutes
|
||||
- File edits (CHANGELOG, README, package.json): ~30 seconds
|
||||
- Git operations (commit, push, create PR): ~30 seconds
|
||||
- CI testing after PR creation: ~8-10 minutes (runs automatically)
|
||||
- Unit tests: ~2 minutes
|
||||
- Integration tests: ~6 minutes (may fail with infrastructure issues - ignore if unit tests pass)
|
||||
- Other checks: ~1 minute
|
||||
|
||||
**Total hands-on time: ~3 minutes** (then wait for CI)
|
||||
|
||||
### Full Workflow with Local Tests
|
||||
- Total time: ~5-7 minutes
|
||||
- Test suite: ~2.5 minutes
|
||||
- npm install and database rebuild: ~2-3 minutes
|
||||
- The rest: seconds
|
||||
|
||||
**Note**: The fast workflow is recommended since CI runs the same tests anyway.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If tests fail:
|
||||
|
||||
@@ -54,6 +54,10 @@ Collected data is used solely to:
|
||||
- Identify common error patterns
|
||||
- Improve tool performance and reliability
|
||||
- Guide development priorities
|
||||
- Train machine learning models for workflow generation
|
||||
|
||||
All ML training uses sanitized, anonymized data only.
|
||||
Users can opt-out at any time with `npx n8n-mcp telemetry disable`
|
||||
|
||||
## Data Retention
|
||||
- Data is retained for analysis purposes
|
||||
@@ -66,4 +70,4 @@ We may update this privacy policy from time to time. Updates will be reflected i
|
||||
For questions about telemetry or privacy, please open an issue on GitHub:
|
||||
https://github.com/czlonkowski/n8n-mcp/issues
|
||||
|
||||
Last updated: 2025-09-25
|
||||
Last updated: 2025-11-06
|
||||
34
README.md
34
README.md
@@ -5,23 +5,23 @@
|
||||
[](https://www.npmjs.com/package/n8n-mcp)
|
||||
[](https://codecov.io/gh/czlonkowski/n8n-mcp)
|
||||
[](https://github.com/czlonkowski/n8n-mcp/actions)
|
||||
[](https://github.com/n8n-io/n8n)
|
||||
[](https://github.com/n8n-io/n8n)
|
||||
[](https://github.com/czlonkowski/n8n-mcp/pkgs/container/n8n-mcp)
|
||||
[](https://railway.com/deploy/n8n-mcp?referralCode=n8n-mcp)
|
||||
|
||||
A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to n8n node documentation, properties, and operations. Deploy in minutes to give Claude and other AI assistants deep knowledge about n8n's 525+ workflow automation nodes.
|
||||
A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to n8n node documentation, properties, and operations. Deploy in minutes to give Claude and other AI assistants deep knowledge about n8n's 541 workflow automation nodes.
|
||||
|
||||
## Overview
|
||||
|
||||
n8n-MCP serves as a bridge between n8n's workflow automation platform and AI models, enabling them to understand and work with n8n nodes effectively. It provides structured access to:
|
||||
|
||||
- 📚 **536 n8n nodes** from both n8n-nodes-base and @n8n/n8n-nodes-langchain
|
||||
- 📚 **541 n8n nodes** from both n8n-nodes-base and @n8n/n8n-nodes-langchain
|
||||
- 🔧 **Node properties** - 99% coverage with detailed schemas
|
||||
- ⚡ **Node operations** - 63.6% coverage of available actions
|
||||
- 📄 **Documentation** - 90% coverage from official n8n docs (including AI nodes)
|
||||
- 🤖 **AI tools** - 263 AI-capable nodes detected with full documentation
|
||||
- 📄 **Documentation** - 87% coverage from official n8n docs (including AI nodes)
|
||||
- 🤖 **AI tools** - 271 AI-capable nodes detected with full documentation
|
||||
- 💡 **Real-world examples** - 2,646 pre-extracted configurations from popular templates
|
||||
- 🎯 **Template library** - 2,500+ workflow templates with smart filtering
|
||||
- 🎯 **Template library** - 2,709 workflow templates with 100% metadata coverage
|
||||
|
||||
|
||||
## ⚠️ Important Safety Warning
|
||||
@@ -51,6 +51,8 @@ npx n8n-mcp
|
||||
|
||||
Add to Claude Desktop config:
|
||||
|
||||
> ⚠️ **Important**: The `MCP_MODE: "stdio"` environment variable is **required** for Claude Desktop. Without it, you will see JSON parsing errors like `"Unexpected token..."` in the UI. This variable ensures that only JSON-RPC messages are sent to stdout, preventing debug logs from interfering with the protocol.
|
||||
|
||||
**Basic configuration (documentation tools only):**
|
||||
```json
|
||||
{
|
||||
@@ -531,7 +533,7 @@ When operations are independent, execute them in parallel for maximum performanc
|
||||
❌ BAD: Sequential tool calls (await each one before the next)
|
||||
|
||||
### 3. Templates First
|
||||
ALWAYS check templates before building from scratch (2,500+ available).
|
||||
ALWAYS check templates before building from scratch (2,709 available).
|
||||
|
||||
### 4. Multi-Level Validation
|
||||
Use validate_node_minimal → validate_node_operation → validate_workflow pattern.
|
||||
@@ -840,7 +842,7 @@ n8n_update_partial_workflow({
|
||||
### Core Behavior
|
||||
1. **Silent execution** - No commentary between tools
|
||||
2. **Parallel by default** - Execute independent operations simultaneously
|
||||
3. **Templates first** - Always check before building (2,500+ available)
|
||||
3. **Templates first** - Always check before building (2,709 available)
|
||||
4. **Multi-level validation** - Quick check → Full validation → Workflow validation
|
||||
5. **Never trust defaults** - Explicitly configure ALL parameters
|
||||
|
||||
@@ -943,7 +945,7 @@ Once connected, Claude can use these powerful tools:
|
||||
- **`get_node_as_tool_info`** - Get guidance on using any node as an AI tool
|
||||
|
||||
### Template Tools
|
||||
- **`list_templates`** - Browse all templates with descriptions and optional metadata (2,500+ templates)
|
||||
- **`list_templates`** - Browse all templates with descriptions and optional metadata (2,709 templates)
|
||||
- **`search_templates`** - Text search across template names and descriptions
|
||||
- **`search_templates_by_metadata`** - Advanced filtering by complexity, setup time, services, audience
|
||||
- **`list_node_templates`** - Find templates using specific nodes
|
||||
@@ -1098,17 +1100,17 @@ npm run dev:http # HTTP dev mode
|
||||
|
||||
## 📊 Metrics & Coverage
|
||||
|
||||
Current database coverage (n8n v1.113.3):
|
||||
Current database coverage (n8n v1.117.2):
|
||||
|
||||
- ✅ **536/536** nodes loaded (100%)
|
||||
- ✅ **528** nodes with properties (98.7%)
|
||||
- ✅ **470** nodes with documentation (88%)
|
||||
- ✅ **267** AI-capable tools detected
|
||||
- ✅ **541/541** nodes loaded (100%)
|
||||
- ✅ **541** nodes with properties (100%)
|
||||
- ✅ **470** nodes with documentation (87%)
|
||||
- ✅ **271** AI-capable tools detected
|
||||
- ✅ **2,646** pre-extracted template configurations
|
||||
- ✅ **2,500+** workflow templates available
|
||||
- ✅ **2,709** workflow templates available (100% metadata coverage)
|
||||
- ✅ **AI Agent & LangChain nodes** fully documented
|
||||
- ⚡ **Average response time**: ~12ms
|
||||
- 💾 **Database size**: ~15MB (optimized)
|
||||
- 💾 **Database size**: ~68MB (includes templates with metadata)
|
||||
|
||||
## 🔄 Recent Updates
|
||||
|
||||
|
||||
BIN
data/nodes.db
BIN
data/nodes.db
Binary file not shown.
@@ -20,19 +20,19 @@ services:
|
||||
image: n8n-mcp:latest
|
||||
container_name: n8n-mcp
|
||||
ports:
|
||||
- "3000:3000"
|
||||
- "${PORT:-3000}:${PORT:-3000}"
|
||||
environment:
|
||||
- MCP_MODE=${MCP_MODE:-http}
|
||||
- AUTH_TOKEN=${AUTH_TOKEN}
|
||||
- NODE_ENV=${NODE_ENV:-production}
|
||||
- LOG_LEVEL=${LOG_LEVEL:-info}
|
||||
- PORT=3000
|
||||
- PORT=${PORT:-3000}
|
||||
volumes:
|
||||
# Mount data directory for persistence
|
||||
- ./data:/app/data
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
|
||||
test: ["CMD", "sh", "-c", "curl -f http://localhost:$${PORT:-3000}/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
@@ -37,11 +37,12 @@ services:
|
||||
container_name: n8n-mcp
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "${MCP_PORT:-3000}:3000"
|
||||
- "${MCP_PORT:-3000}:${MCP_PORT:-3000}"
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
- N8N_MODE=true
|
||||
- MCP_MODE=http
|
||||
- PORT=${MCP_PORT:-3000}
|
||||
- N8N_API_URL=http://n8n:5678
|
||||
- N8N_API_KEY=${N8N_API_KEY}
|
||||
- MCP_AUTH_TOKEN=${MCP_AUTH_TOKEN}
|
||||
@@ -56,7 +57,7 @@ services:
|
||||
n8n:
|
||||
condition: service_healthy
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
|
||||
test: ["CMD", "sh", "-c", "curl -f http://localhost:$${MCP_PORT:-3000}/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
@@ -41,7 +41,7 @@ services:
|
||||
|
||||
# Port mapping
|
||||
ports:
|
||||
- "${PORT:-3000}:3000"
|
||||
- "${PORT:-3000}:${PORT:-3000}"
|
||||
|
||||
# Resource limits
|
||||
deploy:
|
||||
@@ -53,7 +53,7 @@ services:
|
||||
|
||||
# Health check
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://127.0.0.1:3000/health"]
|
||||
test: ["CMD", "sh", "-c", "curl -f http://127.0.0.1:$${PORT:-3000}/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
@@ -4,7 +4,9 @@ Connect n8n-MCP to Claude Code CLI for enhanced n8n workflow development from th
|
||||
|
||||
## Quick Setup via CLI
|
||||
|
||||
### Basic configuration (documentation tools only):
|
||||
### Basic configuration (documentation tools only)
|
||||
|
||||
**For Linux, macOS, or Windows (WSL/Git Bash):**
|
||||
```bash
|
||||
claude mcp add n8n-mcp \
|
||||
-e MCP_MODE=stdio \
|
||||
@@ -13,9 +15,21 @@ claude mcp add n8n-mcp \
|
||||
-- npx n8n-mcp
|
||||
```
|
||||
|
||||
**For native Windows PowerShell:**
|
||||
```powershell
|
||||
# Note: The backtick ` is PowerShell's line continuation character.
|
||||
claude mcp add n8n-mcp `
|
||||
'-e MCP_MODE=stdio' `
|
||||
'-e LOG_LEVEL=error' `
|
||||
'-e DISABLE_CONSOLE_OUTPUT=true' `
|
||||
-- npx n8n-mcp
|
||||
```
|
||||
|
||||

|
||||
|
||||
### Full configuration (with n8n management tools):
|
||||
### Full configuration (with n8n management tools)
|
||||
|
||||
**For Linux, macOS, or Windows (WSL/Git Bash):**
|
||||
```bash
|
||||
claude mcp add n8n-mcp \
|
||||
-e MCP_MODE=stdio \
|
||||
@@ -26,6 +40,18 @@ claude mcp add n8n-mcp \
|
||||
-- npx n8n-mcp
|
||||
```
|
||||
|
||||
**For native Windows PowerShell:**
|
||||
```powershell
|
||||
# Note: The backtick ` is PowerShell's line continuation character.
|
||||
claude mcp add n8n-mcp `
|
||||
'-e MCP_MODE=stdio' `
|
||||
'-e LOG_LEVEL=error' `
|
||||
'-e DISABLE_CONSOLE_OUTPUT=true' `
|
||||
'-e N8N_API_URL=https://your-n8n-instance.com' `
|
||||
'-e N8N_API_KEY=your-api-key' `
|
||||
-- npx n8n-mcp
|
||||
```
|
||||
|
||||
Make sure to replace `https://your-n8n-instance.com` with your actual n8n URL and `your-api-key` with your n8n API key.
|
||||
|
||||
## Alternative Setup Methods
|
||||
@@ -133,9 +159,11 @@ For optimal results, create a `CLAUDE.md` file in your project root with the ins
|
||||
|
||||
## Tips
|
||||
|
||||
- If you're running n8n locally, use `http://localhost:5678` as the N8N_API_URL
|
||||
- The n8n API credentials are optional - without them, you'll have documentation and validation tools only
|
||||
- With API credentials, you'll get full workflow management capabilities
|
||||
- Use `--scope local` (default) to keep your API credentials private
|
||||
- Use `--scope project` to share configuration with your team (put credentials in environment variables)
|
||||
- Claude Code will automatically start the MCP server when you begin a conversation
|
||||
- If you're running n8n locally, use `http://localhost:5678` as the `N8N_API_URL`.
|
||||
- The n8n API credentials are optional. Without them, you'll only have access to documentation and validation tools. With credentials, you get full workflow management capabilities.
|
||||
- **Scope Management:**
|
||||
- By default, `claude mcp add` uses `--scope local` (also called "user scope"), which saves the configuration to your global user settings and keeps API keys private.
|
||||
- To share the configuration with your team, use `--scope project`. This saves the configuration to a `.mcp.json` file in your project's root directory.
|
||||
- **Switching Scope:** The cleanest method is to `remove` the server and then `add` it back with the desired scope flag (e.g., `claude mcp remove n8n-mcp` followed by `claude mcp add n8n-mcp --scope project`).
|
||||
- **Manual Switching (Advanced):** You can manually edit your `.claude.json` file (e.g., `C:\Users\YourName\.claude.json`). To switch, cut the `"n8n-mcp": { ... }` block from the top-level `"mcpServers"` object (user scope) and paste it into the nested `"mcpServers"` object under your project's path key (project scope), or vice versa. **Important:** You may need to restart Claude Code for manual changes to take effect.
|
||||
- Claude Code will automatically start the MCP server when you begin a conversation.
|
||||
|
||||
@@ -59,10 +59,10 @@ docker compose up -d
|
||||
- n8n-mcp-data:/app/data
|
||||
|
||||
ports:
|
||||
- "${PORT:-3000}:3000"
|
||||
|
||||
- "${PORT:-3000}:${PORT:-3000}"
|
||||
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://127.0.0.1:3000/health"]
|
||||
test: ["CMD", "sh", "-c", "curl -f http://127.0.0.1:$${PORT:-3000}/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
@@ -162,7 +162,7 @@ n8n_validate_workflow({id: createdWorkflowId})
|
||||
n8n_update_partial_workflow({
|
||||
workflowId: id,
|
||||
operations: [
|
||||
{type: 'updateNode', nodeId: 'slack1', changes: {position: [100, 200]}}
|
||||
{type: 'updateNode', nodeId: 'slack1', updates: {position: [100, 200]}}
|
||||
]
|
||||
})
|
||||
|
||||
|
||||
1923
package-lock.json
generated
1923
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
10
package.json
10
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "n8n-mcp",
|
||||
"version": "2.22.0",
|
||||
"version": "2.22.12",
|
||||
"description": "Integration between n8n workflow automation and Model Context Protocol (MCP)",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
@@ -140,15 +140,15 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@modelcontextprotocol/sdk": "^1.20.1",
|
||||
"@n8n/n8n-nodes-langchain": "^1.115.1",
|
||||
"@n8n/n8n-nodes-langchain": "^1.117.0",
|
||||
"@supabase/supabase-js": "^2.57.4",
|
||||
"dotenv": "^16.5.0",
|
||||
"express": "^5.1.0",
|
||||
"express-rate-limit": "^7.1.5",
|
||||
"lru-cache": "^11.2.1",
|
||||
"n8n": "^1.116.2",
|
||||
"n8n-core": "^1.115.1",
|
||||
"n8n-workflow": "^1.113.0",
|
||||
"n8n": "^1.118.1",
|
||||
"n8n-core": "^1.117.0",
|
||||
"n8n-workflow": "^1.115.0",
|
||||
"openai": "^4.77.0",
|
||||
"sql.js": "^1.13.0",
|
||||
"tslib": "^2.6.2",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "n8n-mcp-runtime",
|
||||
"version": "2.22.0",
|
||||
"version": "2.22.11",
|
||||
"description": "n8n MCP Server Runtime Dependencies Only",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
|
||||
45
scripts/generate-initial-release-notes.js
Normal file
45
scripts/generate-initial-release-notes.js
Normal file
@@ -0,0 +1,45 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Generate release notes for the initial release
|
||||
* Used by GitHub Actions when no previous tag exists
|
||||
*/
|
||||
|
||||
const { execSync } = require('child_process');
|
||||
|
||||
function generateInitialReleaseNotes(version) {
|
||||
try {
|
||||
// Get total commit count
|
||||
const commitCount = execSync('git rev-list --count HEAD', { encoding: 'utf8' }).trim();
|
||||
|
||||
// Generate release notes
|
||||
const releaseNotes = [
|
||||
'### 🎉 Initial Release',
|
||||
'',
|
||||
`This is the initial release of n8n-mcp v${version}.`,
|
||||
'',
|
||||
'---',
|
||||
'',
|
||||
'**Release Statistics:**',
|
||||
`- Commit count: ${commitCount}`,
|
||||
'- First release setup'
|
||||
];
|
||||
|
||||
return releaseNotes.join('\n');
|
||||
|
||||
} catch (error) {
|
||||
console.error(`Error generating initial release notes: ${error.message}`);
|
||||
return `Failed to generate initial release notes: ${error.message}`;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse command line arguments
|
||||
const version = process.argv[2];
|
||||
|
||||
if (!version) {
|
||||
console.error('Usage: generate-initial-release-notes.js <version>');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const releaseNotes = generateInitialReleaseNotes(version);
|
||||
console.log(releaseNotes);
|
||||
99
scripts/process-batch-metadata.ts
Normal file
99
scripts/process-batch-metadata.ts
Normal file
@@ -0,0 +1,99 @@
|
||||
#!/usr/bin/env ts-node
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { createDatabaseAdapter } from '../src/database/database-adapter';
|
||||
|
||||
interface BatchResponse {
|
||||
id: string;
|
||||
custom_id: string;
|
||||
response: {
|
||||
status_code: number;
|
||||
body: {
|
||||
choices: Array<{
|
||||
message: {
|
||||
content: string;
|
||||
};
|
||||
}>;
|
||||
};
|
||||
};
|
||||
error: any;
|
||||
}
|
||||
|
||||
async function processBatchMetadata(batchFile: string) {
|
||||
console.log(`📥 Processing batch file: ${batchFile}`);
|
||||
|
||||
// Read the JSONL file
|
||||
const content = fs.readFileSync(batchFile, 'utf-8');
|
||||
const lines = content.trim().split('\n');
|
||||
|
||||
console.log(`📊 Found ${lines.length} batch responses`);
|
||||
|
||||
// Initialize database
|
||||
const db = await createDatabaseAdapter('./data/nodes.db');
|
||||
|
||||
let updated = 0;
|
||||
let skipped = 0;
|
||||
let errors = 0;
|
||||
|
||||
for (const line of lines) {
|
||||
try {
|
||||
const response: BatchResponse = JSON.parse(line);
|
||||
|
||||
// Extract template ID from custom_id (format: "template-9100")
|
||||
const templateId = parseInt(response.custom_id.replace('template-', ''));
|
||||
|
||||
// Check for errors
|
||||
if (response.error || response.response.status_code !== 200) {
|
||||
console.warn(`⚠️ Template ${templateId}: API error`, response.error);
|
||||
errors++;
|
||||
continue;
|
||||
}
|
||||
|
||||
// Extract metadata from response
|
||||
const metadataJson = response.response.body.choices[0].message.content;
|
||||
|
||||
// Validate it's valid JSON
|
||||
JSON.parse(metadataJson); // Will throw if invalid
|
||||
|
||||
// Update database
|
||||
const stmt = db.prepare(`
|
||||
UPDATE templates
|
||||
SET metadata_json = ?
|
||||
WHERE id = ?
|
||||
`);
|
||||
|
||||
stmt.run(metadataJson, templateId);
|
||||
updated++;
|
||||
|
||||
console.log(`✅ Template ${templateId}: Updated metadata`);
|
||||
|
||||
} catch (error: any) {
|
||||
console.error(`❌ Error processing line:`, error.message);
|
||||
errors++;
|
||||
}
|
||||
}
|
||||
|
||||
// Close database
|
||||
if ('close' in db && typeof db.close === 'function') {
|
||||
db.close();
|
||||
}
|
||||
|
||||
console.log(`\n📈 Summary:`);
|
||||
console.log(` - Updated: ${updated}`);
|
||||
console.log(` - Skipped: ${skipped}`);
|
||||
console.log(` - Errors: ${errors}`);
|
||||
console.log(` - Total: ${lines.length}`);
|
||||
}
|
||||
|
||||
// Main
|
||||
const batchFile = process.argv[2] || '/Users/romualdczlonkowski/Pliki/n8n-mcp/n8n-mcp/docs/batch_68fff7242850819091cfed64f10fb6b4_output.jsonl';
|
||||
|
||||
processBatchMetadata(batchFile)
|
||||
.then(() => {
|
||||
console.log('\n✅ Batch processing complete!');
|
||||
process.exit(0);
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error('\n❌ Batch processing failed:', error);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -1561,7 +1561,6 @@ export async function handleListAvailableTools(context?: InstanceContext): Promi
|
||||
maxRetries: config.maxRetries
|
||||
} : null,
|
||||
limitations: [
|
||||
'Cannot activate/deactivate workflows via API',
|
||||
'Cannot execute workflows directly (must use webhooks)',
|
||||
'Cannot stop running executions',
|
||||
'Tags and credentials have limited API support'
|
||||
|
||||
@@ -138,6 +138,7 @@ export async function handleUpdatePartialWorkflow(
|
||||
error: 'Failed to apply diff operations',
|
||||
details: {
|
||||
errors: diffResult.errors,
|
||||
warnings: diffResult.warnings,
|
||||
operationsApplied: diffResult.operationsApplied,
|
||||
applied: diffResult.applied,
|
||||
failed: diffResult.failed
|
||||
@@ -154,6 +155,9 @@ export async function handleUpdatePartialWorkflow(
|
||||
data: {
|
||||
valid: true,
|
||||
operationsToApply: input.operations.length
|
||||
},
|
||||
details: {
|
||||
warnings: diffResult.warnings
|
||||
}
|
||||
};
|
||||
}
|
||||
@@ -241,18 +245,56 @@ export async function handleUpdatePartialWorkflow(
|
||||
// Update workflow via API
|
||||
try {
|
||||
const updatedWorkflow = await client.updateWorkflow(input.id, diffResult.workflow!);
|
||||
|
||||
|
||||
// Handle activation/deactivation if requested
|
||||
let finalWorkflow = updatedWorkflow;
|
||||
let activationMessage = '';
|
||||
|
||||
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,
|
||||
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,
|
||||
error: 'Workflow updated successfully but deactivation failed',
|
||||
details: {
|
||||
workflowUpdated: true,
|
||||
deactivationError: deactivationError instanceof Error ? deactivationError.message : 'Unknown error'
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: updatedWorkflow,
|
||||
message: `Workflow "${updatedWorkflow.name}" updated successfully. Applied ${diffResult.operationsApplied} operations.`,
|
||||
data: finalWorkflow,
|
||||
message: `Workflow "${finalWorkflow.name}" updated successfully. Applied ${diffResult.operationsApplied} operations.${activationMessage}`,
|
||||
details: {
|
||||
operationsApplied: diffResult.operationsApplied,
|
||||
workflowId: updatedWorkflow.id,
|
||||
workflowName: updatedWorkflow.name,
|
||||
workflowId: finalWorkflow.id,
|
||||
workflowName: finalWorkflow.name,
|
||||
active: finalWorkflow.active,
|
||||
applied: diffResult.applied,
|
||||
failed: diffResult.failed,
|
||||
errors: diffResult.errors
|
||||
errors: diffResult.errors,
|
||||
warnings: diffResult.warnings
|
||||
}
|
||||
};
|
||||
} catch (error) {
|
||||
|
||||
@@ -296,19 +296,24 @@ export class N8NDocumentationMCPServer {
|
||||
throw new Error('Database is empty. Run "npm run rebuild" to populate node data.');
|
||||
}
|
||||
|
||||
// Check if FTS5 table exists
|
||||
const ftsExists = this.db.prepare(`
|
||||
SELECT name FROM sqlite_master
|
||||
WHERE type='table' AND name='nodes_fts'
|
||||
`).get();
|
||||
// Check if FTS5 table exists (wrap in try-catch for sql.js compatibility)
|
||||
try {
|
||||
const ftsExists = this.db.prepare(`
|
||||
SELECT name FROM sqlite_master
|
||||
WHERE type='table' AND name='nodes_fts'
|
||||
`).get();
|
||||
|
||||
if (!ftsExists) {
|
||||
logger.warn('FTS5 table missing - search performance will be degraded. Please run: npm run rebuild');
|
||||
} else {
|
||||
const ftsCount = this.db.prepare('SELECT COUNT(*) as count FROM nodes_fts').get() as { count: number };
|
||||
if (ftsCount.count === 0) {
|
||||
logger.warn('FTS5 index is empty - search will not work properly. Please run: npm run rebuild');
|
||||
if (!ftsExists) {
|
||||
logger.warn('FTS5 table missing - search performance will be degraded. Please run: npm run rebuild');
|
||||
} else {
|
||||
const ftsCount = this.db.prepare('SELECT COUNT(*) as count FROM nodes_fts').get() as { count: number };
|
||||
if (ftsCount.count === 0) {
|
||||
logger.warn('FTS5 index is empty - search will not work properly. Please run: npm run rebuild');
|
||||
}
|
||||
}
|
||||
} catch (ftsError) {
|
||||
// FTS5 not supported (e.g., sql.js fallback) - this is OK, just warn
|
||||
logger.warn('FTS5 not available - using fallback search. For better performance, ensure better-sqlite3 is properly installed.');
|
||||
}
|
||||
|
||||
logger.info(`Database health check passed: ${nodeCount.count} nodes loaded`);
|
||||
|
||||
@@ -4,7 +4,7 @@ export const n8nUpdatePartialWorkflowDoc: ToolDocumentation = {
|
||||
name: 'n8n_update_partial_workflow',
|
||||
category: 'workflow_management',
|
||||
essentials: {
|
||||
description: 'Update workflow incrementally with diff operations. Types: addNode, removeNode, updateNode, moveNode, enable/disableNode, addConnection, removeConnection, rewireConnection, cleanStaleConnections, replaceConnections, updateSettings, updateName, add/removeTag. Supports smart parameters (branch, case) for multi-output nodes. Full support for AI connections (ai_languageModel, ai_tool, ai_memory, ai_embedding, ai_vectorStore, ai_document, ai_textSplitter, ai_outputParser).',
|
||||
description: 'Update workflow incrementally with diff operations. Types: addNode, removeNode, updateNode, moveNode, enable/disableNode, addConnection, removeConnection, rewireConnection, cleanStaleConnections, replaceConnections, updateSettings, updateName, add/removeTag, activateWorkflow, deactivateWorkflow. Supports smart parameters (branch, case) for multi-output nodes. Full support for AI connections (ai_languageModel, ai_tool, ai_memory, ai_embedding, ai_vectorStore, ai_document, ai_textSplitter, ai_outputParser).',
|
||||
keyParameters: ['id', 'operations', 'continueOnError'],
|
||||
example: 'n8n_update_partial_workflow({id: "wf_123", operations: [{type: "rewireConnection", source: "IF", from: "Old", to: "New", branch: "true"}]})',
|
||||
performance: 'Fast (50-200ms)',
|
||||
@@ -19,11 +19,12 @@ export const n8nUpdatePartialWorkflowDoc: ToolDocumentation = {
|
||||
'For AI connections, specify sourceOutput type (ai_languageModel, ai_tool, etc.)',
|
||||
'Batch AI component connections for atomic updates',
|
||||
'Auto-sanitization: ALL nodes auto-fixed during updates (operator structures, missing metadata)',
|
||||
'Node renames automatically update all connection references - no manual connection operations needed'
|
||||
'Node renames automatically update all connection references - no manual connection operations needed',
|
||||
'Activate/deactivate workflows: Use activateWorkflow/deactivateWorkflow operations (requires activatable triggers like webhook/schedule)'
|
||||
]
|
||||
},
|
||||
full: {
|
||||
description: `Updates workflows using surgical diff operations instead of full replacement. Supports 15 operation types for precise modifications. Operations are validated and applied atomically by default - all succeed or none are applied.
|
||||
description: `Updates workflows using surgical diff operations instead of full replacement. Supports 17 operation types for precise modifications. Operations are validated and applied atomically by default - all succeed or none are applied.
|
||||
|
||||
## Available Operations:
|
||||
|
||||
@@ -48,6 +49,10 @@ export const n8nUpdatePartialWorkflowDoc: ToolDocumentation = {
|
||||
- **addTag**: Add a workflow tag
|
||||
- **removeTag**: Remove a workflow tag
|
||||
|
||||
### Workflow Activation Operations (2 types):
|
||||
- **activateWorkflow**: Activate the workflow to enable automatic execution via triggers
|
||||
- **deactivateWorkflow**: Deactivate the workflow to prevent automatic execution
|
||||
|
||||
## Smart Parameters for Multi-Output Nodes
|
||||
|
||||
For **IF nodes**, use semantic 'branch' parameter instead of technical sourceIndex:
|
||||
@@ -186,7 +191,115 @@ Please choose a different name.
|
||||
- Simply rename nodes with updateNode - no manual connection operations needed
|
||||
- Multiple renames in one call work atomically
|
||||
- Can rename a node and add/remove connections using the new name in the same batch
|
||||
- Use \`validateOnly: true\` to preview effects before applying`,
|
||||
- Use \`validateOnly: true\` to preview effects before applying
|
||||
|
||||
## Removing Properties with undefined
|
||||
|
||||
To remove a property from a node, set its value to \`undefined\` in the updates object. This is essential when migrating from deprecated properties or cleaning up optional configuration fields.
|
||||
|
||||
### Why Use undefined?
|
||||
- **Property removal vs. null**: Setting a property to \`undefined\` removes it completely from the node object, while \`null\` sets the property to a null value
|
||||
- **Validation constraints**: Some properties are mutually exclusive (e.g., \`continueOnFail\` and \`onError\`). Simply setting one without removing the other will fail validation
|
||||
- **Deprecated property migration**: When n8n deprecates properties, you must remove the old property before the new one will work
|
||||
|
||||
### Basic Property Removal
|
||||
\`\`\`javascript
|
||||
// Remove error handling configuration
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_123",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "HTTP Request",
|
||||
updates: { onError: undefined }
|
||||
}]
|
||||
});
|
||||
|
||||
// Remove disabled flag
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_456",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeId: "node_abc",
|
||||
updates: { disabled: undefined }
|
||||
}]
|
||||
});
|
||||
\`\`\`
|
||||
|
||||
### Nested Property Removal
|
||||
Use dot notation to remove nested properties:
|
||||
\`\`\`javascript
|
||||
// Remove nested parameter
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_789",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "API Request",
|
||||
updates: { "parameters.authentication": undefined }
|
||||
}]
|
||||
});
|
||||
|
||||
// Remove entire array property
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_012",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "HTTP Request",
|
||||
updates: { "parameters.headers": undefined }
|
||||
}]
|
||||
});
|
||||
\`\`\`
|
||||
|
||||
### Migrating from Deprecated Properties
|
||||
Common scenario: replacing \`continueOnFail\` with \`onError\`:
|
||||
\`\`\`javascript
|
||||
// WRONG: Setting only the new property leaves the old one
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_123",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "HTTP Request",
|
||||
updates: { onError: "continueErrorOutput" }
|
||||
}]
|
||||
});
|
||||
// Error: continueOnFail and onError are mutually exclusive
|
||||
|
||||
// CORRECT: Remove the old property first
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_123",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "HTTP Request",
|
||||
updates: {
|
||||
continueOnFail: undefined,
|
||||
onError: "continueErrorOutput"
|
||||
}
|
||||
}]
|
||||
});
|
||||
\`\`\`
|
||||
|
||||
### Batch Property Removal
|
||||
Remove multiple properties in one operation:
|
||||
\`\`\`javascript
|
||||
n8n_update_partial_workflow({
|
||||
id: "wf_345",
|
||||
operations: [{
|
||||
type: "updateNode",
|
||||
nodeName: "Data Processor",
|
||||
updates: {
|
||||
continueOnFail: undefined,
|
||||
alwaysOutputData: undefined,
|
||||
"parameters.legacy_option": undefined
|
||||
}
|
||||
}]
|
||||
});
|
||||
\`\`\`
|
||||
|
||||
### When to Use undefined
|
||||
- Removing deprecated properties during migration
|
||||
- Cleaning up optional configuration flags
|
||||
- Resolving mutual exclusivity validation errors
|
||||
- Removing stale or unnecessary node metadata
|
||||
- Simplifying node configuration`,
|
||||
parameters: {
|
||||
id: { type: 'string', required: true, description: 'Workflow ID to update' },
|
||||
operations: {
|
||||
@@ -223,7 +336,13 @@ Please choose a different name.
|
||||
'// Vector Store setup: Connect embeddings and documents\nn8n_update_partial_workflow({id: "ai7", operations: [\n {type: "addConnection", source: "Embeddings OpenAI", target: "Pinecone Vector Store", sourceOutput: "ai_embedding"},\n {type: "addConnection", source: "Default Data Loader", target: "Pinecone Vector Store", sourceOutput: "ai_document"}\n]})',
|
||||
'// Connect Vector Store Tool to AI Agent (retrieval setup)\nn8n_update_partial_workflow({id: "ai8", operations: [\n {type: "addConnection", source: "Pinecone Vector Store", target: "Vector Store Tool", sourceOutput: "ai_vectorStore"},\n {type: "addConnection", source: "Vector Store Tool", target: "AI Agent", sourceOutput: "ai_tool"}\n]})',
|
||||
'// Rewire AI Agent to use different language model\nn8n_update_partial_workflow({id: "ai9", operations: [{type: "rewireConnection", source: "AI Agent", from: "OpenAI Chat Model", to: "Anthropic Chat Model", sourceOutput: "ai_languageModel"}]})',
|
||||
'// Replace all AI tools for an agent\nn8n_update_partial_workflow({id: "ai10", operations: [\n {type: "removeConnection", source: "Old Tool 1", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "removeConnection", source: "Old Tool 2", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "New HTTP Tool", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "New Code Tool", target: "AI Agent", sourceOutput: "ai_tool"}\n]})'
|
||||
'// Replace all AI tools for an agent\nn8n_update_partial_workflow({id: "ai10", operations: [\n {type: "removeConnection", source: "Old Tool 1", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "removeConnection", source: "Old Tool 2", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "New HTTP Tool", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "New Code Tool", target: "AI Agent", sourceOutput: "ai_tool"}\n]})',
|
||||
'\n// ============ REMOVING PROPERTIES EXAMPLES ============',
|
||||
'// Remove a simple property\nn8n_update_partial_workflow({id: "rm1", operations: [{type: "updateNode", nodeName: "HTTP Request", updates: {onError: undefined}}]})',
|
||||
'// Migrate from deprecated continueOnFail to onError\nn8n_update_partial_workflow({id: "rm2", operations: [{type: "updateNode", nodeName: "HTTP Request", updates: {continueOnFail: undefined, onError: "continueErrorOutput"}}]})',
|
||||
'// Remove nested property\nn8n_update_partial_workflow({id: "rm3", operations: [{type: "updateNode", nodeName: "API Request", updates: {"parameters.authentication": undefined}}]})',
|
||||
'// Remove multiple properties\nn8n_update_partial_workflow({id: "rm4", operations: [{type: "updateNode", nodeName: "Data Processor", updates: {continueOnFail: undefined, alwaysOutputData: undefined, "parameters.legacy_option": undefined}}]})',
|
||||
'// Remove entire array property\nn8n_update_partial_workflow({id: "rm5", operations: [{type: "updateNode", nodeName: "HTTP Request", updates: {"parameters.headers": undefined}}]})'
|
||||
],
|
||||
useCases: [
|
||||
'Rewire connections when replacing nodes',
|
||||
@@ -259,7 +378,11 @@ Please choose a different name.
|
||||
'Connect language model BEFORE adding AI Agent to ensure validation passes',
|
||||
'Use targetIndex for fallback models (primary=0, fallback=1)',
|
||||
'Batch AI component connections in a single operation for atomicity',
|
||||
'Validate AI workflows after connection changes to catch configuration errors'
|
||||
'Validate AI workflows after connection changes to catch configuration errors',
|
||||
'To remove properties, set them to undefined (not null) in the updates object',
|
||||
'When migrating from deprecated properties, remove the old property and add the new one in the same operation',
|
||||
'Use undefined to resolve mutual exclusivity validation errors between properties',
|
||||
'Batch multiple property removals in a single updateNode operation for efficiency'
|
||||
],
|
||||
pitfalls: [
|
||||
'**REQUIRES N8N_API_URL and N8N_API_KEY environment variables** - will not work without n8n API access',
|
||||
@@ -272,12 +395,19 @@ Please choose a different name.
|
||||
'Use "updates" property for updateNode operations: {type: "updateNode", updates: {...}}',
|
||||
'Smart parameters (branch, case) only work with IF and Switch nodes - ignored for other node types',
|
||||
'Explicit sourceIndex overrides smart parameters (branch, case) if both provided',
|
||||
'**CRITICAL**: For If nodes, ALWAYS use branch="true"/"false" instead of sourceIndex. Using sourceIndex=0 for multiple connections will put them ALL on the TRUE branch (main[0]), breaking your workflow logic!',
|
||||
'**CRITICAL**: For Switch nodes, ALWAYS use case=N instead of sourceIndex. Using same sourceIndex for multiple connections will put them on the same case output.',
|
||||
'cleanStaleConnections removes ALL broken connections - cannot be selective',
|
||||
'replaceConnections overwrites entire connections object - all previous connections lost',
|
||||
'**Auto-sanitization behavior**: Binary operators (equals, contains) automatically have singleValue removed; unary operators (isEmpty, isNotEmpty) automatically get singleValue:true added',
|
||||
'**Auto-sanitization runs on ALL nodes**: When ANY update is made, ALL nodes in the workflow are sanitized (not just modified ones)',
|
||||
'**Auto-sanitization cannot fix everything**: It fixes operator structures and missing metadata, but cannot fix broken connections or branch mismatches',
|
||||
'**Corrupted workflows beyond repair**: Workflows in paradoxical states (API returns corrupt, API rejects updates) cannot be fixed via API - must be recreated'
|
||||
'**Corrupted workflows beyond repair**: Workflows in paradoxical states (API returns corrupt, API rejects updates) cannot be fixed via API - must be recreated',
|
||||
'Setting a property to null does NOT remove it - use undefined instead',
|
||||
'When properties are mutually exclusive (e.g., continueOnFail and onError), setting only the new property will fail - you must remove the old one with undefined',
|
||||
'Removing a required property may cause validation errors - check node documentation first',
|
||||
'Nested property removal with dot notation only removes the specific nested field, not the entire parent object',
|
||||
'Array index notation (e.g., "parameters.headers[0]") is not supported - remove the entire array property instead'
|
||||
],
|
||||
relatedTools: ['n8n_update_full_workflow', 'n8n_get_workflow', 'validate_workflow', 'tools_documentation']
|
||||
}
|
||||
|
||||
@@ -75,10 +75,15 @@ async function fetchTemplatesRobust() {
|
||||
|
||||
// Fetch detail
|
||||
const detail = await fetcher.fetchTemplateDetail(template.id);
|
||||
|
||||
// Save immediately
|
||||
repository.saveTemplate(template, detail);
|
||||
saved++;
|
||||
|
||||
if (detail !== null) {
|
||||
// Save immediately
|
||||
repository.saveTemplate(template, detail);
|
||||
saved++;
|
||||
} else {
|
||||
errors++;
|
||||
console.error(`\n❌ Failed to fetch template ${template.id} (${template.name}) after retries`);
|
||||
}
|
||||
|
||||
// Rate limiting
|
||||
await new Promise(resolve => setTimeout(resolve, 200));
|
||||
|
||||
@@ -401,7 +401,59 @@ export class EnhancedConfigValidator extends ConfigValidator {
|
||||
config: Record<string, any>,
|
||||
result: EnhancedValidationResult
|
||||
): void {
|
||||
// Examples removed - validation provides error messages and fixes instead
|
||||
const url = String(config.url || '');
|
||||
const options = config.options || {};
|
||||
|
||||
// 1. Suggest alwaysOutputData for better error handling (node-level property)
|
||||
// Note: We can't check if it exists (it's node-level, not in parameters),
|
||||
// but we can suggest it as a best practice
|
||||
if (!result.suggestions.some(s => typeof s === 'string' && s.includes('alwaysOutputData'))) {
|
||||
result.suggestions.push(
|
||||
'Consider adding alwaysOutputData: true at node level (not in parameters) for better error handling. ' +
|
||||
'This ensures the node produces output even when HTTP requests fail, allowing downstream error handling.'
|
||||
);
|
||||
}
|
||||
|
||||
// 2. Suggest responseFormat for API endpoints
|
||||
const lowerUrl = url.toLowerCase();
|
||||
const isApiEndpoint =
|
||||
// Subdomain patterns (api.example.com)
|
||||
/^https?:\/\/api\./i.test(url) ||
|
||||
// Path patterns with word boundaries to prevent false positives like "therapist", "restaurant"
|
||||
/\/api[\/\?]|\/api$/i.test(url) ||
|
||||
/\/rest[\/\?]|\/rest$/i.test(url) ||
|
||||
// Known API service domains
|
||||
lowerUrl.includes('supabase.co') ||
|
||||
lowerUrl.includes('firebase') ||
|
||||
lowerUrl.includes('googleapis.com') ||
|
||||
// Versioned API paths (e.g., example.com/v1, example.com/v2)
|
||||
/\.com\/v\d+/i.test(url);
|
||||
|
||||
if (isApiEndpoint && !options.response?.response?.responseFormat) {
|
||||
result.suggestions.push(
|
||||
'API endpoints should explicitly set options.response.response.responseFormat to "json" or "text" ' +
|
||||
'to prevent confusion about response parsing. Example: ' +
|
||||
'{ "options": { "response": { "response": { "responseFormat": "json" } } } }'
|
||||
);
|
||||
}
|
||||
|
||||
// 3. Enhanced URL protocol validation for expressions
|
||||
if (url && url.startsWith('=')) {
|
||||
// Expression-based URL - check for common protocol issues
|
||||
const expressionContent = url.slice(1); // Remove = prefix
|
||||
const lowerExpression = expressionContent.toLowerCase();
|
||||
|
||||
// Check for missing protocol in expression (case-insensitive)
|
||||
if (expressionContent.startsWith('www.') ||
|
||||
(expressionContent.includes('{{') && !lowerExpression.includes('http'))) {
|
||||
result.warnings.push({
|
||||
type: 'invalid_value',
|
||||
property: 'url',
|
||||
message: 'URL expression appears to be missing http:// or https:// protocol',
|
||||
suggestion: 'Include protocol in your expression. Example: ={{ "https://" + $json.domain + ".com" }}'
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -170,10 +170,41 @@ export class N8nApiClient {
|
||||
}
|
||||
}
|
||||
|
||||
async activateWorkflow(id: string): Promise<Workflow> {
|
||||
try {
|
||||
const response = await this.client.post(`/workflows/${id}/activate`);
|
||||
return response.data;
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
}
|
||||
|
||||
async deactivateWorkflow(id: string): Promise<Workflow> {
|
||||
try {
|
||||
const response = await this.client.post(`/workflows/${id}/deactivate`);
|
||||
return response.data;
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Lists workflows from n8n instance.
|
||||
*
|
||||
* @param params - Query parameters for filtering and pagination
|
||||
* @returns Paginated list of workflows
|
||||
*
|
||||
* @remarks
|
||||
* This method handles two response formats for backwards compatibility:
|
||||
* - Modern (n8n v0.200.0+): {data: Workflow[], nextCursor?: string}
|
||||
* - Legacy (older versions): Workflow[] (wrapped automatically)
|
||||
*
|
||||
* @see https://github.com/czlonkowski/n8n-mcp/issues/349
|
||||
*/
|
||||
async listWorkflows(params: WorkflowListParams = {}): Promise<WorkflowListResponse> {
|
||||
try {
|
||||
const response = await this.client.get('/workflows', { params });
|
||||
return response.data;
|
||||
return this.validateListResponse<Workflow>(response.data, 'workflows');
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
@@ -191,10 +222,23 @@ export class N8nApiClient {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Lists executions from n8n instance.
|
||||
*
|
||||
* @param params - Query parameters for filtering and pagination
|
||||
* @returns Paginated list of executions
|
||||
*
|
||||
* @remarks
|
||||
* This method handles two response formats for backwards compatibility:
|
||||
* - Modern (n8n v0.200.0+): {data: Execution[], nextCursor?: string}
|
||||
* - Legacy (older versions): Execution[] (wrapped automatically)
|
||||
*
|
||||
* @see https://github.com/czlonkowski/n8n-mcp/issues/349
|
||||
*/
|
||||
async listExecutions(params: ExecutionListParams = {}): Promise<ExecutionListResponse> {
|
||||
try {
|
||||
const response = await this.client.get('/executions', { params });
|
||||
return response.data;
|
||||
return this.validateListResponse<Execution>(response.data, 'executions');
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
@@ -261,10 +305,23 @@ export class N8nApiClient {
|
||||
}
|
||||
|
||||
// Credential Management
|
||||
/**
|
||||
* Lists credentials from n8n instance.
|
||||
*
|
||||
* @param params - Query parameters for filtering and pagination
|
||||
* @returns Paginated list of credentials
|
||||
*
|
||||
* @remarks
|
||||
* This method handles two response formats for backwards compatibility:
|
||||
* - Modern (n8n v0.200.0+): {data: Credential[], nextCursor?: string}
|
||||
* - Legacy (older versions): Credential[] (wrapped automatically)
|
||||
*
|
||||
* @see https://github.com/czlonkowski/n8n-mcp/issues/349
|
||||
*/
|
||||
async listCredentials(params: CredentialListParams = {}): Promise<CredentialListResponse> {
|
||||
try {
|
||||
const response = await this.client.get('/credentials', { params });
|
||||
return response.data;
|
||||
return this.validateListResponse<Credential>(response.data, 'credentials');
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
@@ -306,10 +363,23 @@ export class N8nApiClient {
|
||||
}
|
||||
|
||||
// Tag Management
|
||||
/**
|
||||
* Lists tags from n8n instance.
|
||||
*
|
||||
* @param params - Query parameters for filtering and pagination
|
||||
* @returns Paginated list of tags
|
||||
*
|
||||
* @remarks
|
||||
* This method handles two response formats for backwards compatibility:
|
||||
* - Modern (n8n v0.200.0+): {data: Tag[], nextCursor?: string}
|
||||
* - Legacy (older versions): Tag[] (wrapped automatically)
|
||||
*
|
||||
* @see https://github.com/czlonkowski/n8n-mcp/issues/349
|
||||
*/
|
||||
async listTags(params: TagListParams = {}): Promise<TagListResponse> {
|
||||
try {
|
||||
const response = await this.client.get('/tags', { params });
|
||||
return response.data;
|
||||
return this.validateListResponse<Tag>(response.data, 'tags');
|
||||
} catch (error) {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
@@ -412,4 +482,49 @@ export class N8nApiClient {
|
||||
throw handleN8nApiError(error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates and normalizes n8n API list responses.
|
||||
* Handles both modern format {data: [], nextCursor?: string} and legacy array format.
|
||||
*
|
||||
* @param responseData - Raw response data from n8n API
|
||||
* @param resourceType - Resource type for error messages (e.g., 'workflows', 'executions')
|
||||
* @returns Normalized response in modern format
|
||||
* @throws Error if response structure is invalid
|
||||
*/
|
||||
private validateListResponse<T>(
|
||||
responseData: any,
|
||||
resourceType: string
|
||||
): { data: T[]; nextCursor?: string | null } {
|
||||
// Validate response structure
|
||||
if (!responseData || typeof responseData !== 'object') {
|
||||
throw new Error(`Invalid response from n8n API for ${resourceType}: response is not an object`);
|
||||
}
|
||||
|
||||
// Handle legacy case where API returns array directly (older n8n versions)
|
||||
if (Array.isArray(responseData)) {
|
||||
logger.warn(
|
||||
`n8n API returned array directly instead of {data, nextCursor} object for ${resourceType}. ` +
|
||||
'Wrapping in expected format for backwards compatibility.'
|
||||
);
|
||||
return {
|
||||
data: responseData,
|
||||
nextCursor: null
|
||||
};
|
||||
}
|
||||
|
||||
// Validate expected format {data: [], nextCursor?: string}
|
||||
if (!Array.isArray(responseData.data)) {
|
||||
const keys = Object.keys(responseData).slice(0, 5);
|
||||
const keysPreview = keys.length < Object.keys(responseData).length
|
||||
? `${keys.join(', ')}...`
|
||||
: keys.join(', ');
|
||||
throw new Error(
|
||||
`Invalid response from n8n API for ${resourceType}: expected {data: [], nextCursor?: string}, ` +
|
||||
`got object with keys: [${keysPreview}]`
|
||||
);
|
||||
}
|
||||
|
||||
return responseData;
|
||||
}
|
||||
}
|
||||
@@ -133,6 +133,7 @@ export function cleanWorkflowForUpdate(workflow: Workflow): Partial<Workflow> {
|
||||
createdAt,
|
||||
updatedAt,
|
||||
versionId,
|
||||
versionCounter, // Added: n8n 1.118.1+ returns this but rejects it in updates
|
||||
meta,
|
||||
staticData,
|
||||
// Remove fields that cause API errors
|
||||
|
||||
@@ -25,6 +25,8 @@ import {
|
||||
UpdateNameOperation,
|
||||
AddTagOperation,
|
||||
RemoveTagOperation,
|
||||
ActivateWorkflowOperation,
|
||||
DeactivateWorkflowOperation,
|
||||
CleanStaleConnectionsOperation,
|
||||
ReplaceConnectionsOperation
|
||||
} from '../types/workflow-diff';
|
||||
@@ -32,12 +34,15 @@ import { Workflow, WorkflowNode, WorkflowConnection } from '../types/n8n-api';
|
||||
import { Logger } from '../utils/logger';
|
||||
import { validateWorkflowNode, validateWorkflowConnections } from './n8n-validation';
|
||||
import { sanitizeNode, sanitizeWorkflowNodes } from './node-sanitizer';
|
||||
import { isActivatableTrigger } from '../utils/node-type-utils';
|
||||
|
||||
const logger = new Logger({ prefix: '[WorkflowDiffEngine]' });
|
||||
|
||||
export class WorkflowDiffEngine {
|
||||
// Track node name changes during operations for connection reference updates
|
||||
private renameMap: Map<string, string> = new Map();
|
||||
// Track warnings during operation processing
|
||||
private warnings: WorkflowDiffValidationError[] = [];
|
||||
|
||||
/**
|
||||
* Apply diff operations to a workflow
|
||||
@@ -47,8 +52,9 @@ export class WorkflowDiffEngine {
|
||||
request: WorkflowDiffRequest
|
||||
): Promise<WorkflowDiffResult> {
|
||||
try {
|
||||
// Reset rename tracking for this diff operation
|
||||
// Reset tracking for this diff operation
|
||||
this.renameMap.clear();
|
||||
this.warnings = [];
|
||||
|
||||
// Clone workflow to avoid modifying original
|
||||
const workflowCopy = JSON.parse(JSON.stringify(workflow));
|
||||
@@ -114,6 +120,7 @@ export class WorkflowDiffEngine {
|
||||
? 'Validation successful. All operations are valid.'
|
||||
: `Validation completed with ${errors.length} errors.`,
|
||||
errors: errors.length > 0 ? errors : undefined,
|
||||
warnings: this.warnings.length > 0 ? this.warnings : undefined,
|
||||
applied: appliedIndices,
|
||||
failed: failedIndices
|
||||
};
|
||||
@@ -126,6 +133,7 @@ export class WorkflowDiffEngine {
|
||||
operationsApplied: appliedIndices.length,
|
||||
message: `Applied ${appliedIndices.length} operations, ${failedIndices.length} failed (continueOnError mode)`,
|
||||
errors: errors.length > 0 ? errors : undefined,
|
||||
warnings: this.warnings.length > 0 ? this.warnings : undefined,
|
||||
applied: appliedIndices,
|
||||
failed: failedIndices
|
||||
};
|
||||
@@ -209,11 +217,23 @@ export class WorkflowDiffEngine {
|
||||
}
|
||||
|
||||
const operationsApplied = request.operations.length;
|
||||
|
||||
// Extract activation flags from workflow object
|
||||
const shouldActivate = (workflowCopy as any)._shouldActivate === true;
|
||||
const shouldDeactivate = (workflowCopy as any)._shouldDeactivate === true;
|
||||
|
||||
// Clean up temporary flags
|
||||
delete (workflowCopy as any)._shouldActivate;
|
||||
delete (workflowCopy as any)._shouldDeactivate;
|
||||
|
||||
return {
|
||||
success: true,
|
||||
workflow: workflowCopy,
|
||||
operationsApplied,
|
||||
message: `Successfully applied ${operationsApplied} operations (${nodeOperations.length} node ops, ${otherOperations.length} other ops)`
|
||||
message: `Successfully applied ${operationsApplied} operations (${nodeOperations.length} node ops, ${otherOperations.length} other ops)`,
|
||||
warnings: this.warnings.length > 0 ? this.warnings : undefined,
|
||||
shouldActivate: shouldActivate || undefined,
|
||||
shouldDeactivate: shouldDeactivate || undefined
|
||||
};
|
||||
}
|
||||
} catch (error) {
|
||||
@@ -256,6 +276,10 @@ export class WorkflowDiffEngine {
|
||||
case 'addTag':
|
||||
case 'removeTag':
|
||||
return null; // These are always valid
|
||||
case 'activateWorkflow':
|
||||
return this.validateActivateWorkflow(workflow, operation);
|
||||
case 'deactivateWorkflow':
|
||||
return this.validateDeactivateWorkflow(workflow, operation);
|
||||
case 'cleanStaleConnections':
|
||||
return this.validateCleanStaleConnections(workflow, operation);
|
||||
case 'replaceConnections':
|
||||
@@ -309,6 +333,12 @@ export class WorkflowDiffEngine {
|
||||
case 'removeTag':
|
||||
this.applyRemoveTag(workflow, operation);
|
||||
break;
|
||||
case 'activateWorkflow':
|
||||
this.applyActivateWorkflow(workflow, operation);
|
||||
break;
|
||||
case 'deactivateWorkflow':
|
||||
this.applyDeactivateWorkflow(workflow, operation);
|
||||
break;
|
||||
case 'cleanStaleConnections':
|
||||
this.applyCleanStaleConnections(workflow, operation);
|
||||
break;
|
||||
@@ -367,6 +397,17 @@ export class WorkflowDiffEngine {
|
||||
}
|
||||
|
||||
private validateUpdateNode(workflow: Workflow, operation: UpdateNodeOperation): string | null {
|
||||
// Check for common parameter mistake: "changes" instead of "updates" (Issue #392)
|
||||
const operationAny = operation as any;
|
||||
if (operationAny.changes && !operation.updates) {
|
||||
return `Invalid parameter 'changes'. The updateNode operation requires 'updates' (not 'changes'). Example: {type: "updateNode", nodeId: "abc", updates: {name: "New Name", "parameters.url": "https://example.com"}}`;
|
||||
}
|
||||
|
||||
// Check for missing required parameter
|
||||
if (!operation.updates) {
|
||||
return `Missing required parameter 'updates'. The updateNode operation requires an 'updates' object containing properties to modify. Example: {type: "updateNode", nodeId: "abc", updates: {name: "New Name"}}`;
|
||||
}
|
||||
|
||||
const node = this.findNode(workflow, operation.nodeId, operation.nodeName);
|
||||
if (!node) {
|
||||
return this.formatNodeNotFoundError(workflow, operation.nodeId || operation.nodeName || '', 'updateNode');
|
||||
@@ -685,6 +726,24 @@ export class WorkflowDiffEngine {
|
||||
sourceIndex = operation.case;
|
||||
}
|
||||
|
||||
// Validation: Warn if using sourceIndex with If/Switch nodes without smart parameters
|
||||
if (sourceNode && operation.sourceIndex !== undefined && operation.branch === undefined && operation.case === undefined) {
|
||||
if (sourceNode.type === 'n8n-nodes-base.if') {
|
||||
this.warnings.push({
|
||||
operation: -1, // Not tied to specific operation index in request
|
||||
message: `Connection to If node "${operation.source}" uses sourceIndex=${operation.sourceIndex}. ` +
|
||||
`Consider using branch="true" or branch="false" for better clarity. ` +
|
||||
`If node outputs: main[0]=TRUE branch, main[1]=FALSE branch.`
|
||||
});
|
||||
} else if (sourceNode.type === 'n8n-nodes-base.switch') {
|
||||
this.warnings.push({
|
||||
operation: -1, // Not tied to specific operation index in request
|
||||
message: `Connection to Switch node "${operation.source}" uses sourceIndex=${operation.sourceIndex}. ` +
|
||||
`Consider using case=N for better clarity (case=0 for first output, case=1 for second, etc.).`
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return { sourceOutput, sourceIndex };
|
||||
}
|
||||
|
||||
@@ -823,13 +882,46 @@ export class WorkflowDiffEngine {
|
||||
|
||||
private applyRemoveTag(workflow: Workflow, operation: RemoveTagOperation): void {
|
||||
if (!workflow.tags) return;
|
||||
|
||||
|
||||
const index = workflow.tags.indexOf(operation.tag);
|
||||
if (index !== -1) {
|
||||
workflow.tags.splice(index, 1);
|
||||
}
|
||||
}
|
||||
|
||||
// Workflow activation operation validators
|
||||
private validateActivateWorkflow(workflow: Workflow, operation: ActivateWorkflowOperation): string | null {
|
||||
// Check if workflow has at least one activatable trigger
|
||||
// Issue #351: executeWorkflowTrigger cannot activate workflows
|
||||
const activatableTriggers = workflow.nodes.filter(
|
||||
node => !node.disabled && isActivatableTrigger(node.type)
|
||||
);
|
||||
|
||||
if (activatableTriggers.length === 0) {
|
||||
return 'Cannot activate workflow: No activatable trigger nodes found. Workflows must have at least one enabled trigger node (webhook, schedule, email, etc.). Note: executeWorkflowTrigger cannot activate workflows as they can only be invoked by other workflows.';
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private validateDeactivateWorkflow(workflow: Workflow, operation: DeactivateWorkflowOperation): string | null {
|
||||
// Deactivation is always valid - any workflow can be deactivated
|
||||
return null;
|
||||
}
|
||||
|
||||
// Workflow activation operation appliers
|
||||
private applyActivateWorkflow(workflow: Workflow, operation: ActivateWorkflowOperation): void {
|
||||
// Set flag in workflow object to indicate activation intent
|
||||
// The handler will call the API method after workflow update
|
||||
(workflow as any)._shouldActivate = true;
|
||||
}
|
||||
|
||||
private applyDeactivateWorkflow(workflow: Workflow, operation: DeactivateWorkflowOperation): void {
|
||||
// Set flag in workflow object to indicate deactivation intent
|
||||
// The handler will call the API method after workflow update
|
||||
(workflow as any)._shouldDeactivate = true;
|
||||
}
|
||||
|
||||
// Connection cleanup operation validators
|
||||
private validateCleanStaleConnections(workflow: Workflow, operation: CleanStaleConnectionsOperation): string | null {
|
||||
// This operation is always valid - it just cleans up what it finds
|
||||
|
||||
@@ -40,7 +40,37 @@ export interface TemplateDetail {
|
||||
export class TemplateFetcher {
|
||||
private readonly baseUrl = 'https://api.n8n.io/api/templates';
|
||||
private readonly pageSize = 250; // Maximum allowed by API
|
||||
|
||||
private readonly maxRetries = 3;
|
||||
private readonly retryDelay = 1000; // 1 second base delay
|
||||
|
||||
/**
|
||||
* Retry helper for API calls
|
||||
*/
|
||||
private async retryWithBackoff<T>(
|
||||
fn: () => Promise<T>,
|
||||
context: string,
|
||||
maxRetries: number = this.maxRetries
|
||||
): Promise<T | null> {
|
||||
let lastError: any;
|
||||
|
||||
for (let attempt = 1; attempt <= maxRetries; attempt++) {
|
||||
try {
|
||||
return await fn();
|
||||
} catch (error: any) {
|
||||
lastError = error;
|
||||
|
||||
if (attempt < maxRetries) {
|
||||
const delay = this.retryDelay * attempt; // Exponential backoff
|
||||
logger.warn(`${context} - Attempt ${attempt}/${maxRetries} failed, retrying in ${delay}ms...`);
|
||||
await this.sleep(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
logger.error(`${context} - All ${maxRetries} attempts failed, skipping`, lastError);
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch all templates and filter to last 12 months
|
||||
* This fetches ALL pages first, then applies date filter locally
|
||||
@@ -73,93 +103,105 @@ export class TemplateFetcher {
|
||||
let page = 1;
|
||||
let hasMore = true;
|
||||
let totalWorkflows = 0;
|
||||
|
||||
|
||||
logger.info('Starting complete template fetch from n8n.io API');
|
||||
|
||||
|
||||
while (hasMore) {
|
||||
try {
|
||||
const response = await axios.get(`${this.baseUrl}/search`, {
|
||||
params: {
|
||||
page,
|
||||
rows: this.pageSize
|
||||
// Note: sort_by parameter doesn't work, templates come in popularity order
|
||||
}
|
||||
});
|
||||
|
||||
const { workflows } = response.data;
|
||||
totalWorkflows = response.data.totalWorkflows || totalWorkflows;
|
||||
|
||||
allTemplates.push(...workflows);
|
||||
|
||||
// Calculate total pages for better progress reporting
|
||||
const totalPages = Math.ceil(totalWorkflows / this.pageSize);
|
||||
|
||||
if (progressCallback) {
|
||||
// Enhanced progress with page information
|
||||
progressCallback(allTemplates.length, totalWorkflows);
|
||||
}
|
||||
|
||||
logger.debug(`Fetched page ${page}/${totalPages}: ${workflows.length} templates (total so far: ${allTemplates.length}/${totalWorkflows})`);
|
||||
|
||||
// Check if there are more pages
|
||||
if (workflows.length < this.pageSize) {
|
||||
hasMore = false;
|
||||
}
|
||||
|
||||
const result = await this.retryWithBackoff(
|
||||
async () => {
|
||||
const response = await axios.get(`${this.baseUrl}/search`, {
|
||||
params: {
|
||||
page,
|
||||
rows: this.pageSize
|
||||
// Note: sort_by parameter doesn't work, templates come in popularity order
|
||||
}
|
||||
});
|
||||
return response.data;
|
||||
},
|
||||
`Fetching templates page ${page}`
|
||||
);
|
||||
|
||||
if (result === null) {
|
||||
// All retries failed for this page, skip it and continue
|
||||
logger.warn(`Skipping page ${page} after ${this.maxRetries} failed attempts`);
|
||||
page++;
|
||||
|
||||
// Rate limiting - be nice to the API (slightly faster with 250 rows/page)
|
||||
if (hasMore) {
|
||||
await this.sleep(300); // 300ms between requests (was 500ms with 100 rows)
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Error fetching templates page ${page}:`, error);
|
||||
throw error;
|
||||
continue;
|
||||
}
|
||||
|
||||
const { workflows } = result;
|
||||
totalWorkflows = result.totalWorkflows || totalWorkflows;
|
||||
|
||||
allTemplates.push(...workflows);
|
||||
|
||||
// Calculate total pages for better progress reporting
|
||||
const totalPages = Math.ceil(totalWorkflows / this.pageSize);
|
||||
|
||||
if (progressCallback) {
|
||||
// Enhanced progress with page information
|
||||
progressCallback(allTemplates.length, totalWorkflows);
|
||||
}
|
||||
|
||||
logger.debug(`Fetched page ${page}/${totalPages}: ${workflows.length} templates (total so far: ${allTemplates.length}/${totalWorkflows})`);
|
||||
|
||||
// Check if there are more pages
|
||||
if (workflows.length < this.pageSize) {
|
||||
hasMore = false;
|
||||
}
|
||||
|
||||
page++;
|
||||
|
||||
// Rate limiting - be nice to the API (slightly faster with 250 rows/page)
|
||||
if (hasMore) {
|
||||
await this.sleep(300); // 300ms between requests (was 500ms with 100 rows)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
logger.info(`Fetched all ${allTemplates.length} templates from n8n.io`);
|
||||
return allTemplates;
|
||||
}
|
||||
|
||||
async fetchTemplateDetail(workflowId: number): Promise<TemplateDetail> {
|
||||
try {
|
||||
const response = await axios.get(`${this.baseUrl}/workflows/${workflowId}`);
|
||||
return response.data.workflow;
|
||||
} catch (error) {
|
||||
logger.error(`Error fetching template detail for ${workflowId}:`, error);
|
||||
throw error;
|
||||
}
|
||||
async fetchTemplateDetail(workflowId: number): Promise<TemplateDetail | null> {
|
||||
const result = await this.retryWithBackoff(
|
||||
async () => {
|
||||
const response = await axios.get(`${this.baseUrl}/workflows/${workflowId}`);
|
||||
return response.data.workflow;
|
||||
},
|
||||
`Fetching template detail for workflow ${workflowId}`
|
||||
);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
async fetchAllTemplateDetails(
|
||||
workflows: TemplateWorkflow[],
|
||||
workflows: TemplateWorkflow[],
|
||||
progressCallback?: (current: number, total: number) => void
|
||||
): Promise<Map<number, TemplateDetail>> {
|
||||
const details = new Map<number, TemplateDetail>();
|
||||
|
||||
let skipped = 0;
|
||||
|
||||
logger.info(`Fetching details for ${workflows.length} templates`);
|
||||
|
||||
|
||||
for (let i = 0; i < workflows.length; i++) {
|
||||
const workflow = workflows[i];
|
||||
|
||||
try {
|
||||
const detail = await this.fetchTemplateDetail(workflow.id);
|
||||
|
||||
const detail = await this.fetchTemplateDetail(workflow.id);
|
||||
|
||||
if (detail !== null) {
|
||||
details.set(workflow.id, detail);
|
||||
|
||||
if (progressCallback) {
|
||||
progressCallback(i + 1, workflows.length);
|
||||
}
|
||||
|
||||
// Rate limiting (conservative to avoid API throttling)
|
||||
await this.sleep(150); // 150ms between requests
|
||||
} catch (error) {
|
||||
logger.error(`Failed to fetch details for workflow ${workflow.id}:`, error);
|
||||
// Continue with other templates
|
||||
} else {
|
||||
skipped++;
|
||||
logger.warn(`Skipped workflow ${workflow.id} after ${this.maxRetries} failed attempts`);
|
||||
}
|
||||
|
||||
if (progressCallback) {
|
||||
progressCallback(i + 1, workflows.length);
|
||||
}
|
||||
|
||||
// Rate limiting (conservative to avoid API throttling)
|
||||
await this.sleep(150); // 150ms between requests
|
||||
}
|
||||
|
||||
logger.info(`Successfully fetched ${details.size} template details`);
|
||||
|
||||
logger.info(`Successfully fetched ${details.size} template details (${skipped} skipped)`);
|
||||
return details;
|
||||
}
|
||||
|
||||
|
||||
@@ -496,10 +496,17 @@ export class TemplateRepository {
|
||||
// Count node usage
|
||||
const nodeCount: Record<string, number> = {};
|
||||
topNodes.forEach(t => {
|
||||
const nodes = JSON.parse(t.nodes_used);
|
||||
nodes.forEach((n: string) => {
|
||||
nodeCount[n] = (nodeCount[n] || 0) + 1;
|
||||
});
|
||||
if (!t.nodes_used) return;
|
||||
try {
|
||||
const nodes = JSON.parse(t.nodes_used);
|
||||
if (Array.isArray(nodes)) {
|
||||
nodes.forEach((n: string) => {
|
||||
nodeCount[n] = (nodeCount[n] || 0) + 1;
|
||||
});
|
||||
}
|
||||
} catch (error) {
|
||||
logger.warn(`Failed to parse nodes_used for template stats:`, error);
|
||||
}
|
||||
});
|
||||
|
||||
// Get top 10 most used nodes
|
||||
|
||||
@@ -66,6 +66,7 @@ export interface Workflow {
|
||||
updatedAt?: string;
|
||||
createdAt?: string;
|
||||
versionId?: string;
|
||||
versionCounter?: number; // Added: n8n 1.118.1+ returns this in GET responses
|
||||
meta?: {
|
||||
instanceId?: string;
|
||||
};
|
||||
@@ -152,6 +153,7 @@ export interface WorkflowExport {
|
||||
tags?: string[];
|
||||
pinData?: Record<string, unknown>;
|
||||
versionId?: string;
|
||||
versionCounter?: number; // Added: n8n 1.118.1+
|
||||
meta?: Record<string, unknown>;
|
||||
}
|
||||
|
||||
|
||||
@@ -114,6 +114,16 @@ export interface RemoveTagOperation extends DiffOperation {
|
||||
tag: string;
|
||||
}
|
||||
|
||||
export interface ActivateWorkflowOperation extends DiffOperation {
|
||||
type: 'activateWorkflow';
|
||||
// No additional properties needed - just activates the workflow
|
||||
}
|
||||
|
||||
export interface DeactivateWorkflowOperation extends DiffOperation {
|
||||
type: 'deactivateWorkflow';
|
||||
// No additional properties needed - just deactivates the workflow
|
||||
}
|
||||
|
||||
// Connection Cleanup Operations
|
||||
export interface CleanStaleConnectionsOperation extends DiffOperation {
|
||||
type: 'cleanStaleConnections';
|
||||
@@ -148,6 +158,8 @@ export type WorkflowDiffOperation =
|
||||
| UpdateNameOperation
|
||||
| AddTagOperation
|
||||
| RemoveTagOperation
|
||||
| ActivateWorkflowOperation
|
||||
| DeactivateWorkflowOperation
|
||||
| CleanStaleConnectionsOperation
|
||||
| ReplaceConnectionsOperation;
|
||||
|
||||
@@ -170,11 +182,14 @@ export interface WorkflowDiffResult {
|
||||
success: boolean;
|
||||
workflow?: any; // Updated workflow if successful
|
||||
errors?: WorkflowDiffValidationError[];
|
||||
warnings?: WorkflowDiffValidationError[]; // Non-blocking warnings (e.g., parameter suggestions)
|
||||
operationsApplied?: number;
|
||||
message?: string;
|
||||
applied?: number[]; // Indices of successfully applied operations (when continueOnError is true)
|
||||
failed?: number[]; // Indices of failed operations (when continueOnError is true)
|
||||
staleConnectionsRemoved?: Array<{ from: string; to: string }>; // For cleanStaleConnections operation
|
||||
shouldActivate?: boolean; // Flag to activate workflow after update (for activateWorkflow operation)
|
||||
shouldDeactivate?: boolean; // Flag to deactivate workflow after update (for deactivateWorkflow operation)
|
||||
}
|
||||
|
||||
// Helper type for node reference (supports both ID and name)
|
||||
|
||||
@@ -101,7 +101,6 @@ describe('Integration: handleListAvailableTools', () => {
|
||||
|
||||
// Common known limitations
|
||||
const limitationsText = data.limitations.join(' ');
|
||||
expect(limitationsText).toContain('Cannot activate');
|
||||
expect(limitationsText).toContain('Cannot execute workflows directly');
|
||||
});
|
||||
});
|
||||
|
||||
@@ -156,9 +156,11 @@ describe('handlers-workflow-diff', () => {
|
||||
operationsApplied: 1,
|
||||
workflowId: 'test-workflow-id',
|
||||
workflowName: 'Test Workflow',
|
||||
active: true,
|
||||
applied: [0],
|
||||
failed: [],
|
||||
errors: [],
|
||||
warnings: undefined,
|
||||
},
|
||||
});
|
||||
|
||||
@@ -188,6 +190,7 @@ describe('handlers-workflow-diff', () => {
|
||||
operationsApplied: 1,
|
||||
message: 'Validation successful',
|
||||
errors: [],
|
||||
warnings: []
|
||||
});
|
||||
|
||||
const result = await handleUpdatePartialWorkflow(diffRequest, mockRepository);
|
||||
@@ -199,6 +202,9 @@ describe('handlers-workflow-diff', () => {
|
||||
valid: true,
|
||||
operationsToApply: 1,
|
||||
},
|
||||
details: {
|
||||
warnings: []
|
||||
}
|
||||
});
|
||||
|
||||
expect(mockApiClient.updateWorkflow).not.toHaveBeenCalled();
|
||||
@@ -629,5 +635,211 @@ describe('handlers-workflow-diff', () => {
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
describe('Workflow Activation/Deactivation', () => {
|
||||
it('should activate workflow after successful update', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: false });
|
||||
const updatedWorkflow = { ...testWorkflow, active: false };
|
||||
const activatedWorkflow = { ...testWorkflow, active: true };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldActivate: true,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.activateWorkflow = vi.fn().mockResolvedValue(activatedWorkflow);
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'activateWorkflow' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual(activatedWorkflow);
|
||||
expect(result.message).toContain('Workflow activated');
|
||||
expect(result.details?.active).toBe(true);
|
||||
expect(mockApiClient.activateWorkflow).toHaveBeenCalledWith('test-workflow-id');
|
||||
});
|
||||
|
||||
it('should deactivate workflow after successful update', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: true });
|
||||
const updatedWorkflow = { ...testWorkflow, active: true };
|
||||
const deactivatedWorkflow = { ...testWorkflow, active: false };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldDeactivate: true,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.deactivateWorkflow = vi.fn().mockResolvedValue(deactivatedWorkflow);
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'deactivateWorkflow' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.data).toEqual(deactivatedWorkflow);
|
||||
expect(result.message).toContain('Workflow deactivated');
|
||||
expect(result.details?.active).toBe(false);
|
||||
expect(mockApiClient.deactivateWorkflow).toHaveBeenCalledWith('test-workflow-id');
|
||||
});
|
||||
|
||||
it('should handle activation failure after successful update', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: false });
|
||||
const updatedWorkflow = { ...testWorkflow, active: false };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldActivate: true,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.activateWorkflow = vi.fn().mockRejectedValue(new Error('Activation failed: No trigger nodes'));
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'activateWorkflow' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('Workflow updated successfully but activation failed');
|
||||
expect(result.details).toEqual({
|
||||
workflowUpdated: true,
|
||||
activationError: 'Activation failed: No trigger nodes',
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle deactivation failure after successful update', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: true });
|
||||
const updatedWorkflow = { ...testWorkflow, active: true };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldDeactivate: true,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.deactivateWorkflow = vi.fn().mockRejectedValue(new Error('Deactivation failed'));
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'deactivateWorkflow' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('Workflow updated successfully but deactivation failed');
|
||||
expect(result.details).toEqual({
|
||||
workflowUpdated: true,
|
||||
deactivationError: 'Deactivation failed',
|
||||
});
|
||||
});
|
||||
|
||||
it('should update workflow without activation when shouldActivate is false', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: false });
|
||||
const updatedWorkflow = { ...testWorkflow, active: false };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldActivate: false,
|
||||
shouldDeactivate: false,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.activateWorkflow = vi.fn();
|
||||
mockApiClient.deactivateWorkflow = vi.fn();
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'updateName', name: 'Updated' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.message).not.toContain('activated');
|
||||
expect(result.message).not.toContain('deactivated');
|
||||
expect(mockApiClient.activateWorkflow).not.toHaveBeenCalled();
|
||||
expect(mockApiClient.deactivateWorkflow).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should handle non-Error activation failures', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: false });
|
||||
const updatedWorkflow = { ...testWorkflow, active: false };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldActivate: true,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.activateWorkflow = vi.fn().mockRejectedValue('String error');
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'activateWorkflow' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('Workflow updated successfully but activation failed');
|
||||
expect(result.details).toEqual({
|
||||
workflowUpdated: true,
|
||||
activationError: 'Unknown error',
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle non-Error deactivation failures', async () => {
|
||||
const testWorkflow = createTestWorkflow({ active: true });
|
||||
const updatedWorkflow = { ...testWorkflow, active: true };
|
||||
|
||||
mockApiClient.getWorkflow.mockResolvedValue(testWorkflow);
|
||||
mockDiffEngine.applyDiff.mockResolvedValue({
|
||||
success: true,
|
||||
workflow: updatedWorkflow,
|
||||
operationsApplied: 1,
|
||||
message: 'Success',
|
||||
errors: [],
|
||||
shouldDeactivate: true,
|
||||
});
|
||||
mockApiClient.updateWorkflow.mockResolvedValue(updatedWorkflow);
|
||||
mockApiClient.deactivateWorkflow = vi.fn().mockRejectedValue({ code: 'UNKNOWN' });
|
||||
|
||||
const result = await handleUpdatePartialWorkflow({
|
||||
id: 'test-workflow-id',
|
||||
operations: [{ type: 'deactivateWorkflow' }],
|
||||
}, mockRepository);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('Workflow updated successfully but deactivation failed');
|
||||
expect(result.details).toEqual({
|
||||
workflowUpdated: true,
|
||||
deactivationError: 'Unknown error',
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -802,4 +802,335 @@ describe('EnhancedConfigValidator', () => {
|
||||
expect(result.errors[0].property).toBe('test');
|
||||
});
|
||||
});
|
||||
|
||||
describe('enhanceHttpRequestValidation', () => {
|
||||
it('should suggest alwaysOutputData for HTTP Request nodes', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: 'https://api.example.com/data',
|
||||
method: 'GET'
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true },
|
||||
{ name: 'method', type: 'options', required: false }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
expect(result.valid).toBe(true);
|
||||
expect(result.suggestions).toContainEqual(
|
||||
expect.stringContaining('alwaysOutputData: true at node level')
|
||||
);
|
||||
expect(result.suggestions).toContainEqual(
|
||||
expect.stringContaining('ensures the node produces output even when HTTP requests fail')
|
||||
);
|
||||
});
|
||||
|
||||
it('should suggest responseFormat for API endpoint URLs', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: 'https://api.example.com/data',
|
||||
method: 'GET',
|
||||
options: {} // Empty options, no responseFormat
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true },
|
||||
{ name: 'method', type: 'options', required: false },
|
||||
{ name: 'options', type: 'collection', required: false }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
expect(result.valid).toBe(true);
|
||||
expect(result.suggestions).toContainEqual(
|
||||
expect.stringContaining('responseFormat')
|
||||
);
|
||||
expect(result.suggestions).toContainEqual(
|
||||
expect.stringContaining('options.response.response.responseFormat')
|
||||
);
|
||||
});
|
||||
|
||||
it('should suggest responseFormat for Supabase URLs', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: 'https://xxciwnthnnywanbplqwg.supabase.co/rest/v1/messages',
|
||||
method: 'GET',
|
||||
options: {}
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
expect(result.suggestions).toContainEqual(
|
||||
expect.stringContaining('responseFormat')
|
||||
);
|
||||
});
|
||||
|
||||
it('should NOT suggest responseFormat when already configured', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: 'https://api.example.com/data',
|
||||
method: 'GET',
|
||||
options: {
|
||||
response: {
|
||||
response: {
|
||||
responseFormat: 'json'
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true },
|
||||
{ name: 'options', type: 'collection', required: false }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
const responseFormatSuggestion = result.suggestions.find(
|
||||
(s: string) => s.includes('responseFormat')
|
||||
);
|
||||
expect(responseFormatSuggestion).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should warn about missing protocol in expression-based URLs', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: '=www.{{ $json.domain }}.com',
|
||||
method: 'GET'
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
expect(result.warnings).toContainEqual(
|
||||
expect.objectContaining({
|
||||
type: 'invalid_value',
|
||||
property: 'url',
|
||||
message: expect.stringContaining('missing http:// or https://')
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it('should warn about missing protocol in expressions with template markers', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: '={{ $json.domain }}/api/data',
|
||||
method: 'GET'
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
expect(result.warnings).toContainEqual(
|
||||
expect.objectContaining({
|
||||
type: 'invalid_value',
|
||||
property: 'url',
|
||||
message: expect.stringContaining('missing http:// or https://')
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it('should NOT warn when expression includes http protocol', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: '={{ "https://" + $json.domain + ".com" }}',
|
||||
method: 'GET'
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
const urlWarning = result.warnings.find(
|
||||
(w: any) => w.property === 'url' && w.message.includes('protocol')
|
||||
);
|
||||
expect(urlWarning).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should NOT suggest responseFormat for non-API URLs', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: 'https://example.com/page.html',
|
||||
method: 'GET',
|
||||
options: {}
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
const responseFormatSuggestion = result.suggestions.find(
|
||||
(s: string) => s.includes('responseFormat')
|
||||
);
|
||||
expect(responseFormatSuggestion).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should detect missing protocol in expressions with uppercase HTTP', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const config = {
|
||||
url: '={{ "HTTP://" + $json.domain + ".com" }}',
|
||||
method: 'GET'
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
// Should NOT warn because HTTP:// is present (case-insensitive)
|
||||
expect(result.warnings).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('should NOT suggest responseFormat for false positive URLs', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const testUrls = [
|
||||
'https://example.com/therapist-directory',
|
||||
'https://restaurant-bookings.com/reserve',
|
||||
'https://forest-management.org/data'
|
||||
];
|
||||
|
||||
testUrls.forEach(url => {
|
||||
const config = {
|
||||
url,
|
||||
method: 'GET',
|
||||
options: {}
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
const responseFormatSuggestion = result.suggestions.find(
|
||||
(s: string) => s.includes('responseFormat')
|
||||
);
|
||||
expect(responseFormatSuggestion).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
it('should suggest responseFormat for case-insensitive API paths', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const testUrls = [
|
||||
'https://example.com/API/users',
|
||||
'https://example.com/Rest/data',
|
||||
'https://example.com/REST/v1/items'
|
||||
];
|
||||
|
||||
testUrls.forEach(url => {
|
||||
const config = {
|
||||
url,
|
||||
method: 'GET',
|
||||
options: {}
|
||||
};
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
const result = EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
|
||||
expect(result.suggestions).toContainEqual(
|
||||
expect.stringContaining('responseFormat')
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle null and undefined URLs gracefully', () => {
|
||||
const nodeType = 'nodes-base.httpRequest';
|
||||
const testConfigs = [
|
||||
{ url: null, method: 'GET' },
|
||||
{ url: undefined, method: 'GET' },
|
||||
{ url: '', method: 'GET' }
|
||||
];
|
||||
|
||||
testConfigs.forEach(config => {
|
||||
const properties = [
|
||||
{ name: 'url', type: 'string', required: true }
|
||||
];
|
||||
|
||||
expect(() => {
|
||||
EnhancedConfigValidator.validateWithMode(
|
||||
nodeType,
|
||||
config,
|
||||
properties,
|
||||
'operation',
|
||||
'ai-friendly'
|
||||
);
|
||||
}).not.toThrow();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -362,19 +362,19 @@ describe('N8nApiClient', () => {
|
||||
|
||||
it('should delete workflow successfully', async () => {
|
||||
mockAxiosInstance.delete.mockResolvedValue({ data: {} });
|
||||
|
||||
|
||||
await client.deleteWorkflow('123');
|
||||
|
||||
|
||||
expect(mockAxiosInstance.delete).toHaveBeenCalledWith('/workflows/123');
|
||||
});
|
||||
|
||||
it('should handle deletion error', async () => {
|
||||
const error = {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 404, data: { message: 'Not found' } }
|
||||
response: { status: 404, data: { message: 'Not found' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('delete', error);
|
||||
|
||||
|
||||
try {
|
||||
await client.deleteWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
@@ -386,6 +386,178 @@ describe('N8nApiClient', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('activateWorkflow', () => {
|
||||
beforeEach(() => {
|
||||
client = new N8nApiClient(defaultConfig);
|
||||
});
|
||||
|
||||
it('should activate workflow successfully', async () => {
|
||||
const workflow = { id: '123', name: 'Test', active: false, nodes: [], connections: {} };
|
||||
const activatedWorkflow = { ...workflow, active: true };
|
||||
mockAxiosInstance.post.mockResolvedValue({ data: activatedWorkflow });
|
||||
|
||||
const result = await client.activateWorkflow('123');
|
||||
|
||||
expect(mockAxiosInstance.post).toHaveBeenCalledWith('/workflows/123/activate');
|
||||
expect(result).toEqual(activatedWorkflow);
|
||||
expect(result.active).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle activation error - no trigger nodes', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 400, data: { message: 'Workflow must have at least one trigger node' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.activateWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nValidationError);
|
||||
expect((err as N8nValidationError).message).toContain('trigger node');
|
||||
expect((err as N8nValidationError).statusCode).toBe(400);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle activation error - workflow not found', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 404, data: { message: 'Workflow not found' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.activateWorkflow('non-existent');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nNotFoundError);
|
||||
expect((err as N8nNotFoundError).message).toContain('not found');
|
||||
expect((err as N8nNotFoundError).statusCode).toBe(404);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle activation error - workflow already active', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 400, data: { message: 'Workflow is already active' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.activateWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nValidationError);
|
||||
expect((err as N8nValidationError).message).toContain('already active');
|
||||
expect((err as N8nValidationError).statusCode).toBe(400);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle server error during activation', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 500, data: { message: 'Internal server error' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.activateWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nServerError);
|
||||
expect((err as N8nServerError).message).toBe('Internal server error');
|
||||
expect((err as N8nServerError).statusCode).toBe(500);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('deactivateWorkflow', () => {
|
||||
beforeEach(() => {
|
||||
client = new N8nApiClient(defaultConfig);
|
||||
});
|
||||
|
||||
it('should deactivate workflow successfully', async () => {
|
||||
const workflow = { id: '123', name: 'Test', active: true, nodes: [], connections: {} };
|
||||
const deactivatedWorkflow = { ...workflow, active: false };
|
||||
mockAxiosInstance.post.mockResolvedValue({ data: deactivatedWorkflow });
|
||||
|
||||
const result = await client.deactivateWorkflow('123');
|
||||
|
||||
expect(mockAxiosInstance.post).toHaveBeenCalledWith('/workflows/123/deactivate');
|
||||
expect(result).toEqual(deactivatedWorkflow);
|
||||
expect(result.active).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle deactivation error - workflow not found', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 404, data: { message: 'Workflow not found' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.deactivateWorkflow('non-existent');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nNotFoundError);
|
||||
expect((err as N8nNotFoundError).message).toContain('not found');
|
||||
expect((err as N8nNotFoundError).statusCode).toBe(404);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle deactivation error - workflow already inactive', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 400, data: { message: 'Workflow is already inactive' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.deactivateWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nValidationError);
|
||||
expect((err as N8nValidationError).message).toContain('already inactive');
|
||||
expect((err as N8nValidationError).statusCode).toBe(400);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle server error during deactivation', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 500, data: { message: 'Internal server error' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.deactivateWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nServerError);
|
||||
expect((err as N8nServerError).message).toBe('Internal server error');
|
||||
expect((err as N8nServerError).statusCode).toBe(500);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle authentication error during deactivation', async () => {
|
||||
const error = {
|
||||
message: 'Request failed',
|
||||
response: { status: 401, data: { message: 'Invalid API key' } }
|
||||
};
|
||||
await mockAxiosInstance.simulateError('post', error);
|
||||
|
||||
try {
|
||||
await client.deactivateWorkflow('123');
|
||||
expect.fail('Should have thrown an error');
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(N8nAuthenticationError);
|
||||
expect((err as N8nAuthenticationError).message).toBe('Invalid API key');
|
||||
expect((err as N8nAuthenticationError).statusCode).toBe(401);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('listWorkflows', () => {
|
||||
beforeEach(() => {
|
||||
client = new N8nApiClient(defaultConfig);
|
||||
@@ -413,6 +585,242 @@ describe('N8nApiClient', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('Response Format Validation (PR #367)', () => {
|
||||
beforeEach(() => {
|
||||
client = new N8nApiClient(defaultConfig);
|
||||
});
|
||||
|
||||
describe('listWorkflows - validation', () => {
|
||||
it('should handle modern format with data and nextCursor', async () => {
|
||||
const response = { data: [{ id: '1', name: 'Test' }], nextCursor: 'abc123' };
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: response });
|
||||
|
||||
const result = await client.listWorkflows();
|
||||
|
||||
expect(result).toEqual(response);
|
||||
expect(result.data).toHaveLength(1);
|
||||
expect(result.nextCursor).toBe('abc123');
|
||||
});
|
||||
|
||||
it('should wrap legacy array format and log warning', async () => {
|
||||
const workflows = [{ id: '1', name: 'Test' }];
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: workflows });
|
||||
|
||||
const result = await client.listWorkflows();
|
||||
|
||||
expect(result).toEqual({ data: workflows, nextCursor: null });
|
||||
expect(logger.warn).toHaveBeenCalledWith(
|
||||
expect.stringContaining('n8n API returned array directly')
|
||||
);
|
||||
expect(logger.warn).toHaveBeenCalledWith(
|
||||
expect.stringContaining('workflows')
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on null response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: null });
|
||||
|
||||
await expect(client.listWorkflows()).rejects.toThrow(
|
||||
'Invalid response from n8n API for workflows: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on undefined response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: undefined });
|
||||
|
||||
await expect(client.listWorkflows()).rejects.toThrow(
|
||||
'Invalid response from n8n API for workflows: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on string response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: 'invalid' });
|
||||
|
||||
await expect(client.listWorkflows()).rejects.toThrow(
|
||||
'Invalid response from n8n API for workflows: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on number response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: 42 });
|
||||
|
||||
await expect(client.listWorkflows()).rejects.toThrow(
|
||||
'Invalid response from n8n API for workflows: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on invalid structure with different keys', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { items: [], total: 10 } });
|
||||
|
||||
await expect(client.listWorkflows()).rejects.toThrow(
|
||||
'Invalid response from n8n API for workflows: expected {data: [], nextCursor?: string}, got object with keys: [items, total]'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error when data is not an array', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { data: 'invalid' } });
|
||||
|
||||
await expect(client.listWorkflows()).rejects.toThrow(
|
||||
'Invalid response from n8n API for workflows: expected {data: [], nextCursor?: string}'
|
||||
);
|
||||
});
|
||||
|
||||
it('should limit exposed keys to first 5 when many keys present', async () => {
|
||||
const manyKeys = { items: [], total: 10, page: 1, limit: 20, hasMore: true, metadata: {} };
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: manyKeys });
|
||||
|
||||
try {
|
||||
await client.listWorkflows();
|
||||
expect.fail('Should have thrown error');
|
||||
} catch (error: any) {
|
||||
expect(error.message).toContain('items, total, page, limit, hasMore...');
|
||||
expect(error.message).not.toContain('metadata');
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('listExecutions - validation', () => {
|
||||
it('should handle modern format with data and nextCursor', async () => {
|
||||
const response = { data: [{ id: '1' }], nextCursor: 'abc123' };
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: response });
|
||||
|
||||
const result = await client.listExecutions();
|
||||
|
||||
expect(result).toEqual(response);
|
||||
});
|
||||
|
||||
it('should wrap legacy array format and log warning', async () => {
|
||||
const executions = [{ id: '1' }];
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: executions });
|
||||
|
||||
const result = await client.listExecutions();
|
||||
|
||||
expect(result).toEqual({ data: executions, nextCursor: null });
|
||||
expect(logger.warn).toHaveBeenCalledWith(
|
||||
expect.stringContaining('executions')
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on null response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: null });
|
||||
|
||||
await expect(client.listExecutions()).rejects.toThrow(
|
||||
'Invalid response from n8n API for executions: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on invalid structure', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { items: [] } });
|
||||
|
||||
await expect(client.listExecutions()).rejects.toThrow(
|
||||
'Invalid response from n8n API for executions'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error when data is not an array', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { data: 'invalid' } });
|
||||
|
||||
await expect(client.listExecutions()).rejects.toThrow(
|
||||
'Invalid response from n8n API for executions'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('listCredentials - validation', () => {
|
||||
it('should handle modern format with data and nextCursor', async () => {
|
||||
const response = { data: [{ id: '1' }], nextCursor: 'abc123' };
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: response });
|
||||
|
||||
const result = await client.listCredentials();
|
||||
|
||||
expect(result).toEqual(response);
|
||||
});
|
||||
|
||||
it('should wrap legacy array format and log warning', async () => {
|
||||
const credentials = [{ id: '1' }];
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: credentials });
|
||||
|
||||
const result = await client.listCredentials();
|
||||
|
||||
expect(result).toEqual({ data: credentials, nextCursor: null });
|
||||
expect(logger.warn).toHaveBeenCalledWith(
|
||||
expect.stringContaining('credentials')
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on null response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: null });
|
||||
|
||||
await expect(client.listCredentials()).rejects.toThrow(
|
||||
'Invalid response from n8n API for credentials: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on invalid structure', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { items: [] } });
|
||||
|
||||
await expect(client.listCredentials()).rejects.toThrow(
|
||||
'Invalid response from n8n API for credentials'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error when data is not an array', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { data: 'invalid' } });
|
||||
|
||||
await expect(client.listCredentials()).rejects.toThrow(
|
||||
'Invalid response from n8n API for credentials'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('listTags - validation', () => {
|
||||
it('should handle modern format with data and nextCursor', async () => {
|
||||
const response = { data: [{ id: '1' }], nextCursor: 'abc123' };
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: response });
|
||||
|
||||
const result = await client.listTags();
|
||||
|
||||
expect(result).toEqual(response);
|
||||
});
|
||||
|
||||
it('should wrap legacy array format and log warning', async () => {
|
||||
const tags = [{ id: '1' }];
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: tags });
|
||||
|
||||
const result = await client.listTags();
|
||||
|
||||
expect(result).toEqual({ data: tags, nextCursor: null });
|
||||
expect(logger.warn).toHaveBeenCalledWith(
|
||||
expect.stringContaining('tags')
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on null response', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: null });
|
||||
|
||||
await expect(client.listTags()).rejects.toThrow(
|
||||
'Invalid response from n8n API for tags: response is not an object'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error on invalid structure', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { items: [] } });
|
||||
|
||||
await expect(client.listTags()).rejects.toThrow(
|
||||
'Invalid response from n8n API for tags'
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw error when data is not an array', async () => {
|
||||
mockAxiosInstance.get.mockResolvedValue({ data: { data: 'invalid' } });
|
||||
|
||||
await expect(client.listTags()).rejects.toThrow(
|
||||
'Invalid response from n8n API for tags'
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('getExecution', () => {
|
||||
beforeEach(() => {
|
||||
client = new N8nApiClient(defaultConfig);
|
||||
|
||||
@@ -313,6 +313,7 @@ describe('n8n-validation', () => {
|
||||
createdAt: '2023-01-01',
|
||||
updatedAt: '2023-01-01',
|
||||
versionId: 'v123',
|
||||
versionCounter: 5, // n8n 1.118.1+ field
|
||||
meta: { test: 'data' },
|
||||
staticData: { some: 'data' },
|
||||
pinData: { pin: 'data' },
|
||||
@@ -333,6 +334,7 @@ describe('n8n-validation', () => {
|
||||
expect(cleaned).not.toHaveProperty('createdAt');
|
||||
expect(cleaned).not.toHaveProperty('updatedAt');
|
||||
expect(cleaned).not.toHaveProperty('versionId');
|
||||
expect(cleaned).not.toHaveProperty('versionCounter'); // n8n 1.118.1+ compatibility
|
||||
expect(cleaned).not.toHaveProperty('meta');
|
||||
expect(cleaned).not.toHaveProperty('staticData');
|
||||
expect(cleaned).not.toHaveProperty('pinData');
|
||||
@@ -349,6 +351,22 @@ describe('n8n-validation', () => {
|
||||
expect(cleaned.settings).toEqual({ executionOrder: 'v1' });
|
||||
});
|
||||
|
||||
it('should exclude versionCounter for n8n 1.118.1+ compatibility', () => {
|
||||
const workflow = {
|
||||
name: 'Test Workflow',
|
||||
nodes: [],
|
||||
connections: {},
|
||||
versionId: 'v123',
|
||||
versionCounter: 5, // n8n 1.118.1 returns this but rejects it in PUT
|
||||
} as any;
|
||||
|
||||
const cleaned = cleanWorkflowForUpdate(workflow);
|
||||
|
||||
expect(cleaned).not.toHaveProperty('versionCounter');
|
||||
expect(cleaned).not.toHaveProperty('versionId');
|
||||
expect(cleaned.name).toBe('Test Workflow');
|
||||
});
|
||||
|
||||
it('should add empty settings object for cloud API compatibility', () => {
|
||||
const workflow = {
|
||||
name: 'Test Workflow',
|
||||
|
||||
@@ -380,10 +380,52 @@ describe('WorkflowDiffEngine', () => {
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(baseWorkflow, request);
|
||||
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.errors![0].message).toContain('Node not found');
|
||||
});
|
||||
|
||||
it('should provide helpful error when using "changes" instead of "updates" (Issue #392)', async () => {
|
||||
// Simulate the common mistake of using "changes" instead of "updates"
|
||||
const operation: any = {
|
||||
type: 'updateNode',
|
||||
nodeId: 'http-1',
|
||||
changes: { // Wrong property name
|
||||
'parameters.url': 'https://example.com'
|
||||
}
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(baseWorkflow, request);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.errors![0].message).toContain('Invalid parameter \'changes\'');
|
||||
expect(result.errors![0].message).toContain('requires \'updates\'');
|
||||
expect(result.errors![0].message).toContain('Example:');
|
||||
});
|
||||
|
||||
it('should provide helpful error when "updates" parameter is missing', async () => {
|
||||
const operation: any = {
|
||||
type: 'updateNode',
|
||||
nodeId: 'http-1'
|
||||
// Missing "updates" property
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(baseWorkflow, request);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.errors![0].message).toContain('Missing required parameter \'updates\'');
|
||||
expect(result.errors![0].message).toContain('Example:');
|
||||
});
|
||||
});
|
||||
|
||||
describe('MoveNode Operation', () => {
|
||||
@@ -1418,6 +1460,113 @@ describe('WorkflowDiffEngine', () => {
|
||||
expect(result.workflow!.connections['Switch']['main'][2][0].node).toBe('Handler');
|
||||
expect(result.workflow!.connections['Switch']['main'][1]).toEqual([]);
|
||||
});
|
||||
|
||||
it('should warn when using sourceIndex with If node (issue #360)', async () => {
|
||||
const addIF: any = {
|
||||
type: 'addNode',
|
||||
node: {
|
||||
name: 'Check Condition',
|
||||
type: 'n8n-nodes-base.if',
|
||||
position: [400, 300]
|
||||
}
|
||||
};
|
||||
|
||||
const addSuccess: any = {
|
||||
type: 'addNode',
|
||||
node: {
|
||||
name: 'Success Handler',
|
||||
type: 'n8n-nodes-base.set',
|
||||
position: [600, 200]
|
||||
}
|
||||
};
|
||||
|
||||
const addError: any = {
|
||||
type: 'addNode',
|
||||
node: {
|
||||
name: 'Error Handler',
|
||||
type: 'n8n-nodes-base.set',
|
||||
position: [600, 400]
|
||||
}
|
||||
};
|
||||
|
||||
// BAD: Using sourceIndex with If node (reproduces issue #360)
|
||||
const connectSuccess: any = {
|
||||
type: 'addConnection',
|
||||
source: 'Check Condition',
|
||||
target: 'Success Handler',
|
||||
sourceIndex: 0 // Should use branch="true" instead
|
||||
};
|
||||
|
||||
const connectError: any = {
|
||||
type: 'addConnection',
|
||||
source: 'Check Condition',
|
||||
target: 'Error Handler',
|
||||
sourceIndex: 0 // Should use branch="false" instead - both will end up in main[0]!
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [addIF, addSuccess, addError, connectSuccess, connectError]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(baseWorkflow, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
|
||||
// Should produce warnings
|
||||
expect(result.warnings).toBeDefined();
|
||||
expect(result.warnings!.length).toBe(2);
|
||||
expect(result.warnings![0].message).toContain('Consider using branch="true" or branch="false"');
|
||||
expect(result.warnings![0].message).toContain('If node outputs: main[0]=TRUE branch, main[1]=FALSE branch');
|
||||
expect(result.warnings![1].message).toContain('Consider using branch="true" or branch="false"');
|
||||
|
||||
// Both connections end up in main[0] (the bug behavior)
|
||||
expect(result.workflow!.connections['Check Condition']['main'][0].length).toBe(2);
|
||||
expect(result.workflow!.connections['Check Condition']['main'][0][0].node).toBe('Success Handler');
|
||||
expect(result.workflow!.connections['Check Condition']['main'][0][1].node).toBe('Error Handler');
|
||||
});
|
||||
|
||||
it('should warn when using sourceIndex with Switch node', async () => {
|
||||
const addSwitch: any = {
|
||||
type: 'addNode',
|
||||
node: {
|
||||
name: 'Switch',
|
||||
type: 'n8n-nodes-base.switch',
|
||||
position: [400, 300]
|
||||
}
|
||||
};
|
||||
|
||||
const addHandler: any = {
|
||||
type: 'addNode',
|
||||
node: {
|
||||
name: 'Handler',
|
||||
type: 'n8n-nodes-base.set',
|
||||
position: [600, 300]
|
||||
}
|
||||
};
|
||||
|
||||
// BAD: Using sourceIndex with Switch node
|
||||
const connect: any = {
|
||||
type: 'addConnection',
|
||||
source: 'Switch',
|
||||
target: 'Handler',
|
||||
sourceIndex: 1 // Should use case=1 instead
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [addSwitch, addHandler, connect]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(baseWorkflow, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
|
||||
// Should produce warning
|
||||
expect(result.warnings).toBeDefined();
|
||||
expect(result.warnings!.length).toBe(1);
|
||||
expect(result.warnings![0].message).toContain('Consider using case=N for better clarity');
|
||||
});
|
||||
});
|
||||
|
||||
describe('AddConnection with sourceIndex (Phase 0 Fix)', () => {
|
||||
@@ -4162,4 +4311,358 @@ describe('WorkflowDiffEngine', () => {
|
||||
expect(result.workflow.connections["When clicking 'Execute workflow'"]).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Workflow Activation/Deactivation Operations', () => {
|
||||
it('should activate workflow with activatable trigger nodes', async () => {
|
||||
// Create workflow with webhook trigger (activatable)
|
||||
const workflowWithTrigger = createWorkflow('Test Workflow')
|
||||
.addWebhookNode({ id: 'webhook-1', name: 'Webhook Trigger' })
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.connect('webhook-1', 'http-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections to use node names
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithTrigger.connections)) {
|
||||
const node = workflowWithTrigger.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithTrigger.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithTrigger.connections = newConnections;
|
||||
|
||||
const operation: any = {
|
||||
type: 'activateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithTrigger, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.shouldActivate).toBe(true);
|
||||
expect((result.workflow as any)._shouldActivate).toBeUndefined(); // Flag should be cleaned up
|
||||
});
|
||||
|
||||
it('should reject activation if no activatable trigger nodes', async () => {
|
||||
// Create workflow with no trigger nodes at all
|
||||
const workflowWithoutActivatableTrigger = createWorkflow('Test Workflow')
|
||||
.addNode({
|
||||
id: 'set-1',
|
||||
name: 'Set Node',
|
||||
type: 'n8n-nodes-base.set',
|
||||
typeVersion: 1,
|
||||
position: [100, 100],
|
||||
parameters: {}
|
||||
})
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.connect('set-1', 'http-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections to use node names
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithoutActivatableTrigger.connections)) {
|
||||
const node = workflowWithoutActivatableTrigger.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithoutActivatableTrigger.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithoutActivatableTrigger.connections = newConnections;
|
||||
|
||||
const operation: any = {
|
||||
type: 'activateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithoutActivatableTrigger, request);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.errors).toBeDefined();
|
||||
expect(result.errors![0].message).toContain('No activatable trigger nodes found');
|
||||
expect(result.errors![0].message).toContain('executeWorkflowTrigger cannot activate workflows');
|
||||
});
|
||||
|
||||
it('should reject activation if all trigger nodes are disabled', async () => {
|
||||
// Create workflow with disabled webhook trigger
|
||||
const workflowWithDisabledTrigger = createWorkflow('Test Workflow')
|
||||
.addWebhookNode({ id: 'webhook-1', name: 'Webhook Trigger', disabled: true })
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.connect('webhook-1', 'http-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections to use node names
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithDisabledTrigger.connections)) {
|
||||
const node = workflowWithDisabledTrigger.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithDisabledTrigger.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithDisabledTrigger.connections = newConnections;
|
||||
|
||||
const operation: any = {
|
||||
type: 'activateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithDisabledTrigger, request);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.errors).toBeDefined();
|
||||
expect(result.errors![0].message).toContain('No activatable trigger nodes found');
|
||||
});
|
||||
|
||||
it('should activate workflow with schedule trigger', async () => {
|
||||
// Create workflow with schedule trigger (activatable)
|
||||
const workflowWithSchedule = createWorkflow('Test Workflow')
|
||||
.addNode({
|
||||
id: 'schedule-1',
|
||||
name: 'Schedule',
|
||||
type: 'n8n-nodes-base.scheduleTrigger',
|
||||
typeVersion: 1,
|
||||
position: [100, 100],
|
||||
parameters: { rule: { interval: [{ field: 'hours', hoursInterval: 1 }] } }
|
||||
})
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.connect('schedule-1', 'http-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithSchedule.connections)) {
|
||||
const node = workflowWithSchedule.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithSchedule.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithSchedule.connections = newConnections;
|
||||
|
||||
const operation: any = {
|
||||
type: 'activateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithSchedule, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.shouldActivate).toBe(true);
|
||||
});
|
||||
|
||||
it('should deactivate workflow successfully', async () => {
|
||||
// Any workflow can be deactivated
|
||||
const operation: any = {
|
||||
type: 'deactivateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(baseWorkflow, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.shouldDeactivate).toBe(true);
|
||||
expect((result.workflow as any)._shouldDeactivate).toBeUndefined(); // Flag should be cleaned up
|
||||
});
|
||||
|
||||
it('should deactivate workflow without trigger nodes', async () => {
|
||||
// Create workflow without any trigger nodes
|
||||
const workflowWithoutTrigger = createWorkflow('Test Workflow')
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.addNode({
|
||||
id: 'set-1',
|
||||
name: 'Set',
|
||||
type: 'n8n-nodes-base.set',
|
||||
typeVersion: 1,
|
||||
position: [300, 100],
|
||||
parameters: {}
|
||||
})
|
||||
.connect('http-1', 'set-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithoutTrigger.connections)) {
|
||||
const node = workflowWithoutTrigger.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithoutTrigger.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithoutTrigger.connections = newConnections;
|
||||
|
||||
const operation: any = {
|
||||
type: 'deactivateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithoutTrigger, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.shouldDeactivate).toBe(true);
|
||||
});
|
||||
|
||||
it('should combine activation with other operations', async () => {
|
||||
// Create workflow with webhook trigger
|
||||
const workflowWithTrigger = createWorkflow('Test Workflow')
|
||||
.addWebhookNode({ id: 'webhook-1', name: 'Webhook Trigger' })
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.connect('webhook-1', 'http-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithTrigger.connections)) {
|
||||
const node = workflowWithTrigger.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithTrigger.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithTrigger.connections = newConnections;
|
||||
|
||||
const operations: any[] = [
|
||||
{
|
||||
type: 'updateName',
|
||||
name: 'Updated Workflow Name'
|
||||
},
|
||||
{
|
||||
type: 'addTag',
|
||||
tag: 'production'
|
||||
},
|
||||
{
|
||||
type: 'activateWorkflow'
|
||||
}
|
||||
];
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithTrigger, request);
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.operationsApplied).toBe(3);
|
||||
expect(result.workflow!.name).toBe('Updated Workflow Name');
|
||||
expect(result.workflow!.tags).toContain('production');
|
||||
expect(result.shouldActivate).toBe(true);
|
||||
});
|
||||
|
||||
it('should reject activation if workflow has executeWorkflowTrigger only', async () => {
|
||||
// Create workflow with executeWorkflowTrigger (not activatable - Issue #351)
|
||||
const workflowWithExecuteTrigger = createWorkflow('Test Workflow')
|
||||
.addNode({
|
||||
id: 'execute-1',
|
||||
name: 'Execute Workflow Trigger',
|
||||
type: 'n8n-nodes-base.executeWorkflowTrigger',
|
||||
typeVersion: 1,
|
||||
position: [100, 100],
|
||||
parameters: {}
|
||||
})
|
||||
.addHttpRequestNode({ id: 'http-1', name: 'HTTP Request' })
|
||||
.connect('execute-1', 'http-1')
|
||||
.build() as Workflow;
|
||||
|
||||
// Fix connections
|
||||
const newConnections: any = {};
|
||||
for (const [nodeId, outputs] of Object.entries(workflowWithExecuteTrigger.connections)) {
|
||||
const node = workflowWithExecuteTrigger.nodes.find((n: any) => n.id === nodeId);
|
||||
if (node) {
|
||||
newConnections[node.name] = {};
|
||||
for (const [outputName, connections] of Object.entries(outputs)) {
|
||||
newConnections[node.name][outputName] = (connections as any[]).map((conns: any) =>
|
||||
conns.map((conn: any) => {
|
||||
const targetNode = workflowWithExecuteTrigger.nodes.find((n: any) => n.id === conn.node);
|
||||
return { ...conn, node: targetNode ? targetNode.name : conn.node };
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
workflowWithExecuteTrigger.connections = newConnections;
|
||||
|
||||
const operation: any = {
|
||||
type: 'activateWorkflow'
|
||||
};
|
||||
|
||||
const request: WorkflowDiffRequest = {
|
||||
id: 'test-workflow',
|
||||
operations: [operation]
|
||||
};
|
||||
|
||||
const result = await diffEngine.applyDiff(workflowWithExecuteTrigger, request);
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.errors).toBeDefined();
|
||||
expect(result.errors![0].message).toContain('No activatable trigger nodes found');
|
||||
expect(result.errors![0].message).toContain('executeWorkflowTrigger cannot activate workflows');
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user