test: log last request body/query/response on test or hook failure (#40345)

Author: KevLehman

apps/meteor/.mocharc.api.js

@@ -10,5 +10,6 @@ module.exports = /** @satisfies {import('mocha').MochaOptions} */ ({
 	bail: false,
 	retries: 0,
 	file: 'tests/end-to-end/teardown.ts',
+	reporter: 'tests/end-to-end/reporter.ts',
 	spec: ['tests/end-to-end/api/*.ts', 'tests/end-to-end/api/helpers/**/*', 'tests/end-to-end/api/methods/**/*', 'tests/end-to-end/apps/*'],
 });

apps/meteor/tests/end-to-end/reporter.ts

@@ -0,0 +1,23 @@
+import Mocha from 'mocha';
+
+import { getLastRequest } from './teardown';
+
+const { EVENT_TEST_FAIL } = Mocha.Runner.constants;
+
+module.exports = class FailDumpReporter extends Mocha.reporters.Spec {
+	constructor(runner: Mocha.Runner, options: Mocha.MochaOptions) {
+		super(runner, options);
+		runner.on(EVENT_TEST_FAIL, (runnable) => {
+			const { lastUrl, lastMethod, lastBody, lastQuery, lastResponse } = getLastRequest();
+			console.log({
+				where: runnable.fullTitle(),
+				type: runnable.type,
+				lastUrl,
+				lastMethod,
+				lastBody,
+				lastQuery,
+				lastResponse: lastResponse?.text,
+			});
+		});
+	}
+};

apps/meteor/tests/end-to-end/teardown.ts

@@ -1,4 +1,3 @@
-import { afterEach } from 'mocha';
 import type { Response } from 'supertest';
 
 import { request } from '../data/api-data';
@@ -7,25 +6,35 @@ const methods = ['get', 'post', 'put', 'del', 'delete'] as const;
 
 let lastUrl: string;
 let lastMethod: string;
-let lastResponse: Response;
+let lastBody: unknown;
+let lastQuery: unknown;
+let lastResponse: Response | undefined;
 
 methods.forEach((method) => {
 	const original = request[method];
 	request[method] = function (url) {
 		lastUrl = url;
 		lastMethod = method;
-		return original(url).expect((res) => {
+		lastBody = undefined;
+		lastQuery = undefined;
+		lastResponse = undefined;
+
+		const test = original(url);
+		const originalSend = test.send.bind(test);
+		const originalQuery = test.query.bind(test);
+		test.send = (data) => {
+			lastBody = data;
+			return originalSend(data);
+		};
+		test.query = (data) => {
+			lastQuery = data;
+			return originalQuery(data);
+		};
+
+		return test.expect((res) => {
 			lastResponse = res;
 		});
 	};
 });
 
-afterEach(async function () {
-	if (this.currentTest?.state === 'failed') {
-		console.log({
-			lastUrl,
-			lastMethod,
-			lastResponse: lastResponse.text,
-		});
-	}
-});
+export const getLastRequest = () => ({ lastUrl, lastMethod, lastBody, lastQuery, lastResponse });