feat(Switch Node): Add support for infinite Switch outputs (#7499)

Github issue / Community forum post (link here to close automatically):
https://community.n8n.io/t/add-more-outputs-to-switch-node/3864

---------

Signed-off-by: Oleg Ivaniv <me@olegivaniv.com>
This commit is contained in:
OlegIvaniv
2023-10-25 14:34:47 +02:00
committed by GitHub
parent 6f45298d3d
commit 2febc61ec9
19 changed files with 1933 additions and 751 deletions

View File

@@ -0,0 +1,686 @@
import type {
IExecuteFunctions,
INodeExecutionData,
INodeParameters,
INodeType,
INodeTypeBaseDescription,
INodeTypeDescription,
NodeParameterValue,
} from 'n8n-workflow';
import { NodeOperationError } from 'n8n-workflow';
export class SwitchV1 implements INodeType {
description: INodeTypeDescription;
constructor(baseDescription: INodeTypeBaseDescription) {
this.description = {
...baseDescription,
version: [1],
defaults: {
name: 'Switch',
color: '#506000',
},
inputs: ['main'],
outputs: ['main', 'main', 'main', 'main'],
outputNames: ['0', '1', '2', '3'],
properties: [
{
displayName: 'Mode',
name: 'mode',
type: 'options',
options: [
{
name: 'Expression',
value: 'expression',
description: 'Expression decides how to route data',
},
{
name: 'Rules',
value: 'rules',
description: 'Rules decide how to route data',
},
],
default: 'rules',
description: 'How data should be routed',
},
// ----------------------------------
// mode:expression
// ----------------------------------
{
displayName: 'Output',
name: 'output',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 3,
},
displayOptions: {
show: {
mode: ['expression'],
},
},
default: 0,
description: 'The index of output to which to send data to',
},
// ----------------------------------
// mode:rules
// ----------------------------------
{
displayName: 'Data Type',
name: 'dataType',
type: 'options',
displayOptions: {
show: {
mode: ['rules'],
},
},
options: [
{
name: 'Boolean',
value: 'boolean',
},
{
name: 'Date & Time',
value: 'dateTime',
},
{
name: 'Number',
value: 'number',
},
{
name: 'String',
value: 'string',
},
],
default: 'number',
description: 'The type of data to route on',
},
// ----------------------------------
// dataType:boolean
// ----------------------------------
{
displayName: 'Value 1',
name: 'value1',
type: 'boolean',
displayOptions: {
show: {
dataType: ['boolean'],
mode: ['rules'],
},
},
default: false,
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
description: 'The value to compare with the first one',
},
{
displayName: 'Routing Rules',
name: 'rules',
placeholder: 'Add Routing Rule',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
dataType: ['boolean'],
mode: ['rules'],
},
},
default: {},
options: [
{
name: 'rules',
displayName: 'Boolean',
values: [
// eslint-disable-next-line n8n-nodes-base/node-param-operation-without-no-data-expression
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: 'Equal',
value: 'equal',
},
{
name: 'Not Equal',
value: 'notEqual',
},
],
default: 'equal',
description: 'Operation to decide where the the data should be mapped to',
},
{
displayName: 'Value 2',
name: 'value2',
type: 'boolean',
default: false,
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
description: 'The value to compare with the first one',
},
{
displayName: 'Output',
name: 'output',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 3,
},
default: 0,
description: 'The index of output to which to send data to if rule matches',
},
],
},
],
},
// ----------------------------------
// dataType:dateTime
// ----------------------------------
{
displayName: 'Value 1',
name: 'value1',
type: 'dateTime',
displayOptions: {
show: {
dataType: ['dateTime'],
mode: ['rules'],
},
},
default: '',
description: 'The value to compare with the second one',
},
{
displayName: 'Routing Rules',
name: 'rules',
placeholder: 'Add Routing Rule',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
dataType: ['dateTime'],
mode: ['rules'],
},
},
default: {},
options: [
{
name: 'rules',
displayName: 'Dates',
values: [
// eslint-disable-next-line n8n-nodes-base/node-param-operation-without-no-data-expression
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: 'Occurred After',
value: 'after',
},
{
name: 'Occurred Before',
value: 'before',
},
],
default: 'after',
description: 'Operation to decide where the the data should be mapped to',
},
{
displayName: 'Value 2',
name: 'value2',
type: 'dateTime',
default: 0,
description: 'The value to compare with the first one',
},
{
displayName: 'Output',
name: 'output',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 3,
},
default: 0,
description: 'The index of output to which to send data to if rule matches',
},
],
},
],
},
// ----------------------------------
// dataType:number
// ----------------------------------
{
displayName: 'Value 1',
name: 'value1',
type: 'number',
displayOptions: {
show: {
dataType: ['number'],
mode: ['rules'],
},
},
default: 0,
description: 'The value to compare with the second one',
},
{
displayName: 'Routing Rules',
name: 'rules',
placeholder: 'Add Routing Rule',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
dataType: ['number'],
mode: ['rules'],
},
},
default: {},
options: [
{
name: 'rules',
displayName: 'Numbers',
values: [
// eslint-disable-next-line n8n-nodes-base/node-param-operation-without-no-data-expression
{
displayName: 'Operation',
name: 'operation',
type: 'options',
// eslint-disable-next-line n8n-nodes-base/node-param-options-type-unsorted-items
options: [
{
name: 'Smaller',
value: 'smaller',
},
{
name: 'Smaller Equal',
value: 'smallerEqual',
},
{
name: 'Equal',
value: 'equal',
},
{
name: 'Not Equal',
value: 'notEqual',
},
{
name: 'Larger',
value: 'larger',
},
{
name: 'Larger Equal',
value: 'largerEqual',
},
],
default: 'smaller',
description: 'Operation to decide where the the data should be mapped to',
},
{
displayName: 'Value 2',
name: 'value2',
type: 'number',
default: 0,
description: 'The value to compare with the first one',
},
{
displayName: 'Output',
name: 'output',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 3,
},
default: 0,
description: 'The index of output to which to send data to if rule matches',
},
],
},
],
},
// ----------------------------------
// dataType:string
// ----------------------------------
{
displayName: 'Value 1',
name: 'value1',
type: 'string',
displayOptions: {
show: {
dataType: ['string'],
mode: ['rules'],
},
},
default: '',
description: 'The value to compare with the second one',
},
{
displayName: 'Routing Rules',
name: 'rules',
placeholder: 'Add Routing Rule',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
dataType: ['string'],
mode: ['rules'],
},
},
default: {},
options: [
{
name: 'rules',
displayName: 'Strings',
values: [
// eslint-disable-next-line n8n-nodes-base/node-param-operation-without-no-data-expression
{
displayName: 'Operation',
name: 'operation',
type: 'options',
// eslint-disable-next-line n8n-nodes-base/node-param-options-type-unsorted-items
options: [
{
name: 'Contains',
value: 'contains',
},
{
name: 'Not Contains',
value: 'notContains',
},
{
name: 'Ends With',
value: 'endsWith',
},
{
name: 'Not Ends With',
value: 'notEndsWith',
},
{
name: 'Equal',
value: 'equal',
},
{
name: 'Not Equal',
value: 'notEqual',
},
{
name: 'Regex Match',
value: 'regex',
},
{
name: 'Regex Not Match',
value: 'notRegex',
},
{
name: 'Starts With',
value: 'startsWith',
},
{
name: 'Not Starts With',
value: 'notStartsWith',
},
],
default: 'equal',
description: 'Operation to decide where the the data should be mapped to',
},
{
displayName: 'Value 2',
name: 'value2',
type: 'string',
displayOptions: {
hide: {
operation: ['regex', 'notRegex'],
},
},
default: '',
description: 'The value to compare with the first one',
},
{
displayName: 'Regex',
name: 'value2',
type: 'string',
displayOptions: {
show: {
operation: ['regex', 'notRegex'],
},
},
default: '',
placeholder: '/text/i',
description: 'The regex which has to match',
},
{
displayName: 'Output',
name: 'output',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 3,
},
default: 0,
description: 'The index of output to which to send data to if rule matches',
},
],
},
],
},
{
displayName: 'Fallback Output',
name: 'fallbackOutput',
type: 'options',
displayOptions: {
show: {
mode: ['rules'],
},
},
// eslint-disable-next-line n8n-nodes-base/node-param-options-type-unsorted-items
options: [
{
name: 'None',
value: -1,
},
{
name: '0',
value: 0,
},
{
name: '1',
value: 1,
},
{
name: '2',
value: 2,
},
{
name: '3',
value: 3,
},
],
default: -1,
description: 'The output to which to route all items which do not match any of the rules',
},
],
};
}
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const returnData: INodeExecutionData[][] = [[], [], [], []];
const items = this.getInputData();
let compareOperationResult: boolean;
let item: INodeExecutionData;
let mode: string;
let outputIndex: number;
let ruleData: INodeParameters;
// The compare operations
const compareOperationFunctions: {
[key: string]: (value1: NodeParameterValue, value2: NodeParameterValue) => boolean;
} = {
after: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || 0) > (value2 || 0),
before: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || 0) < (value2 || 0),
contains: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || '').toString().includes((value2 || '').toString()),
notContains: (value1: NodeParameterValue, value2: NodeParameterValue) =>
!(value1 || '').toString().includes((value2 || '').toString()),
endsWith: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 as string).endsWith(value2 as string),
notEndsWith: (value1: NodeParameterValue, value2: NodeParameterValue) =>
!(value1 as string).endsWith(value2 as string),
equal: (value1: NodeParameterValue, value2: NodeParameterValue) => value1 === value2,
notEqual: (value1: NodeParameterValue, value2: NodeParameterValue) => value1 !== value2,
larger: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || 0) > (value2 || 0),
largerEqual: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || 0) >= (value2 || 0),
smaller: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || 0) < (value2 || 0),
smallerEqual: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 || 0) <= (value2 || 0),
startsWith: (value1: NodeParameterValue, value2: NodeParameterValue) =>
(value1 as string).startsWith(value2 as string),
notStartsWith: (value1: NodeParameterValue, value2: NodeParameterValue) =>
!(value1 as string).startsWith(value2 as string),
regex: (value1: NodeParameterValue, value2: NodeParameterValue) => {
const regexMatch = (value2 || '').toString().match(new RegExp('^/(.*?)/([gimusy]*)$'));
let regex: RegExp;
if (!regexMatch) {
regex = new RegExp((value2 || '').toString());
} else if (regexMatch.length === 1) {
regex = new RegExp(regexMatch[1]);
} else {
regex = new RegExp(regexMatch[1], regexMatch[2]);
}
return !!(value1 || '').toString().match(regex);
},
notRegex: (value1: NodeParameterValue, value2: NodeParameterValue) => {
const regexMatch = (value2 || '').toString().match(new RegExp('^/(.*?)/([gimusy]*)$'));
let regex: RegExp;
if (!regexMatch) {
regex = new RegExp((value2 || '').toString());
} else if (regexMatch.length === 1) {
regex = new RegExp(regexMatch[1]);
} else {
regex = new RegExp(regexMatch[1], regexMatch[2]);
}
return !(value1 || '').toString().match(regex);
},
};
// Converts the input data of a dateTime into a number for easy compare
const convertDateTime = (value: NodeParameterValue): number => {
let returnValue: number | undefined = undefined;
if (typeof value === 'string') {
returnValue = new Date(value).getTime();
} else if (typeof value === 'number') {
returnValue = value;
}
if ((value as unknown as object) instanceof Date) {
returnValue = (value as unknown as Date).getTime();
}
if (returnValue === undefined || isNaN(returnValue)) {
throw new NodeOperationError(
this.getNode(),
`The value "${value}" is not a valid DateTime.`,
);
}
return returnValue;
};
const checkIndexRange = (index: number) => {
if (index < 0 || index >= returnData.length) {
throw new NodeOperationError(
this.getNode(),
`The ouput ${index} is not allowed. It has to be between 0 and ${returnData.length - 1}!`,
);
}
};
// Iterate over all items to check to which output they should be routed to
itemLoop: for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
try {
item = items[itemIndex];
mode = this.getNodeParameter('mode', itemIndex) as string;
if (mode === 'expression') {
// One expression decides how to route item
outputIndex = this.getNodeParameter('output', itemIndex) as number;
checkIndexRange(outputIndex);
returnData[outputIndex].push(item);
} else if (mode === 'rules') {
// Rules decide how to route item
const dataType = this.getNodeParameter('dataType', 0) as string;
let value1 = this.getNodeParameter('value1', itemIndex) as NodeParameterValue;
if (dataType === 'dateTime') {
value1 = convertDateTime(value1);
}
for (ruleData of this.getNodeParameter(
'rules.rules',
itemIndex,
[],
) as INodeParameters[]) {
// Check if the values passes
let value2 = ruleData.value2 as NodeParameterValue;
if (dataType === 'dateTime') {
value2 = convertDateTime(value2);
}
compareOperationResult = compareOperationFunctions[ruleData.operation as string](
value1,
value2,
);
if (compareOperationResult) {
// If rule matches add it to the correct output and continue with next item
checkIndexRange(ruleData.output as number);
returnData[ruleData.output as number].push(item);
continue itemLoop;
}
}
// Check if a fallback output got defined and route accordingly
outputIndex = this.getNodeParameter('fallbackOutput', itemIndex) as number;
if (outputIndex !== -1) {
checkIndexRange(outputIndex);
returnData[outputIndex].push(item);
}
}
} catch (error) {
if (this.continueOnFail()) {
returnData[0].push({ json: { error: error.message } });
continue;
}
throw error;
}
}
return returnData;
}
}

