From f667c3ec48cedf5af5ed38aca21c51c476c1bd8c Mon Sep 17 00:00:00 2001
From: Alex Grozav <alex@grozav.com>
Date: Tue, 4 Mar 2025 15:05:05 +0200
Subject: [PATCH 1/5] feat(editor): Add support for Simulate nodes to new
 canvas

---
 .../src/components/canvas/Canvas.vue          |  6 ++++
 .../src/components/canvas/WorkflowCanvas.vue  | 34 ++++++++++++++++++-
 .../canvas/elements/nodes/CanvasNode.vue      | 11 +++---
 .../src/composables/useCanvasMapping.ts       | 30 +++++++++++++++-
 .../frontend/editor-ui/src/types/canvas.ts    |  1 +
 5 files changed, 73 insertions(+), 9 deletions(-)

diff --git a/packages/frontend/editor-ui/src/components/canvas/Canvas.vue b/packages/frontend/editor-ui/src/components/canvas/Canvas.vue
index 918b0b06a3..f82931ae89 100644
--- a/packages/frontend/editor-ui/src/components/canvas/Canvas.vue
+++ b/packages/frontend/editor-ui/src/components/canvas/Canvas.vue
@@ -45,6 +45,7 @@ import { onKeyDown, onKeyUp, useThrottleFn } from '@vueuse/core';
 import CanvasArrowHeadMarker from './elements/edges/CanvasArrowHeadMarker.vue';
 import CanvasBackground from './elements/background/CanvasBackground.vue';
 import { useCanvasTraversal } from '@/composables/useCanvasTraversal';
+import type { INodeTypeDescription } from 'n8n-workflow';
 import { NodeConnectionType } from 'n8n-workflow';
 import { useCanvasNodeHover } from '@/composables/useCanvasNodeHover';
 import { useCanvasLayout } from '@/composables/useCanvasLayout';
