refactor(core): Use an IoC container to manage singleton classes [Part-1] (no-changelog) (#5509)

* add typedi

* convert ActiveWorkflowRunner into an injectable service

* convert ExternalHooks into an injectable service

* convert InternalHooks into an injectable service

* convert LoadNodesAndCredentials into an injectable service

* convert NodeTypes and CredentialTypes into an injectable service

* convert ActiveExecutions into an injectable service

* convert WaitTracker into an injectable service

* convert Push into an injectable service

* convert ActiveWebhooks and  TestWebhooks into an injectable services

* handle circular references, and log errors when a circular dependency is found

packages/cli/src/workflows/workflows.controller.ee.ts

@@ -1,7 +1,6 @@
 import express from 'express';
 import { v4 as uuid } from 'uuid';
 import * as Db from '@/Db';
-import { InternalHooksManager } from '@/InternalHooksManager';
 import * as ResponseHelper from '@/ResponseHelper';
 import * as WorkflowHelpers from '@/WorkflowHelpers';
 import config from '@/config';
@@ -18,6 +17,8 @@ import { EECredentialsService as EECredentials } from '../credentials/credential
 import type { IExecutionPushResponse } from '@/Interfaces';
 import * as GenericHelpers from '@/GenericHelpers';
 import { In } from 'typeorm';
+import { Container } from 'typedi';
+import { InternalHooks } from '@/InternalHooks';
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const EEWorkflowController = express.Router();
@@ -75,7 +76,7 @@ EEWorkflowController.put(
 			}
 		});
 
-		void InternalHooksManager.getInstance().onWorkflowSharingUpdate(
+		void Container.get(InternalHooks).onWorkflowSharingUpdate(
 			workflowId,
 			req.user.id,
 			shareWithIds,
@@ -126,7 +127,7 @@ EEWorkflowController.post(
 
 		await validateEntity(newWorkflow);
 
-		await ExternalHooks().run('workflow.create', [newWorkflow]);
+		await Container.get(ExternalHooks).run('workflow.create', [newWorkflow]);
 
 		const { tags: tagIds } = req.body;
 
@@ -190,8 +191,8 @@ EEWorkflowController.post(
 			});
 		}
 
-		await ExternalHooks().run('workflow.afterCreate', [savedWorkflow]);
-		void InternalHooksManager.getInstance().onWorkflowCreated(req.user, newWorkflow, false);
+		await Container.get(ExternalHooks).run('workflow.afterCreate', [savedWorkflow]);
+		void Container.get(InternalHooks).onWorkflowCreated(req.user, newWorkflow, false);
 
 		return savedWorkflow;
 	}),

packages/cli/src/workflows/workflows.controller.ts

@@ -15,7 +15,6 @@ import * as TagHelpers from '@/TagHelpers';
 import { SharedWorkflow } from '@db/entities/SharedWorkflow';
 import { WorkflowEntity } from '@db/entities/WorkflowEntity';
 import { validateEntity } from '@/GenericHelpers';
-import { InternalHooksManager } from '@/InternalHooksManager';
 import { ExternalHooks } from '@/ExternalHooks';
 import { getLogger } from '@/Logger';
 import type { WorkflowRequest } from '@/requests';
@@ -24,6 +23,8 @@ import { EEWorkflowController } from './workflows.controller.ee';
 import { WorkflowsService } from './workflows.services';
 import { whereClause } from '@/UserManagement/UserManagementHelper';
 import { In } from 'typeorm';
+import { Container } from 'typedi';
+import { InternalHooks } from '@/InternalHooks';
 
 export const workflowsController = express.Router();
 
@@ -57,7 +58,7 @@ workflowsController.post(
 
 		await validateEntity(newWorkflow);
 
-		await ExternalHooks().run('workflow.create', [newWorkflow]);
+		await Container.get(ExternalHooks).run('workflow.create', [newWorkflow]);
 
 		const { tags: tagIds } = req.body;
 
@@ -106,8 +107,8 @@ workflowsController.post(
 			});
 		}
 
-		await ExternalHooks().run('workflow.afterCreate', [savedWorkflow]);
-		void InternalHooksManager.getInstance().onWorkflowCreated(req.user, newWorkflow, false);
+		await Container.get(ExternalHooks).run('workflow.afterCreate', [savedWorkflow]);
+		void Container.get(InternalHooks).onWorkflowCreated(req.user, newWorkflow, false);
 
 		return savedWorkflow;
 	}),

packages/cli/src/workflows/workflows.services.ts

@@ -1,3 +1,4 @@
+import { Container } from 'typedi';
 import { validate as jsonSchemaValidate } from 'jsonschema';
 import type { INode, IPinData, JsonObject } from 'n8n-workflow';
 import { NodeApiError, jsonParse, LoggerProxy, Workflow } from 'n8n-workflow';
@@ -5,9 +6,8 @@ import type { FindOptionsSelect, FindOptionsWhere, UpdateResult } from 'typeorm'
 import { In } from 'typeorm';
 import pick from 'lodash.pick';
 import { v4 as uuid } from 'uuid';
