import type { IRun, WorkflowExecuteMode } from 'n8n-workflow'; import { LoggerProxy } from 'n8n-workflow'; import { mock } from 'jest-mock-extended'; import config from '@/config'; import * as Db from '@/Db'; import { User } from '@db/entities/User'; import { StatisticsNames } from '@db/entities/WorkflowStatistics'; import type { WorkflowStatistics } from '@db/entities/WorkflowStatistics'; import type { WorkflowStatisticsRepository } from '@db/repositories'; import { nodeFetchedData, workflowExecutionCompleted } from '@/events/WorkflowStatistics'; import * as UserManagementHelper from '@/UserManagement/UserManagementHelper'; import { getLogger } from '@/Logger'; import { InternalHooks } from '@/InternalHooks'; import { mockInstance } from '../integration/shared/utils'; import { UserService } from '@/user/user.service'; import { WorkflowEntity } from '@/databases/entities/WorkflowEntity'; jest.mock('@/Db', () => { return { collections: { WorkflowStatistics: mock({ metadata: { tableName: 'workflow_statistics' }, }), }, }; }); jest.spyOn(UserService, 'updateUserSettings').mockImplementation(); describe('Events', () => { const dbType = config.getEnv('database.type'); const fakeUser = Object.assign(new User(), { id: 'abcde-fghij' }); const internalHooks = mockInstance(InternalHooks); jest.spyOn(UserManagementHelper, 'getWorkflowOwner').mockResolvedValue(fakeUser); const workflowStatisticsRepository = Db.collections.WorkflowStatistics as ReturnType< typeof mock >; beforeAll(() => { config.set('diagnostics.enabled', true); config.set('deployment.type', 'n8n-testing'); LoggerProxy.init(getLogger()); }); afterAll(() => { jest.clearAllTimers(); jest.useRealTimers(); }); beforeEach(() => { if (dbType === 'sqlite') { workflowStatisticsRepository.findOne.mockClear(); } else { workflowStatisticsRepository.query.mockClear(); } internalHooks.onFirstProductionWorkflowSuccess.mockClear(); internalHooks.onFirstWorkflowDataLoad.mockClear(); }); const mockDBCall = (count = 1) => { if (dbType === 'sqlite') { workflowStatisticsRepository.findOne.mockResolvedValueOnce( mock({ count }), ); } else { const result = dbType === 'postgresdb' ? [{ count }] : { affectedRows: count }; workflowStatisticsRepository.query.mockImplementationOnce(async (query) => query.startsWith('INSERT INTO') ? result : null, ); } }; describe('workflowExecutionCompleted', () => { test('should create metrics for production successes', async () => { // Call the function with a production success result, ensure metrics hook gets called const workflow = { id: '1', name: '', active: false, createdAt: new Date(), updatedAt: new Date(), nodes: [], connections: {}, }; const runData: IRun = { finished: true, status: 'success', data: { resultData: { runData: {} } }, mode: 'internal' as WorkflowExecuteMode, startedAt: new Date(), }; mockDBCall(); await workflowExecutionCompleted(workflow, runData); expect(internalHooks.onFirstProductionWorkflowSuccess).toBeCalledTimes(1); expect(internalHooks.onFirstProductionWorkflowSuccess).toHaveBeenNthCalledWith(1, { user_id: fakeUser.id, workflow_id: workflow.id, }); }); test('should only create metrics for production successes', async () => { // Call the function with a non production success result, ensure metrics hook is never called const workflow = { id: '1', name: '', active: false, createdAt: new Date(), updatedAt: new Date(), nodes: [], connections: {}, }; const runData: IRun = { finished: false, status: 'failed', data: { resultData: { runData: {} } }, mode: 'internal' as WorkflowExecuteMode, startedAt: new Date(), }; await workflowExecutionCompleted(workflow, runData); expect(internalHooks.onFirstProductionWorkflowSuccess).toBeCalledTimes(0); }); test('should not send metrics for updated entries', async () => { // Call the function with a fail insert, ensure update is called *and* metrics aren't sent const workflow = { id: '1', name: '', active: false, createdAt: new Date(), updatedAt: new Date(), nodes: [], connections: {}, }; const runData: IRun = { finished: true, status: 'success', data: { resultData: { runData: {} } }, mode: 'internal' as WorkflowExecuteMode, startedAt: new Date(), }; mockDBCall(2); await workflowExecutionCompleted(workflow, runData); expect(internalHooks.onFirstProductionWorkflowSuccess).toBeCalledTimes(0); }); }); describe('nodeFetchedData', () => { test('should create metrics when the db is updated', async () => { // Call the function with a production success result, ensure metrics hook gets called const workflowId = '1'; const node = { id: 'abcde', name: 'test node', typeVersion: 1, type: '', position: [0, 0] as [number, number], parameters: {}, }; await nodeFetchedData(workflowId, node); expect(internalHooks.onFirstWorkflowDataLoad).toBeCalledTimes(1); expect(internalHooks.onFirstWorkflowDataLoad).toHaveBeenNthCalledWith(1, { user_id: fakeUser.id, workflow_id: workflowId, node_type: node.type, node_id: node.id, }); }); test('should create metrics with credentials when the db is updated', async () => { // Call the function with a production success result, ensure metrics hook gets called const workflowId = '1'; const node = { id: 'abcde', name: 'test node', typeVersion: 1, type: '', position: [0, 0] as [number, number], parameters: {}, credentials: { testCredentials: { id: '1', name: 'Test Credentials', }, }, }; await nodeFetchedData(workflowId, node); expect(internalHooks.onFirstWorkflowDataLoad).toBeCalledTimes(1); expect(internalHooks.onFirstWorkflowDataLoad).toHaveBeenNthCalledWith(1, { user_id: fakeUser.id, workflow_id: workflowId, node_type: node.type, node_id: node.id, credential_type: 'testCredentials', credential_id: node.credentials.testCredentials.id, }); }); test('should not send metrics for entries that already have the flag set', async () => { // Fetch data for workflow 2 which is set up to not be altered in the mocks workflowStatisticsRepository.findOne.mockImplementationOnce(async () => { return { count: 1, name: StatisticsNames.dataLoaded, latestEvent: new Date(), workflowId: '2', workflow: new WorkflowEntity(), }; }); const workflowId = '1'; const node = { id: 'abcde', name: 'test node', typeVersion: 1, type: '', position: [0, 0] as [number, number], parameters: {}, }; await nodeFetchedData(workflowId, node); expect(internalHooks.onFirstWorkflowDataLoad).toBeCalledTimes(0); }); }); });