feat: More hints to nodes (#10565)

Co-authored-by: Giulio Andreini <g.andreini@gmail.com>
Co-authored-by: Shireen Missi <94372015+ShireenMissi@users.noreply.github.com>

packages/editor-ui/src/utils/__tests__/nodeViewUtils.spec.ts

@@ -0,0 +1,139 @@
+import { getGenericHints } from '../nodeViewUtils';
+import type { INode, INodeTypeDescription, INodeExecutionData, Workflow } from 'n8n-workflow';
+import type { INodeUi } from '@/Interface';
+import { NodeHelpers } from 'n8n-workflow';
+
+import { describe, it, expect, beforeEach } from 'vitest';
+import { mock, type MockProxy } from 'vitest-mock-extended';
+
+describe('getGenericHints', () => {
+	let mockWorkflowNode: MockProxy<INode>;
+	let mockNode: MockProxy<INodeUi>;
+	let mockNodeType: MockProxy<INodeTypeDescription>;
+	let mockNodeOutputData: INodeExecutionData[];
+	let mockWorkflow: MockProxy<Workflow>;
+	let hasMultipleInputItems: boolean;
+	let hasNodeRun: boolean;
+
+	beforeEach(() => {
+		mockWorkflowNode = mock<INode>();
+		mockNode = mock<INodeUi>();
+		mockNodeType = mock<INodeTypeDescription>();
+		mockNodeOutputData = [];
+		mockWorkflow = mock<Workflow>();
+
+		hasMultipleInputItems = false;
+		hasNodeRun = false;
+	});
+
+	it('should return a limit reached hint if node output data reaches the limit', () => {
+		mockWorkflowNode.parameters.limit = 5;
+		mockNodeOutputData = Array(5).fill({ json: {} });
+		hasNodeRun = true;
+
+		const hints = getGenericHints({
+			workflowNode: mockWorkflowNode,
+			node: mockNode,
+			nodeType: mockNodeType,
+			nodeOutputData: mockNodeOutputData,
+			hasMultipleInputItems,
+			workflow: mockWorkflow,
+			hasNodeRun,
+		});
+
+		expect(hints).toEqual([
+			{
+				message:
+					"Limit of 5 items reached. There may be more items that aren't being returned. Tweak the 'Return All' or 'Limit' parameters to access more items.",
+				location: 'outputPane',
+				whenToDisplay: 'afterExecution',
+			},
+		]);
+	});
+
+	it('should return an Execute Once hint if operation is list-like and Execute Once is not set', () => {
+		mockWorkflowNode.parameters.operation = 'getAll';
+		hasMultipleInputItems = true;
+		mockWorkflow.getNode.mockReturnValue({ executeOnce: false } as unknown as INode);
+
+		const hints = getGenericHints({
+			workflowNode: mockWorkflowNode,
+			node: mockNode,
+			nodeType: mockNodeType,
+			nodeOutputData: mockNodeOutputData,
+			hasMultipleInputItems,
+			workflow: mockWorkflow,
+			hasNodeRun,
+		});
+
+		expect(hints).toEqual([
+			{
+				message:
+					"The operation is performed for each input item. Use the 'Execute Once' setting to execute it only once for the first input item.",
+				location: 'outputPane',
+			},
+		]);
+	});
+
+	it('should return a hint for expression in field name if found in Set node', () => {
+		mockNode.type = 'n8n-nodes-base.set';
+		mockNode.parameters.mode = 'manual';
+		mockNodeType.properties = [];
+
+		vi.spyOn(NodeHelpers, 'getNodeParameters').mockReturnValue({
+			assignments: {
+				assignments: [
+					{
+						id: 'xxxxx',
+						name: '=',
+						value: '',
+						type: 'string',
+					},
+				],
+			},
+			options: {},
+		});
+
+		const hints = getGenericHints({
+			workflowNode: mockWorkflowNode,
+			node: mockNode,
+			nodeType: mockNodeType,
+			nodeOutputData: mockNodeOutputData,
+			hasMultipleInputItems,
+			workflow: mockWorkflow,
+			hasNodeRun,
+		});
+
+		expect(hints).toEqual([
+			{
+				message:
+					"An expression is used in 'Fields to Set' in field 1, did you mean to use it in the value instead?",
+				whenToDisplay: 'beforeExecution',
+				location: 'outputPane',
+			},
+		]);
+	});
+
+	it('should return Split In Batches setup hints if loop is not set up correctly', () => {
+		mockNode.type = 'n8n-nodes-base.splitInBatches';
+		mockWorkflow.getChildNodes.mockReturnValue([]);
+
+		const hints = getGenericHints({
+			workflowNode: mockWorkflowNode,
+			node: mockNode,
+			nodeType: mockNodeType,
+			nodeOutputData: mockNodeOutputData,
+			hasMultipleInputItems,
+			workflow: mockWorkflow,
+			hasNodeRun,
+		});
+
+		expect(hints).toEqual([
+			{
+				message: "No nodes connected to the 'loop' output of this node",
+				whenToDisplay: 'beforeExecution',
+				location: 'outputPane',
+			},
+		]);
+	});
+});