View File

@@ -0,0 +1,225 @@
{
"name": "review node unit tests",
"nodes": [
{
"parameters": {},
"id": "fb04a728-d2b9-4b98-8d3b-3762b0a60c43",
"name": "When clicking \"Execute Workflow\"",
"type": "n8n-nodes-base.manualTrigger",
"typeVersion": 1,
"position": [
-7020,
1700
]
},
{
"parameters": {
"mode": "expression",
"output": "={{ $json.data }}"
},
"id": "6addcb47-5a9d-4a02-a915-b3b60b2ffad3",
"name": "Switch",
"type": "n8n-nodes-base.switch",
"typeVersion": 1,
"position": [
-6460,
1700
]
},
{
"parameters": {
"values": {
"number": [
{
"name": "data[0]"
},
{
"name": "data[1]",
"value": 1
},
{
"name": "data[2]",
"value": 2
},
{
"name": "data[3]",
"value": 3
}
]
},
"options": {}
},
"id": "b1f9468e-4604-48ff-a851-4041b224f9a5",
"name": "Set",
"type": "n8n-nodes-base.set",
"typeVersion": 1,
"position": [
-6840,
1700
]
},
{
"parameters": {},
"id": "66650986-03a4-4cd7-a7c9-3792218cb2f5",
"name": "Output 0",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-6180,
1460
]
},
{
"parameters": {
"fieldToSplitOut": "data",
"options": {}
},
"id": "808579aa-9da2-4c6b-bdd6-387119593d97",
"name": "Item Lists",
"type": "n8n-nodes-base.itemLists",
"typeVersion": 1,
"position": [
-6660,
1700
]
},
{
"parameters": {},
"id": "dd764387-3ff7-4a6c-8451-3a0511f80415",
"name": "Output 1",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-6180,
1620
]
},
{
"parameters": {},
"id": "02561ebf-8054-4d12-98b1-e099bcb20b34",
"name": "Output 2",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-6180,
1780
]
},
{
"parameters": {},
"id": "bfaaacd7-956c-4e6f-bc40-f6459bc43faa",
"name": "Output 3",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-6180,
1940
]
}
],
"pinData": {
"Output 0": [
{
"json": {
"data": 0
}
}
],
"Output 1": [
{
"json": {
"data": 1
}
}
],
"Output 2": [
{
"json": {
"data": 2
}
}
],
"Output 3": [
{
"json": {
"data": 3
}
}
]
},
"connections": {
"When clicking \"Execute Workflow\"": {
"main": [
[
{
"node": "Set",
"type": "main",
"index": 0
}
]
]
},
"Switch": {
"main": [
[
{
"node": "Output 0",
"type": "main",
"index": 0
}
],
[
{
"node": "Output 1",
"type": "main",
"index": 0
}
],
[
{
"node": "Output 2",
"type": "main",
"index": 0
}
],
[
{
"node": "Output 3",
"type": "main",
"index": 0
}
]
]
},
"Set": {
"main": [
[
{
"node": "Item Lists",
"type": "main",
"index": 0
}
]
]
},
"Item Lists": {
"main": [
[
{
"node": "Switch",
"type": "main",
"index": 0
}
]
]
}
},
"active": false,
"settings": {},
"versionId": "d9f4d9b1-a282-473e-a527-f1e6c3b5bb89",
"id": "182",
"meta": {
"instanceId": "104a4d08d8897b8bdeb38aaca515021075e0bd8544c983c2bb8c86e6a8e6081c"
},
"tags": []
}

