n8n/packages/@n8n/nodes-langchain/nodes/agents/Agent/test/utils.test.ts

import type { Tool } from '@langchain/classic/tools';
import { DynamicStructuredTool } from '@langchain/classic/tools';
import { NodeOperationError } from 'n8n-workflow';
import type { INode } from 'n8n-workflow';
import { z } from 'zod';

import type { ZodObjectAny } from '../../../../types/types';
import { checkForStructuredTools } from '../agents/utils';
import { getInputs } from '../utils';

describe('checkForStructuredTools', () => {
	let mockNode: INode;

	beforeEach(() => {
		mockNode = {
			id: 'test-node',
			name: 'Test Node',
			type: 'test',
			typeVersion: 1,
			position: [0, 0],
			parameters: {},
		};
	});

	it('should not throw error when no DynamicStructuredTools are present', async () => {
		const tools = [
			{
				name: 'regular-tool',
				constructor: { name: 'Tool' },
			} as Tool,
		];

		await expect(
			checkForStructuredTools(tools, mockNode, 'Conversation Agent'),
		).resolves.not.toThrow();
	});

	it('should throw NodeOperationError when DynamicStructuredTools are present', async () => {
		const dynamicTool = new DynamicStructuredTool({
			name: 'dynamic-tool',
			description: 'test tool',
			schema: z.object({}),
			func: async () => 'result',
		});

		const tools: Array<Tool | DynamicStructuredTool<ZodObjectAny>> = [dynamicTool];

		await expect(checkForStructuredTools(tools, mockNode, 'Conversation Agent')).rejects.toThrow(
			NodeOperationError,
		);

		await expect(
			checkForStructuredTools(tools, mockNode, 'Conversation Agent'),
		).rejects.toMatchObject({
			message:
				'The selected tools are not supported by "Conversation Agent", please use "Tools Agent" instead',
			description: 'Incompatible connected tools: "dynamic-tool"',
		});
	});

	it('should list multiple dynamic tools in error message', async () => {
		const dynamicTool1 = new DynamicStructuredTool({
			name: 'dynamic-tool-1',
			description: 'test tool 1',
			schema: z.object({}),
			func: async () => 'result',
		});

		const dynamicTool2 = new DynamicStructuredTool({
			name: 'dynamic-tool-2',
			description: 'test tool 2',
			schema: z.object({}),
			func: async () => 'result',
		});

		const tools = [dynamicTool1, dynamicTool2];

		await expect(
			checkForStructuredTools(tools, mockNode, 'Conversation Agent'),
		).rejects.toMatchObject({
			description: 'Incompatible connected tools: "dynamic-tool-1", "dynamic-tool-2"',
		});
	});

	it('should throw error with mixed tool types and list only dynamic tools in error message', async () => {
		const regularTool = {
			name: 'regular-tool',
			constructor: { name: 'Tool' },
		} as Tool;

		const dynamicTool = new DynamicStructuredTool({
			name: 'dynamic-tool',
			description: 'test tool',
			schema: z.object({}),
			func: async () => 'result',
		});

		const tools = [regularTool, dynamicTool];

		await expect(
			checkForStructuredTools(tools, mockNode, 'Conversation Agent'),
		).rejects.toMatchObject({
			message:
				'The selected tools are not supported by "Conversation Agent", please use "Tools Agent" instead',
			description: 'Incompatible connected tools: "dynamic-tool"',
		});
	});
});

