@samsara-dev/appwright 0.7.0 → 0.7.2

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # appwright
 
+## 0.7.2
+
+### Patch Changes
+
+- ecdfc42: Avoid video filename collisions in the Playwright reporter by including the provider session ID in downloaded video filenames.
+
+## 0.7.1
+
+### Patch Changes
+
+- 75adf30: Add CI metadata support for BrowserStack build traceability
+
+  BrowserStack sessions now automatically include CI context in build names and session names:
+
+  - **Buildkite**: Build number, branch, commit from `BUILDKITE_*` env vars
+  - **GitHub Actions**: Run number, ref name, SHA from `GITHUB_*` env vars
+  - **GitLab CI**: Pipeline ID, ref name, commit from `CI_*` env vars
+
+  Example build names:
+
+  - CI: `driver-performance-tests android #35 (main)`
+  - Local: `driver-performance-tests android`
+
+  Environment variable overrides:
+
+  - `BROWSERSTACK_BUILD_NAME`: Override auto-generated build name
+  - `BROWSERSTACK_SESSION_NAME`: Override auto-generated session name
+
 ## 0.7.0
 
 ### Minor 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;AAsDtC,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;YAiBZ,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;IAuFlD,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;CAuHrB"}
+{"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;AAsDtC,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;YAiBZ,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;IAuFlD,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;CAsJrB"}

package/dist/providers/browserstack/index.js

@@ -251,6 +251,28 @@ class BrowserStackDeviceProvider {
             throw new Error(`process.env.${envVarKey} is not set. Did the file upload work?`);
         }
         const permissionPrompts = deviceConfig?.permissionPrompts;
