@piwitests/reporter 0.18.2 → 0.19.0

package/dist/internal/capture/capture-fixtures.js

@@ -481,6 +481,34 @@ var ACTION_METHODS = [
   "waitFor"
 ];
 var LOCATOR_CREATING_CHAINS = new Set(LOCATOR_METHODS);
+var EXPECT_METHOD = "_expect";
+var EXPECT_CAPTURE_EXPRESSIONS = /* @__PURE__ */ new Set([
+  "to.be.attached",
+  "to.be.checked",
+  "to.be.disabled",
+  "to.be.editable",
+  "to.be.empty",
+  "to.be.enabled",
+  "to.be.focused",
+  "to.be.in.viewport",
+  "to.be.readonly",
+  "to.be.visible",
+  "to.contain.class",
+  "to.contain.text",
+  "to.have.accessible.description",
+  "to.have.accessible.error.message",
+  "to.have.accessible.name",
+  "to.have.attribute",
+  "to.have.attribute.value",
+  "to.have.class",
+  "to.have.css",
+  "to.have.id",
+  "to.have.js.property",
+  "to.have.role",
+  "to.have.text",
+  "to.have.value",
+  "to.match.aria"
+]);
 function extractAccessibleName(ariaSnapshot) {
   if (!ariaSnapshot) return null;
   const match = ariaSnapshot.match(/- \w+ "([^"]+)"/);
