refactor: remove one extra layer around test batches

Author: Ethaks

package.json

@@ -57,7 +57,7 @@
 		"@league-of-foundry-developers/foundry-vtt-types": "github:League-of-Foundry-Developers/foundry-vtt-types#e787013319b46f7465cce2c71263083abba70ce8"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "^1.8.3",
+		"@biomejs/biome": "^1.9.0",
 		"@commitlint/cli": "^19.3.0",
 		"@commitlint/config-conventional": "^19.2.2",
 		"@guanghechen/rollup-plugin-copy": "^6.0.0-alpha.9",

src/module/apps/quench-results.ts

@@ -1,7 +1,7 @@
 import * as Diff from "diff";
 
 import type { Quench, QuenchBatchKey } from "../quench";
-import type { RUNNABLE_STATE } from "../utils/quench-utils";
+import { type RUNNABLE_STATE, getBatchKey } from "../utils/quench-utils";
 
 import { MissingSnapshotError } from "../utils/quench-snapshot-error";
 import {
@@ -18,7 +18,9 @@ import {
 } from "../utils/quench-utils";
 import { pause } from "../utils/user-utils";
 
-const { HandlebarsApplicationMixin, ApplicationV2 } = foundry.applications.api;
+import ApplicationV2 = foundry.applications.api.ApplicationV2;
+import HandlebarsApplicationMixin = foundry.applications.api.HandlebarsApplicationMixin;
+// const { HandlebarsApplicationMixin, ApplicationV2 } = foundry.applications.api;
 
 /**
  * The visual UI for representing Quench test batches and the tests results thereof.
@@ -36,10 +38,7 @@ export class QuenchResults extends HandlebarsApplicationMixin(ApplicationV2) {
 	 * @param quench - The `Quench` instance this `Application` belongs to
 	 * @param options - Additional options
 	 */
-	constructor(
-		quench: Quench,
-		options: Partial<foundry.applications.api.ApplicationV2.Configuration> = {},
-	) {
+	constructor(quench: Quench, options: Partial<ApplicationV2.Configuration> = {}) {
 		super(options);
 		this.quench = quench;
 	}
@@ -539,7 +538,7 @@ export class QuenchResults extends HandlebarsApplicationMixin(ApplicationV2) {
 	 * @param suite - The starting Mocha suite
 	 */
 	handleSuiteBegin(suite: Mocha.Suite) {
-		const batchkey = suite._quench_parentBatch;
+		const batchkey = getBatchKey(suite);
 		const isBatchRoot = suite._quench_batchRoot || suite.root;
 
 		// If this suite is the root of a test batch or does not belong to a test batch, don't show in the UI.
@@ -582,7 +581,7 @@ export class QuenchResults extends HandlebarsApplicationMixin(ApplicationV2) {
 	 * @param test - The starting test
 	 */
 	handleTestBegin(test: Mocha.Test) {
-		const batchKey = test._quench_parentBatch;
+		const batchKey = getBatchKey(test);
 		const parentId = test.parent?.id;
 
 		const batchLi: HTMLLIElement | null = this.element.querySelector(
@@ -667,7 +666,7 @@ export class QuenchResults extends HandlebarsApplicationMixin(ApplicationV2) {
 	 * @param error - The error thrown by the hook
 	 */
 	handleBatchFail(hook: Mocha.Hook, error: Error) {
-		const batchKey = hook.parent?._quench_parentBatch;
+		const batchKey = getBatchKey(hook);
 		const isBatchRoot = hook.parent?._quench_batchRoot === true;
 
 		if (!batchKey || !isBatchRoot) return;

src/module/quench-reporter.ts

@@ -8,6 +8,7 @@ import {
 	RUNNABLE_STATE,
 	RUNNABLE_STATES,
 	createDirectory,
+	getBatchKey,
 	getGame,
 	getTestState,
 	logPrefix,
@@ -98,7 +99,7 @@ export class QuenchReporter extends Mocha.reporters.Base {
 
 				// Log detailed results in console
 				if (QuenchReporter._shouldLogTestDetails() && !suite.root) {
-					const batchKey = suite._quench_parentBatch;
+					const batchKey = getBatchKey(suite);
 					const isBatchRoot = suite._quench_batchRoot;
 					if (isBatchRoot) {
 						console.group(quench._testBatches.get(batchKey)?.displayName);

src/module/quench-snapshot.ts

@@ -3,6 +3,7 @@ import { MissingSnapshotError } from "./utils/quench-snapshot-error";
 import {
 	createDirectoryTree,
 	enforce,
+	getBatchKey,
 	getBatchNameParts,
 	localize,
 	logPrefix,
@@ -110,7 +111,7 @@ export class QuenchSnapshotManager {
 				const updateSnapshot = quench.snapshots.enableUpdates;
 				const currentRunnable = quench._currentRunner?.currentRunnable;
 				if (!currentRunnable) throw new Error("No Runner found");
-				const quenchBatch = currentRunnable._quench_parentBatch;
+				const quenchBatch = getBatchKey(currentRunnable);
 				const [, ...titleParts] = currentRunnable.titlePath();
 				// Slugify non-Quench batch test name (describe and it parts)
 				const fullTitle = titleParts.join("-").trim().slugify();

src/module/quench-tests/nonsense-tests.ts

@@ -14,6 +14,7 @@ export function registerExampleTests(quench: Quench) {
 		registerSnapshotTestBatch,
 		registerPropertyTestBatch,
 		registerPromiseTestBatch,
+		registerAsyncDynamicTestBatch,
 		registerNonQuenchTestBatch,
 	]) {
 		batchFunction(quench);
@@ -261,6 +262,43 @@ function registerPromiseTestBatch(quench: Quench) {
 	);
 }
 
+function registerAsyncDynamicTestBatch(quench: Quench) {
+	quench.registerBatch(
+		"quench.examples.dynamicasync",
+		async function (context) {
+			const { it, assert, expect, before } = context;
+
+			const addIt = (title: string, fn: Mocha.Func): void => {
+				const test = new (quench.mocha.constructor as typeof Mocha).Test(title, fn);
+				this.addTest(test);
+			};
+
+			before(async function () {
+				const tests: { args: number[]; expected: number }[] = await new Promise((resolve) => {
+					setTimeout(resolve, 1000, [
+						{ args: [1, 2], expected: 3 },
+						{ args: [1, 2, 3], expected: 6 },
+						{ args: [1, 2, 3, 4], expected: 10 },
+					]);
+				});
+
+				for (const { args, expected } of tests) {
+					addIt(`should equal ${expected}`, function () {
+						const sum = args.reduce((a, b) => a + b, 0);
+						expect(sum).to.equal(expected);
+					});
+				}
+			});
+
+			it("requires a single test to register as non-empty suite", function () {
+				assert.ok(true);
+			});
+		},
+
+		{ displayName: "QUENCH: Asynchronously Dynamically Generated Tests" },
+	);
+}
+
 // ============================ //
 // Additional Quench self tests //
 // ============================ //

src/module/quench.ts

@@ -11,11 +11,11 @@ import * as quenchUserUtils from "./utils/user-utils";
 declare global {
 	namespace Mocha {
 		interface Runnable {
-			_quench_parentBatch: string;
+			_quench_parentBatch?: string;
 		}
 		interface Suite {
-			_quench_parentBatch: string;
-			_quench_batchRoot: boolean;
+			_quench_parentBatch?: string;
+			_quench_batchRoot?: boolean;
 			get id(): string;
 		}
 		interface Test {
@@ -135,29 +135,6 @@ export class Quench {
 		});
 		return batches.map(({ key }) => key);
 	}
-	/**
-	 * A helper function adding a reference to a test's Quench Batch to a given Mocha function's result
-	 *
-	 * @internal
-	 * @param fn - The Mocha function to add the batch to
-	 * @param key - The key of the batch to add
-	 * @returns The Mocha function with the batch reference added
-	 */
-	protected static _quenchify<Fn extends Mocha.TestFunction | Mocha.SuiteFunction>(
-		fn: Fn,
-		key: string,
-	): Fn {
-		const quenchFn = function quenchFn(...args: Parameters<Fn>) {
-			// @ts-expect-error Args are passed through as-is
-			const result = fn(...args);
-			result._quench_parentBatch = key;
-			return result;
-		};
-		quenchFn.only = fn.only;
-		quenchFn.skip = fn.skip;
-		if ("retries" in fn) quenchFn.retries = fn.retries;
-		return quenchFn as Fn;
-	}
 
 	/**
 	 * Registers a new Quench test batch which will show up in the quench window to be enabled/disabled and run.
@@ -284,11 +261,13 @@ export class Quench {
 		// Run should to patch object prototype
 		const should = this.chai.should();
 
-		const baseContext: Omit<QuenchBatchContext, "describe" | "it"> = {
+		const baseContext: QuenchBatchContext = {
 			after,
 			afterEach,
 			before,
 			beforeEach,
+			describe,
+			it,
 			utils,
 			assert,
 			expect,
@@ -303,18 +282,15 @@ export class Quench {
 
 		// Register suites and tests for provided batches
 		for (const key of batchKeys) {
-			const context: QuenchBatchContext = {
-				...baseContext,
-				describe: (this.constructor as typeof Quench)._quenchify(describe, key), // typecasting necessary, see #3841
-				it: (this.constructor as typeof Quench)._quenchify(it, key), // see above; check again ~2030
-			};
-
+			const context = { ...baseContext };
 			// Create a wrapper suite to contain this test batch
-			const testBatchRoot = context.describe(`${key}_root`, async () => {
+			const quench = this;
+			const testBatchRoot = context.describe(`${key}_root`, async function () {
 				// Call the batch's registration function
-				await this._testBatches.get(key)?.fn(context);
+				await quench._testBatches.get(key)?.fn.apply(this, [context]);
 			});
 			testBatchRoot._quench_batchRoot = true;
+			testBatchRoot._quench_parentBatch = key;
 		}
 
 		// Run the tests and hold on to the runner
@@ -370,7 +346,10 @@ export interface QuenchRegisterBatchOptions {
  * @public
  * @param context - Various Mocha and Chai functions
  */
-export type QuenchRegisterBatchFunction = (context: QuenchBatchContext) => void | Promise<void>;
+export type QuenchRegisterBatchFunction = (
+	this: Mocha.Suite,
+	context: QuenchBatchContext,
+) => void | Promise<void>;
 
 /**
  * A context object passed to batch registration functions, containing functions usually

src/module/settings.ts

@@ -35,9 +35,7 @@ export function registerSettings(): void {
 		config: true,
 		type: Boolean,
 		default: false,
-		onChange: foundry.utils.debounce(() => {
-			location.reload();
-		}, 500),
+		requiresReload: true,
 	});
 
 	game.settings.register(MODULE_ID, "collapseSuccessful", {

src/module/utils/quench-utils.ts

@@ -65,6 +65,30 @@ export function getSuiteState(suite: Mocha.Suite): RUNNABLE_STATE {
 	return allSuitesSucceed ? RUNNABLE_STATES.SUCCESS : RUNNABLE_STATES.FAILURE;
 }
 
+/**
+ * Get the batch key for a test, suite, or hook.
+ *
+ * @param test - The test, suite, or hook to get the batch key for
+ * @returns The batch key, or "" if none was found.
+ */
+export function getBatchKey(runnable: Mocha.Runnable | Mocha.Test | Mocha.Suite | Mocha.Hook) {
+	// Given runnable already is the batch root providing the key
+	if (runnable._quench_parentBatch) return runnable._quench_parentBatch;
+
+	// Find key by traversing the parent chain
+	let key = "";
+	let parent: Mocha.Runnable | Mocha.Test | Mocha.Suite | Mocha.Hook | null = runnable;
+	let depth = 0;
+	do {
+		depth += 1;
+		if (parent.parent) parent = parent.parent;
+		else if (parent.ctx?.parent) parent = parent.ctx.parent;
+		else parent = null;
+		if (parent?._quench_parentBatch) key = parent._quench_parentBatch;
+	} while (depth < 30 && parent && !key);
+	return key as QuenchBatchKey;
+}
+
 /**
  * Returns a tuple containing the package name and the batch identifier
  *

src/styles/quench.css

@@ -145,6 +145,12 @@
   font-weight: bold;
 }
 
+#quench-results .summary .runnable-title {
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
 #quench-results .expandable>.summary {
   margin-left: 0.4rem;
 }