@samsara-dev/appwright 0.9.8 → 0.9.9

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # appwright
 
+## 0.9.9
+
+### Patch Changes
+
+- bfa24e5: Fix corrupt video trim when BrowserStack video download is incomplete
+  - Recreate write stream on each download retry to avoid appending corrupt data from previous failed attempts
+  - Add MP4 moov atom validation before attempting ffmpeg trim to fail fast with a clear error
+
 ## 0.9.8
 
 ### Patch Changes

package/dist/providers/browserstack/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/browserstack/index.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,eAAe,EACf,cAAc,EAGf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AA0DtC,qBAAa,0BAA2B,YAAW,cAAc;IAC/D,OAAO,CAAC,cAAc,CAAC,CAA6B;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,OAAO,CAA+B;gBAG5C,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,EACrC,WAAW,EAAE,MAAM,GAAG,SAAS;IAU3B,WAAW;IA0EX,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAMlC,OAAO,CAAC,cAAc;YASR,YAAY;YAkCZ,iBAAiB;YAKjB,yBAAyB;WAK1B,aAAa,CACxB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAsGlD,eAAe,CAAC,OAAO,EAAE;QAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IA2BD,OAAO,CAAC,YAAY;CA4KrB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/browserstack/index.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,eAAe,EACf,cAAc,EAGf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AA0DtC,qBAAa,0BAA2B,YAAW,cAAc;IAC/D,OAAO,CAAC,cAAc,CAAC,CAA6B;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,OAAO,CAA+B;gBAG5C,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,EACrC,WAAW,EAAE,MAAM,GAAG,SAAS;IAU3B,WAAW;IA0EX,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAMlC,OAAO,CAAC,cAAc;YASR,YAAY;YAkCZ,iBAAiB;YAKjB,yBAAyB;WAK1B,aAAa,CACxB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAmGlD,eAAe,CAAC,OAAO,EAAE;QAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IA2BD,OAAO,CAAC,YAAY;CA4KrB"}

package/dist/providers/browserstack/index.js

