fix(editor): Improve formatting of expired trial error message (n8n-i…

…o#11708)
jacovanwyk · Nov 14, 2024 · 8a0ad0f · 8a0ad0f
1 parent a91abee
commit 8a0ad0f
Show file tree

Hide file tree

Showing 4 changed files with 168 additions and 3 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -47,9 +47,7 @@
 			"request": "launch",
 			"skipFiles": ["<node_internals>/**"],
 			"type": "node",
-			"env": {
-				// "N8N_PORT": "5679",
-			},
+			"envFile": "${workspaceFolder}/.env",
 			"outputCapture": "std",
 			"killBehavior": "polite"
 		},

diff --git a/packages/editor-ui/src/composables/usePushConnection.test.ts b/packages/editor-ui/src/composables/usePushConnection.test.ts
@@ -5,6 +5,10 @@ import type { PushMessage, PushPayload } from '@n8n/api-types';
 import { usePushConnection } from '@/composables/usePushConnection';
 import { usePushConnectionStore } from '@/stores/pushConnection.store';
 import { useOrchestrationStore } from '@/stores/orchestration.store';
+import { useUIStore } from '@/stores/ui.store';
+import { useWorkflowsStore } from '@/stores/workflows.store';
+import { useToast } from '@/composables/useToast';
+import type { WorkflowOperationError } from 'n8n-workflow';
 
 vi.mock('vue-router', () => {
 	return {
@@ -16,21 +20,44 @@ vi.mock('vue-router', () => {
 	};
 });
 
+vi.mock('@/composables/useToast', () => {
+	const showMessage = vi.fn();
+	const showError = vi.fn();
+	return {
+		useToast: () => {
+			return {
+				showMessage,
+				showError,
+			};
+		},
+	};
+});
+
 vi.useFakeTimers();
 
 describe('usePushConnection()', () => {
 	let router: ReturnType<typeof useRouter>;
 	let pushStore: ReturnType<typeof usePushConnectionStore>;
 	let orchestrationStore: ReturnType<typeof useOrchestrationStore>;
 	let pushConnection: ReturnType<typeof usePushConnection>;
+	let uiStore: ReturnType<typeof useUIStore>;
+	let workflowsStore: ReturnType<typeof useWorkflowsStore>;
+	let toast: ReturnType<typeof useToast>;
 
 	beforeEach(() => {
 		setActivePinia(createPinia());
 
 		router = vi.mocked(useRouter)();
 		pushStore = usePushConnectionStore();
 		orchestrationStore = useOrchestrationStore();
+		uiStore = useUIStore();
+		workflowsStore = useWorkflowsStore();
 		pushConnection = usePushConnection({ router });
+		toast = useToast();
+	});
+
+	afterEach(() => {
+		vi.restoreAllMocks();
 	});
 
 	describe('initialize()', () => {
@@ -106,5 +133,89 @@ describe('usePushConnection()', () => {
 				expect(result).toBeTruthy();
 			});
 		});
+
+		describe('executionFinished', () => {
+			it('should handle executionFinished event correctly', async () => {
+				const event: PushMessage = {
+					type: 'executionFinished',
+					data: {
+						executionId: '1',
+						data: {
+							data: {
+								resultData: {
+									runData: {},
+								},
+							},
+							finished: true,
+							mode: 'manual',
+							startedAt: new Date(),
+							stoppedAt: new Date(),
+							status: 'success',
+						},
+					},
+				};
+
+				workflowsStore.activeExecutionId = '1';
+				uiStore.isActionActive.workflowRunning = true;
+
+				const result = await pushConnection.pushMessageReceived(event);
+
+				expect(result).toBeTruthy();
+				expect(workflowsStore.workflowExecutionData).toBeDefined();
+				expect(uiStore.isActionActive['workflowRunning']).toBeTruthy();
+
+				expect(toast.showMessage).toHaveBeenCalledWith({
+					title: 'Workflow executed successfully',
+					type: 'success',
+				});
+			});
+
+			it('should handle isManualExecutionCancelled correctly', async () => {
+				const event: PushMessage = {
+					type: 'executionFinished',
+					data: {
+						executionId: '1',
+						data: {
+							data: {
+								startData: {},
+								resultData: {
+									runData: {
+										'Last Node': [],
+									},
+									lastNodeExecuted: 'Last Node',
+									error: {
+										message:
+											'Your trial has ended. <a href="https://app.n8n.cloud/account/change-plan">Upgrade now</a> to keep automating',
+										name: 'NodeApiError',
+										node: 'Last Node',
+									} as unknown as WorkflowOperationError,
+								},
+							},
+							startedAt: new Date(),
+							mode: 'manual',
+							status: 'running',
+						},
+					},
+				};
+
+				workflowsStore.activeExecutionId = '1';
+				uiStore.isActionActive['workflowRunning'] = true;
+
+				const result = await pushConnection.pushMessageReceived(event);
+
+				expect(useToast().showMessage).toHaveBeenCalledWith({
+					message:
+						'Your trial has ended. <a href="https://app.n8n.cloud/account/change-plan">Upgrade now</a> to keep automating',
+					title: 'Problem in node ‘Last Node‘',
+					type: 'error',
+					duration: 0,
+					dangerouslyUseHTMLString: true,
+				});
+
+				expect(result).toBeTruthy();
+				expect(workflowsStore.workflowExecutionData).toBeDefined();
+				expect(uiStore.isActionActive.workflowRunning).toBeTruthy();
+			});
+		});
 	});
 });
diff --git a/packages/editor-ui/src/composables/usePushConnection.ts b/packages/editor-ui/src/composables/usePushConnection.ts
@@ -423,6 +423,7 @@ export function usePushConnection({ router }: { router: ReturnType<typeof useRou
 							message: runDataExecutedErrorMessage,
 							type: 'error',
 							duration: 0,
+							dangerouslyUseHTMLString: true,
 						});
 					}
 				}

diff --git a/packages/editor-ui/src/composables/useToast.test.ts b/packages/editor-ui/src/composables/useToast.test.ts
@@ -0,0 +1,55 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { useToast } from './useToast';
+import { createPinia, setActivePinia } from 'pinia';
+import { ElNotification as Notification } from 'element-plus';
+
+vi.mock('element-plus', async () => {
+	const original = await vi.importActual('element-plus');
+	return {
+		...original,
+		ElNotification: vi.fn(),
+		ElTooltip: vi.fn(),
+	};
+});
+
+describe('useToast', () => {
+	let toast: ReturnType<typeof useToast>;
+
+	beforeEach(() => {
+		setActivePinia(createPinia());
+
+		toast = useToast();
+	});
+
+	afterEach(() => {
+		vi.restoreAllMocks();
+	});
+
+	it('should show a message', () => {
+		const messageData = { message: 'Test message', title: 'Test title' };
+		toast.showMessage(messageData);
+
+		expect(Notification).toHaveBeenCalledWith(
+			expect.objectContaining({
+				message: 'Test message',
+				title: 'Test title',
+			}),
+		);
+	});
+
+	it('should sanitize message and title', () => {
+		const messageData = {
+			message: '<script>alert("xss")</script>',
+			title: '<script>alert("xss")</script>',
+		};
+
+		toast.showMessage(messageData);
+
+		expect(Notification).toHaveBeenCalledWith(
+			expect.objectContaining({
+				message: 'alert("xss")',
+				title: 'alert("xss")',
+			}),
+		);
+	});
+});