TODO: consider dom sandbox for testing ui (see long desc)

see https://discord.com/channels/1388415325036609617/1458088018232479824/1484195713347879012

cmd/pkgserver/ui/static/test.ts

@@ -34,17 +34,26 @@ function checkDuplicates(parent: string, names: { name: string }[]) {
 
 class FailNowSentinel {}
 
+export type Journal = ({ method: "fail" } | { method: "log", message: string })[];
+function formatJournal(journal: Journal): string {
+    return journal
+        .filter((e) => e.method === "log")
+        .map((e) => e.message)
+        .join("\n");
+}
+
 export class TestController {
-    #logs: string[];
+    journal: Journal;
     #failed: boolean;
 
     constructor() {
-        this.#logs = [];
+        this.journal = [];
         this.#failed = false;
     }
 
     fail() {
         this.#failed = true;
+        this.journal.push({ method: "fail" });
     }
 
     failed(): boolean {
@@ -57,7 +66,7 @@ export class TestController {
     }
 
     log(message: string) {
-        this.#logs.push(message);
+        this.journal.push({ method: "log", message });
     }
 
     error(message: string) {
@@ -69,10 +78,6 @@ export class TestController {
         this.log(message);
         this.failNow();
     }
-
-    getLog(): string[] {
-        return this.#logs;
-    }
 }
 
 // =============================================================================
@@ -80,7 +85,7 @@ export class TestController {
 
 export interface TestResult {
     success: boolean;
-    logs: string[];
+    journal: Journal;
 }
 
 export function run(reporter: Reporter) {
@@ -98,14 +103,16 @@ function runTests(reporter: Reporter, parents: string[], node: TestTree) {
         return;
     }
     let controller = new TestController();
+    let excStr: string;
     try {
         node.test(controller);
     } catch (e) {
         if (!(e instanceof FailNowSentinel)) {
-            controller.error(extractExceptionString(e));
+            excStr = extractExceptionString(e);
         }
     }
-    reporter.update(path, { success: !controller.failed(), logs: controller.getLog() });
+    if (excStr !== undefined) controller.error(excStr);
+    reporter.update(path, { success: !controller.failed(), journal: controller.journal });
 }
 
 function extractExceptionString(e: any): string {
@@ -192,13 +199,11 @@ export class StreamReporter implements Reporter {
 
     #writeOutput(test: { name: string } & TestResult, prefix: string, nested: boolean) {
         let output = "";
-        if (test.logs.length) {
+        let logOutput = formatJournal(test.journal);
-            // Individual logs might span multiple lines, so join them together
+        if (logOutput) {
-            // then split it again.
+            const lines = logOutput.split("\n");
-            const logStr = test.logs.join("\n");
-            const lines = logStr.split("\n");
             if (lines.length <= 1) {
-                output = `: ${logStr}`;
+                output = `: ${logOutput}`;
             } else {
                 const padding = nested ? "      " : "  ";
                 output = ":\n" + lines.map((line) => padding + line).join("\n");
@@ -242,9 +247,10 @@ export class DOMReporter implements Reporter {
         }
         const p = document.createElement("p");
         p.classList.add("test-desc");
-        if (result.logs.length) {
+        const logOutput = formatJournal(result.journal);
+        if (logOutput) {
             const pre = document.createElement("pre");
-            pre.appendChild(document.createTextNode(result.logs.join("\n")));
+            pre.appendChild(document.createTextNode(logOutput));
             p.appendChild(pre);
         } else {
             p.classList.add("italic");
@@ -265,9 +271,10 @@ interface GoNode {
 export class GoTestReporter implements Reporter {
     // Convert a test tree into the one expected by the Go code.
     static serialize(node: TestTree): GoNode {
+        if (!("children" in node)) return { name: node.name, subtests: null };
         return {
             name: node.name,
-            subtests: "children" in node ? node.children.map(GoTestReporter.serialize) : null,
+            subtests: node.children.map(GoTestReporter.serialize),
         };
     }
 
@@ -276,7 +283,7 @@ export class GoTestReporter implements Reporter {
     }
 
     update(path: string[], result: TestResult) {
-        console.log(JSON.stringify({ path: path, ...result }));
+        console.log(JSON.stringify({ "path": path, ...result }));
     }
 
     finalize() {