@smoothdeploy/playwright 1.58.1 → 1.58.4

package/lib/index.js

@@ -76,6 +76,7 @@ const playwrightFixtures = {
   }, { scope: "worker", option: true, box: true }],
   screenshot: ["off", { scope: "worker", option: true, box: true }],
   resultScreenshots: [false, { scope: "worker", option: true, box: true }],
+  pauseOnFailure: [false, { scope: "worker", option: true, box: true }],
   video: ["off", { scope: "worker", option: true, box: true }],
   trace: ["off", { scope: "worker", option: true, box: true }],
   _browserOptions: [async ({ playwright, headless, channel, launchOptions }, use) => {
@@ -229,9 +230,9 @@ const playwrightFixtures = {
     playwright._defaultContextTimeout = void 0;
     playwright._defaultContextNavigationTimeout = void 0;
   }, { auto: "all-hooks-included", title: "context configuration", box: true }],
-  _setupArtifacts: [async ({ playwright, screenshot, resultScreenshots, _combinedContextOptions }, use, testInfo) => {
+  _setupArtifacts: [async ({ playwright, headless, screenshot, resultScreenshots, pauseOnFailure, _combinedContextOptions }, use, testInfo) => {
     testInfo.setTimeout(testInfo.project.timeout);
-    const artifactsRecorder = new ArtifactsRecorder(playwright, tracing().artifactsDir(), screenshot);
+    const artifactsRecorder = new ArtifactsRecorder(playwright, tracing().artifactsDir(), screenshot, resultScreenshots, pauseOnFailure && !headless);
     await artifactsRecorder.willStartTest(testInfo);
     const tracingGroupSteps = [];
     const csiListener = {
@@ -609,9 +610,11 @@ class SnapshotRecorder {
   }
 }
 class ArtifactsRecorder {
-  constructor(playwright, artifactsDir, screenshot) {
+  constructor(playwright, artifactsDir, screenshot, resultScreenshots, pauseOnFailure) {
     this._playwright = playwright;
     this._artifactsDir = artifactsDir;
+    this._resultScreenshots = resultScreenshots;
+    this._pauseOnFailure = pauseOnFailure;
     const screenshotOptions = typeof screenshot === "string" ? void 0 : screenshot;
     this._startedCollectingArtifacts = Symbol("startedCollectingArtifacts");
     this._screenshotRecorder = new SnapshotRecorder(this, normalizeScreenshotMode(screenshot), "screenshot", "image/png", ".png", async (page, path2) => {
@@ -661,6 +664,51 @@ class ArtifactsRecorder {
   }
   async didFinishTestFunction() {
     await this._screenshotRecorder.maybeCapture();
+    if (this._resultScreenshots && this._testInfo._isFailure()) {
+      try {
+        const page = this._playwright._allPages()[0];
+        if (page) {
+          const pngBuffer = await page._wrapApiCall(async () => {
+            return await page.screenshot({ type: "png", timeout: 5e3 });
+          }, { internal: true });
+          const safeTestId = this._testInfo.testId.replace(/[^a-zA-Z0-9_-]/g, "-");
+          const screenshotDir = import_path.default.join(process.cwd(), ".smoothdeploy-output", "screenshots", safeTestId);
+          import_fs.default.mkdirSync(screenshotDir, { recursive: true });
+          import_fs.default.writeFileSync(import_path.default.join(screenshotDir, "failure.png"), pngBuffer);
+        }
+      } catch {
+      }
+    }
+    if (this._pauseOnFailure && this._testInfo._isFailure()) {
+      this._emitPauseOnFailure();
+      const page = this._playwright._allPages()[0];
+      if (page)
+        await page.pause();
+    }
+  }
+  _emitPauseOnFailure() {
+    const findFailingPath = (steps) => {
+      for (let i = steps.length - 1; i >= 0; i--) {
+        const step = steps[i];
+        const childPath = findFailingPath(step.steps);
+        if (childPath.length > 0)
+          return [step.title, ...childPath];
+        if (step.error)
+          return [step.title];
+      }
+      return [];
+    };
+    const stepPath = findFailingPath(this._testInfo._steps);
+    const error = this._testInfo.errors[0];
+    process.stdout.write(`[SMOOTHDEPLOY_EVENT]${JSON.stringify({
+      event: "pauseOnFailure",
+      testId: this._testInfo.testId,
+      testTitle: this._testInfo.titlePath.slice(1).join(" > "),
+      stepPath,
+      error: error ? { message: error.message ?? String(error) } : null,
+      timestamp: Date.now()
+    })}
+`);
   }
   async didFinishTest() {
     await this.didFinishTestFunction();
@@ -760,7 +808,7 @@ async function captureResultScreenshot(channel, data, testInfo) {
     const { full, cropped } = (0, import_screenshotCompositor.compositeHighlight)(pngBuffer, box, cssViewport);
     const safeTestId = testInfo.testId.replace(/[^a-zA-Z0-9_-]/g, "-");
     const safeStepId = (data.stepId ?? "unknown").replace(/[^a-zA-Z0-9_-]/g, "-");
-    const screenshotDir = import_path.default.join(process.cwd(), "_internal_output", "screenshots", safeTestId);
+    const screenshotDir = import_path.default.join(process.cwd(), ".smoothdeploy-output", "screenshots", safeTestId);
     import_fs.default.mkdirSync(screenshotDir, { recursive: true });
     const fullPng = new import_utilsBundle.PNG({ width: full.width, height: full.height });
     fullPng.data = full.data;

package/lib/reporters/smoothdeploy.js

@@ -37,8 +37,8 @@ class SmoothDeployReporter {
   constructor() {
     this._configDir = "";
     this._manifest = null;
-    // Resolved manifest test for each active pw test
-    this._manifestTests = /* @__PURE__ */ new Map();
+    // Resolved manifest test + paramIndex for each active pw test
+    this._resolvedTests = /* @__PURE__ */ new Map();
     // Map pw TestStep → matched manifest step
     this._stepToManifest = /* @__PURE__ */ new WeakMap();
     // Child counter per parent (TestStep for nested, test.id string for root-level)
@@ -64,9 +64,9 @@ class SmoothDeployReporter {
     this._loadManifest();
   }
   _loadManifest() {
-    const manifestPath = path.join(this._configDir, "smoothdeploy-manifest.json");
+    const manifestPath = path.join(this._configDir, ".smoothdeploy-manifest.json");
     if (!fs.existsSync(manifestPath))
-      throw new Error(`SmoothDeploy reporter requires smoothdeploy-manifest.json in ${this._configDir}`);
+      throw new Error(`SmoothDeploy reporter requires .smoothdeploy-manifest.json in ${this._configDir}`);
     const raw = fs.readFileSync(manifestPath, "utf-8");
     this._manifest = JSON.parse(raw);
   }
@@ -95,8 +95,9 @@ class SmoothDeployReporter {
       return false;
     return true;
   }
-  // Resolve a pw TestCase to its manifest test entry using titlePath.
-  // titlePath = ["", projectName, "file.spec.ts", ...describes..., "test title"]
+  // Resolve a pw TestCase to its manifest test entry + param index.
+  // For parameterized tests: manifest title "Foo" with params=3 matches pw titles "Foo0", "Foo1", "Foo2".
+  // For non-parameterized tests: exact match, paramIndex=0.
   _resolveManifestTest(test) {
     if (!this._manifest)
       return null;
@@ -117,30 +118,47 @@ class SmoothDeployReporter {
       currentSuites = suite.suites;
       currentTests = suite.tests;
     }
-    return currentTests.find((t) => t.title === testTitle) ?? null;
+    const exactMatch = currentTests.find((t) => t.title === testTitle);
+    if (exactMatch)
+      return { manifestTest: exactMatch, paramIndex: 0 };
+    for (const mt of currentTests) {
+      if (!mt.params || mt.params < 1)
+        continue;
+      if (!testTitle.startsWith(mt.title))
+        continue;
+      const suffix = testTitle.slice(mt.title.length);
+      const idx = parseInt(suffix, 10);
+      if (String(idx) === suffix && idx >= 0 && idx < mt.params)
+        return { manifestTest: mt, paramIndex: idx };
+    }
+    return null;
   }
   onTestBegin(test, result) {
-    const manifestTest = this._resolveManifestTest(test);
-    if (manifestTest) {
-      this._manifestTests.set(test.id, manifestTest);
-      const safePw = test.id.replace(/[^a-zA-Z0-9_-]/g, "-");
-      const safeManifest = manifestTest.id.replace(/[^a-zA-Z0-9_-]/g, "-");
-      this._testIdMap.set(safePw, safeManifest);
-    }
+    const resolved = this._resolveManifestTest(test);
+    if (!resolved)
+      return;
+    this._resolvedTests.set(test.id, resolved);
+    const safePw = test.id.replace(/[^a-zA-Z0-9_-]/g, "-");
+    const safeManifest = resolved.manifestTest.id.replace(/[^a-zA-Z0-9_-]/g, "-");
+    this._testIdMap.set(safePw, safeManifest);
     this._childCounters.set(test.id, 0);
     this._testSteps.set(test.id, []);
     this._emit({
       event: "testBegin",
-      testId: manifestTest.id,
+      testId: resolved.manifestTest.id,
+      paramIndex: resolved.paramIndex,
       testTitle: test.title,
       timestamp: Date.now()
     });
   }
   onTestEnd(test, result) {
-    const manifestTest = this._manifestTests.get(test.id);
+    const resolved = this._resolvedTests.get(test.id);
+    if (!resolved)
+      return;
     this._emit({
       event: "testEnd",
-      testId: manifestTest.id,
+      testId: resolved.manifestTest.id,
+      paramIndex: resolved.paramIndex,
       testTitle: test.title,
       status: result.status,
       duration: result.duration,
@@ -151,13 +169,15 @@ class SmoothDeployReporter {
   onStepBegin(test, result, step) {
     if (!this._isUserStep(step))
       return;
-    const manifestTest = this._manifestTests.get(test.id);
+    const resolved = this._resolvedTests.get(test.id);
+    if (!resolved)
+      return;
     let parentStep = step.parent;
     while (parentStep && !this._stepToOutput.has(parentStep))
       parentStep = parentStep.parent;
     const parentKey = parentStep ?? test.id;
     const parentManifest = parentStep ? this._stepToManifest.get(parentStep) : void 0;
-    const parentSteps = parentManifest ? parentManifest.children : manifestTest?.steps;
+    const parentSteps = parentManifest ? parentManifest.children : resolved.manifestTest.steps;
     const idx = this._childCounters.get(parentKey) ?? 0;
     this._childCounters.set(parentKey, idx + 1);
     const manifestStep = parentSteps?.[idx] ?? null;
@@ -182,7 +202,8 @@ class SmoothDeployReporter {
       this._testSteps.get(test.id)?.push(outputStep);
     this._emit({
       event: "stepBegin",
-      testId: manifestTest.id,
+      testId: resolved.manifestTest.id,
+      paramIndex: resolved.paramIndex,
       id: manifestStep?.id,
       action: manifestStep?.action,
       title: step.title,
@@ -193,6 +214,9 @@ class SmoothDeployReporter {
   onStepEnd(test, result, step) {
     if (!this._isUserStep(step))
       return;
+    const resolved = this._resolvedTests.get(test.id);
+    if (!resolved)
+      return;
     const manifestStep = this._stepToManifest.get(step) ?? null;
     const outputStep = this._stepToOutput.get(step);
     const safeTestId = test.id.replace(/[^a-zA-Z0-9_-]/g, "-");
@@ -210,8 +234,8 @@ class SmoothDeployReporter {
     const internalStepId = step._stepId ?? step.title;
     const safeStepId = internalStepId.replace(/[^a-zA-Z0-9_-]/g, "-");
     const screenshots = hasScreenshot ? {
-      page: `_internal_output/screenshots/${safeTestId}/${safeStepId}-page.png`,
-      element: `_internal_output/screenshots/${safeTestId}/${safeStepId}-element.png`
+      page: `.smoothdeploy-output/screenshots/${safeTestId}/${safeStepId}-page.png`,
+      element: `.smoothdeploy-output/screenshots/${safeTestId}/${safeStepId}-element.png`
     } : null;
     if (manifestStep) {
       const safeManifestStepId = manifestStep.id.replace(/[^a-zA-Z0-9_-]/g, "-");
@@ -219,13 +243,15 @@ class SmoothDeployReporter {
     }
     if (outputStep) {
       outputStep.duration = step.duration;
-      outputStep.error = step.error ? { message: step.error.message } : null;
+      const hasDescendantError = (steps) => steps.some((c) => c.error !== null || hasDescendantError(c.children));
+      outputStep.error = step.error && !hasDescendantError(outputStep.children) ? { message: step.error.message } : null;
       outputStep.screenshots = screenshots;
     }
     this._childCounters.delete(step);
     this._emit({
       event: "stepEnd",
-      testId: this._manifestTests.get(test.id).id,
+      testId: resolved.manifestTest.id,
+      paramIndex: resolved.paramIndex,
       id: manifestStep?.id,
       action: manifestStep?.action,
       title: step.title,
@@ -235,7 +261,7 @@ class SmoothDeployReporter {
     });
   }
   onEnd(result) {
-    const outputDir = path.join(process.cwd(), "_internal_output");
+    const outputDir = path.join(process.cwd(), ".smoothdeploy-output");
     const screenshotsDir = path.join(outputDir, "screenshots");
     if (this._manifest) {
       for (const [safePwTestId] of this._testIdMap) {
@@ -254,8 +280,11 @@ class SmoothDeployReporter {
       for (const [safePwTestId, safeManifestTestId] of this._testIdMap) {
         const src = path.join(screenshotsDir, safePwTestId);
         const dst = path.join(screenshotsDir, safeManifestTestId);
-        if (fs.existsSync(src))
+        if (fs.existsSync(src)) {
+          if (fs.existsSync(dst))
+            fs.rmSync(dst, { recursive: true });
           fs.renameSync(src, dst);
+        }
       }
     }
     const remapScreenshotPaths = (steps) => {
@@ -269,9 +298,17 @@ class SmoothDeployReporter {
     };
     const manifest = {};
     for (const [testId, steps] of this._testSteps) {
-      const manifestTest = this._manifestTests.get(testId);
+      const resolved = this._resolvedTests.get(testId);
+      if (!resolved)
+        continue;
       remapScreenshotPaths(steps);
-      manifest[manifestTest.id] = { steps };
+      const safeManifestTestId = resolved.manifestTest.id.replace(/[^a-zA-Z0-9_-]/g, "-");
+      const failurePath = path.join(screenshotsDir, safeManifestTestId, "failure.png");
+      const failureScreenshot = fs.existsSync(failurePath) ? `.smoothdeploy-output/screenshots/${safeManifestTestId}/failure.png` : null;
+      const key = resolved.manifestTest.id;
+      if (!manifest[key])
+        manifest[key] = [];
+      manifest[key].push({ paramIndex: resolved.paramIndex, steps, failureScreenshot });
     }
     fs.mkdirSync(outputDir, { recursive: true });
     fs.writeFileSync(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smoothdeploy/playwright",
-  "version": "1.58.1",
+  "version": "1.58.4",
   "description": "A high-level API to automate web browsers",
   "repository": {
     "type": "git",
@@ -64,7 +64,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "playwright-core": "npm:@smoothdeploy/playwright-core@1.58.1"
+    "playwright-core": "npm:@smoothdeploy/playwright-core@1.58.4"
   },
   "optionalDependencies": {
     "fsevents": "2.3.2"

package/types/test.d.ts

@@ -6895,6 +6895,7 @@ export interface PlaywrightWorkerOptions {
    *
    */
   resultScreenshots: boolean;
+  pauseOnFailure: boolean;
   /**
    * Whether to record trace for each test. Defaults to `'off'`.
    * - `'off'`: Do not record trace.