first commit

packages/nodes-base/nodes/StopAndError/StopAndError.node.json

@@ -0,0 +1,17 @@
+{
+	"node": "n8n-nodes-base.stopAndError",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Core Nodes", "Utility"],
+	"resources": {
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror/"
+			}
+		]
+	},
+	"alias": ["Throw error", "Error", "Exception"],
+	"subcategories": {
+		"Core Nodes": ["Flow"]
+	}
+}

packages/nodes-base/nodes/StopAndError/StopAndError.node.ts

@@ -0,0 +1,94 @@
+import type {
+	IExecuteFunctions,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes, NodeOperationError } from 'n8n-workflow';
+
+import { createErrorFromParameters } from './utils';
+
+const errorObjectPlaceholder = `{
+	"code": "404",
+	"description": "The resource could not be fetched"
+}`;
+
+export class StopAndError implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Stop and Error',
+		name: 'stopAndError',
+		icon: 'fa:exclamation-triangle',
+		iconColor: 'red',
+		group: ['input'],
+		version: 1,
+		description: 'Throw an error in the workflow',
+		defaults: {
+			name: 'Stop and Error',
+			color: '#ff0000',
+		},
+		inputs: [NodeConnectionTypes.Main],
+
+		outputs: [],
+		properties: [
+			{
+				displayName: 'Error Type',
+				name: 'errorType',
+				type: 'options',
+				options: [
+					{
+						name: 'Error Message',
+						value: 'errorMessage',
+					},
+					{
+						name: 'Error Object',
+						value: 'errorObject',
+					},
+				],
+				default: 'errorMessage',
+				description: 'Type of error to throw',
+			},
+			{
+				displayName: 'Error Message',
+				name: 'errorMessage',
+				type: 'string',
+				placeholder: 'An error occurred!',
+				default: '',
+				required: true,
+				displayOptions: {
+					show: {
+						errorType: ['errorMessage'],
+					},
+				},
+			},
+			{
+				displayName: 'Error Object',
+				name: 'errorObject',
+				type: 'json',
+				description: 'Object containing error properties',
+				default: '',
+				typeOptions: {
+					alwaysOpenEditWindow: true,
+				},
+				placeholder: errorObjectPlaceholder,
+				required: true,
+				displayOptions: {
+					show: {
+						errorType: ['errorObject'],
+					},
+				},
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const errorType = this.getNodeParameter('errorType', 0) as 'errorMessage' | 'errorObject';
+		const errorParameter =
+			errorType === 'errorMessage'
+				? (this.getNodeParameter('errorMessage', 0) as string)
+				: (this.getNodeParameter('errorObject', 0) as string);
+
+		const { message, options } = createErrorFromParameters(errorType, errorParameter);
+
+		throw new NodeOperationError(this.getNode(), message, options);
+	}
+}

packages/nodes-base/nodes/StopAndError/test/node/StopAndError.test.ts