@@ -171,7 +171,6 @@ class BrowserStackDeviceProvider {
          * of 10 retries, whichever comes first.
          */
         await new Promise((resolve) => setTimeout(resolve, 10_000));
-        const fileStream = fs_1.default.createWriteStream(tempPathForWriting);
         //To catch the browserstack error in case all retries fails
         try {
             if (videoURL) {
@@ -188,16 +187,32 @@ class BrowserStackDeviceProvider {
                     if (!reader) {
                         throw new Error("Failed to get reader from response body.");
                     }
-                    const streamToFile = async () => {
+                    // Create a fresh write stream on each attempt to avoid
+                    // appending corrupt data from previous failed retries
+                    const fileStream = fs_1.default.createWriteStream(tempPathForWriting);
+                    // Register finish/error listeners before any writes so errors
+                    // during the loop are captured and finish always resolves.
+                    const streamDone = new Promise((resolve, reject) => {
+                        fileStream.on("finish", resolve);
+                        fileStream.on("error", reject);
+                    });
+                    try {
                         while (true) {
                             const { done, value } = await reader.read();
                             if (done)
                                 break;
-                            fileStream.write(value);
+                            if (!fileStream.write(value)) {
+                                // Back-pressure: wait for drain before continuing
+                                await new Promise((r) => fileStream.once("drain", r));
+                            }
                         }
-                    };
-                    await streamToFile();
-                    fileStream.close();
+                        fileStream.end();
+                        await streamDone;
+                    }
+                    catch (err) {
+                        fileStream.destroy();
+                        throw err;
+                    }
                 }, {
                     retries: 10,
                     minTimeout: 3_000,
@@ -207,26 +222,9 @@ class BrowserStackDeviceProvider {
                         logger_1.logger.warn(`[${new Date().toISOString()}] Video download retry ${i}/10 failed: ${message}`);
                     },
                 });
-                return new Promise((resolve, reject) => {
-                    // Ensure file stream is closed even in case of an error
-                    fileStream.on("finish", () => {
-                        try {
-                            fs_1.default.renameSync(tempPathForWriting, pathToTestVideo);
-                            logger_1.logger.log(`[${new Date().toISOString()}] Video download completed: ${pathToTestVideo}`);
-                            resolve({ path: pathToTestVideo, contentType: "video/mp4" });
-                        }
-                        catch (err) {
-                            const message = err instanceof Error ? err.message : String(err);
-                            logger_1.logger.error(`Failed to rename file: ${message}`, err);
-                            reject(err instanceof Error ? err : new Error(message));
-                        }
-                    });
-                    fileStream.on("error", (err) => {
-                        const message = err instanceof Error ? err.message : String(err);
-                        logger_1.logger.error(`Failed to write file: ${message}`, err);
-                        reject(err instanceof Error ? err : new Error(message));
-                    });
-                });
+                fs_1.default.renameSync(tempPathForWriting, pathToTestVideo);
+                logger_1.logger.log(`[${new Date().toISOString()}] Video download completed: ${pathToTestVideo}`);
+                return { path: pathToTestVideo, contentType: "video/mp4" };
             }
             else {
                 return null;

package/dist/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAUhF,cAAM,eAAgB,YAAW,QAAQ;IACvC,OAAO,CAAC,gBAAgB,CAAsB;IAE9C,OAAO;IAQP,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAU9C,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAsGtC,KAAK;YAKG,kCAAkC;IA6ChD,OAAO,CAAC,4BAA4B;IAyBpC,OAAO,CAAC,qBAAqB;CAU9B;AA8ED,eAAe,eAAe,CAAC"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAUhF,cAAM,eAAgB,YAAW,QAAQ;IACvC,OAAO,CAAC,gBAAgB,CAAsB;IAE9C,OAAO;IAQP,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAU9C,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAsGtC,KAAK;YAKG,kCAAkC;IA6ChD,OAAO,CAAC,4BAA4B;IAyBpC,OAAO,CAAC,qBAAqB;CAU9B;AAwHD,eAAe,eAAe,CAAC"}

package/dist/reporter.js

@@ -189,8 +189,43 @@ function waitFor(condition, timeout = 60 * 60 * 1000) {
         }, 500);
     });
 }
+/**
+ * Validate that an MP4 file has a valid moov atom (metadata header).
+ * BrowserStack videos can be incomplete if downloaded before finalization,
+ * resulting in a missing moov atom that causes ffmpeg to fail.
+ */
+function validateMp4(filePath) {
+    try {
+        const fd = fs_1.default.openSync(filePath, "r");
+        const stat = fs_1.default.fstatSync(fd);
+        const moovMarker = Buffer.from("moov");
+        const chunkSize = Math.min(stat.size, 128 * 1024);
+        // Check the beginning (fast-start MP4s place moov before mdat)
+        const head = Buffer.alloc(chunkSize);
+        fs_1.default.readSync(fd, head, 0, chunkSize, 0);
+        if (head.includes(moovMarker)) {
+            fs_1.default.closeSync(fd);
+            return true;
+        }
+        // Check the end (standard MP4s place moov after mdat)
+        if (stat.size > chunkSize) {
+            const tail = Buffer.alloc(chunkSize);
+            fs_1.default.readSync(fd, tail, 0, chunkSize, stat.size - chunkSize);
+            fs_1.default.closeSync(fd);
+            return tail.includes(moovMarker);
+        }
+        fs_1.default.closeSync(fd);
+        return false;
+    }
+    catch {
+        return false;
+    }
+}
 function trimVideo({ originalVideoPath, startSecs, durationSecs, outputPath, }) {
     logger_1.logger.log(`Attemping to trim video: ${originalVideoPath} at start: ${startSecs} and duration: ${durationSecs} to ${outputPath}`);
+    if (!validateMp4(originalVideoPath)) {
+        throw new Error(`Video file is incomplete or corrupt (missing moov atom): ${originalVideoPath}`);
+    }
     const copyName = `draft-for-${outputPath}`;
     const dirPath = path_1.default.dirname(originalVideoPath);
     const copyFullPath = path_1.default.join(dirPath, copyName);

package/dist/tests/reporter.spec.js

@@ -135,7 +135,8 @@ let VideoDownloader;
             tests: [],
         }, null, 2));
         const downloadedVideoPath = path_1.default.join(mockBasePath, `${workerVideoBaseName}.mp4`);
