Set test.meta.debugMode = true when timeout has been disabled for debugging

[bitjson]

I'm using AVA to test a program that interacts with a Postgres database and has timing-related tests (code here).

I'm analyzing the stdout from a child process to verify it's producing the expected results. Results can sometimes come in unexpected orders, so I need close control over how long to wait for each, and timers run in parallel, so t.timeout() isn't really a good fit.

It's easy enough to manage the timers myself, but one inconvenience is that I need to manually disable them when debugging the tests. (AVA logs ⚠ The timeout option has been disabled to help with debugging. which is perfect, but my timers still interfere with debugging.)

Also, my tests can't inspect whether or not the inspector is active for some reason (probably something about them being in separate processes?) so I can't use the same code as AVA here:

ava/lib/cli.js

Lines 122 to 133 in 639b905

	// Enter debug mode if the main process is being inspected. This assumes the
	// worker processes are automatically inspected, too. It is not necessary to
	// run AVA with the debug command, though it's allowed.
	let activeInspector = false;
	try {
	const {default: inspector} = await import('node:inspector');
	activeInspector = inspector.url() !== undefined;
	} catch {}
	let debug = activeInspector
	? {

It would be very helpful if AVA somehow exposed this boolean to my tests so I can have them deliberately behave differently in debug mode. Maybe by adding it to test.meta? E.g.:

if(test.meta.debugMode) {
  // code to run if AVA is in debugging mode
}

[novemberborn]

I like it!

@bitjson are you game to implement this? Let me know if you need some pointers.

[bitjson]

@novemberborn I'd be happy to try! Though I'll need help with testing the feature.

I tried hacking something together initially, but I probably need a better understanding of the codebase. Could you point me to the location where test.meta is actually set?

[novemberborn]

Hi @bitjson, I think the meta object is defined here:

ava/lib/runner.js

Lines 71 to 77 in c749348

	const meta = Object.freeze({
	file: makeFileURL(options.file),
	get snapshotDirectory() {
	const {file, snapshotDir: fixedLocation, projectDir} = options;
	return makeFileURL(determineSnapshotDir({file, fixedLocation, projectDir}));
	},
	});

It's then made available through the CJS and ESM entrypoints and some indirection.

Runner is instantiated here:

ava/lib/worker/base.js

Line 78 in c749348

runner = new Runner({

The options there should have the debug flag, see further down:

ava/lib/worker/base.js

Line 186 in c749348

if (options.debug && options.debug.port !== undefined && options.debug.host !== undefined) {