@uniflowed/test 0.0.0-alpha.6 → 0.0.0-alpha.7

package/internal/frames.js

@@ -16,11 +16,24 @@
 /** A position in a source file, one-based line and column. */
 export type Site = {| readonly line: number, readonly column: number |};
 
-/** Frames belonging to the runner itself, which no test author wrote. */
+/**
+ * Frames belonging to the testing libraries, which no test author wrote.
+ *
+ * `@uniflowed/react-testing` is here for exactly the reason `@uniflowed/test`
+ * is, and was missing because it is a different package. Every `getBy…`
+ * failure is *constructed* inside it, so the first surviving frame of the
+ * commonest failure a component test can produce was `internal/queries.js` —
+ * and since a site is reported as a line of the file being run, the reader was
+ * sent to a line their own file does not have. That is ubugeeei-prod/uf#319.
+ * A library that raises on the caller's behalf is the runner as far as the
+ * report is concerned.
+ */
 const INTERNAL_MARKERS = [
   "/packages/test/internal/",
   "/packages/test/worker.js",
+  "/packages/react-testing/",
   "/@uniflowed/test/",
+  "/@uniflowed/react-testing/",
   "node:internal/",
 ];
 
@@ -93,6 +106,36 @@ export function firstUserSite(
   return null;
 }
 
+/**
+ * The first position in `stack` that is in `file`, or `null`.
+ *
+ * The reporter draws a failure's position as `path:line:column`, and it takes
+ * the path from the file it asked the worker to run rather than from the
+ * frame. So a number lifted from any other file is not a vaguer answer than
+ * none — it is a wrong one, naming a line the reader can open and that has
+ * nothing to do with what failed. Restricting the search to the file that will
+ * be named makes the two halves of that position come from the same place.
+ *
+ * `null` when the file is on no frame, which is a failure raised from work the
+ * case left behind: no line of it is the one that failed, and printing none is
+ * the honest answer.
+ */
+export function siteInFile(stack: string | null | void, file: string): Site | null {
+  if (stack == null) {
+    return null;
+  }
+  for (const frame of stack.split("\n").slice(1)) {
+    if (!frame.includes(file)) {
+      continue;
+    }
+    const site = frameSite(frame);
+    if (site != null) {
+      return site;
+    }
+  }
+  return null;
+}
+
 /**
  * `stack` with the runner's own frames removed.
  *

package/internal/run.js

@@ -12,7 +12,7 @@
 import * as output from "./output.js";
 import * as snapshot from "./snapshot.js";
 import { AssertionError } from "./expect.js";
-import { firstUserSite, userFrames } from "./frames.js";
+import { type Site, firstUserSite, siteInFile, userFrames } from "./frames.js";
 import { type Body, type Case, type Suite, collected } from "./registry.js";
 
 /** How one case ended. */
@@ -102,7 +102,22 @@ async function withTimeout(body: Body, timeoutMs: number): Promise<void> {
   }
 }
 
-function failure(thrown: mixed): Outcome {
+/**
+ * Where to say a failure happened.
+ *
+ * The reported position is printed under the path of the file being run, so
+ * when that file is known the line has to come from it: `firstUserSite` will
+ * hand back the first frame of whatever library raised, and a library's line
+ * number wearing the test file's path sends the reader to the wrong place
+ * (ubugeeei-prod/uf#319). The fallback is for a caller that did not say which
+ * file it is running — `run` is driven directly by this repository's own
+ * tests as well as by the worker — and is what every failure used before.
+ */
+function siteOf(stack: string | null, file: string | null): Site | null {
+  return file == null || file === "" ? firstUserSite(stack, false) : siteInFile(stack, file);
+}
+
+function failure(thrown: mixed, file: string | null): Outcome {
   if (thrown instanceof AssertionError) {
     const stack = userFrames(thrown.stack);
     return {
@@ -111,7 +126,7 @@ function failure(thrown: mixed): Outcome {
       stack,
       expected: thrown.expected,
       received: thrown.received,
-      site: firstUserSite(stack, false),
+      site: siteOf(stack, file),
     };
   }
   if (thrown instanceof Error) {
@@ -122,7 +137,7 @@ function failure(thrown: mixed): Outcome {
       stack,
       expected: null,
       received: null,
-      site: firstUserSite(stack, false),
+      site: siteOf(stack, file),
     };
   }
   return {
@@ -209,7 +224,7 @@ async function runCase(
       }
       await withTimeout(test.body, timeoutMs);
     } catch (thrown) {
-      outcome = failure(thrown);
+      outcome = failure(thrown, options.file ?? null);
     }
     // Teardown runs whatever happened above, and only reports its own failure
     // when the body had not already failed.
@@ -218,7 +233,7 @@ async function runCase(
         await withTimeout(hook, timeoutMs);
       } catch (thrown) {
         if (outcome.status === "passed") {
-          outcome = failure(thrown);
+          outcome = failure(thrown, options.file ?? null);
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniflowed/test",
-  "version": "0.0.0-alpha.6",
+  "version": "0.0.0-alpha.7",
   "description": "The test API and worker for `uf test`: describe/it, a full matcher set, and the process uf fans test files out to.",
   "type": "module",
   "license": "MIT",
@@ -21,6 +21,6 @@
     "internal"
   ],
   "dependencies": {
-    "@uniflowed/host": "0.0.0-alpha.6"
+    "@uniflowed/host": "0.0.0-alpha.7"
   }
 }