-        await promises_1.default.writeFile(downloadedVideoPath, "video-bytes");
+        // Include a fake moov atom so validateMp4 passes
+        await promises_1.default.writeFile(downloadedVideoPath, "fake-video-moov-marker");
         downloadVideoMock.mockResolvedValueOnce({
             path: downloadedVideoPath,
             contentType: "video/mp4",
@@ -165,6 +166,67 @@ let VideoDownloader;
             },
         ]);
     });
+    (0, vitest_1.test)("falls back to full video when downloaded MP4 is corrupt (missing moov atom)", async () => {
+        vitest_1.vi.useFakeTimers();
+        mockBasePath = await promises_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), "appwright-videos-"));
+        const workerIndex = 0;
+        const sessionId = "session-corrupt";
+        const providerName = "browserstack";
+        const workerVideoBaseName = `worker-${workerIndex}-${sessionId}-video`;
+        const workerStart = new Date("2025-01-01T00:00:00.000Z");
+        const testStart = new Date("2025-01-01T00:00:10.000Z");
+        await promises_1.default.writeFile(path_1.default.join(mockBasePath, `worker-info-${workerIndex}.json`), JSON.stringify({
+            idx: workerIndex,
+            sessionId,
+            providerName,
+            startTime: {
+                beforeAppiumSession: workerStart.toISOString(),
+                afterAppiumSession: workerStart.toISOString(),
+            },
+            endTime: new Date("2025-01-01T00:00:20.000Z").toISOString(),
+            tests: [],
+        }, null, 2));
+        const downloadedVideoPath = path_1.default.join(mockBasePath, `${workerVideoBaseName}.mp4`);
+        // Write a file WITHOUT moov atom — simulates an incomplete BrowserStack download
+        await promises_1.default.writeFile(downloadedVideoPath, "corrupt-partial-video-data");
+        downloadVideoMock.mockResolvedValueOnce({
+            path: downloadedVideoPath,
+            contentType: "video/mp4",
+        });
+        const { logger } = await import("../logger.js");
+        const reporter = new VideoDownloader();
+        const testCase = {
+            id: "test-corrupt",
+            title: "corrupt video test",
+            annotations: [],
+        };
+        const testResult = {
+            workerIndex,
+            duration: 5000,
+            startTime: testStart,
+            retry: 0,
+            attachments: [],
+        };
+        reporter.onTestEnd(testCase, testResult);
+        await vitest_1.vi.advanceTimersByTimeAsync(5000);
+        await reporter.onEnd();
+        // Should fall back to attaching the full untrimmed video
+        (0, vitest_1.expect)(testResult.attachments).toMatchObject([
+            {
+                contentType: "video/mp4",
+                name: "video",
+                path: downloadedVideoPath,
+            },
+        ]);
+        // Should annotate the test with a videoError explaining the fallback
+        const videoErrorAnnotation = testCase.annotations.find((a) => a.type === "videoError");
+        (0, vitest_1.expect)(videoErrorAnnotation).toBeDefined();
+        (0, vitest_1.expect)(videoErrorAnnotation.description).toContain("Unable to trim video");
+        // Should log the trim failure
+        (0, vitest_1.expect)(logger.error).toHaveBeenCalledWith("Failed to trim video:", vitest_1.expect.objectContaining({
+            message: vitest_1.expect.stringContaining("missing moov atom"),
+        }));
+    });
     (0, vitest_1.test)("skips BrowserStack video handling when video download is disabled", async () => {
         vitest_1.vi.useFakeTimers();
         process.env.APPWRIGHT_DISABLE_VIDEO_DOWNLOAD = "true";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samsara-dev/appwright",
-  "version": "0.9.8",
+  "version": "0.9.9",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"