@@ -567,6 +595,7 @@ function suggestLocatorsFromAria(failed, ariaSnapshot) {
 function captureCallerLocation(stack = new Error().stack ?? "") {
   const lines = stack.split("\n");
   let prevWasCaptureModule = false;
+  let selfFile = null;
   for (let i = 1; i < lines.length; i++) {
     const line = lines[i].trim();
     if (!line.startsWith("at")) continue;
@@ -585,6 +614,11 @@ function captureCallerLocation(stack = new Error().stack ?? "") {
       prevWasCaptureModule = false;
       continue;
     }
+    if (selfFile === null || file === selfFile) {
+      selfFile ??= file;
+      prevWasCaptureModule = /[\\/]locator-healing\.[a-z]+$/i.test(file);
+      continue;
+    }
     if (/[\\/]locator-healing\.[a-z]+$/i.test(file)) {
       prevWasCaptureModule = true;
       continue;
@@ -1519,6 +1553,7 @@ function createSink() {
     capturedLocators: [],
     capturePromises: [],
     failedLocators: [],
+    expectCapturedLocations: /* @__PURE__ */ new Set(),
     lastActivePage: null,
     testInfo: null,
     stashedWebVitals: null,
@@ -1922,6 +1957,53 @@ function probeElementAttrs(el, arg) {
     ancestors
   };
 }
+function startElementCapture(sink, target, seq, callerLocation, used) {
+  const probe = target.evaluate(probeElementAttrs, CAPTURED_ATTRS_ARG);
+  const settledProbe = probe.then(
+    () => void 0,
+    () => void 0
+  );
+  PENDING_PROBES.add(settledProbe);
+  settledProbe.then(() => PENDING_PROBES.delete(settledProbe));
+  sink.capturePromises.push(settledProbe);
+  const resolveAttrs = (async () => {
+    let deadline;
+    try {
+      const attrs = await Promise.race([
+        probe,
+        new Promise((_, reject) => {
+          deadline = setTimeout(() => reject(new Error("locator capture timeout")), 500);
+        })
+      ]);
+      const role = resolveAriaRole({ ...attrs, accessibleName: null });
+      const isFormField = FORM_FIELD_TAGS.has(attrs.tagName);
+      const aria = role || isFormField ? await ariaSnapshotBestEffort(target, 500) : null;
+      const accessibleName = extractAccessibleName(aria) || approximateAccessibleName({ ...attrs, accessibleName: null });
+      sink.capturedLocators[seq] = {
+        location: callerLocation,
+        used,
+        // hasLabel/selectorCounts inform alternative generation only —
+        // keep the stored element to the wire shape. rolePosition and
+        // ancestors ARE wire fields: the server's renamed-element match
+        // uses them at heal time.
+        element: {
+          tagName: attrs.tagName,
+          attributes: attrs.attributes,
+          textContent: attrs.textContent,
+          accessibleName,
+          center: attrs.center,
+          ...attrs.rolePosition ? { rolePosition: attrs.rolePosition } : {},
+          ...attrs.ancestors && attrs.ancestors.length > 0 ? { ancestors: attrs.ancestors } : {}
+        },
+        alternatives: generateAlternatives({ ...attrs, accessibleName })
+      };
+    } catch {
+    } finally {
+      clearTimeout(deadline);
+    }
+  })();
+  sink.capturePromises.push(resolveAttrs);
+}
 function wrapLocator(page, locator, originMethod, originArgs) {
   return new Proxy(locator, {
     get(target, prop) {
@@ -1937,6 +2019,38 @@ function wrapLocator(page, locator, originMethod, originArgs) {
           return wrapLocator(page, next, originMethod, originArgs);
         };
       }
+      if (prop === EXPECT_METHOD) {
+        return async (...callArgs) => {
+          const sink = currentSink;
+          const expression = typeof callArgs[0] === "string" ? callArgs[0] : "";
+          const isNot = Boolean(callArgs[1]?.isNot);
+          if (!sink || isNot || !EXPECT_CAPTURE_EXPRESSIONS.has(expression)) {
+            return fn.apply(target, callArgs);
+          }
+          sink.lastActivePage = page;
+          const callerLocation = captureCallerLocation();
+          const used = {
+            method: originMethod,
+            args: originArgs,
+            raw: `${originMethod}(${JSON.stringify(originArgs)})`
+          };
+          const alreadyCaptured = callerLocation !== null && sink.expectCapturedLocations.has(callerLocation);
+          let seq = -1;
+          if (!alreadyCaptured) {
+            seq = sink.capturedLocators.length;
+            sink.capturedLocators.push({ location: callerLocation, used, element: null, alternatives: [] });
+          }
+          const result = await fn.apply(target, callArgs);
+          const matches = result?.matches;
+          if (matches === true && !alreadyCaptured) {
+            if (callerLocation) sink.expectCapturedLocations.add(callerLocation);
+            startElementCapture(sink, target, seq, callerLocation, used);
+          } else if (matches === false) {
+            sink.failedLocators.push({ method: originMethod, args: originArgs, location: callerLocation });
+          }
+          return result;
+        };
+      }
       if (!ACTION_METHOD_SET.has(prop)) return original;
       return async (...callArgs) => {
         const sink = currentSink;
@@ -1962,51 +2076,7 @@ function wrapLocator(page, locator, originMethod, originArgs) {
           sink.failedLocators.push({ method: originMethod, args: originArgs, location: callerLocation });
           throw error;
         }
-        const probe = target.evaluate(probeElementAttrs, CAPTURED_ATTRS_ARG);
-        const settledProbe = probe.then(
-          () => void 0,
-          () => void 0
-        );
-        PENDING_PROBES.add(settledProbe);
-        settledProbe.then(() => PENDING_PROBES.delete(settledProbe));
-        sink.capturePromises.push(settledProbe);
-        const resolveAttrs = (async () => {
-          let deadline;
-          try {
-            const attrs = await Promise.race([
-              probe,
-              new Promise((_, reject) => {
-                deadline = setTimeout(() => reject(new Error("locator capture timeout")), 500);
-              })
-            ]);
-            const role = resolveAriaRole({ ...attrs, accessibleName: null });
-            const isFormField = FORM_FIELD_TAGS.has(attrs.tagName);
-            const aria = role || isFormField ? await ariaSnapshotBestEffort(target, 500) : null;
-            const accessibleName = extractAccessibleName(aria) || approximateAccessibleName({ ...attrs, accessibleName: null });
-            sink.capturedLocators[seq] = {
-              location: callerLocation,
-              used,
-              // hasLabel/selectorCounts inform alternative generation only —
-              // keep the stored element to the wire shape. rolePosition and
-              // ancestors ARE wire fields: the server's renamed-element match
-              // uses them at heal time.
-              element: {
-                tagName: attrs.tagName,
-                attributes: attrs.attributes,
-                textContent: attrs.textContent,
-                accessibleName,
-                center: attrs.center,
-                ...attrs.rolePosition ? { rolePosition: attrs.rolePosition } : {},
-                ...attrs.ancestors && attrs.ancestors.length > 0 ? { ancestors: attrs.ancestors } : {}
-              },
-              alternatives: generateAlternatives({ ...attrs, accessibleName })
-            };
-          } catch {
-          } finally {
-            clearTimeout(deadline);
-          }
-        })();
-        sink.capturePromises.push(resolveAttrs);
+        startElementCapture(sink, target, seq, callerLocation, used);
         return result;
       };
     }

package/dist/internal/capture/locator-healing.d.ts

@@ -43,6 +43,34 @@ declare const CHAIN_METHODS: string[];
 declare const ACTION_METHODS: string[];
 /** Chain methods that create a new locator scope (origin tracks the chain call). */
 declare const LOCATOR_CREATING_CHAINS: ReadonlySet<string>;
+/**
+ * The private `Locator` method every web-first assertion funnels through:
+ * `expect(locator).toBeVisible()` and friends all resolve to
+ * `locator._expect(expression, { isNot, timeout, … })` on the locator instance
+ * the test passed to `expect()` — which, under the capture fixtures, is the
+ * wrapped proxy. Intercepting it is what lets assertion-only locators build
+ * healing history. The funnel is unchanged across Playwright 1.40 → current;
+ * if a future version renames it the interception silently never fires and
+ * assertions behave exactly as without the proxy.
+ */
+declare const EXPECT_METHOD = "_expect";
+/**
+ * Web-first assertion expressions whose PASS proves the target element
+ * resolved — the assertion-side equivalent of a successful action, and the
+ * capture hook for locators only ever used in `expect()`.
+ *
+ * Deliberately excluded:
+ *  - absence assertions (`to.be.hidden`, `to.be.detached`): passing means the
+ *    element may not exist at all — nothing to probe;
+ *  - multi-element assertions (`to.have.count`, the `*.array` text/class
+ *    forms, `to.have.values`): the single-element probe would only hit a
+ *    strict-mode violation;
+ *  - page-level assertions (`to.have.title`, `to.have.url`): they run on an
+ *    internal `:root` locator that carries no healing value.
+ * Negated calls (`.not.…`, `isNot: true`) are skipped at the call site — a
+ * passing negative assertion proves nothing about the element resolving.
+ */
+declare const EXPECT_CAPTURE_EXPRESSIONS: ReadonlySet<string>;
 /**
  * Extract the accessible name from a YAML-like ariaSnapshot() output.
  *
@@ -98,4 +126,4 @@ declare function suggestLocatorsFromAria(failed: FailedLocatorInfo, ariaSnapshot
  */
 declare function captureCallerLocation(stack?: string): string | null;
 
-export { ACTION_METHODS, CHAIN_METHODS, type FailedLocatorInfo, LOCATOR_CREATING_CHAINS, LOCATOR_METHODS, type LocatorSuggestion, captureCallerLocation, dedupeSnapshotsByLocation, extractAccessibleName, renderFailing, suggestLocatorsFromAria };
+export { ACTION_METHODS, CHAIN_METHODS, EXPECT_CAPTURE_EXPRESSIONS, EXPECT_METHOD, type FailedLocatorInfo, LOCATOR_CREATING_CHAINS, LOCATOR_METHODS, type LocatorSuggestion, captureCallerLocation, dedupeSnapshotsByLocation, extractAccessibleName, renderFailing, suggestLocatorsFromAria };

package/dist/internal/capture/locator-healing.js

@@ -33,6 +33,8 @@ __export(locator_healing_exports, {
   ACTION_METHODS: () => ACTION_METHODS,
   CAPTURED_ATTRIBUTES: () => CAPTURED_ATTRIBUTES,
   CHAIN_METHODS: () => CHAIN_METHODS,
+  EXPECT_CAPTURE_EXPRESSIONS: () => EXPECT_CAPTURE_EXPRESSIONS,
+  EXPECT_METHOD: () => EXPECT_METHOD,
   INPUT_TYPE_TO_ROLE: () => INPUT_TYPE_TO_ROLE,
   LOCATOR_CREATING_CHAINS: () => LOCATOR_CREATING_CHAINS,
   LOCATOR_METHODS: () => LOCATOR_METHODS,
@@ -489,6 +491,34 @@ var ACTION_METHODS = [
   "waitFor"
 ];
 var LOCATOR_CREATING_CHAINS = new Set(LOCATOR_METHODS);
+var EXPECT_METHOD = "_expect";
+var EXPECT_CAPTURE_EXPRESSIONS = /* @__PURE__ */ new Set([
+  "to.be.attached",
+  "to.be.checked",
+  "to.be.disabled",
+  "to.be.editable",
+  "to.be.empty",
+  "to.be.enabled",
+  "to.be.focused",
+  "to.be.in.viewport",
+  "to.be.readonly",
+  "to.be.visible",
+  "to.contain.class",
+  "to.contain.text",
+  "to.have.accessible.description",
+  "to.have.accessible.error.message",
+  "to.have.accessible.name",
+  "to.have.attribute",
+  "to.have.attribute.value",
+  "to.have.class",
+  "to.have.css",
+  "to.have.id",
+  "to.have.js.property",
+  "to.have.role",
+  "to.have.text",
+  "to.have.value",
+  "to.match.aria"
+]);
 function extractAccessibleName(ariaSnapshot) {
   if (!ariaSnapshot) return null;
   const match = ariaSnapshot.match(/- \w+ "([^"]+)"/);
@@ -575,6 +605,7 @@ function suggestLocatorsFromAria(failed, ariaSnapshot) {
 function captureCallerLocation(stack = new Error().stack ?? "") {
   const lines = stack.split("\n");
   let prevWasCaptureModule = false;
+  let selfFile = null;
   for (let i = 1; i < lines.length; i++) {
     const line = lines[i].trim();
     if (!line.startsWith("at")) continue;
@@ -593,6 +624,11 @@ function captureCallerLocation(stack = new Error().stack ?? "") {
       prevWasCaptureModule = false;
       continue;
     }
+    if (selfFile === null || file === selfFile) {
+      selfFile ??= file;
+      prevWasCaptureModule = /[\\/]locator-healing\.[a-z]+$/i.test(file);
+      continue;
+    }
     if (/[\\/]locator-healing\.[a-z]+$/i.test(file)) {
       prevWasCaptureModule = true;
       continue;
@@ -621,6 +657,8 @@ function captureCallerLocation(stack = new Error().stack ?? "") {
   ACTION_METHODS,
   CAPTURED_ATTRIBUTES,
   CHAIN_METHODS,
+  EXPECT_CAPTURE_EXPRESSIONS,
+  EXPECT_METHOD,
   INPUT_TYPE_TO_ROLE,
   LOCATOR_CREATING_CHAINS,
   LOCATOR_METHODS,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.18.2",
-  "description": "Playwright reporter for sending test results to Piwi Dashboard",
+  "version": "0.19.0",
+  "description": "Playwright reporter that streams results, traces and HTML reports to a Piwi Dashboard instance",
   "url": "https://github.com/PiwiTests/platform",
   "homepage": "https://piwitests.github.io",
   "repository": {
@@ -14,6 +14,9 @@
   "type": "commonjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "piwi": "dist/cli/index.js"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -23,9 +26,11 @@
     "./package.json": "./package.json"
   },
   "keywords": [
+    "ci",
+    "dashboard",
     "playwright",
+    "quality-gate",
     "reporter",
-    "dashboard",
     "test-results"
   ],
   "author": "piwitests",