@@ -0,0 +1,79 @@
+import { NodeTestHarness } from '@nodes-testing/node-test-harness';
+import { NodeConnectionTypes, type WorkflowTestData } from 'n8n-workflow';
+
+describe('Execute Stop and Error Node', () => {
+	const testHarness = new NodeTestHarness();
+	const tests: WorkflowTestData[] = [
+		{
+			description: 'should run stopAndError node',
+			input: {
+				workflowData: {
+					nodes: [
+						{
+							parameters: {},
+							id: 'b1dcfb89-3dda-4d18-bdd6-c12d8dee70d2',
+							name: 'When clicking "Execute Workflow"',
+							type: 'n8n-nodes-base.manualTrigger',
+							typeVersion: 1,
+							position: [820, 400],
+						},
+						{
+							parameters: {
+								errorType: 'errorObject',
+								errorObject: '{\n"code": 404,\n"message": "error object from node"\n}',
+							},
+							id: '5dae596a-8956-4149-ba9d-36b6b5e80c4a',
+							name: 'Stop and Error1',
+							type: 'n8n-nodes-base.stopAndError',
+							typeVersion: 1,
+							position: [1080, 300],
+							continueOnFail: true,
+						},
+						{
+							parameters: {
+								errorMessage: 'error message from node 0',
+							},
+							id: '196ca8fe-994d-46aa-a0ed-bd9beeaa490e',
+							name: 'Stop and Error',
+							type: 'n8n-nodes-base.stopAndError',
+							typeVersion: 1,
+							position: [1080, 480],
+							continueOnFail: true,
+						},
+					],
+					connections: {
+						'When clicking "Execute Workflow"': {
+							main: [
+								[
+									{
+										node: 'Stop and Error1',
+										type: NodeConnectionTypes.Main,
+										index: 0,
+									},
+									{
+										node: 'Stop and Error',
+										type: NodeConnectionTypes.Main,
+										index: 0,
+									},
+								],
+							],
+						},
+					},
+				},
+			},
+			output: {
+				nodeExecutionOrder: [
+					'When clicking "Execute Workflow"',
+					'Stop and Error1',
+					'Stop and Error',
+				],
+				nodeData: {},
+				error: 'error message from node 0',
+			},
+		},
+	];
+
+	for (const testData of tests) {
+		testHarness.setupTest(testData);
+	}
+});

packages/nodes-base/nodes/StopAndError/test/utils.test.ts

