mohiit1502/Automata
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor(core): Rename ActiveWorkflowRunner to ActiveWorkflowManager (no-changelog) (#9280)

Browse Source
This commit is contained in:
Iván Ovejero
2024-05-06 17:54:05 +02:00
committed by GitHub
parent 552cf8f3db
commit 7b925ab871
25 changed files with 129 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
packages/cli/test/integration/active-workflow-runner.test.ts → packages/cli/test/integration/active-workflow-manager.test.ts
View File

@@ -4,7 +4,7 @@ import { NodeApiError, NodeOperationError, Workflow } from 'n8n-workflow';
import type { IWebhookData, WorkflowActivateMode } from 'n8n-workflow';
import { ActiveExecutions } from '@/ActiveExecutions';
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { ExternalHooks } from '@/ExternalHooks';
import { Push } from '@/push';
import { SecretsHelper } from '@/SecretsHelpers';
@@ -47,7 +47,7 @@ Object.assign(loader.loadedNodes, {
const webhookService = mockInstance(WebhookService);
const externalHooks = mockInstance(ExternalHooks);
let runner: ActiveWorkflowRunner;
let activeWorkflowManager: ActiveWorkflowManager;
let createActiveWorkflow: () => Promise<WorkflowEntity>;
let createInactiveWorkflow: () => Promise<WorkflowEntity>;
@@ -55,7 +55,7 @@ let createInactiveWorkflow: () => Promise<WorkflowEntity>;
beforeAll(async () => {
await testDb.init();
runner = Container.get(ActiveWorkflowRunner);
activeWorkflowManager = Container.get(ActiveWorkflowManager);
const owner = await createOwner();
createActiveWorkflow = async () => await createWorkflow({ active: true }, owner);
@@ -64,7 +64,7 @@ beforeAll(async () => {
afterEach(async () => {
await testDb.truncate(['Workflow', 'Webhook']);
await runner.removeAll();
await activeWorkflowManager.removeAll();
jest.restoreAllMocks();
});
@@ -74,18 +74,18 @@ afterAll(async () => {
describe('init()', () => {
it('should load workflows into memory', async () => {
await runner.init();
await activeWorkflowManager.init();
expect(runner.allActiveInMemory()).toHaveLength(0);
expect(activeWorkflowManager.allActiveInMemory()).toHaveLength(0);
await createActiveWorkflow();
await runner.init();
await activeWorkflowManager.init();
expect(runner.allActiveInMemory()).toHaveLength(1);
expect(activeWorkflowManager.allActiveInMemory()).toHaveLength(1);
});
it('should call external hook', async () => {
await runner.init();
await activeWorkflowManager.init();
const [hook, arg] = externalHooks.run.mock.calls[0];
@@ -100,7 +100,7 @@ describe('init()', () => {
.spyOn(Workflow.prototype, 'checkIfWorkflowCanBeActivated')
.mockReturnValue(true);
await runner.init();
await activeWorkflowManager.init();
expect(checkSpy).toHaveBeenCalledTimes(2);
});
@@ -110,17 +110,17 @@ describe('isActive()', () => {
it('should return `true` for active workflow in storage', async () => {
const dbWorkflow = await createActiveWorkflow();
await runner.init();
await activeWorkflowManager.init();
await expect(runner.isActive(dbWorkflow.id)).resolves.toBe(true);
await expect(activeWorkflowManager.isActive(dbWorkflow.id)).resolves.toBe(true);
});
it('should return `false` for inactive workflow in storage', async () => {
const dbWorkflow = await createInactiveWorkflow();
await runner.init();
await activeWorkflowManager.init();
await expect(runner.isActive(dbWorkflow.id)).resolves.toBe(false);
await expect(activeWorkflowManager.isActive(dbWorkflow.id)).resolves.toBe(false);
});
});
@@ -129,13 +129,13 @@ describe('add()', () => {
test.each(['activate', 'update'])(
"should add webhooks, triggers and pollers for workflow in '%s' activation mode",
async (mode: WorkflowActivateMode) => {
await runner.init();
await activeWorkflowManager.init();
const dbWorkflow = await createActiveWorkflow();
const addWebhooksSpy = jest.spyOn(runner, 'addWebhooks');
const addTriggersAndPollersSpy = jest.spyOn(runner, 'addTriggersAndPollers');
const addWebhooksSpy = jest.spyOn(activeWorkflowManager, 'addWebhooks');
const addTriggersAndPollersSpy = jest.spyOn(activeWorkflowManager, 'addTriggersAndPollers');
await runner.add(dbWorkflow.id, mode);
await activeWorkflowManager.add(dbWorkflow.id, mode);
const [argWorkflow] = addWebhooksSpy.mock.calls[0];
const [_, _argWorkflow] = addTriggersAndPollersSpy.mock.calls[0];
@@ -158,10 +158,10 @@ describe('removeAll()', () => {
await createActiveWorkflow();
await createActiveWorkflow();
await runner.init();
await runner.removeAll();
await activeWorkflowManager.init();
await activeWorkflowManager.removeAll();
expect(runner.allActiveInMemory()).toHaveLength(0);
expect(activeWorkflowManager.allActiveInMemory()).toHaveLength(0);
});
});
@@ -170,8 +170,8 @@ describe('remove()', () => {
it('should remove all webhooks of a workflow from database', async () => {
const dbWorkflow = await createActiveWorkflow();
await runner.init();
await runner.remove(dbWorkflow.id);
await activeWorkflowManager.init();
await activeWorkflowManager.remove(dbWorkflow.id);
expect(webhookService.deleteWorkflowWebhooks).toHaveBeenCalledTimes(1);
});
@@ -183,18 +183,21 @@ describe('remove()', () => {
.spyOn(WebhookHelpers, 'getWorkflowWebhooks')
.mockReturnValue([mock<IWebhookData>({ path: 'some-path' })]);
await runner.init();
await runner.remove(dbWorkflow.id);
await activeWorkflowManager.init();
await activeWorkflowManager.remove(dbWorkflow.id);
expect(deleteWebhookSpy).toHaveBeenCalledTimes(1);
});
it('should stop running triggers and pollers', async () => {
const dbWorkflow = await createActiveWorkflow();
const removeTriggersAndPollersSpy = jest.spyOn(runner, 'removeWorkflowTriggersAndPollers');
const removeTriggersAndPollersSpy = jest.spyOn(
activeWorkflowManager,
'removeWorkflowTriggersAndPollers',
);
await runner.init();
await runner.remove(dbWorkflow.id);
await activeWorkflowManager.init();
await activeWorkflowManager.remove(dbWorkflow.id);
expect(removeTriggersAndPollersSpy).toHaveBeenCalledTimes(1);
});
@@ -208,9 +211,9 @@ describe('executeErrorWorkflow()', () => {
const executeSpy = jest.spyOn(AdditionalData, 'executeErrorWorkflow');
await runner.init();
await activeWorkflowManager.init();
runner.executeErrorWorkflow(
activeWorkflowManager.executeErrorWorkflow(
new NodeOperationError(node, 'Something went wrong'),
dbWorkflow,
'trigger',
@@ -222,16 +225,16 @@ describe('executeErrorWorkflow()', () => {
it('should be called on failure to activate due to 401', async () => {
const dbWorkflow = await createActiveWorkflow();
const [node] = dbWorkflow.nodes;
const executeSpy = jest.spyOn(runner, 'executeErrorWorkflow');
const executeSpy = jest.spyOn(activeWorkflowManager, 'executeErrorWorkflow');
jest.spyOn(runner, 'add').mockImplementation(() => {
jest.spyOn(activeWorkflowManager, 'add').mockImplementation(() => {
throw new NodeApiError(node, {
httpCode: '401',
message: 'Authorization failed - please check your credentials',
});
});
await runner.init();
await activeWorkflowManager.init();
expect(executeSpy).toHaveBeenCalledTimes(1);
const [error, _dbWorkflow] = executeSpy.mock.calls[0];
@@ -270,7 +273,7 @@ describe('addWebhooks()', () => {
jest.spyOn(Workflow.prototype, 'checkIfWorkflowCanBeActivated').mockReturnValue(true);
jest.spyOn(Workflow.prototype, 'createWebhookIfNotExists').mockResolvedValue(undefined);
await runner.addWebhooks(workflow, additionalData, 'trigger', 'init');
await activeWorkflowManager.addWebhooks(workflow, additionalData, 'trigger', 'init');
expect(webhookService.storeWebhook).toHaveBeenCalledTimes(1);
});

4
packages/cli/test/integration/auth.mw.test.ts
View File

@@ -1,4 +1,4 @@
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import type { SuperAgentTest } from 'supertest';
import * as utils from './shared/utils/';
@@ -6,7 +6,7 @@ import { createUser } from './shared/db/users';
import { mockInstance } from '../shared/mocking';
describe('Auth Middleware', () => {
mockInstance(ActiveWorkflowRunner);
mockInstance(ActiveWorkflowManager);
const testServer = utils.setupTestServer({
endpointGroups: ['me', 'auth', 'owner', 'users', 'invitations'],

8
packages/cli/test/integration/debug.controller.test.ts
View File

@@ -1,5 +1,5 @@
import { WorkflowRepository } from '@/databases/repositories/workflow.repository';
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { mockInstance } from '../shared/mocking';
import { randomName } from './shared/random';
import { generateNanoId } from '@/databases/utils/generators';
@@ -12,7 +12,7 @@ import { MultiMainSetup } from '@/services/orchestration/main/MultiMainSetup.ee'
describe('DebugController', () => {
const workflowRepository = mockInstance(WorkflowRepository);
const activeWorkflowRunner = mockInstance(ActiveWorkflowRunner);
const activeWorkflowManager = mockInstance(ActiveWorkflowManager);
let testServer = setupTestServer({ endpointGroups: ['debug'] });
let ownerAgent: SuperAgentTest;
@@ -34,8 +34,8 @@ describe('DebugController', () => {
workflowRepository.findIn.mockResolvedValue(triggersAndPollers);
workflowRepository.findWebhookBasedActiveWorkflows.mockResolvedValue(webhooks);
activeWorkflowRunner.allActiveInMemory.mockReturnValue([workflowId]);
activeWorkflowRunner.getAllWorkflowActivationErrors.mockResolvedValue(activationErrors);
activeWorkflowManager.allActiveInMemory.mockReturnValue([workflowId]);
activeWorkflowManager.getAllWorkflowActivationErrors.mockResolvedValue(activationErrors);
jest.spyOn(OrchestrationService.prototype, 'instanceId', 'get').mockReturnValue(instanceId);
jest.spyOn(MultiMainSetup.prototype, 'fetchLeaderKey').mockResolvedValue(leaderKey);

6
packages/cli/test/integration/publicApi/executions.test.ts
View File

@@ -1,6 +1,6 @@
import type { SuperAgentTest } from 'supertest';
import type { User } from '@db/entities/User';
import type { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import type { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { randomApiKey } from '../shared/random';
import * as utils from '../shared/utils/';
@@ -24,7 +24,7 @@ let user2: User;
let authOwnerAgent: SuperAgentTest;
let authUser1Agent: SuperAgentTest;
let authUser2Agent: SuperAgentTest;
let workflowRunner: ActiveWorkflowRunner;
let workflowRunner: ActiveWorkflowManager;
const testServer = utils.setupTestServer({ endpointGroups: ['publicApi'] });
@@ -37,7 +37,7 @@ beforeAll(async () => {
await utils.initBinaryDataService();
await utils.initNodeTypes();
workflowRunner = await utils.initActiveWorkflowRunner();
workflowRunner = await utils.initActiveWorkflowManager();
});
beforeEach(async () => {

18
packages/cli/test/integration/publicApi/workflows.test.ts
View File

@@ -7,7 +7,7 @@ import type { TagEntity } from '@db/entities/TagEntity';
import type { User } from '@db/entities/User';
import { SharedWorkflowRepository } from '@db/repositories/sharedWorkflow.repository';
import { WorkflowHistoryRepository } from '@db/repositories/workflowHistory.repository';
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { ExecutionService } from '@/executions/execution.service';
import { randomApiKey } from '../shared/random';
@@ -22,7 +22,7 @@ let owner: User;
let member: User;
let authOwnerAgent: SuperAgentTest;
let authMemberAgent: SuperAgentTest;
let workflowRunner: ActiveWorkflowRunner;
let activeWorkflowManager: ActiveWorkflowManager;
const testServer = utils.setupTestServer({ endpointGroups: ['publicApi'] });
const license = testServer.license;
@@ -42,9 +42,9 @@ beforeAll(async () => {
await utils.initNodeTypes();
workflowRunner = Container.get(ActiveWorkflowRunner);
activeWorkflowManager = Container.get(ActiveWorkflowManager);
await workflowRunner.init();
await activeWorkflowManager.init();
});
beforeEach(async () => {
@@ -62,7 +62,7 @@ beforeEach(async () => {
});
afterEach(async () => {
await workflowRunner?.removeAll();
await activeWorkflowManager?.removeAll();
});
const testWithAPIKey =
@@ -517,7 +517,7 @@ describe('POST /workflows/:id/activate', () => {
expect(sharedWorkflow?.workflow.active).toBe(true);
// check whether the workflow is on the active workflow runner
expect(await workflowRunner.isActive(workflow.id)).toBe(true);
expect(await activeWorkflowManager.isActive(workflow.id)).toBe(true);
});
test('should set non-owned workflow as active when owner', async () => {
@@ -561,7 +561,7 @@ describe('POST /workflows/:id/activate', () => {
expect(sharedWorkflow?.workflow.active).toBe(true);
// check whether the workflow is on the active workflow runner
expect(await workflowRunner.isActive(workflow.id)).toBe(true);
expect(await activeWorkflowManager.isActive(workflow.id)).toBe(true);
});
});
@@ -615,7 +615,7 @@ describe('POST /workflows/:id/deactivate', () => {
// check whether the workflow is deactivated in the database
expect(sharedWorkflow?.workflow.active).toBe(false);
expect(await workflowRunner.isActive(workflow.id)).toBe(false);
expect(await activeWorkflowManager.isActive(workflow.id)).toBe(false);
});
test('should deactivate non-owned workflow when owner', async () => {
@@ -660,7 +660,7 @@ describe('POST /workflows/:id/deactivate', () => {
expect(sharedWorkflow?.workflow.active).toBe(false);
expect(await workflowRunner.isActive(workflow.id)).toBe(false);
expect(await activeWorkflowManager.isActive(workflow.id)).toBe(false);
});
});

10
packages/cli/test/integration/shared/utils/index.ts
View File

@@ -29,7 +29,7 @@ export { setupTestServer } from './testServer';
/**
* Initialize node types.
*/
export async function initActiveWorkflowRunner() {
export async function initActiveWorkflowManager() {
mockInstance(OrchestrationService, {
isMultiMainSetupEnabled: false,
shouldAddWebhooks: jest.fn().mockReturnValue(true),
@@ -37,10 +37,10 @@ export async function initActiveWorkflowRunner() {
mockInstance(Push);
mockInstance(ExecutionService);
const { ActiveWorkflowRunner } = await import('@/ActiveWorkflowRunner');
const workflowRunner = Container.get(ActiveWorkflowRunner);
await workflowRunner.init();
return workflowRunner;
const { ActiveWorkflowManager } = await import('@/ActiveWorkflowManager');
const activeWorkflowManager = Container.get(ActiveWorkflowManager);
await activeWorkflowManager.init();
return activeWorkflowManager;
}
/**

6
packages/cli/test/integration/webhooks.api.test.ts
View File

@@ -11,7 +11,7 @@ import { Push } from '@/push';
import type { WorkflowEntity } from '@db/entities/WorkflowEntity';
import { mockInstance } from '../shared/mocking';
import { initActiveWorkflowRunner } from './shared/utils';
import { initActiveWorkflowManager } from './shared/utils';
import * as testDb from './shared/testDb';
import { createUser } from './shared/db/users';
import { createWorkflow } from './shared/db/workflows';
@@ -41,7 +41,7 @@ describe('Webhook API', () => {
nodeTypes.getByName.mockReturnValue(node);
nodeTypes.getByNameAndVersion.mockReturnValue(node);
await initActiveWorkflowRunner();
await initActiveWorkflowManager();
const server = new (class extends AbstractServer {})();
await server.start();
@@ -144,7 +144,7 @@ describe('Webhook API', () => {
nodeTypes.getByName.mockReturnValue(node);
nodeTypes.getByNameAndVersion.mockReturnValue(node);
await initActiveWorkflowRunner();
await initActiveWorkflowManager();
const server = new (class extends AbstractServer {})();
await server.start();

14
packages/cli/test/integration/workflows/workflow.service.test.ts
View File

@@ -1,6 +1,6 @@
import Container from 'typedi';
import { mock } from 'jest-mock-extended';
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { SharedWorkflowRepository } from '@db/repositories/sharedWorkflow.repository';
import { WorkflowRepository } from '@db/repositories/workflow.repository';
import { MessageEventBus } from '@/eventbus/MessageEventBus/MessageEventBus';
@@ -14,7 +14,7 @@ import { createOwner } from '../shared/db/users';
import { createWorkflow } from '../shared/db/workflows';
let workflowService: WorkflowService;
const activeWorkflowRunner = mockInstance(ActiveWorkflowRunner);
const activeWorkflowManager = mockInstance(ActiveWorkflowManager);
const orchestrationService = mockInstance(OrchestrationService);
mockInstance(MessageEventBus);
mockInstance(Telemetry);
@@ -34,7 +34,7 @@ beforeAll(async () => {
mock(),
orchestrationService,
mock(),
activeWorkflowRunner,
activeWorkflowManager,
);
});
@@ -52,8 +52,8 @@ describe('update()', () => {
const owner = await createOwner();
const workflow = await createWorkflow({ active: true }, owner);
const removeSpy = jest.spyOn(activeWorkflowRunner, 'remove');
const addSpy = jest.spyOn(activeWorkflowRunner, 'add');
const removeSpy = jest.spyOn(activeWorkflowManager, 'remove');
const addSpy = jest.spyOn(activeWorkflowManager, 'add');
await workflowService.update(owner, workflow, workflow.id);
@@ -71,8 +71,8 @@ describe('update()', () => {
const owner = await createOwner();
const workflow = await createWorkflow({ active: true }, owner);
const removeSpy = jest.spyOn(activeWorkflowRunner, 'remove');
const addSpy = jest.spyOn(activeWorkflowRunner, 'add');
const removeSpy = jest.spyOn(activeWorkflowManager, 'remove');
const addSpy = jest.spyOn(activeWorkflowManager, 'add');
workflow.active = false;
await workflowService.update(owner, workflow, workflow.id);

14
packages/cli/test/integration/workflows/workflows.controller.ee.test.ts
View File

@@ -5,7 +5,7 @@ import type { INode } from 'n8n-workflow';
import type { User } from '@db/entities/User';
import { WorkflowHistoryRepository } from '@db/repositories/workflowHistory.repository';
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { WorkflowSharingService } from '@/workflows/workflowSharing.service';
import { mockInstance } from '../../shared/mocking';
@@ -29,7 +29,7 @@ let authMemberAgent: SuperAgentTest;
let authAnotherMemberAgent: SuperAgentTest;
let saveCredential: SaveCredentialFunction;
const activeWorkflowRunner = mockInstance(ActiveWorkflowRunner);
const activeWorkflowManager = mockInstance(ActiveWorkflowManager);
const sharingSpy = jest.spyOn(License.prototype, 'isSharingEnabled').mockReturnValue(true);
const testServer = utils.setupTestServer({
@@ -54,8 +54,8 @@ beforeAll(async () => {
});
beforeEach(async () => {
activeWorkflowRunner.add.mockReset();
activeWorkflowRunner.remove.mockReset();
activeWorkflowManager.add.mockReset();
activeWorkflowManager.remove.mockReset();
await testDb.truncate(['Workflow', 'SharedWorkflow', 'WorkflowHistory']);
});
@@ -1152,7 +1152,7 @@ describe('PATCH /workflows/:id - activate workflow', () => {
const response = await authOwnerAgent.patch(`/workflows/${workflow.id}`).send(payload);
expect(response.statusCode).toBe(200);
expect(activeWorkflowRunner.add).toBeCalled();
expect(activeWorkflowManager.add).toBeCalled();
const {
data: { id, versionId, active },
@@ -1174,8 +1174,8 @@ describe('PATCH /workflows/:id - activate workflow', () => {
const response = await authOwnerAgent.patch(`/workflows/${workflow.id}`).send(payload);
expect(response.statusCode).toBe(200);
expect(activeWorkflowRunner.add).not.toBeCalled();
expect(activeWorkflowRunner.remove).toBeCalled();
expect(activeWorkflowManager.add).not.toBeCalled();
expect(activeWorkflowManager.remove).toBeCalled();
const {
data: { id, versionId, active },

10
packages/cli/test/integration/workflows/workflows.controller.test.ts
View File

@@ -8,7 +8,7 @@ import { WorkflowRepository } from '@db/repositories/workflow.repository';
import type { WorkflowEntity } from '@db/entities/WorkflowEntity';
import type { ListQuery } from '@/requests';
import { WorkflowHistoryRepository } from '@db/repositories/workflowHistory.repository';
import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
import { ActiveWorkflowManager } from '@/ActiveWorkflowManager';
import { EnterpriseWorkflowService } from '@/workflows/workflow.service.ee';
import { mockInstance } from '../../shared/mocking';
@@ -32,7 +32,7 @@ const license = testServer.license;
const { objectContaining, arrayContaining, any } = expect;
const activeWorkflowRunnerLike = mockInstance(ActiveWorkflowRunner);
const activeWorkflowManagerLike = mockInstance(ActiveWorkflowManager);
beforeAll(async () => {
owner = await createOwner();
@@ -574,7 +574,7 @@ describe('PATCH /workflows/:id', () => {
const response = await authOwnerAgent.patch(`/workflows/${workflow.id}`).send(payload);
expect(response.statusCode).toBe(200);
expect(activeWorkflowRunnerLike.add).toBeCalled();
expect(activeWorkflowManagerLike.add).toBeCalled();
const {
data: { id, versionId, active },
@@ -596,8 +596,8 @@ describe('PATCH /workflows/:id', () => {
const response = await authOwnerAgent.patch(`/workflows/${workflow.id}`).send(payload);
expect(response.statusCode).toBe(200);
expect(activeWorkflowRunnerLike.add).not.toBeCalled();
expect(activeWorkflowRunnerLike.remove).toBeCalled();
expect(activeWorkflowManagerLike.add).not.toBeCalled();
expect(activeWorkflowManagerLike.remove).toBeCalled();
const {
data: { id, versionId, active },