test: Migrate @n8n/decorators to Vitest (n8n-io#24737)

shortstacked · web-flow · commit 2f370f4b5fba · 2026-01-23T18:59:09.000Z
diff --git a/packages/@n8n/decorators/jest.config.js b/packages/@n8n/decorators/jest.config.js
diff --git a/packages/@n8n/decorators/package.json b/packages/@n8n/decorators/package.json
@@ -11,9 +11,9 @@
     "lint": "eslint . --quiet",
     "lint:fix": "eslint . --fix",
     "watch": "tsc -p tsconfig.build.json --watch",
-    "test": "jest",
-    "test:unit": "jest",
-    "test:dev": "jest --watch"
+    "test": "vitest run",
+    "test:unit": "vitest run",
+    "test:dev": "vitest"
   },
   "main": "dist/index.js",
   "module": "src/index.ts",
@@ -23,8 +23,10 @@
   ],
   "devDependencies": {
     "@n8n/typescript-config": "workspace:*",
+    "@n8n/vitest-config": "workspace:*",
     "@types/express": "catalog:",
     "@types/lodash": "catalog:",
+    "vitest": "catalog:",
     "zod": "catalog:"
   },
   "dependencies": {
diff --git a/packages/@n8n/decorators/src/__tests__/redactable.test.ts b/packages/@n8n/decorators/src/__tests__/redactable.test.ts
@@ -200,7 +200,7 @@ describe('Redactable Decorator', () => {
 		});
 
 		it('should correctly apply the original method', () => {
-			const spy = jest.spyOn(instance, 'methodWithUser');
+			const spy = vi.spyOn(instance, 'methodWithUser');
 
 			const input = {
 				user: {
diff --git a/packages/@n8n/decorators/src/command/__tests__/command.test.ts b/packages/@n8n/decorators/src/command/__tests__/command.test.ts
@@ -8,7 +8,7 @@ describe('@Command decorator', () => {
 	let commandMetadata: CommandMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 		Container.reset();
 
 		commandMetadata = new CommandMetadata();
diff --git a/packages/@n8n/decorators/src/context-establishment/__tests__/context-establishment-hook.test.ts b/packages/@n8n/decorators/src/context-establishment/__tests__/context-establishment-hook.test.ts
@@ -14,7 +14,7 @@ describe('@ContextEstablishmentHook decorator', () => {
 	let hookMetadata: ContextEstablishmentHookMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		hookMetadata = new ContextEstablishmentHookMetadata();
 		Container.set(ContextEstablishmentHookMetadata, hookMetadata);
diff --git a/packages/@n8n/decorators/src/controller/__tests__/args.test.ts b/packages/@n8n/decorators/src/controller/__tests__/args.test.ts
@@ -8,7 +8,7 @@ describe('Args Decorators', () => {
 	let controllerRegistryMetadata: ControllerRegistryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		controllerRegistryMetadata = new ControllerRegistryMetadata();
 		Container.set(ControllerRegistryMetadata, controllerRegistryMetadata);
diff --git a/packages/@n8n/decorators/src/controller/__tests__/license.test.ts b/packages/@n8n/decorators/src/controller/__tests__/license.test.ts
@@ -9,7 +9,7 @@ describe('@Licensed Decorator', () => {
 	let controllerRegistryMetadata: ControllerRegistryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		controllerRegistryMetadata = new ControllerRegistryMetadata();
 		Container.set(ControllerRegistryMetadata, controllerRegistryMetadata);
diff --git a/packages/@n8n/decorators/src/controller/__tests__/rest-controller.test.ts b/packages/@n8n/decorators/src/controller/__tests__/rest-controller.test.ts
@@ -8,7 +8,7 @@ describe('@RestController Decorator', () => {
 	let controllerRegistryMetadata: ControllerRegistryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 		Container.reset();
 
 		controllerRegistryMetadata = new ControllerRegistryMetadata();
diff --git a/packages/@n8n/decorators/src/controller/__tests__/root-level-controller.test.ts b/packages/@n8n/decorators/src/controller/__tests__/root-level-controller.test.ts
@@ -8,7 +8,7 @@ describe('@RootLevelController Decorator', () => {
 	let controllerRegistryMetadata: ControllerRegistryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 		Container.reset();
 
 		controllerRegistryMetadata = new ControllerRegistryMetadata();
diff --git a/packages/@n8n/decorators/src/controller/__tests__/route.test.ts b/packages/@n8n/decorators/src/controller/__tests__/route.test.ts
@@ -9,7 +9,7 @@ describe('Route Decorators', () => {
 	let controllerRegistryMetadata: ControllerRegistryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		controllerRegistryMetadata = new ControllerRegistryMetadata();
 		Container.set(ControllerRegistryMetadata, controllerRegistryMetadata);
diff --git a/packages/@n8n/decorators/src/controller/__tests__/scoped.test.ts b/packages/@n8n/decorators/src/controller/__tests__/scoped.test.ts
@@ -9,7 +9,7 @@ describe('Scope Decorators', () => {
 	let controllerRegistryMetadata: ControllerRegistryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		controllerRegistryMetadata = new ControllerRegistryMetadata();
 		Container.set(ControllerRegistryMetadata, controllerRegistryMetadata);
diff --git a/packages/@n8n/decorators/src/credential-resolver/__tests__/credential-resolver.test.ts b/packages/@n8n/decorators/src/credential-resolver/__tests__/credential-resolver.test.ts
@@ -11,7 +11,7 @@ describe('@CredentialResolver decorator', () => {
 	let resolverMetadata: CredentialResolverEntryMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		resolverMetadata = new CredentialResolverEntryMetadata();
 		Container.set(CredentialResolverEntryMetadata, resolverMetadata);
diff --git a/packages/@n8n/decorators/src/execution-lifecycle/__tests__/on-lifecycle-event.test.ts b/packages/@n8n/decorators/src/execution-lifecycle/__tests__/on-lifecycle-event.test.ts
@@ -10,7 +10,7 @@ describe('OnLifecycleEvent', () => {
 	beforeEach(() => {
 		lifecycleMetadata = new LifecycleMetadata();
 		Container.set(LifecycleMetadata, lifecycleMetadata);
-		jest.spyOn(lifecycleMetadata, 'register');
+		vi.spyOn(lifecycleMetadata, 'register');
 	});
 
 	it('should register a method decorated with OnLifecycleEvent', () => {
diff --git a/packages/@n8n/decorators/src/module/__tests__/module.test.ts b/packages/@n8n/decorators/src/module/__tests__/module.test.ts
@@ -8,7 +8,7 @@ describe('@BackendModule decorator', () => {
 	let moduleMetadata: ModuleMetadata;
 
 	beforeEach(() => {
-		jest.resetAllMocks();
+		vi.resetAllMocks();
 
 		moduleMetadata = new ModuleMetadata();
 		Container.set(ModuleMetadata, moduleMetadata);
diff --git a/packages/@n8n/decorators/src/multi-main/__tests__/on-multi-main-event.test.ts b/packages/@n8n/decorators/src/multi-main/__tests__/on-multi-main-event.test.ts
@@ -35,7 +35,7 @@ beforeEach(() => {
 });
 
 it('should register methods decorated with @OnLeaderTakeover', () => {
-	jest.spyOn(metadata, 'register');
+	vi.spyOn(metadata, 'register');
 
 	@Service()
 	class TestService {
@@ -51,7 +51,7 @@ it('should register methods decorated with @OnLeaderTakeover', () => {
 });
 
 it('should register methods decorated with @OnLeaderStepdown', () => {
-	jest.spyOn(metadata, 'register');
+	vi.spyOn(metadata, 'register');
 
 	@Service()
 	class TestService {
@@ -99,8 +99,8 @@ it('should call decorated methods when events are emitted', async () => {
 	}
 
 	const testService = Container.get(TestService);
-	jest.spyOn(testService, 'handleLeaderTakeover');
-	jest.spyOn(testService, 'handleLeaderStepdown');
+	vi.spyOn(testService, 'handleLeaderTakeover');
+	vi.spyOn(testService, 'handleLeaderStepdown');
 
 	multiMainSetup.registerEventHandlers();
 
diff --git a/packages/@n8n/decorators/src/pubsub/__tests__/on-pubsub-event.test.ts b/packages/@n8n/decorators/src/pubsub/__tests__/on-pubsub-event.test.ts
@@ -15,7 +15,7 @@ describe('@OnPubSubEvent', () => {
 	});
 
 	it('should register methods decorated with @OnPubSubEvent', () => {
-		jest.spyOn(metadata, 'register');
+		vi.spyOn(metadata, 'register');
 
 		@Service()
 		class TestService {
diff --git a/packages/@n8n/decorators/src/shutdown/__tests__/on-shutdown.test.ts b/packages/@n8n/decorators/src/shutdown/__tests__/on-shutdown.test.ts
@@ -9,7 +9,7 @@ describe('OnShutdown', () => {
 	beforeEach(() => {
 		shutdownMetadata = new ShutdownMetadata();
 		Container.set(ShutdownMetadata, shutdownMetadata);
-		jest.spyOn(shutdownMetadata, 'register');
+		vi.spyOn(shutdownMetadata, 'register');
 	});
 
 	it('should register a methods that is decorated with OnShutdown', () => {
diff --git a/packages/@n8n/decorators/tsconfig.json b/packages/@n8n/decorators/tsconfig.json
@@ -2,7 +2,7 @@
 	"extends": "@n8n/typescript-config/tsconfig.common.json",
 	"compilerOptions": {
 		"rootDir": ".",
-		"types": ["node", "jest"],
+		"types": ["node", "vitest/globals"],
 		"baseUrl": "src",
 		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo",
 		"experimentalDecorators": true,
diff --git a/packages/@n8n/decorators/vitest.config.ts b/packages/@n8n/decorators/vitest.config.ts
@@ -0,0 +1,5 @@
+import { createVitestConfigWithDecorators } from '@n8n/vitest-config/node-decorators';
+
+export default createVitestConfigWithDecorators({
+	coveragePathIgnorePatterns: ['index.ts'],
+});
diff --git a/packages/@n8n/vitest-config/node-decorators.ts b/packages/@n8n/vitest-config/node-decorators.ts
@@ -0,0 +1,36 @@
+import swc from 'unplugin-swc';
+import { mergeConfig } from 'vitest/config';
+import type { InlineConfig } from 'vitest/node';
+import { createVitestConfig } from './node.js';
+
+const swcPlugin = swc.vite({
+	jsc: {
+		parser: {
+			syntax: 'typescript',
+			decorators: true,
+		},
+		transform: {
+			legacyDecorator: true,
+			decoratorMetadata: true,
+		},
+		target: 'es2022',
+	},
+	// Include node_modules TypeScript files (like @n8n/tournament)
+	exclude: [],
+});
+
+export const createVitestConfigWithDecorators = (options: InlineConfig = {}) => {
+	const baseConfig = createVitestConfig(options);
+	return mergeConfig(baseConfig, {
+		plugins: [swcPlugin],
+		esbuild: false, // Disable esbuild - it doesn't support decoratorMetadata
+		server: {
+			deps: {
+				// Inline all dependencies so SWC can transform them (including TypeScript in node_modules)
+				inline: [/.*/],
+			},
+		},
+	});
+};
+
+export const vitestConfigWithDecorators = createVitestConfigWithDecorators();
diff --git a/packages/@n8n/vitest-config/package.json b/packages/@n8n/vitest-config/package.json
@@ -6,6 +6,9 @@
     "vite": "catalog:",
     "vitest": "catalog:"
   },
+  "dependencies": {
+    "unplugin-swc": "^1.5.1"
+  },
   "devDependencies": {
     "@n8n/typescript-config": "workspace:*",
     "@swc/core": "^1.10.7",
@@ -31,6 +34,11 @@
       "import": "./dist/node.js",
       "require": "./dist/node.js",
       "types": "./dist/node.d.ts"
+    },
+    "./node-decorators": {
+      "import": "./dist/node-decorators.js",
+      "require": "./dist/node-decorators.js",
+      "types": "./dist/node-decorators.d.ts"
     }
   },
   "scripts": {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
