@samsara-dev/appwright 0.9.13 → 0.9.15

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # appwright
 
+## 0.9.15
+
+### Patch Changes
+
+- 7e70815: Fix stale testId in GPT Driver when using persistent device fixtures
+
+  Update testId on the cached gpt-driver-node instance before every API call
+  so persistent device fixtures (scope: "worker") report the correct test in
+  GPT Driver sessions. Previously the testId was baked in on first use and
+  never updated, causing all subsequent tests and resetToHome teardowns to
+  report the same stale testId on the MobileBoost dashboard.
+
+## 0.9.14
+
+### Patch Changes
+
+- c7b7722: Switch GPT Driver cachingMode from FULL_SCREEN to INTERACTION_REGION
+
 ## 0.9.13
 
 ### Patch Changes

package/dist/gptDriver/index.d.ts

@@ -2,7 +2,7 @@ import type { Client as WebDriverClient } from "webdriver";
 import type { GptDriverConfig } from "../types";
 /**
  * Options for aiExecute. Intentionally exposes only appiumHandler;
- * cachingMode is set globally at provider init (FULL_SCREEN),
+ * cachingMode is set globally at provider init (INTERACTION_REGION),
  * and useSmartLoop is not yet surfaced.
  */
 export interface AiExecuteOptions {
@@ -32,6 +32,7 @@ export declare class GptDriverProvider implements GptDriverApi {
     private webDriverClient;
     private options?;
     private driver;
+    private testIdWarned;
     constructor(webDriverClient: WebDriverClient, options?: GptDriverConfig | undefined);
     private getAppiumUrl;
     private getDriver;

package/dist/gptDriver/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/gptDriver/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,WAAW,CAAC;AAG3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAIhD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC9D;AAED;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IAIlD,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,OAAO,CAAC;IAJlB,OAAO,CAAC,MAAM,CAA0B;gBAG9B,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,eAAe,YAAA;IAGnC,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,aAAa;IAMf,SAAS,CACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,IAAI,CAAC;IAkBV,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/C,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAajE,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAWnE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/gptDriver/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,WAAW,CAAC;AAG3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAIhD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC9D;AAED;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IAKlD,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,OAAO,CAAC;IALlB,OAAO,CAAC,MAAM,CAA0B;IACxC,OAAO,CAAC,YAAY,CAAS;gBAGnB,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,eAAe,YAAA;IAGnC,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,aAAa;IA8BrB,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,aAAa;IAMf,SAAS,CACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,IAAI,CAAC;IAkBV,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/C,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAajE,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAWnE"}

package/dist/gptDriver/index.js

@@ -77,6 +77,7 @@ let GptDriverProvider = (() => {
         webDriverClient = __runInitializers(this, _instanceExtraInitializers);
         options;
         driver = null;
+        testIdWarned = false;
         constructor(webDriverClient, options) {
             this.webDriverClient = webDriverClient;
             this.options = options;
@@ -100,7 +101,7 @@ let GptDriverProvider = (() => {
                 // gpt-driver-node expects webdriverio Browser type but webdriver Client is API-compatible at runtime
                 driver: this.webDriverClient,
                 serverConfig: { url: this.getAppiumUrl() },
-                cachingMode: "FULL_SCREEN",
+                cachingMode: "INTERACTION_REGION",
                 testId: test_1.default.info()?.testId ?? `test-${Date.now()}`,
                 ...(this.options?.additionalUserContext != null && {
                     additionalUserContext: this.options.additionalUserContext,
@@ -115,6 +116,21 @@ let GptDriverProvider = (() => {
                 test_1.default.skip(true, "GPT Driver not configured. Set GPT_DRIVER_API_KEY environment variable.");
                 throw new Error("GPT Driver not configured");
             }
+            // Update testId to current test context so persistent device fixtures
+            // report the correct test in GPT Driver API calls.
+            // gpt-driver-node declares testId as private in TS but it's a plain
+            // JS property at runtime — safe to mutate directly.
+            // TODO: Replace with public setTestId() if gpt-driver-node exposes one.
+            const currentTestId = test_1.default.info()?.testId;
+            if (currentTestId && "testId" in driver) {
+                driver.testId = currentTestId;
+            }
+            else if (currentTestId && !this.testIdWarned) {
+                console.warn("[GptDriver] Cannot update testId — property not found on driver instance. " +
+                    "GPT Driver sessions may be attributed to the wrong test. " +
+                    "Check if gpt-driver-node renamed or removed the testId field.");
+                this.testIdWarned = true;
+            }
             return driver;
         }
         validateInstruction(instruction, methodName) {

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

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

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

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

package/dist/tests/gptDriver.spec.js

@@ -0,0 +1,131 @@
+"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 test_1 = __importDefault(require("@playwright/test"));
+// --- Mock gpt-driver-node ---
+// vi.hoisted runs before vi.mock hoisting, so variables are available in the factory
+const { MockGptDriver, mockAiExecute } = vitest_1.vi.hoisted(() => {
+    const mockAiExecute = vitest_1.vi.fn().mockResolvedValue(undefined);
+    // Must use function (not arrow) so it can be called with `new`
+    const MockGptDriver = vitest_1.vi.fn(function (config) {
+        this.aiExecute = mockAiExecute;
+        this.assert = vitest_1.vi.fn().mockResolvedValue(undefined);
+        this.assertBulk = vitest_1.vi.fn().mockResolvedValue(undefined);
+        this.checkBulk = vitest_1.vi.fn().mockResolvedValue({});
+        this.extract = vitest_1.vi.fn().mockResolvedValue({});
+        this.testId = config.testId;
+    });
+    return { MockGptDriver, mockAiExecute };
+});
+vitest_1.vi.mock("gpt-driver-node", () => ({ default: MockGptDriver }));
+// --- Mock Playwright test helpers ---
+let currentTestId = "test-initial";
+test_1.default.step = vitest_1.vi.fn(async (_name, body) => await body());
+test_1.default.info = () => currentTestId ? { testId: currentTestId } : undefined;
+test_1.default.skip = vitest_1.vi.fn();
+const gptDriver_1 = require("../gptDriver");
+function createProvider() {
+    return new gptDriver_1.GptDriverProvider({
+        options: {
+            protocol: "http",
+            hostname: "localhost",
+            port: 4723,
+            path: "/wd/hub",
+        },
+    });
+}
+(0, vitest_1.describe)("GptDriverProvider", () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.clearAllMocks();
+        currentTestId = "test-initial";
+        process.env.GPT_DRIVER_API_KEY = "fake-key";
+    });
+    (0, vitest_1.afterEach)(() => {
+        delete process.env.GPT_DRIVER_API_KEY;
+    });
+    (0, vitest_1.describe)("testId tracks current test context", () => {
+        (0, vitest_1.test)("initializes testId from first call's test context", async () => {
+            const provider = createProvider();
+            currentTestId = "test-first";
+            await provider.aiExecute("login");
+            const driver = provider.driver;
+            (0, vitest_1.expect)(driver.testId).toBe("test-first");
+        });
+        (0, vitest_1.test)("updates testId when a different test uses the same device", async () => {
+            const provider = createProvider();
+            // Test A runs
+            currentTestId = "test-aaa";
+            await provider.aiExecute("tap the submit button");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-aaa");
+            // Test B runs on the same persistent device
+            currentTestId = "test-bbb";
+            await provider.aiExecute("verify the results screen");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-bbb");
+        });
+        (0, vitest_1.test)("fixture teardown uses the current test's ID, not the first", async () => {
+            const provider = createProvider();
+            // Test A runs
+            currentTestId = "test-aaa";
+            await provider.aiExecute("perform action");
+            // Fixture teardown runs in Test A's context
+            await provider.aiExecute("navigate back to home");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-aaa");
+            // Test B starts with new context
+            currentTestId = "test-bbb";
+            await provider.aiExecute("perform another action");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-bbb");
+            // Fixture teardown runs in Test B's context
+            await provider.aiExecute("navigate back to home");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-bbb");
+        });
+        (0, vitest_1.test)("preserves testId when test.info() returns undefined", async () => {
+            const provider = createProvider();
+            currentTestId = "test-known";
+            await provider.aiExecute("do something");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-known");
+            // Worker teardown — no test context
+            currentTestId = undefined;
+            await provider.aiExecute("cleanup");
+            (0, vitest_1.expect)(provider.driver.testId).toBe("test-known");
+        });
+        (0, vitest_1.test)("warns once if testId property is missing from driver", async () => {
+            const provider = createProvider();
+            const warnSpy = vitest_1.vi.spyOn(console, "warn").mockImplementation(() => { });
+            currentTestId = "test-aaa";
+            await provider.aiExecute("initialize");
+            // Remove testId to simulate SDK rename/removal
+            delete provider.driver.testId;
+            currentTestId = "test-bbb";
+            await provider.aiExecute("second call");
+            (0, vitest_1.expect)(warnSpy).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(warnSpy).toHaveBeenCalledWith(vitest_1.expect.stringContaining("Cannot update testId"));
+            // Should not warn again on subsequent calls
+            currentTestId = "test-ccc";
+            await provider.aiExecute("third call");
+            (0, vitest_1.expect)(warnSpy).toHaveBeenCalledTimes(1);
+            warnSpy.mockRestore();
+        });
+    });
+    (0, vitest_1.describe)("lazy singleton", () => {
+        (0, vitest_1.test)("creates GptDriver instance only once", async () => {
+            const provider = createProvider();
+            currentTestId = "test-1";
+            await provider.aiExecute("first");
+            currentTestId = "test-2";
+            await provider.aiExecute("second");
+            currentTestId = "test-3";
+            await provider.aiExecute("third");
+            (0, vitest_1.expect)(MockGptDriver).toHaveBeenCalledTimes(1);
+        });
+        (0, vitest_1.test)("does not create GptDriver when API key is missing", async () => {
+            delete process.env.GPT_DRIVER_API_KEY;
+            const provider = createProvider();
+            // Should call test.skip and throw
+            await (0, vitest_1.expect)(provider.aiExecute("anything")).rejects.toThrow("GPT Driver not configured");
+            (0, vitest_1.expect)(MockGptDriver).not.toHaveBeenCalled();
+        });
+    });
+});

package/package.json

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