@piwitests/reporter 0.59.0 → 0.60.0

package/dist/internal/capture/pick-on-failure.d.ts

@@ -57,15 +57,18 @@ declare function parseLeafLocatorExpression(rawExpr: string): {
 declare function deriveFailedLocator(testInfo: TestInfo): FailedLocatorInfo | null;
 /** What the element → anchors → confirm flow yields: the confirmed locator, its alternatives and the element. */
 type PickedLocator = Omit<UserPickResult, 'failing'>;
+/** `run`, or undefined as soon as `ended` aborts; `run` itself is left to settle on its own. */
+declare function unlessEnded<T>(run: Promise<T>, ended: AbortSignal | undefined): Promise<T | undefined>;
 /**
  * Run the element → anchors → confirm flow on a live page: element pick (snap
  * + tree-walk), optional stable-parent anchoring with live match counts, ranked
  * candidates (standard generation merged with anchor-scoped chains), and a
  * final confirmation. `failing` is the locator the pick replaces, rendered, for
  * the overlay's headings; null to pick any element. Returns null when the
- * human skips or no locator could be generated; throws when the page breaks.
+ * human skips, no locator could be generated or `ended` aborts, the overlay
+ * then taken out of the page; throws when the page breaks.
  */
-declare function pickLocator(page: Page, probe: PickerProbe, failing: string | null): Promise<PickedLocator | null>;
+declare function pickLocator(page: Page, probe: PickerProbe, failing: string | null, ended?: AbortSignal): Promise<PickedLocator | null>;
 /**
  * Drive the full pick flow on the failing page (`pickLocator`), the test
  * timeout lifted while waiting. Returns null when skipped or when anything
@@ -88,4 +91,4 @@ declare function runLocatorPicker(page: Page, testInfo: TestInfo, failed: Failed
  */
 declare function applyPickToSnapshots(snapshots: LocatorSnapshot[], pick: UserPickResult): boolean;
 
-export { type PickedLocator, type PickerProbe, type UserPickResult, applyPickToSnapshots, deriveFailedLocator, parseLeafLocatorExpression, pickLocator, runLocatorPicker };
+export { type PickedLocator, type PickerProbe, type UserPickResult, applyPickToSnapshots, deriveFailedLocator, parseLeafLocatorExpression, pickLocator, runLocatorPicker, unlessEnded };

package/dist/internal/capture/pick-on-failure.js

@@ -39,7 +39,8 @@ __export(pick_on_failure_exports, {
   pickLocator: () => pickLocator,
   runLocatorPicker: () => runLocatorPicker,
   showAnchorPicker: () => showAnchorPicker,
-  showPickerChoices: () => showPickerChoices
+  showPickerChoices: () => showPickerChoices,
+  unlessEnded: () => unlessEnded
 });
 module.exports = __toCommonJS(pick_on_failure_exports);
 var path2 = __toESM(require("path"));
@@ -1616,32 +1617,55 @@ ${err.stack ?? ""}`));
   }
   return null;
 }
-async function cleanupPicker(page) {
+var PICK_ENDED = "__piwiPickEnded";
+async function cleanupPicker(page, ended = false) {
   try {
-    await page.evaluate(() => {
-      const g = globalThis;
-      if (typeof g.__piwiPickCleanup === "function") g.__piwiPickCleanup();
-      if (typeof g.__piwiAnchorCleanup === "function") g.__piwiAnchorCleanup();
-      delete g.__piwiPickCleanup;
-      delete g.__piwiAnchorCleanup;
-      delete g.__piwiPickState;
-      delete g.__piwiPickChoice;
-      delete g.__piwiPickedElement;
-      delete g.__piwiAnchorState;
-      delete g.__piwiPickAnchors;
-      delete g.__piwiPickChainCount;
-    });
+    await page.evaluate(
+      ([endedKey, unanswered]) => {
+        const g = globalThis;
+        if (typeof g.__piwiPickCleanup === "function") g.__piwiPickCleanup();
+        if (typeof g.__piwiAnchorCleanup === "function") g.__piwiAnchorCleanup();
+        delete g.__piwiPickCleanup;
+        delete g.__piwiAnchorCleanup;
+        delete g.__piwiPickState;
+        delete g.__piwiPickChoice;
+        delete g.__piwiPickedElement;
+        delete g.__piwiAnchorState;
+        delete g.__piwiPickAnchors;
+        delete g.__piwiPickChainCount;
+        if (unanswered) g[endedKey] = true;
+        else delete g[endedKey];
+      },
+      [PICK_ENDED, ended]
+    );
   } catch {
   }
 }
-async function pickLocator(page, probe, failing) {
+function unlessEnded(run, ended) {
+  if (!ended) return run;
+  return Promise.race([
+    run,
+    new Promise((resolve) => {
+      if (ended.aborted) resolve(void 0);
+      else ended.addEventListener("abort", () => resolve(void 0), { once: true });
+    })
+  ]);
+}
+async function pickLocator(page, probe, failing, ended) {
+  const answered = async (name) => {
+    const wait = page.waitForFunction(
+      ([key, endedKey]) => globalThis[key] !== void 0 || globalThis[endedKey] === true,
+      [name, PICK_ENDED],
+      { timeout: 0, polling: 250 }
+    );
+    await unlessEnded(wait, ended);
+    return !ended?.aborted;
+  };
   try {
     const overlayArg = { transport: "global", failing };
+    await page.evaluate((endedKey) => delete globalThis[endedKey], PICK_ENDED);
     await page.evaluate(installPickerOverlay, overlayArg);
-    await page.waitForFunction(() => globalThis.__piwiPickState !== void 0, void 0, {
-      timeout: 0,
-      polling: 250
-    });
+    if (!await answered("__piwiPickState")) return null;
     const state = await page.evaluate(() => globalThis.__piwiPickState);
     if (state !== "picked") return null;
     const handle = await page.evaluateHandle(() => globalThis.__piwiPickedElement);
@@ -1662,10 +1686,7 @@ async function pickLocator(page, probe, failing) {
         leafLevel: level,
         leafTestId: attrs.attributes["data-testid"] ?? null
       });
-      await page.waitForFunction(() => globalThis.__piwiAnchorState !== void 0, void 0, {
-        timeout: 0,
-        polling: 250
-      });
+      if (!await answered("__piwiAnchorState")) return null;
       const anchorResult = await page.evaluate(() => {
         const g = globalThis;
         return { state: g.__piwiAnchorState, anchors: g.__piwiPickAnchors ?? [], chainCount: g.__piwiPickChainCount };
@@ -1687,10 +1708,7 @@ async function pickLocator(page, probe, failing) {
       failing,
       choices: ranked.map((r) => ({ locator: r.locator, score: r.score }))
     });
-    await page.waitForFunction(() => globalThis.__piwiPickChoice !== void 0, void 0, {
-      timeout: 0,
-      polling: 250
-    });
+    if (!await answered("__piwiPickChoice")) return null;
     const choice = await page.evaluate(() => globalThis.__piwiPickChoice);
     if (typeof choice !== "number" || choice < 0 || choice >= ranked.length) return null;
     const picked = { ...ranked[choice], pickedByUser: true };
@@ -1709,7 +1727,7 @@ async function pickLocator(page, probe, failing) {
       ...anchors.length > 0 ? { anchors } : {}
     };
   } finally {
-    await cleanupPicker(page);
+    await cleanupPicker(page, ended?.aborted);
   }
 }
 async function runLocatorPicker(page, testInfo, failed, probe) {
@@ -1773,5 +1791,6 @@ function applyPickToSnapshots(snapshots, pick) {
   pickLocator,
   runLocatorPicker,
   showAnchorPicker,
-  showPickerChoices
+  showPickerChoices,
+  unlessEnded
 });

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.59.0",
+  "version": "0.60.0",
   "description": "Playwright reporter that streams results, traces and HTML reports to a Piwi Dashboard instance",
-  "url": "https://github.com/PiwiTests/platform",
+  "url": "https://github.com/PiwiTests/piwi",
   "homepage": "https://piwitests.dev",
   "repository": {
     "type": "git",
-    "url": "https://github.com/PiwiTests/platform"
+    "url": "https://github.com/PiwiTests/piwi"
   },
   "bugs": {
-    "url": "https://github.com/PiwiTests/platform/issues"
+    "url": "https://github.com/PiwiTests/piwi/issues"
   },
   "type": "commonjs",
   "main": "dist/index.js",
@@ -66,7 +66,7 @@
     "node": ">=20"
   },
   "peerDependencies": {
-    "@playwright/test": "^1.61.1"
+    "@playwright/test": "^1.64.1"
   },
   "dependencies": {
     "form-data": "^4.0.0"

package/templates/skills/run-the-right-tests/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: run-the-right-tests
-description: Pick and run the right subset of Playwright tests using Piwi's data-driven selections, instead of always running the whole suite. Use when the user asks to "run smoke tests", "run the right tests", "just run what's relevant", "verify this fix", or wants a fast, targeted test loop rather than the full run.
+description: Pick and run the right subset of Playwright tests using Piwi's data-driven selections and the tests a change impacts, instead of always running the whole suite. Use when the user asks to "run smoke tests", "run the right tests", "just run what's relevant", "run the tests my change affects", "verify this fix", or wants a fast, targeted test loop rather than the full run.
 ---
 
 # Run the right tests with Piwi selections
@@ -9,8 +9,8 @@ Running the whole suite for every change is slow, and hand-maintained grep patte
 
 ## How you reach Piwi
 
-Prefer the **Piwi MCP server** if it is connected (`list_selections`, `resolve_selection`, `preview_selection`,
-`predict_locator_breaks`). Otherwise use the reporter CLI (`npx @piwitests/reporter select|run|preflight`) with `PIWI_DASHBOARD_URL` / `PIWI_API_KEY` / `PIWI_PROJECT_NAME` set, or the dashboard's **Selections** tab.
+Prefer the **Piwi MCP server** if it is connected (`get_impacted_tests`, `list_selections`, `resolve_selection`,
+`preview_selection`, `predict_locator_breaks`). Otherwise use the reporter CLI (`npx @piwitests/reporter select|run|preflight`) with `PIWI_DASHBOARD_URL` / `PIWI_API_KEY` / `PIWI_PROJECT_NAME` set, or the dashboard's **Selections** tab.
 
 ## Steps
 
@@ -25,22 +25,33 @@ Prefer the **Piwi MCP server** if it is connected (`list_selections`, `resolve_s
    your `git diff` and returns the same breaks and edits. A prediction is not a failure: say which breaks you fixed and
    which you left, and why.
 
-1. **See what selections exist.** Call `list_selections` for the project. Every project has the built-ins `failed` (tests whose latest run failed) and `quarantine-free`, plus any the team saved (often `smoke`). Pick the one that matches the intent:
+1. **After any code change, run the tests it impacts.** Over MCP, call `get_impacted_tests` with your diff
+   (`git diff --full-index <base>`, the base being the commit your change starts from, such as `origin/main`). Each
+   changed file lists the tests it selects and how: `lines` (the test ran a changed line), `functions` (it ran the
+   function around one), `file` (its coverage cannot rule it out), `test-file`, `frames` or `route`. Run the
+   `command` it returns, or, from the CLI, `npx @piwitests/reporter run impact --base origin/main`. Read the answer
+   before trusting it:
+   - `widened` means a changed file maps to no test, so the command runs the whole suite. Say which files did that.
+   - A file's `notRun` lines are changed code no test runs: no test can catch a mistake there. Name them, and offer
+     to write the test (the `write-the-missing-test` skill).
+   - The tests marked `lines` or `test-file` are the first to check for edits a change in behavior needs.
+
+2. **See what selections exist.** Call `list_selections` for the project. Every project has the built-ins `failed` (tests whose latest run failed) and `quarantine-free`, plus any the team saved (often `smoke`). Pick the one that matches the intent:
    - About to make a broad change, or want a quick confidence check → `smoke` (or `preview_selection` with `{ "include": [{ "tags": ["smoke"] }] }`).
    - Iterating on a fix → `failed`, or a `{ "include": [{ "failedInLastRuns": 5 }] }` preview.
    - Time-boxed → resolve any selection with a `budgetMs` (e.g. 300000 for five minutes).
 
-2. **Resolve it to a command.** Call `resolve_selection` with the key (and optional `budgetMs`). You get back the matching tests, an estimate, and a ready-to-run `playwright test` command. Check the count and warnings first — a selection that matches **zero** tests is a red flag (too narrow, or nothing qualifies), and a `quarantined-included` warning means a flaky test is in the set.
+3. **Resolve it to a command.** Call `resolve_selection` with the key (and optional `budgetMs`). You get back the matching tests, an estimate, and a ready-to-run `playwright test` command. Check the count and warnings first — a selection that matches **zero** tests is a red flag (too narrow, or nothing qualifies), and a `quarantined-included` warning means a flaky test is in the set.
 
-3. **Run it.** The most reliable way is the reporter CLI, which resolves and runs in one step and stamps the run so the dashboard names the subset:
+4. **Run it.** The most reliable way is the reporter CLI, which resolves and runs in one step and stamps the run so the dashboard names the subset:
    ```
    npx @piwitests/reporter run <key>
    ```
    Or run the materialized command `resolve_selection` returned directly with `playwright test`. Pass extra Playwright args after `--` (e.g. `-- --workers=4`).
 
-4. **After a fix, verify with the same selection.** Re-run the selection that covered the failure and confirm it now passes. In CI, `npx @piwitests/reporter gate --require-selection <key>` fails the build if any test the selection currently matches did not run or did not pass — catching a smoke job that silently shrank.
+5. **After a fix, verify with the same selection.** Re-run the selection that covered the failure and confirm it now passes. In CI, `npx @piwitests/reporter gate --require-selection <key>` fails the build if any test the selection currently matches did not run or did not pass — catching a smoke job that silently shrank.
 
-5. **Report.** State which selection you ran, how many tests it resolved to, and the outcome. If no saved selection fit, suggest one (a `preview_selection` definition the team could save) rather than falling back to the whole suite silently.
+6. **Report.** State which selection you ran, how many tests it resolved to, and the outcome. If no saved selection fit, suggest one (a `preview_selection` definition the team could save) rather than falling back to the whole suite silently.
 
 ## Guardrails
 

package/templates/skills/setup-piwi/SKILL.md

@@ -13,6 +13,9 @@ Find out two things (ask the user only if you cannot infer them):
 
 - **Dashboard URL** — e.g. `http://localhost:3000` for a local server, or a deployed URL. Defaults to `http://localhost:3000`.
 - **Project name** — the label runs are grouped under. Defaults to the package or folder name.
+- **Where local runs go** — when developers run the Piwi desktop app and CI reports to a shared server, add
+  `--desktop-app prefer`: a local run lands in the app while it is running, and CI runs go to `--server-url`. When the
+  desktop app is the only dashboard, pass `--no-server-url` instead of a URL: the reporter finds the running app itself.
 
 Confirm this is a Playwright project: there should be a `playwright.config.ts|js` and `@playwright/test` in `package.json`. If there is no Playwright at all, set that up first.
 
@@ -47,7 +50,7 @@ change it to import from the fixtures file instead, e.g. `import { test, expect
 
 ## Authentication
 
-If the dashboard has auth enabled, runs need an API key. Have the user create one in the dashboard (**Settings → Account → API keys**; keys start with `pd_`), then put it in `.env` as `PIWI_API_KEY=pd_...` and make sure `.env` is git-ignored. Never hardcode a key into `playwright.config.ts` or commit it. In CI, pass it as a secret (`PIWI_API_KEY`).
+If the dashboard has auth enabled, runs need an API key. Have the user create one in the dashboard (**Settings → Account → API keys**; keys start with `pd_`), then put it in `.env` as `PIWI_API_KEY=pd_...` and make sure `.env` is git-ignored. The reporter reads `PIWI_DASHBOARD_URL`, `PIWI_API_KEY` and `PIWI_PROJECT_NAME` from the `.env` next to `playwright.config`, so the config needs no dotenv loading; a variable set in the environment wins over the file. Never hardcode a key into `playwright.config.ts` or commit it. In CI, where `.env` is not checked out, pass it as a secret (`PIWI_API_KEY`).
 
 ## Verify it worked