+        // Build CI-aware metadata for better traceability between CI builds and BrowserStack sessions
+        const ciBuildIdentifier = process.env.BUILDKITE_BUILD_ID ||
+            process.env.GITHUB_RUN_ID ||
+            process.env.CI_JOB_ID || // GitLab CI
+            process.env.USER;
+        const ciBuildNumber = process.env.BUILDKITE_BUILD_NUMBER ||
+            process.env.GITHUB_RUN_NUMBER ||
+            process.env.CI_PIPELINE_IID; // GitLab CI
+        const ciBranch = process.env.BUILDKITE_BRANCH ||
+            process.env.GITHUB_REF_NAME ||
+            process.env.CI_COMMIT_REF_NAME; // GitLab CI
+        const ciCommit = (process.env.BUILDKITE_COMMIT ||
+            process.env.GITHUB_SHA ||
+            process.env.CI_COMMIT_SHA) // GitLab CI
+            ?.substring(0, 7);
+        // Allow env var override, otherwise build a descriptive name with CI context
+        const defaultBuildName = ciBuildNumber
+            ? `${projectName} ${platformName} #${ciBuildNumber}${ciBranch ? ` (${ciBranch})` : ""}`
+            : `${projectName} ${platformName}`;
+        const defaultSessionName = ciCommit
+            ? `${projectName} ${platformName} test @ ${ciCommit}`
+            : `${projectName} ${platformName} test`;
         const bstackOptions = {
             debug: true,
             interactiveDebugging: true,
@@ -262,11 +284,9 @@ class BrowserStackDeviceProvider {
             osVersion: deviceConfig.osVersion,
             platformName: platformName,
             deviceOrientation: deviceConfig?.orientation,
-            buildName: `${projectName} ${platformName}`,
-            sessionName: `${projectName} ${platformName} test`,
-            buildIdentifier: process.env.GITHUB_ACTIONS === "true"
-                ? `CI ${process.env.GITHUB_RUN_ID}`
-                : process.env.USER,
+            buildName: process.env.BROWSERSTACK_BUILD_NAME || defaultBuildName,
+            sessionName: process.env.BROWSERSTACK_SESSION_NAME || defaultSessionName,
+            buildIdentifier: ciBuildIdentifier,
         };
         if (typeof deviceConfig?.appProfiling === "boolean") {
             bstackOptions.appProfiling = deviceConfig.appProfiling;

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;IA0FtC,KAAK;YAKG,kCAAkC;IA4ChD,OAAO,CAAC,4BAA4B;IAyBpC,OAAO,CAAC,qBAAqB;CAI9B;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;IA2FtC,KAAK;YAKG,kCAAkC;IA6ChD,OAAO,CAAC,4BAA4B;IAyBpC,OAAO,CAAC,qBAAqB;CAI9B;AA8ED,eAAe,eAAe,CAAC"}

package/dist/reporter.js

@@ -51,7 +51,6 @@ class VideoDownloader {
                 type: "workerInfo",
                 description: `Ran on worker #${workerIndex}.`,
             });
-            const expectedVideoPath = path_1.default.join((0, utils_1.basePath)(), `worker-${workerIndex}-video.mp4`);
             // The `onTestEnd` is method is called before the worker ends and
             // the worker's `endTime` is saved to disk. We add a 5 secs delay
             // to prevent a harmful race condition.
@@ -68,10 +67,11 @@ class VideoDownloader {
                 if (!this.providerSupportsVideo(providerName)) {
                     return; // Nothing to do here
                 }
+                const workerVideoBaseName = `worker-${workerIndex}-${sessionId}-video`;
                 if (endTime) {
                     // This is the last test in the worker, so let's download the video
                     const provider = (0, providers_1.getProviderClass)(providerName);
-                    const downloaded = await provider.downloadVideo(sessionId, (0, utils_1.basePath)(), `worker-${workerIndex}-video`);
+                    const downloaded = await provider.downloadVideo(sessionId, (0, utils_1.basePath)(), workerVideoBaseName);
                     if (!downloaded) {
                         return;
                     }
@@ -80,8 +80,9 @@ class VideoDownloader {
                 else {
                     // This is an intermediate test in the worker, so let's wait for the
                     // video file to be found on disk. Once it is, we trim and attach it.
-                    await waitFor(() => fs_1.default.existsSync(expectedVideoPath));
-                    return this.trimAndAttachPersistentDeviceVideo(test, result, expectedVideoPath);
+                    const expectedWorkerVideoPath = path_1.default.join((0, utils_1.basePath)(), `${workerVideoBaseName}.mp4`);
+                    await waitFor(() => fs_1.default.existsSync(expectedWorkerVideoPath));
+                    return this.trimAndAttachPersistentDeviceVideo(test, result, expectedWorkerVideoPath);
                 }
             })
                 .catch((e) => {
@@ -111,7 +112,8 @@ class VideoDownloader {
         }
         else {
             const trimSkipPoint = (testStart.getTime() - workerStart.getTime()) / 1000;
-            const trimmedFileName = `worker-${workerIdx}-trimmed-${test.id}.mp4`;
+            const retryIndex = result.retry ?? 0;
+            const trimmedFileName = `worker-${workerIdx}-trimmed-${test.id}-retry-${retryIndex}.mp4`;
             try {
                 pathToAttach = await trimVideo({
                     originalVideoPath: workerVideoPath,
@@ -135,7 +137,7 @@ class VideoDownloader {
         });
     }
     downloadAndAttachDeviceVideo(test, result, providerClass, sessionId) {
-        const videoFileName = `${test.id}`;
+        const videoFileName = `${sessionId}-${test.id}`;
         if (!providerClass.downloadVideo) {
             return;
         }

package/dist/tests/reporter.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=reporter.spec.d.ts.map

package/dist/tests/reporter.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.spec.d.ts","sourceRoot":"","sources":["../../src/tests/reporter.spec.ts"],"names":[],"mappings":""}

package/dist/tests/reporter.spec.js

@@ -0,0 +1,167 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const promises_1 = __importDefault(require("fs/promises"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+vitest_1.vi.mock("@ffmpeg-installer/ffmpeg", () => {
+    return {
+        default: { path: "/fake/ffmpeg" },
+        __esModule: true,
+    };
+});
+vitest_1.vi.mock("fluent-ffmpeg", () => {
+    return {
+        default: () => {
+            const handlers = {};
+            const chain = {
+                setFfmpegPath: () => chain,
+                setStartTime: () => chain,
+                setDuration: () => chain,
+                output: () => chain,
+                on: (event, cb) => {
+                    handlers[event] = cb;
+                    return chain;
+                },
+                run: () => {
+                    void Promise.resolve().then(() => handlers.end?.());
+                },
+            };
+            return chain;
+        },
+        __esModule: true,
+    };
+});
+let mockBasePath = "";
+const downloadVideoMock = vitest_1.vi.fn();
+const getProviderClassMock = vitest_1.vi.fn(() => ({
+    downloadVideo: downloadVideoMock,
+}));
+vitest_1.vi.mock("../providers", () => {
+    return {
+        getProviderClass: getProviderClassMock,
+        __esModule: true,
+    };
+});
+vitest_1.vi.mock("../utils", () => {
+    return {
+        basePath: () => mockBasePath,
+        __esModule: true,
+    };
+});
+vitest_1.vi.mock("../logger", () => {
+    return {
+        logger: {
+            log: vitest_1.vi.fn(),
+            warn: vitest_1.vi.fn(),
+            error: vitest_1.vi.fn(),
+        },
+        __esModule: true,
+    };
+});
+let VideoDownloader;
+(0, vitest_1.beforeAll)(async () => {
+    const reporterModule = await import("../reporter.js");
+    VideoDownloader = reporterModule.default;
+});
+(0, vitest_1.afterEach)(async () => {
+    const basePathToDelete = mockBasePath;
+    downloadVideoMock.mockReset();
+    mockBasePath = "";
+    getProviderClassMock.mockClear();
+    vitest_1.vi.useRealTimers();
+    if (basePathToDelete) {
+        await promises_1.default.rm(basePathToDelete, { recursive: true, force: true });
+    }
+});
+(0, vitest_1.describe)("VideoDownloader", () => {
+    (0, vitest_1.test)("downloads device videos with session-scoped filename", async () => {
+        mockBasePath = await promises_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), "appwright-videos-"));
+        const sessionId = "session-123";
+        const testId = "test-abc";
+        downloadVideoMock.mockResolvedValueOnce({
+            path: path_1.default.join(mockBasePath, `${sessionId}-${testId}.mp4`),
+            contentType: "video/mp4",
+        });
+        const reporter = new VideoDownloader();
+        const testCase = {
+            id: testId,
+            title: "example",
+            annotations: [
+                { type: "sessionId", description: sessionId },
+                { type: "providerName", description: "browserstack" },
+            ],
+        };
+        const testResult = {
+            workerIndex: 0,
+            duration: 1,
+            startTime: new Date(),
+            attachments: [],
+        };
+        reporter.onTestEnd(testCase, testResult);
+        (0, vitest_1.expect)(getProviderClassMock).toHaveBeenCalledWith("browserstack");
+        (0, vitest_1.expect)(downloadVideoMock).toHaveBeenCalledWith(sessionId, mockBasePath, `${sessionId}-${testId}`);
+        await reporter.onEnd();
+        (0, vitest_1.expect)(testResult.attachments).toEqual([
+            {
+                path: path_1.default.join(mockBasePath, `${sessionId}-${testId}.mp4`),
+                contentType: "video/mp4",
+                name: "video",
+            },
+        ]);
+    });
+    (0, vitest_1.test)("scopes persistentDevice worker video base name by sessionId", 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-xyz";
+        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:02.000Z").toISOString(),
+            tests: [],
+        }, null, 2));
+        const downloadedVideoPath = path_1.default.join(mockBasePath, `${workerVideoBaseName}.mp4`);
+        await promises_1.default.writeFile(downloadedVideoPath, "video-bytes");
+        downloadVideoMock.mockResolvedValueOnce({
+            path: downloadedVideoPath,
+            contentType: "video/mp4",
+        });
+        const reporter = new VideoDownloader();
+        const testCase = {
+            id: "test-1",
+            title: "persistent",
+            annotations: [],
+        };
+        const testResult = {
+            workerIndex,
+            duration: 1,
+            startTime: testStart,
+            retry: 1,
+            attachments: [],
+        };
+        reporter.onTestEnd(testCase, testResult);
+        await vitest_1.vi.advanceTimersByTimeAsync(5000);
+        await reporter.onEnd();
+        (0, vitest_1.expect)(downloadVideoMock).toHaveBeenCalledWith(sessionId, mockBasePath, workerVideoBaseName);
+        (0, vitest_1.expect)(testResult.attachments).toMatchObject([
+            {
+                contentType: "video/mp4",
+                name: "video",
+                path: vitest_1.expect.stringContaining(`-retry-1.mp4`),
+            },
+        ]);
+    });
+});

package/package.json

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