@@ -96,6 +97,7 @@ const props = withDefaults(
 	defineProps<{
 		id?: string;
 		nodes: CanvasNode[];
+		nodeTypeDescriptions: Record<string, INodeTypeDescription>;
 		connections: CanvasConnection[];
 		controlsPosition?: PanelPosition;
 		eventBus?: EventBus<CanvasEventBusEvents>;
@@ -804,6 +806,10 @@ provide(CanvasKey, {
 				:event-bus="eventBus"
 				:hovered="nodesHoveredById[nodeProps.id]"
 				:nearby-hovered="nodeProps.id === hoveredTriggerNode.id.value"
+				:node-type-description="
+					nodeTypeDescriptions[`${nodeProps.data.type}@${nodeProps.data.typeVersion}`]
+				"
+				:simulated-node-type-description="nodeTypeDescriptions[nodeProps.data.simulatedType]"
 				@delete="onDeleteNode"
 				@run="onRunNode"
 				@select="onSelectNode"
diff --git a/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue b/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
index b91c6dba37..aaa5b00338 100644
--- a/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
+++ b/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
@@ -1,13 +1,15 @@
 <script setup lang="ts">
 import Canvas from '@/components/canvas/Canvas.vue';
 import { computed, ref, toRef, useCssModule } from 'vue';
-import type { Workflow } from 'n8n-workflow';
+import type { INodeTypeDescription, Workflow } from 'n8n-workflow';
 import type { IWorkflowDb } from '@/Interface';
 import { useCanvasMapping } from '@/composables/useCanvasMapping';
 import type { EventBus } from '@n8n/utils/event-bus';
 import { createEventBus } from '@n8n/utils/event-bus';
 import type { CanvasEventBusEvents } from '@/types';
 import { useVueFlow } from '@vue-flow/core';
+import { useNodeTypesStore } from '@/stores/nodeTypes.store';
+import { SIMULATE_NODE_TYPE, SIMULATE_TRIGGER_NODE_TYPE } from '@/constants';
 
 defineOptions({
 	inheritAttrs: false,
@@ -34,6 +36,8 @@ const props = withDefaults(
 
 const $style = useCssModule();
 
+const nodeTypesStore = useNodeTypesStore();
+
 const { onNodesInitialized } = useVueFlow({ id: props.id });
 
 const workflow = toRef(props, 'workflow');
@@ -52,6 +56,33 @@ const { nodes: mappedNodes, connections: mappedConnections } = useCanvasMapping(
 	workflowObject,
 });
 
+const nodeTypeDescriptions = computed(() => {
+	return mappedNodes.value.reduce<Record<string, INodeTypeDescription>>((acc, node) => {
+		if (!node.data) {
+			return acc;
+		}
+
+		if (node.data.simulatedType) {
+			const simulatedNodeType = nodeTypesStore.getNodeType(node.data.simulatedType);
+			if (simulatedNodeType) {
+				acc[simulatedNodeType.name] = simulatedNodeType;
+			}
+		}
+
+		const key = `${node.data.type}@${node.data.typeVersion}`;
+		if (acc[key]) {
+			return acc;
+		}
+
+		const nodeTypeDescription = nodeTypesStore.getNodeType(node.data.type, node.data.typeVersion);
+		if (nodeTypeDescription) {
+			acc[key] = nodeTypeDescription;
+		}
+
+		return acc;
+	}, {});
+});
+
 const initialFitViewDone = ref(false); // Workaround for https://github.com/bcakmakoglu/vue-flow/issues/1636
 onNodesInitialized(() => {
 	if (!initialFitViewDone.value || props.showFallbackNodes) {
@@ -68,6 +99,7 @@ onNodesInitialized(() => {
 				v-if="workflow"
 				:id="id"
 				:nodes="mappedNodes"
+				:node-type-descriptions="nodeTypeDescriptions"
 				:connections="mappedConnections"
 				:event-bus="eventBus"
 				:read-only="readOnly"
diff --git a/packages/frontend/editor-ui/src/components/canvas/elements/nodes/CanvasNode.vue b/packages/frontend/editor-ui/src/components/canvas/elements/nodes/CanvasNode.vue
index f0ac39c9f7..6bde872d4f 100644
--- a/packages/frontend/editor-ui/src/components/canvas/elements/nodes/CanvasNode.vue
+++ b/packages/frontend/editor-ui/src/components/canvas/elements/nodes/CanvasNode.vue
@@ -18,7 +18,6 @@ import type {
 } from '@/types';
 import { CanvasConnectionMode, CanvasNodeRenderType } from '@/types';
 import NodeIcon from '@/components/NodeIcon.vue';
-import { useNodeTypesStore } from '@/stores/nodeTypes.store';
 import CanvasNodeToolbar from '@/components/canvas/elements/nodes/CanvasNodeToolbar.vue';
 import CanvasNodeRenderer from '@/components/canvas/elements/nodes/CanvasNodeRenderer.vue';
 import CanvasHandleRenderer from '@/components/canvas/elements/handles/CanvasHandleRenderer.vue';
@@ -36,12 +35,15 @@ import type { EventBus } from '@n8n/utils/event-bus';
 import { createEventBus } from '@n8n/utils/event-bus';
 import { isEqual } from 'lodash-es';
 import CanvasNodeTrigger from '@/components/canvas/elements/nodes/render-types/parts/CanvasNodeTrigger.vue';
+import type { INodeTypeDescription } from 'n8n-workflow';
 
 type Props = NodeProps<CanvasNodeData> & {
 	readOnly?: boolean;
 	eventBus?: EventBus<CanvasEventBusEvents>;
 	hovered?: boolean;
 	nearbyHovered?: boolean;
+	nodeTypeDescription: INodeTypeDescription;
+	simulatedNodeTypeDescription?: INodeTypeDescription;
 };
 
 const slots = defineSlots<{
@@ -71,7 +73,6 @@ const style = useCssModule();
 
 const props = defineProps<Props>();
 
-const nodeTypesStore = useNodeTypesStore();
 const contextMenu = useContextMenu();
 
 const { connectingHandle } = useCanvas();
@@ -98,10 +99,6 @@ const {
 
 const isDisabled = computed(() => props.data.disabled);
 
-const nodeTypeDescription = computed(() => {
-	return nodeTypesStore.getNodeType(props.data.type, props.data.typeVersion);
-});
-
 const classes = computed(() => ({
 	[style.canvasNode]: true,
 	[style.showToolbar]: showToolbar.value,
@@ -407,7 +404,7 @@ onBeforeUnmount(() => {
 			@open:contextmenu="onOpenContextMenuFromNode"
 		>
 			<NodeIcon
-				:node-type="nodeTypeDescription"
+				:node-type="simulatedNodeTypeDescription ?? nodeTypeDescription"
 				:size="nodeIconSize"
 				:shrink="false"
 				:disabled="isDisabled"
diff --git a/packages/frontend/editor-ui/src/composables/useCanvasMapping.ts b/packages/frontend/editor-ui/src/composables/useCanvasMapping.ts
index d35340cc20..5578bf1f9e 100644
--- a/packages/frontend/editor-ui/src/composables/useCanvasMapping.ts
+++ b/packages/frontend/editor-ui/src/composables/useCanvasMapping.ts
@@ -44,7 +44,14 @@ import {
 	WAIT_INDEFINITELY,
 } from 'n8n-workflow';
 import type { INodeUi } from '@/Interface';
-import { CUSTOM_API_CALL_KEY, FORM_NODE_TYPE, STICKY_NODE_TYPE, WAIT_NODE_TYPE } from '@/constants';
+import {
+	CUSTOM_API_CALL_KEY,
+	FORM_NODE_TYPE,
+	SIMULATE_NODE_TYPE,
+	SIMULATE_TRIGGER_NODE_TYPE,
+	STICKY_NODE_TYPE,
+	WAIT_NODE_TYPE,
+} from '@/constants';
 import { sanitizeHtml } from '@/utils/htmlUtils';
 import { MarkerType } from '@vue-flow/core';
 import { useNodeHelpers } from './useNodeHelpers';
@@ -510,6 +517,26 @@ export function useCanvasMapping({
 		);
 	});
 
+	const simulatedNodeTypesById = computed(() => {
+		return nodes.value.reduce<Record<string, string | undefined>>((acc, node) => {
+			if ([SIMULATE_NODE_TYPE, SIMULATE_TRIGGER_NODE_TYPE].includes(node.type)) {
+				const icon = node.parameters?.icon as string;
+				const iconValue = workflowObject.value.expression.getSimpleParameterValue(
+					node,
+					icon,
+					'internal',
+					{},
+				);
+
+				if (iconValue && typeof iconValue === 'string') {
+					acc[node.id] = iconValue;
+				}
+			}
+
+			return acc;
+		}, {});
+	});
+
 	const mappedNodes = computed<CanvasNode[]>(() => [
 		...nodes.value.map<CanvasNode>((node) => {
 			const inputConnections = workflowObject.value.connectionsByDestinationNode[node.name] ?? {};
@@ -521,6 +548,7 @@ export function useCanvasMapping({
 				subtitle: nodeSubtitleById.value[node.id] ?? '',
 				type: node.type,
 				typeVersion: node.typeVersion,
+				simulatedType: simulatedNodeTypesById.value[node.id],
 				disabled: node.disabled,
 				inputs: nodeInputsById.value[node.id] ?? [],
 				outputs: nodeOutputsById.value[node.id] ?? [],
diff --git a/packages/frontend/editor-ui/src/types/canvas.ts b/packages/frontend/editor-ui/src/types/canvas.ts
index c1c05e4966..832dd3e2e8 100644
--- a/packages/frontend/editor-ui/src/types/canvas.ts
+++ b/packages/frontend/editor-ui/src/types/canvas.ts
@@ -95,6 +95,7 @@ export interface CanvasNodeData {
 	subtitle: string;
 	type: INodeUi['type'];
 	typeVersion: INodeUi['typeVersion'];
+	simulatedType?: INodeUi['type'];
 	disabled: INodeUi['disabled'];
 	inputs: CanvasConnectionPort[];
 	outputs: CanvasConnectionPort[];

From 94012147001cbbf75a1a13ffb4857a402497b32b Mon Sep 17 00:00:00 2001
From: Alex Grozav <alex@grozav.com>
Date: Tue, 4 Mar 2025 15:11:07 +0200
Subject: [PATCH 2/5] fix: Update remaining Canvas usages

---
 .../EditDefinition/NodesPinning.vue           | 19 +++++++++++++++++++
 .../src/components/canvas/Canvas.vue          |  3 ++-
 .../src/components/canvas/WorkflowCanvas.vue  |  2 +-
 3 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/packages/frontend/editor-ui/src/components/TestDefinition/EditDefinition/NodesPinning.vue b/packages/frontend/editor-ui/src/components/TestDefinition/EditDefinition/NodesPinning.vue
index 687f18006a..4cfdcdb86e 100644
--- a/packages/frontend/editor-ui/src/components/TestDefinition/EditDefinition/NodesPinning.vue
+++ b/packages/frontend/editor-ui/src/components/TestDefinition/EditDefinition/NodesPinning.vue
@@ -11,6 +11,7 @@ import { N8nTooltip } from '@n8n/design-system';
 import { createEventBus } from '@n8n/utils/event-bus';
 import { computed, onMounted, ref, useCssModule } from 'vue';
 import { useRoute, useRouter } from 'vue-router';
+import type { INodeTypeDescription } from 'n8n-workflow';
 
 const workflowsStore = useWorkflowsStore();
 const nodeTypesStore = useNodeTypesStore();
@@ -51,6 +52,23 @@ const { nodes: mappedNodes, connections: mappedConnections } = useCanvasMapping(
 	connections,
 	workflowObject,
 });
+
+const nodeTypeDescriptions = computed(() => {
+	return nodes.value.reduce<Record<string, INodeTypeDescription>>((acc, node) => {
+		const key = `${node.type}@${node.typeVersion}`;
+		if (acc[key]) {
+			return acc;
+		}
+
+		const nodeTypeDescription = nodeTypesStore.getNodeType(node.type, node.typeVersion);
+		if (nodeTypeDescription) {
+			acc[key] = nodeTypeDescription;
+		}
+
+		return acc;
+	}, {});
+});
+
 async function loadData() {
 	workflowsStore.resetState();
 	resetWorkspace();
@@ -141,6 +159,7 @@ onMounted(loadData);
 			:class="{ [$style.canvas]: true }"
 			:nodes="mappedNodes"
 			:connections="mappedConnections"
+			:node-type-descriptions="nodeTypeDescriptions"
 			:show-bug-reporting-button="false"
 			:read-only="true"
 			:event-bus="eventBus"
diff --git a/packages/frontend/editor-ui/src/components/canvas/Canvas.vue b/packages/frontend/editor-ui/src/components/canvas/Canvas.vue
index f82931ae89..0a2ac3c3d5 100644
--- a/packages/frontend/editor-ui/src/components/canvas/Canvas.vue
+++ b/packages/frontend/editor-ui/src/components/canvas/Canvas.vue
@@ -97,8 +97,8 @@ const props = withDefaults(
 	defineProps<{
 		id?: string;
 		nodes: CanvasNode[];
-		nodeTypeDescriptions: Record<string, INodeTypeDescription>;
 		connections: CanvasConnection[];
+		nodeTypeDescriptions?: Record<string, INodeTypeDescription>;
 		controlsPosition?: PanelPosition;
 		eventBus?: EventBus<CanvasEventBusEvents>;
 		readOnly?: boolean;
@@ -110,6 +110,7 @@ const props = withDefaults(
 		id: 'canvas',
 		nodes: () => [],
 		connections: () => [],
+		nodeTypeDescriptions: () => ({}),
 		controlsPosition: PanelPosition.BottomLeft,
 		eventBus: () => createEventBus(),
 		readOnly: false,
diff --git a/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue b/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
index aaa5b00338..6e2b1a782a 100644
--- a/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
+++ b/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
@@ -99,8 +99,8 @@ onNodesInitialized(() => {
 				v-if="workflow"
 				:id="id"
 				:nodes="mappedNodes"
-				:node-type-descriptions="nodeTypeDescriptions"
 				:connections="mappedConnections"
+				:node-type-descriptions="nodeTypeDescriptions"
 				:event-bus="eventBus"
 				:read-only="readOnly"
 				v-bind="$attrs"

From c01af2e85a6a3ad58637e6e30345e9d38b8a805d Mon Sep 17 00:00:00 2001
From: Alex Grozav <alex@grozav.com>
Date: Tue, 4 Mar 2025 15:42:11 +0200
Subject: [PATCH 3/5] test: add test for rendering simulate node

---
 .../editor-ui/src/__tests__/data/canvas.ts    |  2 +-
 .../frontend/editor-ui/src/__tests__/mocks.ts |  5 +++
 .../src/components/canvas/Canvas.test.ts      | 35 +++++++++++++++++++
 3 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/packages/frontend/editor-ui/src/__tests__/data/canvas.ts b/packages/frontend/editor-ui/src/__tests__/data/canvas.ts
index 08330730c3..4230779894 100644
--- a/packages/frontend/editor-ui/src/__tests__/data/canvas.ts
+++ b/packages/frontend/editor-ui/src/__tests__/data/canvas.ts
@@ -55,7 +55,7 @@ export function createCanvasNodeData({
 
 export function createCanvasNodeElement({
 	id = '1',
-	type = 'default',
+	type = 'canvas-node',
 	label = 'Node',
 	position = { x: 100, y: 100 },
 	data,
diff --git a/packages/frontend/editor-ui/src/__tests__/mocks.ts b/packages/frontend/editor-ui/src/__tests__/mocks.ts
index 6db800e785..09787a5888 100644
--- a/packages/frontend/editor-ui/src/__tests__/mocks.ts
+++ b/packages/frontend/editor-ui/src/__tests__/mocks.ts
@@ -23,6 +23,7 @@ import {
 	MANUAL_TRIGGER_NODE_TYPE,
 	NO_OP_NODE_TYPE,
 	SET_NODE_TYPE,
+	SIMULATE_NODE_TYPE,
 	STICKY_NODE_TYPE,
 } from '@/constants';
 import type { INodeUi, IWorkflowDb } from '@/Interface';
@@ -50,6 +51,7 @@ export const mockNode = ({
 
 export const mockNodeTypeDescription = ({
 	name = SET_NODE_TYPE,
+	icon = 'icon',
 	version = 1,
 	credentials = [],
 	inputs = [NodeConnectionType.Main],
@@ -58,6 +60,7 @@ export const mockNodeTypeDescription = ({
 	properties = [],
 }: {
 	name?: INodeTypeDescription['name'];
+	icon?: INodeTypeDescription['icon'];
 	version?: INodeTypeDescription['version'];
 	credentials?: INodeTypeDescription['credentials'];
 	inputs?: INodeTypeDescription['inputs'];
@@ -67,6 +70,7 @@ export const mockNodeTypeDescription = ({
 } = {}) =>
 	mock<INodeTypeDescription>({
 		name,
+		icon,
 		displayName: name,
 		description: '',
 		version,
@@ -101,6 +105,7 @@ export const mockNodes = [
 	mockNode({ name: 'Chat Trigger', type: CHAT_TRIGGER_NODE_TYPE }),
 	mockNode({ name: 'Agent', type: AGENT_NODE_TYPE }),
 	mockNode({ name: 'Sticky', type: STICKY_NODE_TYPE }),
+	mockNode({ name: 'Simulate', type: SIMULATE_NODE_TYPE }),
 	mockNode({ name: CanvasNodeRenderType.AddNodes, type: CanvasNodeRenderType.AddNodes }),
 	mockNode({ name: 'End', type: NO_OP_NODE_TYPE }),
 ];
diff --git a/packages/frontend/editor-ui/src/components/canvas/Canvas.test.ts b/packages/frontend/editor-ui/src/components/canvas/Canvas.test.ts
index c40d75c6be..b8f01ec5e0 100644
--- a/packages/frontend/editor-ui/src/components/canvas/Canvas.test.ts
+++ b/packages/frontend/editor-ui/src/components/canvas/Canvas.test.ts
@@ -8,6 +8,8 @@ import { createCanvasConnection, createCanvasNodeElement } from '@/__tests__/dat
 import { NodeConnectionType } from 'n8n-workflow';
 import type { useDeviceSupport } from '@n8n/composables/useDeviceSupport';
 import { useVueFlow } from '@vue-flow/core';
+import { defaultNodeTypes, mockNodeTypeDescription } from '@/__tests__/mocks';
+import { SET_NODE_TYPE, SIMULATE_NODE_TYPE } from '@/constants';
 
 const matchMedia = global.window.matchMedia;
 // @ts-expect-error Initialize window object
@@ -273,4 +275,37 @@ describe('Canvas', () => {
 			expect(patternCanvas?.innerHTML).not.toContain('<circle');
 		});
 	});
+
+	describe('simulate', () => {
+		it('should render simulate node', async () => {
+			const nodes = [
+				createCanvasNodeElement({
+					id: '1',
+					label: 'Node',
+					position: { x: 200, y: 200 },
+					data: {
+						type: SIMULATE_NODE_TYPE,
+						typeVersion: 1,
+						simulatedType: SET_NODE_TYPE,
+					},
+				}),
+			];
+
+			const nodeTypeDescriptions = {
+				[SET_NODE_TYPE]: mockNodeTypeDescription({ name: SET_NODE_TYPE, icon: 'fa:pen' }),
+				[`${SIMULATE_NODE_TYPE}@1`]: defaultNodeTypes[SIMULATE_NODE_TYPE].type.description,
+			};
+
+			const { container } = renderComponent({
+				props: {
+					nodes,
+					nodeTypeDescriptions,
+				},
+			});
+
+			await waitFor(() => expect(container.querySelectorAll('.vue-flow__node')).toHaveLength(1));
+
+			expect(container.querySelector('.icon')).toBeInTheDocument();
+		});
+	});
 });

From 1fd69b9ecc0cd2aaca6acc90919526ba42ac15b5 Mon Sep 17 00:00:00 2001
From: Alex Grozav <alex@grozav.com>
Date: Tue, 4 Mar 2025 15:42:53 +0200
Subject: [PATCH 4/5] fix: typecheck

---
 .../frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue  | 1 -
 1 file changed, 1 deletion(-)

diff --git a/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue b/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
index 6e2b1a782a..cc037c41bc 100644
--- a/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
+++ b/packages/frontend/editor-ui/src/components/canvas/WorkflowCanvas.vue
@@ -9,7 +9,6 @@ import { createEventBus } from '@n8n/utils/event-bus';
 import type { CanvasEventBusEvents } from '@/types';
 import { useVueFlow } from '@vue-flow/core';
 import { useNodeTypesStore } from '@/stores/nodeTypes.store';
-import { SIMULATE_NODE_TYPE, SIMULATE_TRIGGER_NODE_TYPE } from '@/constants';
 
 defineOptions({
 	inheritAttrs: false,

From e5fa17e11197adcdf0fd7f1ec465f1ee179fd424 Mon Sep 17 00:00:00 2001
From: Alex Grozav <alex@grozav.com>
Date: Tue, 4 Mar 2025 15:48:50 +0200
Subject: [PATCH 5/5] fix: typecheck

---
 packages/frontend/editor-ui/src/__tests__/mocks.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/frontend/editor-ui/src/__tests__/mocks.ts b/packages/frontend/editor-ui/src/__tests__/mocks.ts
index 09787a5888..a2827c2cfc 100644
--- a/packages/frontend/editor-ui/src/__tests__/mocks.ts
+++ b/packages/frontend/editor-ui/src/__tests__/mocks.ts
@@ -51,7 +51,7 @@ export const mockNode = ({
 
 export const mockNodeTypeDescription = ({
 	name = SET_NODE_TYPE,
-	icon = 'icon',
+	icon = 'fa:pen',
 	version = 1,
 	credentials = [],
 	inputs = [NodeConnectionType.Main],