-import * as ActiveWorkflowRunner from '@/ActiveWorkflowRunner';
+import { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
 import * as Db from '@/Db';
-import { InternalHooksManager } from '@/InternalHooksManager';
 import * as ResponseHelper from '@/ResponseHelper';
 import * as WorkflowHelpers from '@/WorkflowHelpers';
 import config from '@/config';
@@ -22,10 +22,11 @@ import type { IWorkflowDb, IWorkflowExecutionDataProcess } from '@/Interfaces';
 import { NodeTypes } from '@/NodeTypes';
 import { WorkflowRunner } from '@/WorkflowRunner';
 import * as WorkflowExecuteAdditionalData from '@/WorkflowExecuteAdditionalData';
-import * as TestWebhooks from '@/TestWebhooks';
+import { TestWebhooks } from '@/TestWebhooks';
 import { getSharedWorkflowIds } from '@/WorkflowHelpers';
 import { isSharingEnabled, whereClause } from '@/UserManagement/UserManagementHelper';
 import type { WorkflowForList } from '@/workflows/workflows.types';
+import { InternalHooks } from '@/InternalHooks';
 
 export type IGetWorkflowsQueryFilter = Pick<
 	FindOptionsWhere<WorkflowEntity>,
@@ -91,7 +92,7 @@ export class WorkflowsService {
 			nodes: workflow.nodes,
 			connections: workflow.connections,
 			active: workflow.active,
-			nodeTypes: NodeTypes(),
+			nodeTypes: Container.get(NodeTypes),
 		}).getParentNodes(startNodeName);
 
 		let checkNodeName = '';
@@ -236,12 +237,12 @@ export class WorkflowsService {
 
 		WorkflowHelpers.addNodeIds(workflow);
 
-		await ExternalHooks().run('workflow.update', [workflow]);
+		await Container.get(ExternalHooks).run('workflow.update', [workflow]);
 
 		if (shared.workflow.active) {
 			// When workflow gets saved always remove it as the triggers could have been
 			// changed and so the changes would not take effect
-			await ActiveWorkflowRunner.getInstance().remove(workflowId);
+			await Container.get(ActiveWorkflowRunner).remove(workflowId);
 		}
 
 		if (workflow.settings) {
@@ -319,14 +320,14 @@ export class WorkflowsService {
 			});
 		}
 
-		await ExternalHooks().run('workflow.afterUpdate', [updatedWorkflow]);
-		void InternalHooksManager.getInstance().onWorkflowSaved(user, updatedWorkflow, false);
+		await Container.get(ExternalHooks).run('workflow.afterUpdate', [updatedWorkflow]);
+		void Container.get(InternalHooks).onWorkflowSaved(user, updatedWorkflow, false);
 
 		if (updatedWorkflow.active) {
 			// When the workflow is supposed to be active add it again
 			try {
-				await ExternalHooks().run('workflow.activate', [updatedWorkflow]);
-				await ActiveWorkflowRunner.getInstance().add(
+				await Container.get(ExternalHooks).run('workflow.activate', [updatedWorkflow]);
+				await Container.get(ActiveWorkflowRunner).add(
 					workflowId,
 					shared.workflow.active ? 'update' : 'activate',
 				);
@@ -383,14 +384,14 @@ export class WorkflowsService {
 				nodes: workflowData.nodes,
 				connections: workflowData.connections,
 				active: false,
-				nodeTypes: NodeTypes(),
+				nodeTypes: Container.get(NodeTypes),
 				staticData: undefined,
 				settings: workflowData.settings,
 			});
 
 			const additionalData = await WorkflowExecuteAdditionalData.getBase(user.id);
 
-			const needsWebhook = await TestWebhooks.getInstance().needsWebhookData(
+			const needsWebhook = await Container.get(TestWebhooks).needsWebhookData(
 				workflowData,
 				workflow,
 				additionalData,
@@ -436,7 +437,7 @@ export class WorkflowsService {
 	}
 
 	static async delete(user: User, workflowId: string): Promise<WorkflowEntity | undefined> {
-		await ExternalHooks().run('workflow.delete', [workflowId]);
+		await Container.get(ExternalHooks).run('workflow.delete', [workflowId]);
 
 		const sharedWorkflow = await Db.collections.SharedWorkflow.findOne({
 			relations: ['workflow', 'role'],
@@ -454,13 +455,13 @@ export class WorkflowsService {
 
 		if (sharedWorkflow.workflow.active) {
 			// deactivate before deleting
-			await ActiveWorkflowRunner.getInstance().remove(workflowId);
+			await Container.get(ActiveWorkflowRunner).remove(workflowId);
 		}
 
 		await Db.collections.Workflow.delete(workflowId);
 
-		void InternalHooksManager.getInstance().onWorkflowDeleted(user, workflowId, false);
-		await ExternalHooks().run('workflow.afterDelete', [workflowId]);
+		void Container.get(InternalHooks).onWorkflowDeleted(user, workflowId, false);
+		await Container.get(ExternalHooks).run('workflow.afterDelete', [workflowId]);
 
 		return sharedWorkflow.workflow;
 	}