Move to suites.ts

Author: ivov

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

@@ -0,0 +1,68 @@
+import 'reflect-metadata';
+import path from 'node:path';
+import type Bench from 'tinybench';
+import { assert } from 'n8n-workflow';
+import glob from 'fast-glob';
+import callsites from 'callsites';
+import type { Task } from '../types';
+
+export const suites: {
+	[suiteFilepath: string]: {
+		hooks: Partial<{ beforeEach: () => Promise<void> }>;
+		tasks: Task[];
+	};
+} = {};
+
+export function suiteCount() {
+	return Object.keys(suites).length;
+}
+
+function suiteFilePath() {
+	const filePath = callsites()
+		.map((site) => site.getFileName())
+		.filter((site): site is string => site !== null)
+		.find((site) => site.endsWith('.tasks.js'));
+
+	assert(filePath !== undefined);
+
+	return filePath;
+}
+
+export async function collectSuites() {
+	const files = await glob('**/*.tasks.js', {
+		cwd: path.join('dist', 'benchmark'),
+		absolute: true,
+	});
+
+	for (const file of files) {
+		await import(file);
+	}
+}
+
+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 } : {};
+
+			bench.add(t.description, t.operation, options);
+		}
+	}
+}
+
+/**
+ * Benchmarking API
+ */
+
+export function task(description: string, operation: Task['operation']) {
+	suites[suiteFilePath()] ||= { hooks: {}, tasks: [] };
+	suites[suiteFilePath()].tasks.push({ description, operation });
+}
+
+export function beforeEach(fn: () => Promise<void>) {
+	suites[suiteFilePath()] ||= { hooks: {}, tasks: [] };
+	suites[suiteFilePath()].hooks.beforeEach = fn;
+}

packages/cli/src/benchmark/main.ts

@@ -1,61 +1,20 @@
 import 'reflect-metadata';
-import path from 'node:path';
-import { assert } from 'n8n-workflow';
-import glob from 'fast-glob';
-import callsites from 'callsites';
-import type { Task } from './types';
 import { globalHooks } from './hooks';
 
 /* eslint-disable import/no-extraneous-dependencies */
 import { withCodSpeed } from '@codspeed/tinybench-plugin';
 import Bench from 'tinybench';
+import { collectSuites, registerSuites, suiteCount } from './lib/suites';
 /* eslint-enable import/no-extraneous-dependencies */
 
-const map: {
-	[suiteFilepath: string]: {
-		hooks: Partial<{ beforeEach: () => Promise<void> }>;
-		tasks: Task[];
-	};
-} = {};
-
-function suiteFilePath() {
-	const filePath = callsites()
-		.map((site) => site.getFileName())
-		.filter((site): site is string => site !== null)
-		.find((site) => site.endsWith('.tasks.js'));
-
-	assert(filePath !== undefined);
-
-	return filePath;
-}
-
-export function task(description: string, operation: Task['operation']) {
-	map[suiteFilePath()] ||= { hooks: {}, tasks: [] };
-	map[suiteFilePath()].tasks.push({ description, operation });
-}
-
-export function beforeEach(fn: () => Promise<void>) {
-	map[suiteFilePath()] ||= { hooks: {}, tasks: [] };
-	map[suiteFilePath()].hooks.beforeEach = fn;
-}
-
-async function loadTasks() {
-	const files = await glob('**/*.tasks.js', {
-		cwd: path.join('dist', 'benchmark'),
-		absolute: true,
-	});
-
-	for (const file of files) {
-		await import(file);
-	}
-}
+export { beforeEach, task } from './lib/suites';
 
 async function main() {
-	await loadTasks();
+	await collectSuites();
 
-	const suitesCount = Object.keys(map).length;
+	const count = suiteCount();
 
-	if (suitesCount === 0) {
+	if (count === 0) {
 		console.log('No benchmarking suites found');
 		return;
 	}
@@ -69,21 +28,9 @@ async function main() {
 
 	const bench = process.env.CI === 'true' ? withCodSpeed(_bench) : _bench;
 
-	for (const filePath of Object.keys(map)) {
-		const { tasks, hooks } = map[filePath];
-
-		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 } : {};
-
-			bench.add(t.description, t.operation, options);
-		}
-	}
+	registerSuites(bench);
 
-	console.log(`Running ${suitesCount} benchmarking suites...`);
+	console.log(`Running ${count} benchmarking suites...`);
 
 	await bench.run();
 

packages/cli/src/benchmark/types.ts

@@ -3,3 +3,5 @@ export type Task = {
 	description: string;
 	operation: () => Promise<void>;
 };
+
+export type Callback = () => void | Promise<void>;