first commit

packages/nodes-base/nodes/Redis/__tests__/RedisTrigger.node.test.ts

@@ -0,0 +1,120 @@
+import { captor, mock } from 'jest-mock-extended';
+import { returnJsonArray } from 'n8n-core';
+import type { ICredentialDataDecryptedObject, ITriggerFunctions } from 'n8n-workflow';
+
+import { RedisTrigger } from '../RedisTrigger.node';
+import type { RedisClient } from '../types';
+import { setupRedisClient } from '../utils';
+
+jest.mock('../utils', () => {
+	const mockRedisClient = mock<RedisClient>();
+	return {
+		setupRedisClient: jest.fn().mockReturnValue(mockRedisClient),
+	};
+});
+
+describe('Redis Trigger Node', () => {
+	const channel = 'testing';
+	const credentials = mock<ICredentialDataDecryptedObject>();
+	const triggerFunctions = mock<ITriggerFunctions>({
+		helpers: { returnJsonArray },
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+
+		triggerFunctions.getCredentials.calledWith('redis').mockResolvedValue(credentials);
+		triggerFunctions.getNodeParameter.calledWith('channels').mockReturnValue(channel);
+	});
+
+	it('should emit in manual mode', async () => {
+		triggerFunctions.getMode.mockReturnValue('manual');
+		triggerFunctions.getNodeParameter.calledWith('options').mockReturnValue({});
+
+		const response = await new RedisTrigger().trigger.call(triggerFunctions);
+		expect(response.manualTriggerFunction).toBeDefined();
+		expect(response.closeFunction).toBeDefined();
+
+		expect(triggerFunctions.getCredentials).toHaveBeenCalledTimes(1);
+		expect(triggerFunctions.getNodeParameter).toHaveBeenCalledTimes(2);
+
+		const mockRedisClient = setupRedisClient(mock());
+		expect(mockRedisClient.connect).toHaveBeenCalledTimes(1);
+		expect(mockRedisClient.ping).toHaveBeenCalledTimes(1);
+
+		// manually trigger the node, like Workflow.runNode does
+		const triggerPromise = response.manualTriggerFunction!();
+
+		const onMessageCaptor = captor<(message: string, channel: string) => unknown>();
+		expect(mockRedisClient.pSubscribe).toHaveBeenCalledWith([channel], onMessageCaptor);
+		expect(triggerFunctions.emit).not.toHaveBeenCalled();
+
+		// simulate a message
+		const onMessage = onMessageCaptor.value;
+		onMessage('{"testing": true}', channel);
+		expect(triggerFunctions.emit).toHaveBeenCalledWith([
+			[{ json: { message: '{"testing": true}', channel } }],
+		]);
+
+		// wait for the promise to resolve
+		await new Promise((resolve) => setImmediate(resolve));
+		await expect(triggerPromise).resolves.toEqual(undefined);
+
+		expect(mockRedisClient.quit).not.toHaveBeenCalled();
+		await response.closeFunction!();
+		expect(mockRedisClient.pUnsubscribe).toHaveBeenCalledTimes(1);
+		expect(mockRedisClient.quit).toHaveBeenCalledTimes(1);
+	});
+
+	it('should emit in trigger mode', async () => {
+		triggerFunctions.getMode.mockReturnValue('trigger');
+		triggerFunctions.getNodeParameter.calledWith('options').mockReturnValue({});
+
+		const response = await new RedisTrigger().trigger.call(triggerFunctions);
+		expect(response.manualTriggerFunction).toBeDefined();
+		expect(response.closeFunction).toBeDefined();
+
+		expect(triggerFunctions.getCredentials).toHaveBeenCalledTimes(1);
+		expect(triggerFunctions.getNodeParameter).toHaveBeenCalledTimes(2);
+
+		const mockRedisClient = setupRedisClient(mock());
+		expect(mockRedisClient.connect).toHaveBeenCalledTimes(1);
+		expect(mockRedisClient.ping).toHaveBeenCalledTimes(1);
+
+		const onMessageCaptor = captor<(message: string, channel: string) => unknown>();
+		expect(mockRedisClient.pSubscribe).toHaveBeenCalledWith([channel], onMessageCaptor);
+		expect(triggerFunctions.emit).not.toHaveBeenCalled();
+
+		// simulate a message
+		const onMessage = onMessageCaptor.value;
+		onMessage('{"testing": true}', channel);
+		expect(triggerFunctions.emit).toHaveBeenCalledWith([
+			[{ json: { message: '{"testing": true}', channel } }],
+		]);
+
+		expect(mockRedisClient.quit).not.toHaveBeenCalled();
+		await response.closeFunction!();
+		expect(mockRedisClient.pUnsubscribe).toHaveBeenCalledTimes(1);
+		expect(mockRedisClient.quit).toHaveBeenCalledTimes(1);
+	});
+
+	it('should parse JSON messages when configured', async () => {
+		triggerFunctions.getMode.mockReturnValue('trigger');
+		triggerFunctions.getNodeParameter.calledWith('options').mockReturnValue({
+			jsonParseBody: true,
+		});
+
+		await new RedisTrigger().trigger.call(triggerFunctions);
+
+		const mockRedisClient = setupRedisClient(mock());
+		const onMessageCaptor = captor<(message: string, channel: string) => unknown>();
+		expect(mockRedisClient.pSubscribe).toHaveBeenCalledWith([channel], onMessageCaptor);
+
+		// simulate a message
+		const onMessage = onMessageCaptor.value;
+		onMessage('{"testing": true}', channel);
+		expect(triggerFunctions.emit).toHaveBeenCalledWith([
+			[{ json: { message: { testing: true }, channel } }],
+		]);
+	});
+});