View File

@@ -0,0 +1,4 @@
import { testWorkflows, getWorkflowFilenames } from '@test/nodes/Helpers';
const workflows = getWorkflowFilenames(__dirname);
describe('Execute Switch Node', () => testWorkflows(workflows));

View File

@@ -0,0 +1,242 @@
{
"name": "review node unit tests",
"nodes": [
{
"parameters": {},
"id": "ec017d65-ca3c-4df3-ba84-e79da16c05b3",
"name": "When clicking \"Execute Workflow\"",
"type": "n8n-nodes-base.manualTrigger",
"typeVersion": 1,
"position": [
-8460,
1740
]
},
{
"parameters": {
"values": {
"number": [
{
"name": "data[0]"
},
{
"name": "data[1]",
"value": 1
},
{
"name": "data[2]",
"value": 2
},
{
"name": "data[3]",
"value": 3
}
]
},
"options": {}
},
"id": "1a799394-e0a8-459f-b9a6-0b656e315df6",
"name": "Set",
"type": "n8n-nodes-base.set",
"typeVersion": 1,
"position": [
-8280,
1740
]
},
{
"parameters": {},
"id": "56138ddd-b0b7-429e-b740-37da602fd250",
"name": "Output 0",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-7640,
1500
]
},
{
"parameters": {
"fieldToSplitOut": "data",
"options": {}
},
"id": "a2af4a95-866c-44ac-9a58-0eb94fe6a27a",
"name": "Item Lists",
"type": "n8n-nodes-base.itemLists",
"typeVersion": 1,
"position": [
-8100,
1740
]
},
{
"parameters": {},
"id": "55dd8064-5ed1-49ab-9c9a-5de8266b0c87",
"name": "Output 1",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-7640,
1660
]
},
{
"parameters": {},
"id": "605a11b1-6fe2-48cc-944f-0f8d89cff669",
"name": "Output 2",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-7640,
1820
]
},
{
"parameters": {},
"id": "6615c351-46ba-4013-b49b-9f44f5195a2e",
"name": "Output 3",
"type": "n8n-nodes-base.noOp",
"typeVersion": 1,
"position": [
-7640,
1980
]
},
{
"parameters": {
"value1": "={{ $json.data }}",
"rules": {
"rules": [
{
"operation": "equal"
},
{
"operation": "equal",
"value2": 1,
"output": 1
},
{
"operation": "equal",
"value2": 2,
"output": 2
}
]
},
"fallbackOutput": 3
},
"id": "176e3656-28fb-45b9-9ac5-385c4c544d9e",
"name": "Switch",
"type": "n8n-nodes-base.switch",
"typeVersion": 1,
"position": [
-7900,
1740
]
}
],
"pinData": {
"Output 0": [
{
"json": {
"data": 0
}
}
],
"Output 1": [
{
"json": {
"data": 1
}
}
],
"Output 2": [
{
"json": {
"data": 2
}
}
],
"Output 3": [
{
"json": {
"data": 3
}
}
]
},
"connections": {
"When clicking \"Execute Workflow\"": {
"main": [
[
{
"node": "Set",
"type": "main",
"index": 0
}
]
]
},
"Set": {
"main": [
[
{
"node": "Item Lists",
"type": "main",
"index": 0
}
]
]
},
"Item Lists": {
"main": [
[
{
"node": "Switch",
"type": "main",
"index": 0
}
]
]
},
"Switch": {
"main": [
[
{
"node": "Output 0",
"type": "main",
"index": 0
}
],
[
{
"node": "Output 1",
"type": "main",
"index": 0
}
],
[
{
"node": "Output 2",
"type": "main",
"index": 0
}
],
[
{
"node": "Output 3",
"type": "main",
"index": 0
}
]
]
}
},
"active": false,
"settings": {},
"versionId": "962a14d7-c5a6-4e29-96f3-6208877d3d45",
"id": "182",
"meta": {
"instanceId": "104a4d08d8897b8bdeb38aaca515021075e0bd8544c983c2bb8c86e6a8e6081c"
},
"tags": []
}