@@ -0,0 +1,206 @@
+import { createErrorFromParameters } from '../utils';
+
+describe('createErrorFromParameters', () => {
+	describe('Error Message Type', () => {
+		it('should return simple message for errorMessage type', () => {
+			const result = createErrorFromParameters('errorMessage', 'Simple error message');
+
+			expect(result.message).toBe('Simple error message');
+			expect(result.options).toBeUndefined();
+		});
+
+		it('should handle empty error message', () => {
+			const result = createErrorFromParameters('errorMessage', '');
+
+			expect(result.message).toBe('');
+			expect(result.options).toBeUndefined();
+		});
+
+		it('should handle whitespace-only error message', () => {
+			const result = createErrorFromParameters('errorMessage', '   ');
+
+			expect(result.message).toBe('   ');
+			expect(result.options).toBeUndefined();
+		});
+	});
+
+	describe('Error Object Type', () => {
+		it('should extract message from error object', () => {
+			const errorObject = JSON.stringify({
+				message: 'Custom error message',
+				code: '404',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Custom error message');
+			expect(result.options?.level).toBe('error');
+			expect(result.options?.metadata).toEqual({
+				message: 'Custom error message',
+				code: '404',
+			});
+		});
+
+		it('should use description when message is not available', () => {
+			const errorObject = JSON.stringify({
+				description: 'Detailed error description',
+				code: '500',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Detailed error description');
+			expect(result.options?.description).toBe('Detailed error description');
+		});
+
+		it('should use error property when message and description are not available', () => {
+			const errorObject = JSON.stringify({
+				error: 'Something went wrong',
+				code: '400',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Something went wrong');
+			expect(result.options?.description).toBeUndefined();
+		});
+
+		it('should stringify object when no recognizable message properties exist', () => {
+			const errorObjectData = {
+				code: '404',
+				status: 'not found',
+			};
+			const errorObject = JSON.stringify(errorObjectData);
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe(`Error: ${JSON.stringify(errorObjectData)}`);
+			expect(result.options?.metadata).toEqual(errorObjectData);
+		});
+
+		it('should include type and description in options when available', () => {
+			const errorObject = JSON.stringify({
+				message: 'Main error',
+				description: 'Detailed description',
+				type: 'ValidationError',
+				code: '400',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Main error');
+			expect(result.options?.description).toBe('Detailed description');
+			expect(result.options?.type).toBe('ValidationError');
+			expect(result.options?.level).toBe('error');
+		});
+
+		it('should handle complex nested object', () => {
+			const errorObjectData = {
+				message: 'Database error',
+				details: {
+					table: 'users',
+					operation: 'SELECT',
+					constraint: 'foreign_key',
+				},
+				code: 'DB_001',
+			};
+			const errorObject = JSON.stringify(errorObjectData);
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Database error');
+			expect(result.options?.metadata).toEqual(errorObjectData);
+		});
+
+		it('should handle object with null and undefined values', () => {
+			const errorObject = JSON.stringify({
+				message: 'Test message',
+				description: null,
+				type: undefined,
+				code: '200',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Test message');
+			expect(result.options?.description).toBeUndefined();
+			expect(result.options?.type).toBeUndefined();
+		});
+
+		it('should prioritize message over description and error', () => {
+			const errorObject = JSON.stringify({
+				message: 'Primary message',
+				description: 'Secondary description',
+				error: 'Tertiary error',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Primary message');
+		});
+
+		it('should prioritize description over error when message is not available', () => {
+			const errorObject = JSON.stringify({
+				description: 'Primary description',
+				error: 'Secondary error',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Primary description');
+			expect(result.options?.description).toBe('Primary description');
+		});
+	});
+
+	describe('Invalid JSON Handling', () => {
+		it('should throw error for invalid JSON in errorObject type', () => {
+			expect(() => {
+				createErrorFromParameters('errorObject', '{invalid json}');
+			}).toThrow();
+		});
+
+		it('should handle empty JSON object', () => {
+			const result = createErrorFromParameters('errorObject', '{}');
+
+			expect(result.message).toBe('Error: {}');
+			expect(result.options?.metadata).toEqual({});
+		});
+	});
+
+	describe('Edge Cases', () => {
+		it('should handle arrays in error object', () => {
+			const errorObjectData = {
+				message: 'Validation failed',
+				errors: ['Field required', 'Invalid format'],
+			};
+			const errorObject = JSON.stringify(errorObjectData);
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Validation failed');
+			expect(result.options?.metadata).toEqual(errorObjectData);
+		});
+
+		it('should handle empty string values in message fields', () => {
+			const errorObject = JSON.stringify({
+				message: '',
+				description: 'Fallback description',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('Fallback description');
+		});
+
+		it('should handle whitespace-only string values in message fields', () => {
+			const errorObject = JSON.stringify({
+				message: '   ',
+				description: 'Fallback description',
+			});
+
+			const result = createErrorFromParameters('errorObject', errorObject);
+
+			expect(result.message).toBe('   ');
+		});
+	});
+});

packages/nodes-base/nodes/StopAndError/utils.ts

@@ -0,0 +1,45 @@
+import type { JsonObject } from 'n8n-workflow';
+import { jsonParse } from 'n8n-workflow';
+
+export interface ErrorHandlerResult {
+	message: string;
+	options?: {
+		description?: string;
+		type?: string;
+		level: 'error';
+		metadata?: JsonObject;
+	};
+}
+
+function isString(value: unknown): value is string {
+	return typeof value === 'string' && value.length > 0;
+}
+
+export function createErrorFromParameters(
+	errorType: 'errorMessage' | 'errorObject',
+	errorParameter: string,
+): ErrorHandlerResult {
+	if (errorType === 'errorMessage') {
+		return {
+			message: errorParameter,
+		};
+	} else {
+		const errorObject = jsonParse<JsonObject>(errorParameter);
+
+		const errorMessage =
+			(isString(errorObject.message) ? errorObject.message : '') ||
+			(isString(errorObject.description) ? errorObject.description : '') ||
+			(isString(errorObject.error) ? errorObject.error : '') ||
+			`Error: ${JSON.stringify(errorObject)}`;
+
+		return {
+			message: errorMessage,
+			options: {
+				description: isString(errorObject.description) ? errorObject.description : undefined,
+				type: isString(errorObject.type) ? errorObject.type : undefined,
+				level: 'error',
+				metadata: errorObject,
+			},
+		};
+	}
+}