Add and use withRecordingLoggerAsync

Author: mbg

src/start-proxy.test.ts

@@ -15,6 +15,7 @@ import {
   getRecordingLogger,
   makeTestToken,
   setupTests,
+  withRecordingLoggerAsync,
 } from "./testing-utils";
 
 setupTests(test);
@@ -390,29 +391,29 @@ const wrapFailureTest = test.macro({
     setup: () => void,
     fn: (logger: Logger) => Promise<void>,
   ) => {
-    const loggedMessages = [];
-    const logger = getRecordingLogger(loggedMessages);
-    setup();
+    await withRecordingLoggerAsync(async (logger) => {
+      setup();
 
-    await t.throwsAsync(fn(logger), {
-      instanceOf: startProxyExports.StartProxyError,
+      await t.throwsAsync(fn(logger), {
+        instanceOf: startProxyExports.StartProxyError,
+      });
     });
   },
   title: (providedTitle) => `${providedTitle} - wraps errors on failure`,
 });
 
 test("downloadProxy - returns file path on success", async (t) => {
-  const loggedMessages = [];
-  const logger = getRecordingLogger(loggedMessages);
-  const testPath = "/some/path";
-  sinon.stub(toolcache, "downloadTool").resolves(testPath);
-
-  const result = await startProxyExports.downloadProxy(
-    logger,
-    "url",
-    undefined,
-  );
-  t.is(result, testPath);
+  await withRecordingLoggerAsync(async (logger) => {
+    const testPath = "/some/path";
+    sinon.stub(toolcache, "downloadTool").resolves(testPath);
+
+    const result = await startProxyExports.downloadProxy(
+      logger,
+      "url",
+      undefined,
+    );
+    t.is(result, testPath);
+  });
 });
 
 test(

src/testing-utils.ts

@@ -208,6 +208,23 @@ export function checkExpectedLogMessages(
   }
 }
 
+/**
+ * Initialises a recording logger and calls `body` with it.
+ *
+ * @param body The test that requires a recording logger.
+ * @returns The logged messages.
+ */
+export async function withRecordingLoggerAsync(
+  body: (logger: Logger) => Promise<void>,
+): Promise<LoggedMessage[]> {
+  const messages = [];
+  const logger = getRecordingLogger(messages);
+
+  await body(logger);
+
+  return messages;
+}
+
 /** Mock the HTTP request to the feature flags enablement API endpoint. */
 export function mockFeatureFlagApiEndpoint(
   responseStatusCode: number,