Implement afterEach

Author: ivov

packages/cli/src/benchmark/lib/duplicate-hook.error.ts

@@ -1,7 +1,7 @@
 import { ApplicationError } from 'n8n-workflow';
 
 export class DuplicateHookError extends ApplicationError {
-	constructor(hookName: 'beforeEach', filePath: string) {
+	constructor(hookName: 'beforeEach' | 'afterEach', filePath: string) {
 		super(
 			`Duplicate \`${hookName}\` hook found in benchmarking suite \`${filePath}\`. Please define a single \`${hookName}\` hook for this suite.`,
 			{ level: 'warning' },

packages/cli/src/benchmark/lib/suites.ts

@@ -25,14 +25,22 @@ export async function collectSuites() {
 }
 
 export function registerSuites(bench: Bench) {
-	for (const { tasks, hooks } of Object.values(suites)) {
-		for (const t of tasks) {
-			/**
-			 * `beforeAll` in tinybench is called once before all iterations of a single operation.
-			 * This is functionally equivalent to `beforeEach` in jest and vitest.
-			 */
-			const options = hooks.beforeEach ? { beforeAll: hooks.beforeEach } : {};
+	for (const { hooks, tasks } of Object.values(suites)) {
+		/**
+		 * In tinybench, `beforeAll` and `afterAll` refer to all iterations of
+		 * a single task, while `beforeEach` and `afterEach` refer to each iteration.
+		 *
+		 * In jest and vitest, `beforeAll` and `afterAll` refer to all tests in a suite,
+		 * while `beforeEach` and `afterEach` refer to each individual test.
+		 *
+		 * The API renames tinybench's hooks to prevent confusion from this difference.
+		 */
+		const options: Record<string, Callback> = {};
+
+		if (hooks.beforeEach) options.beforeAll = hooks.beforeEach;
+		if (hooks.afterEach) options.afterAll = hooks.afterEach;
 
+		for (const t of tasks) {
 			bench.add(t.description, t.operation, options);
 		}
 	}
@@ -70,3 +78,14 @@ export function beforeEach(fn: Callback) {
 	suites[filePath] ||= { hooks: {}, tasks: [] };
 	suites[filePath].hooks.beforeEach = fn;
 }
+
+export function afterEach(fn: Callback) {
+	const filePath = suiteFilePath();
+
+	if (suites[filePath]?.hooks.afterEach) {
+		throw new DuplicateHookError('afterEach', filePath);
+	}
+
+	suites[filePath] ||= { hooks: {}, tasks: [] };
+	suites[filePath].hooks.afterEach = fn;
+}

packages/cli/src/benchmark/lib/types.ts

@@ -1,6 +1,9 @@
 export type Suites = {
 	[suiteFilepath: string]: {
-		hooks: Partial<{ beforeEach: Callback }>;
+		hooks: {
+			beforeEach?: Callback;
+			afterEach?: Callback;
+		};
 		tasks: Task[];
 	};
 };

packages/cli/src/benchmark/main.ts

@@ -7,7 +7,7 @@ import Bench from 'tinybench';
 import { withCodSpeed } from '@codspeed/tinybench-plugin';
 /* eslint-enable import/no-extraneous-dependencies */
 
-export { beforeEach, task } from './lib/suites';
+export { beforeEach, afterEach, task } from './lib/suites';
 
 async function main() {
 	await collectSuites();

packages/cli/src/benchmark/tasks/example.tasks.ts

@@ -1,9 +1,13 @@
-import { task, beforeEach } from '../main.js';
+import { task, beforeEach, afterEach } from '../main.js';
 
 beforeEach(async () => {
 	console.log('[[[beforeEach]]] for example.tasks.ts');
 });
 
+afterEach(async () => {
+	console.log('[[[afterEach]]] for example.tasks.ts');
+});
+
 task('[example] Should do something', async () => {
 	console.log('Example task 1 executed');
 });