describe('getInputs', () => {
	it('should include all inputs when no flags are set to false', () => {
		const inputs = getInputs(true, true, true);
		expect(inputs).toEqual([
			'main',
			{
				type: 'ai_languageModel',
				displayName: 'Chat Model',
				required: true,
				maxConnections: 1,
				filter: {
					excludedNodes: [
						'@n8n/n8n-nodes-langchain.lmCohere',
						'@n8n/n8n-nodes-langchain.lmOllama',
						'n8n/n8n-nodes-langchain.lmOpenAi',
						'@n8n/n8n-nodes-langchain.lmOpenHuggingFaceInference',
					],
				},
			},
			{
				type: 'ai_languageModel',
				displayName: 'Fallback Model',
				required: true,
				maxConnections: 1,
				filter: {
					excludedNodes: [
						'@n8n/n8n-nodes-langchain.lmCohere',
						'@n8n/n8n-nodes-langchain.lmOllama',
						'n8n/n8n-nodes-langchain.lmOpenAi',
						'@n8n/n8n-nodes-langchain.lmOpenHuggingFaceInference',
					],
				},
			},
			{
				type: 'ai_memory',
				displayName: 'Memory',
				maxConnections: 1,
			},
			{
				type: 'ai_tool',
				displayName: 'Tool',
			},
			{
				type: 'ai_outputParser',
				displayName: 'Output Parser',
				maxConnections: 1,
			},
		]);
	});

	it('should exclude Output Parser when hasOutputParser is false', () => {
		const inputs = getInputs(true, false, true);
		expect(inputs).toEqual([
			'main',
			{
				type: 'ai_languageModel',
				displayName: 'Chat Model',
				required: true,
				maxConnections: 1,
				filter: {
					excludedNodes: [
						'@n8n/n8n-nodes-langchain.lmCohere',
						'@n8n/n8n-nodes-langchain.lmOllama',
						'n8n/n8n-nodes-langchain.lmOpenAi',
						'@n8n/n8n-nodes-langchain.lmOpenHuggingFaceInference',
					],
				},
			},
			{
				type: 'ai_languageModel',
				displayName: 'Fallback Model',
				required: true,
				maxConnections: 1,
				filter: {
					excludedNodes: [
						'@n8n/n8n-nodes-langchain.lmCohere',
						'@n8n/n8n-nodes-langchain.lmOllama',
						'n8n/n8n-nodes-langchain.lmOpenAi',
						'@n8n/n8n-nodes-langchain.lmOpenHuggingFaceInference',
					],
				},
			},
			{
				type: 'ai_memory',
				displayName: 'Memory',
				maxConnections: 1,
			},
			{
				type: 'ai_tool',
				displayName: 'Tool',
			},
		]);
	});

	it('should exclude Fallback Model when needsFallback is false', () => {
		const inputs = getInputs(true, true, false);
		expect(inputs).toEqual([
			'main',
			{
				type: 'ai_languageModel',
				displayName: 'Chat Model',
				required: true,
				maxConnections: 1,
				filter: {
					excludedNodes: [
						'@n8n/n8n-nodes-langchain.lmCohere',
						'@n8n/n8n-nodes-langchain.lmOllama',
						'n8n/n8n-nodes-langchain.lmOpenAi',
						'@n8n/n8n-nodes-langchain.lmOpenHuggingFaceInference',
					],
				},
			},
			{
				type: 'ai_memory',
				displayName: 'Memory',
				maxConnections: 1,
			},
			{
				type: 'ai_tool',
				displayName: 'Tool',
			},
			{
				type: 'ai_outputParser',
				displayName: 'Output Parser',
				maxConnections: 1,
			},
		]);
	});

	it('should include main input when hasMainInput is true', () => {
		const inputs = getInputs(true, true, true);
		expect(inputs[0]).toBe('main');
	});

	it('should exclude main input when hasMainInput is false', () => {
		const inputs = getInputs(false, true, true);
		expect(inputs).not.toContain('main');
	});

	it('should handle all flags set to false', () => {
		const inputs = getInputs(false, false, false);
		expect(inputs).toEqual([
			{
				type: 'ai_languageModel',
				displayName: 'Chat Model',
				required: true,
				maxConnections: 1,
				filter: {
					excludedNodes: [
						'@n8n/n8n-nodes-langchain.lmCohere',
						'@n8n/n8n-nodes-langchain.lmOllama',
						'n8n/n8n-nodes-langchain.lmOpenAi',
						'@n8n/n8n-nodes-langchain.lmOpenHuggingFaceInference',
					],
				},
			},
			{
				type: 'ai_memory',
				displayName: 'Memory',
				maxConnections: 1,
			},
			{
				type: 'ai_tool',
				displayName: 'Tool',
			},
		]);
	});
});