fix(core): Change VariablesService to DI and use caching (n8n-io#6827)

* support redis cluster

* cleanup, fix config schema

* set default prefix to bull

* initial commit

* improve logging

* improve types and refactor

* list support and refactor

* fix redis service and tests

* add comment

* add redis and cache prefix

* use injection

* lint fix

* clean schema comments

* improve naming, tests, cluster client

* merge master

* cache returns unknown instead of T

* update cache service, tests and doc

* remove console.log

* VariablesService as DI, add caching, fix tests

* do not cache null or undefined values

* import fix

* more DI and remove collections

* fix merge

* lint fix

* rename to ~Cached

* fix test for CI

* fix ActiveWorkflowRunner test

Author: flipswitchingmonkey

packages/cli/src/WorkflowHelpers.ts

@@ -37,6 +37,7 @@ import { isWorkflowIdValid } from './utils';
 import { UserService } from './user/user.service';
 import type { SharedWorkflow } from '@db/entities/SharedWorkflow';
 import type { RoleNames } from '@db/entities/Role';
+import { VariablesService } from './environments/variables/variables.service';
 
 const ERROR_TRIGGER_TYPE = config.getEnv('nodes.errorTriggerType');
 
@@ -571,8 +572,9 @@ export function validateWorkflowCredentialUsage(
 }
 
 export async function getVariables(): Promise<IDataObject> {
+	const variables = await Container.get(VariablesService).getAllCached();
 	return Object.freeze(
-		(await Db.collections.Variables.find()).reduce((prev, curr) => {
+		variables.reduce((prev, curr) => {
 			prev[curr.key] = curr.value;
 			return prev;
 		}, {} as IDataObject),

packages/cli/src/environments/sourceControl/sourceControlExport.service.ee.ts

@@ -25,6 +25,7 @@ import {
 import type { WorkflowEntity } from '@db/entities/WorkflowEntity';
 import { In } from 'typeorm';
 import type { SourceControlledFile } from './types/sourceControlledFile';
+import { VariablesService } from '../variables/variables.service';
 
 @Service()
 export class SourceControlExportService {
@@ -34,7 +35,7 @@ export class SourceControlExportService {
 
 	private credentialExportFolder: string;
 
-	constructor() {
+	constructor(private readonly variablesService: VariablesService) {
 		const userFolder = UserSettings.getUserN8nFolderPath();
 		this.gitFolder = path.join(userFolder, SOURCE_CONTROL_GIT_FOLDER);
 		this.workflowExportFolder = path.join(this.gitFolder, SOURCE_CONTROL_WORKFLOW_EXPORT_FOLDER);
@@ -136,7 +137,7 @@ export class SourceControlExportService {
 	async exportVariablesToWorkFolder(): Promise<ExportResult> {
 		try {
 			sourceControlFoldersExistCheck([this.gitFolder]);
-			const variables = await Db.collections.Variables.find();
+			const variables = await this.variablesService.getAllCached();
 			// do not export empty variables
 			if (variables.length === 0) {
 				return {

packages/cli/src/environments/sourceControl/sourceControlImport.service.ee.ts

@@ -1,4 +1,4 @@
-import { Container, Service } from 'typedi';
+import { Service } from 'typedi';
 import path from 'path';
 import {
 	SOURCE_CONTROL_CREDENTIAL_EXPORT_FOLDER,
@@ -25,6 +25,7 @@ import { isUniqueConstraintError } from '@/ResponseHelper';
 import type { SourceControlWorkflowVersionId } from './types/sourceControlWorkflowVersionId';
 import { getCredentialExportPath, getWorkflowExportPath } from './sourceControlHelper.ee';
 import type { SourceControlledFile } from './types/sourceControlledFile';
+import { VariablesService } from '../variables/variables.service';
 
 @Service()
 export class SourceControlImportService {
@@ -34,7 +35,10 @@ export class SourceControlImportService {
 
 	private credentialExportFolder: string;
 
-	constructor() {
+	constructor(
+		private readonly variablesService: VariablesService,
+		private readonly activeWorkflowRunner: ActiveWorkflowRunner,
+	) {
 		const userFolder = UserSettings.getUserN8nFolderPath();
 		this.gitFolder = path.join(userFolder, SOURCE_CONTROL_GIT_FOLDER);
 		this.workflowExportFolder = path.join(this.gitFolder, SOURCE_CONTROL_WORKFLOW_EXPORT_FOLDER);
@@ -240,10 +244,7 @@ export class SourceControlImportService {
 	}
 
 	public async getLocalVariablesFromDb(): Promise<Variables[]> {
-		const localVariables = await Db.collections.Variables.find({
-			select: ['id', 'key', 'type', 'value'],
-		});
-		return localVariables;
+		return this.variablesService.getAllCached();
 	}
 
 	public async getRemoteTagsAndMappingsFromFile(): Promise<{
@@ -280,7 +281,7 @@ export class SourceControlImportService {
 
 	public async importWorkflowFromWorkFolder(candidates: SourceControlledFile[], userId: string) {
 		const ownerWorkflowRole = await this.getOwnerWorkflowRole();
-		const workflowRunner = Container.get(ActiveWorkflowRunner);
+		const workflowRunner = this.activeWorkflowRunner;
 		const candidateIds = candidates.map((c) => c.id);
 		const existingWorkflows = await Db.collections.Workflow.find({
 			where: {
@@ -581,6 +582,8 @@ export class SourceControlImportService {
 			}
 		}
 
+		await this.variablesService.updateCache();
+
 		return result;
 	}
 }

packages/cli/src/environments/variables/variables.controller.ee.ts

@@ -9,6 +9,7 @@ import {
 	VariablesValidationError,
 } from './variables.service.ee';
 import { isVariablesEnabled } from './enviromentHelpers';
+import Container from 'typedi';
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const EEVariablesController = express.Router();
@@ -37,7 +38,7 @@ EEVariablesController.post(
 		const variable = req.body;
 		delete variable.id;
 		try {
-			return await EEVariablesService.create(variable);
+			return await Container.get(EEVariablesService).create(variable);
 		} catch (error) {
 			if (error instanceof VariablesLicenseError) {
 				throw new ResponseHelper.BadRequestError(error.message);
@@ -63,7 +64,7 @@ EEVariablesController.patch(
 		const variable = req.body;
 		delete variable.id;
 		try {
-			return await EEVariablesService.update(id, variable);
+			return await Container.get(EEVariablesService).update(id, variable);
 		} catch (error) {
 			if (error instanceof VariablesLicenseError) {
 				throw new ResponseHelper.BadRequestError(error.message);

packages/cli/src/environments/variables/variables.controller.ts

@@ -6,6 +6,7 @@ import * as ResponseHelper from '@/ResponseHelper';
 import type { VariablesRequest } from '@/requests';
 import { VariablesService } from './variables.service';
 import { EEVariablesController } from './variables.controller.ee';
+import Container from 'typedi';
 
 export const variablesController = express.Router();
 
@@ -28,7 +29,7 @@ variablesController.use(EEVariablesController);
 variablesController.get(
 	'/',
 	ResponseHelper.send(async () => {
-		return VariablesService.getAll();
+		return Container.get(VariablesService).getAllCached();
 	}),
 );
 
@@ -43,7 +44,7 @@ variablesController.get(
 	'/:id(\\w+)',
 	ResponseHelper.send(async (req: VariablesRequest.Get) => {
 		const id = req.params.id;
-		const variable = await VariablesService.get(id);
+		const variable = await Container.get(VariablesService).getCached(id);
 		if (variable === null) {
 			throw new ResponseHelper.NotFoundError(`Variable with id ${req.params.id} not found`);
 		}
@@ -69,7 +70,7 @@ variablesController.delete(
 			});
 			throw new ResponseHelper.AuthError('Unauthorized');
 		}
-		await VariablesService.delete(id);
+		await Container.get(VariablesService).delete(id);
 
 		return true;
 	}),

packages/cli/src/environments/variables/variables.service.ee.ts

@@ -1,6 +1,5 @@
-import { Container } from 'typedi';
+import { Container, Service } from 'typedi';
 import type { Variables } from '@db/entities/Variables';
-import { collections } from '@/Db';
 import { InternalHooks } from '@/InternalHooks';
 import { generateNanoId } from '@db/utils/generators';
 import { canCreateNewVariable } from './enviromentHelpers';
@@ -9,12 +8,9 @@ import { VariablesService } from './variables.service';
 export class VariablesLicenseError extends Error {}
 export class VariablesValidationError extends Error {}
 
+@Service()
 export class EEVariablesService extends VariablesService {
-	static async getCount(): Promise<number> {
-		return collections.Variables.count();
-	}
-
-	static validateVariable(variable: Omit<Variables, 'id'>): void {
+	validateVariable(variable: Omit<Variables, 'id'>): void {
 		if (variable.key.length > 50) {
 			throw new VariablesValidationError('key cannot be longer than 50 characters');
 		}
@@ -26,23 +22,25 @@ export class EEVariablesService extends VariablesService {
 		}
 	}
 
-	static async create(variable: Omit<Variables, 'id'>): Promise<Variables> {
+	async create(variable: Omit<Variables, 'id'>): Promise<Variables> {
 		if (!canCreateNewVariable(await this.getCount())) {
 			throw new VariablesLicenseError('Variables limit reached');
 		}
 		this.validateVariable(variable);
 
 		void Container.get(InternalHooks).onVariableCreated({ variable_type: variable.type });
-		return collections.Variables.save({
+		const saveResult = await this.variablesRepository.save({
 			...variable,
 			id: generateNanoId(),
 		});
+		await this.updateCache();
+		return saveResult;
 	}
 
-	static async update(id: string, variable: Omit<Variables, 'id'>): Promise<Variables> {
+	async update(id: string, variable: Omit<Variables, 'id'>): Promise<Variables> {
 		this.validateVariable(variable);
-		await collections.Variables.update(id, variable);
-
-		return (await this.get(id))!;
+		await this.variablesRepository.update(id, variable);
+		await this.updateCache();
+		return (await this.getCached(id))!;
 	}
 }

packages/cli/src/environments/variables/variables.service.ts

@@ -1,20 +1,53 @@
 import type { Variables } from '@db/entities/Variables';
-import { collections } from '@/Db';
+import { CacheService } from '@/services/cache.service';
+import Container, { Service } from 'typedi';
+import { VariablesRepository } from '@/databases/repositories';
+import type { DeepPartial } from 'typeorm';
 
+@Service()
 export class VariablesService {
-	static async getAll(): Promise<Variables[]> {
-		return collections.Variables.find();
+	constructor(
+		protected cacheService: CacheService,
+		protected variablesRepository: VariablesRepository,
+	) {}
+
+	async getAllCached(): Promise<Variables[]> {
+		const variables = await this.cacheService.get('variables', {
+			async refreshFunction() {
+				// TODO: log refresh cache metric
+				return Container.get(VariablesService).findAll();
+			},
+		});
+		return (variables as Array<DeepPartial<Variables>>).map((v) =>
+			this.variablesRepository.create(v),
+		);
+	}
+
+	async getCount(): Promise<number> {
+		return (await this.getAllCached()).length;
+	}
+
+	async getCached(id: string): Promise<Variables | null> {
+		const variables = await this.getAllCached();
+		const foundVariable = variables.find((variable) => variable.id === id);
+		if (!foundVariable) {
+			return null;
+		}
+		return this.variablesRepository.create(foundVariable as DeepPartial<Variables>);
 	}
 
-	static async getCount(): Promise<number> {
-		return collections.Variables.count();
+	async delete(id: string): Promise<void> {
+		await this.variablesRepository.delete(id);
+		await this.updateCache();
 	}
 
-	static async get(id: string): Promise<Variables | null> {
-		return collections.Variables.findOne({ where: { id } });
+	async updateCache(): Promise<void> {
+		// TODO: log update cache metric
+		const variables = await this.findAll();
+		await this.cacheService.set('variables', variables);
 	}
 
-	static async delete(id: string): Promise<void> {
-		await collections.Variables.delete(id);
+	async findAll(): Promise<Variables[]> {
+		return this.variablesRepository.find();
 	}
 }

packages/cli/test/integration/shared/testDb.ts

@@ -34,6 +34,7 @@ import type {
 } from './types';
 import type { ExecutionData } from '@db/entities/ExecutionData';
 import { generateNanoId } from '@db/utils/generators';
+import { VariablesService } from '@/environments/variables/variables.service';
 
 export type TestDBType = 'postgres' | 'mysql';
 
@@ -514,11 +515,13 @@ export async function getWorkflowSharing(workflow: WorkflowEntity) {
 // ----------------------------------
 
 export async function createVariable(key: string, value: string) {
-	return Db.collections.Variables.save({
+	const result = await Db.collections.Variables.save({
 		id: generateNanoId(),
 		key,
 		value,
 	});
+	await Container.get(VariablesService).updateCache();
+	return result;
 }
 
 export async function getVariableByKey(key: string) {

packages/cli/test/integration/variables.test.ts

@@ -98,7 +98,7 @@ describe('POST /variables', () => {
 	});
 	const toCreate = generatePayload();
 
-	test('should create a new credential and return it for an owner', async () => {
+	test('should create a new variable and return it for an owner', async () => {
 		const response = await authOwnerAgent.post('/variables').send(toCreate);
 		expect(response.statusCode).toBe(200);
 		expect(response.body.data.key).toBe(toCreate.key);
@@ -118,7 +118,7 @@ describe('POST /variables', () => {
 		expect(byKey!.value).toBe(toCreate.value);
 	});
 
-	test('should not create a new credential and return it for a member', async () => {
+	test('should not create a new variable and return it for a member', async () => {
 		const response = await authMemberAgent.post('/variables').send(toCreate);
 		expect(response.statusCode).toBe(401);
 		expect(response.body.data?.key).not.toBe(toCreate.key);
@@ -128,7 +128,7 @@ describe('POST /variables', () => {
 		expect(byKey).toBeNull();
 	});
 
-	test("POST /variables should not create a new credential and return it if the instance doesn't have a license", async () => {
+	test("POST /variables should not create a new variable and return it if the instance doesn't have a license", async () => {
 		licenseLike.isVariablesEnabled.mockReturnValue(false);
 		const response = await authOwnerAgent.post('/variables').send(toCreate);
 		expect(response.statusCode).toBe(400);
@@ -139,7 +139,7 @@ describe('POST /variables', () => {
 		expect(byKey).toBeNull();
 	});
 
-	test('should fail to create a new credential and if one with the same key exists', async () => {
+	test('should fail to create a new variable and if one with the same key exists', async () => {
 		await testDb.createVariable(toCreate.key, toCreate.value);
 		const response = await authOwnerAgent.post('/variables').send(toCreate);
 		expect(response.statusCode).toBe(500);
@@ -224,7 +224,7 @@ describe('PATCH /variables/:id', () => {
 		value: 'createvalue1',
 	};
 
-	test('should modify existing credential if use is an owner', async () => {
+	test('should modify existing variable if use is an owner', async () => {
 		const variable = await testDb.createVariable('test1', 'value1');
 		const response = await authOwnerAgent.patch(`/variables/${variable.id}`).send(toModify);
 		expect(response.statusCode).toBe(200);
@@ -245,7 +245,7 @@ describe('PATCH /variables/:id', () => {
 		expect(byKey!.value).toBe(toModify.value);
 	});
 
-	test('should modify existing credential if use is an owner', async () => {
+	test('should modify existing variable if use is an owner', async () => {
 		const variable = await testDb.createVariable('test1', 'value1');
 		const response = await authOwnerAgent.patch(`/variables/${variable.id}`).send(toModify);
 		expect(response.statusCode).toBe(200);
@@ -266,7 +266,7 @@ describe('PATCH /variables/:id', () => {
 		expect(byKey!.value).toBe(toModify.value);
 	});
 
-	test('should not modify existing credential if use is a member', async () => {
+	test('should not modify existing variable if use is a member', async () => {
 		const variable = await testDb.createVariable('test1', 'value1');
 		const response = await authMemberAgent.patch(`/variables/${variable.id}`).send(toModify);
 		expect(response.statusCode).toBe(401);
@@ -279,7 +279,7 @@ describe('PATCH /variables/:id', () => {
 		expect(byId!.value).not.toBe(toModify.value);
 	});
 
-	test('should not modify existing credential if one with the same key exists', async () => {
+	test('should not modify existing variable if one with the same key exists', async () => {
 		const [var1, var2] = await Promise.all([
 			testDb.createVariable('test1', 'value1'),
 			testDb.createVariable(toModify.key, toModify.value),
@@ -300,7 +300,7 @@ describe('PATCH /variables/:id', () => {
 // DELETE /variables/:id - change a variable
 // ----------------------------------------
 describe('DELETE /variables/:id', () => {
-	test('should delete a single credential for an owner', async () => {
+	test('should delete a single variable for an owner', async () => {
 		const [var1, var2, var3] = await Promise.all([
 			testDb.createVariable('test1', 'value1'),
 			testDb.createVariable('test2', 'value2'),
@@ -317,7 +317,7 @@ describe('DELETE /variables/:id', () => {
 		expect(getResponse.body.data.length).toBe(2);
 	});
 
-	test('should not delete a single credential for a member', async () => {
+	test('should not delete a single variable for a member', async () => {
 		const [var1, var2, var3] = await Promise.all([
 			testDb.createVariable('test1', 'value1'),
 			testDb.createVariable('test2', 'value2'),