@samsara-dev/appwright 0.7.1 → 0.7.3

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # appwright
 
+## 0.7.3
+
+### Patch Changes
+
+- 92deea8: Add AWS Device Farm provider support for mobile testing
+
+  This release introduces comprehensive AWS Device Farm integration for mobile app testing, enabling teams to run tests on real devices in AWS's device cloud.
+
+  ### Features
+  - **AWS Device Farm Provider**: Complete implementation with support for both Android and iOS testing
+  - **Automated App Upload**: Automatically uploads APK/IPA files to Device Farm during test setup
+  - **ARN Persistence**: Intelligently reuses uploaded builds across test runs to minimize upload time
+  - **Remote Session Management**: Creates and manages Device Farm remote access sessions
+  - **Video Recording**: Automatic video capture of test sessions with download capability
+  - **Flexible Configuration**: Support for custom capabilities, interaction modes, and session settings
+
+  ### Technical Details
+  - Added comprehensive test suite with 15 tests covering all functionality
+  - Implemented proper async cleanup callbacks for resource management
+  - Enhanced error handling with descriptive error messages
+  - Added support for AWS region configuration
+  - Improved WebDriver connection handling with query parameter support
+
+  ### Configuration Example
+
+  ```typescript
+  export default defineConfig({
+    use: {
+      platform: Platform.ANDROID,
+      buildPath: "./app.apk",
+      device: {
+        provider: "aws-device-farm",
+        projectArn: "arn:aws:devicefarm:us-west-2:123:project:456",
+        deviceArn: "arn:aws:devicefarm:us-west-2::device:789",
+        region: "us-west-2",
+        sessionName: "My Test Session",
+      },
+    },
+  });
+  ```
+
+  This provider enables teams to leverage AWS Device Farm's extensive device library for comprehensive mobile testing without maintaining physical device labs.
+
+## 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
@@ -7,18 +56,15 @@
 - 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
 
@@ -107,7 +153,6 @@
 ### Minor Changes
 
 - 9415229: feat: add Visual Trace Service for automatic screenshot capture during test execution
-
   - Implements automatic screenshot capture with smart defaults (only captures for failed tests)
   - Adds screenshot deduplication using SHA-256 hashing
   - Supports configurable screenshot limits (default: 50)

package/README.md

@@ -77,7 +77,7 @@ export default defineConfig({
 - `platform`: The platform you want to test on, such as 'android' or 'ios'.
 
 - `provider`: The device provider where you want to run your tests.
-              You can choose between `browserstack`, `lambdatest`, `emulator`, or `local-device`.
+              You can choose between `browserstack`, `lambdatest`, `emulator`, `local-device`, or `aws-device-farm`.
 
 - `buildPath`: The path to your build file. For Android, it should be an APK file.
                For iOS, if you are running tests on real device, it should be an `.ipa` file. For running tests on an emulator, it should be a `.app` file.
@@ -170,6 +170,33 @@ the provider in your config.
 },
 ```
 
+#### Run tests on AWS Device Farm
+
+Appwright can connect to AWS Device Farm remote access sessions. Configure the provider in your config and supply either a Device Farm `appArn` or a local `buildPath` that Appwright can upload during global setup.
+
+```ts
+{
+  name: "ios",
+  use: {
+    platform: Platform.IOS,
+    appBundleId: "com.example.myapp",
+    buildPath: "./builds/MyApp.ipa",
+    device: {
+      provider: "aws-device-farm",
+      projectArn: "arn:aws:devicefarm:us-west-2:123456789012:project:abc123",
+      deviceArn:
+        "arn:aws:devicefarm:us-west-2::device:Apple:iPhone.15.Pro:17.5",
+      interactionMode: "VIDEO_ONLY",
+      sessionName: "smoke-suite",
+    },
+  },
+},
+```
+
+Set the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and (optionally) `AWS_SESSION_TOKEN` & `AWS_REGION` environment variables before running the tests.
+
+Appwright always requests Device Farm video recordings and attaches the MP4 to Playwright reports once the session completes.
+
 ## Run the sample project
 
 To run the sample project:

package/dist/device/index.d.ts

@@ -15,7 +15,8 @@ export declare class Device {
     private deviceProvider?;
     private persistentSyncEnabled;
     private activePersistentKey?;
-    constructor(webDriverClient: WebDriverClient, bundleId: string | undefined, timeoutOpts: TimeoutOptions, provider: string, deviceProvider?: DeviceProvider);
+    private cleanupCallback?;
+    constructor(webDriverClient: WebDriverClient, bundleId: string | undefined, timeoutOpts: TimeoutOptions, provider: string, deviceProvider?: DeviceProvider, cleanupCallback?: () => Promise<void>);
     attachDeviceProvider(provider: DeviceProvider): void;
     enablePersistentStatusSync(): void;
     ensurePersistentLifecycle(testInfo: TestInfo): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/device/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,WAAW,CAAC;AAE3D,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACd,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAKlB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAO7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,KAAK,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7E,qBAAa,MAAM;IAOf,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,QAAQ;IATlB,OAAO,CAAC,kBAAkB,CAAC,CAAqB;IAChD,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,mBAAmB,CAAC,CAAS;gBAG3B,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,WAAW,EAAE,cAAc,EAC3B,QAAQ,EAAE,MAAM,EACxB,cAAc,CAAC,EAAE,cAAc;IAKjC,oBAAoB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAIpD,0BAA0B,IAAI,IAAI;IAI5B,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5D,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxD,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB/D,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,aAAa;YAQP,QAAQ;IAetB;;OAEG;IACH,qBAAqB,CACnB,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,iBAAiB,GACzB,IAAI;IAQP;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvC,OAAO,CAAC,EACN,QAAQ,EACR,YAAY,EACZ,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KAC/B,GAAG,gBAAgB;IAWpB,OAAO,CAAC,MAAM;IAId,IAAI;sBAEQ,MAAM,YACJ;YACR,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,SAAS,CAAC,EAAE;gBACV,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;aACjB,CAAC;SACH,KACA,OAAO,CAAC;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;gBAItB,CAAC,SAAS,CAAC,CAAC,OAAO,UACvB,MAAM,YACJ;YACR,cAAc,CAAC,EAAE,CAAC,CAAC;YACnB,KAAK,CAAC,EAAE,QAAQ,CAAC;YACjB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,SAAS,CAAC,EAAE;gBACV,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;aACjB,CAAC;SACH,KACA,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;MAG1B;IAEF;;;;;;;OAOG;IACG,KAAK;IAiBX;;;;;;;;;;;OAWG;IAEG,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE;IAoB5C;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CACP,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,EAAE,KAAa,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1C,gBAAgB;IAsCnB;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,EAAE,KAAa,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1C,gBAAgB;IAiBnB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB;IAI3C;;;;;;;;;OASG;IACH,WAAW,IAAI,QAAQ;IAMjB,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM;IAc9B,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM;IAanC;;;;;;;;;;;;;;;;;OAiBG;IAEG,aAAa,CAAC,OAAO,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxD;;;;;;;;;;OAUG;IAEG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAqBzC;;;;;;;;;;;OAWG;IAEG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBnD,KAAK;IAmBL,cAAc,CAAC,OAAO,EAAE,MAAM;IAIpC;;OAEG;IAEG,WAAW,IAAI,OAAO,CAAC,cAAc,CAAC;IAI5C;;OAEG;IAEG,aAAa,IAAI,OAAO,CAAC;QAC7B,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IAIF;;OAEG;IAEG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC;;;;;;;;;;OAUG;IAEG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAU7B;;;OAGG;IAEG,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBlD;;;;;;;;;;;;;;;;;OAiBG;IAEU,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnE;;;;;;;;;;;;;OAaG;IAEU,wBAAwB,CACnC,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;CAe9B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/device/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,WAAW,CAAC;AAE3D,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACd,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAKlB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAO7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,KAAK,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7E,qBAAa,MAAM;IAQf,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,QAAQ;IAVlB,OAAO,CAAC,kBAAkB,CAAC,CAAqB;IAChD,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,mBAAmB,CAAC,CAAS;IACrC,OAAO,CAAC,eAAe,CAAC,CAAsB;gBAGpC,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,WAAW,EAAE,cAAc,EAC3B,QAAQ,EAAE,MAAM,EACxB,cAAc,CAAC,EAAE,cAAc,EAC/B,eAAe,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC;IAMvC,oBAAoB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAIpD,0BAA0B,IAAI,IAAI;IAI5B,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5D,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxD,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB/D,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,aAAa;YAQP,QAAQ;IAetB;;OAEG;IACH,qBAAqB,CACnB,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,iBAAiB,GACzB,IAAI;IAQP;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvC,OAAO,CAAC,EACN,QAAQ,EACR,YAAY,EACZ,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KAC/B,GAAG,gBAAgB;IAWpB,OAAO,CAAC,MAAM;IAId,IAAI;sBAEQ,MAAM,YACJ;YACR,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,SAAS,CAAC,EAAE;gBACV,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;aACjB,CAAC;SACH,KACA,OAAO,CAAC;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;gBAItB,CAAC,SAAS,CAAC,CAAC,OAAO,UACvB,MAAM,YACJ;YACR,cAAc,CAAC,EAAE,CAAC,CAAC;YACnB,KAAK,CAAC,EAAE,QAAQ,CAAC;YACjB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,SAAS,CAAC,EAAE;gBACV,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;aACjB,CAAC;SACH,KACA,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;MAG1B;IAEF;;;;;;;OAOG;IACG,KAAK;IA0BX;;;;;;;;;;;OAWG;IAEG,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE;IAoB5C;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CACP,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,EAAE,KAAa,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1C,gBAAgB;IAsCnB;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,EAAE,KAAa,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1C,gBAAgB;IAiBnB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB;IAI3C;;;;;;;;;OASG;IACH,WAAW,IAAI,QAAQ;IAMjB,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM;IAc9B,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM;IAanC;;;;;;;;;;;;;;;;;OAiBG;IAEG,aAAa,CAAC,OAAO,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxD;;;;;;;;;;OAUG;IAEG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAqBzC;;;;;;;;;;;OAWG;IAEG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBnD,KAAK;IAmBL,cAAc,CAAC,OAAO,EAAE,MAAM;IAIpC;;OAEG;IAEG,WAAW,IAAI,OAAO,CAAC,cAAc,CAAC;IAI5C;;OAEG;IAEG,aAAa,IAAI,OAAO,CAAC;QAC7B,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IAIF;;OAEG;IAEG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC;;;;;;;;;;OAUG;IAEG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAU7B;;;OAGG;IAEG,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBlD;;;;;;;;;;;;;;;;;OAiBG;IAEU,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnE;;;;;;;;;;;;;OAaG;IAEU,wBAAwB,CACnC,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;CAe9B"}

package/dist/device/index.js

@@ -103,12 +103,14 @@ let Device = (() => {
         deviceProvider;
         persistentSyncEnabled = false;
         activePersistentKey;
-        constructor(webDriverClient, bundleId, timeoutOpts, provider, deviceProvider) {
+        cleanupCallback;
+        constructor(webDriverClient, bundleId, timeoutOpts, provider, deviceProvider, cleanupCallback) {
             this.webDriverClient = webDriverClient;
             this.bundleId = bundleId;
             this.timeoutOpts = timeoutOpts;
             this.provider = provider;
             this.deviceProvider = deviceProvider;
+            this.cleanupCallback = cleanupCallback;
         }
         attachDeviceProvider(provider) {
             this.deviceProvider = provider;
@@ -240,6 +242,15 @@ let Device = (() => {
                 (0, visualTrace_1.clearVisualTraceService)();
                 this.visualTraceService = undefined;
             }
+            // Call the cleanup callback if provided
+            if (this.cleanupCallback) {
+                try {
+                    await this.cleanupCallback();
+                }
+                catch (e) {
+                    logger_1.logger.error(`cleanup callback error:`, e);
+                }
+            }
         }
         /**
          * Tap on the screen at the given coordinates, specified as x and y. The top left corner

package/dist/providers/awsDeviceFarm/index.d.ts

@@ -0,0 +1,35 @@
+import { FullProject } from "@playwright/test";
+import { AppwrightConfig, DeviceProvider } from "../../types";
+import { Device } from "../../device";
+export declare class AWSDeviceFarmProvider implements DeviceProvider {
+    sessionId?: string;
+    private readonly project;
+    private readonly appBundleId;
+    private readonly deviceConfig;
+    private readonly platform;
+    private readonly region;
+    private client;
+    private uploadArn?;
+    private remoteSessionArn?;
+    constructor(project: FullProject<AppwrightConfig>, appBundleId: string | undefined);
+    globalSetup(): Promise<void>;
+    getDevice(): Promise<Device>;
+    syncTestDetails(): Promise<void>;
+    private validateBuildFile;
+    private uploadApplication;
+    private waitForUploadProcessing;
+    private createRemoteSession;
+    private waitForRemoteSession;
+    private normalizeEndpoint;
+    private buildCapabilities;
+    private assumeRole;
+    static downloadVideo(sessionArn: string, outputDir: string, fileName: string): Promise<{
+        path: string;
+        contentType: string;
+    } | null>;
+    private static findVideoArtifact;
+    private static downloadFromPresignedUrl;
+    private static extractRegionFromArn;
+    private stopRemoteSession;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/awsDeviceFarm/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACL,eAAe,EACf,cAAc,EAGf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AA+BtC,qBAAa,qBAAsB,YAAW,cAAc;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IACvD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,gBAAgB,CAAC,CAAS;gBAGhC,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,EACrC,WAAW,EAAE,MAAM,GAAG,SAAS;IAwD3B,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IA8B5B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IA4D5B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAMtC,OAAO,CAAC,iBAAiB;YASX,iBAAiB;YA6CjB,uBAAuB;YAmCvB,mBAAmB;YAgCnB,oBAAoB;IA0ClC,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,iBAAiB;YA8CX,UAAU;WA4CX,aAAa,CACxB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;mBA2EnC,iBAAiB;mBA6BjB,wBAAwB;IAwB7C,OAAO,CAAC,MAAM,CAAC,oBAAoB;YAQrB,iBAAiB;CAgBhC"}

package/dist/providers/awsDeviceFarm/index.js

@@ -0,0 +1,443 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AWSDeviceFarmProvider = void 0;
+const async_retry_1 = __importDefault(require("async-retry"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const types_1 = require("../../types");
+const device_1 = require("../../device");
+const logger_1 = require("../../logger");
+const client_device_farm_1 = require("@aws-sdk/client-device-farm");
+const client_sts_1 = require("@aws-sdk/client-sts");
+const utils_1 = require("../../utils");
+const DEFAULT_REGION = "us-west-2";
+const envVarKeyForUpload = (projectName) => `AWS_DEVICE_FARM_APP_ARN_${projectName.toUpperCase().replace(/-/g, "_")}`;
+class AWSDeviceFarmProvider {
+    sessionId;
+    project;
+    appBundleId;
+    deviceConfig;
+    platform;
+    region;
+    client;
+    uploadArn;
+    remoteSessionArn;
+    constructor(project, appBundleId) {
+        this.project = project;
+        this.appBundleId = appBundleId;
+        this.deviceConfig = project.use.device;
+        if (!project.use.platform) {
+            throw new Error("AWS Device Farm: `platform` must be specified in the project configuration.");
+        }
+        this.platform = project.use.platform;
+        if (!this.deviceConfig.projectArn) {
+            throw new Error("AWS Device Farm: `projectArn` is required in the device configuration.");
+        }
+        if (!this.deviceConfig.deviceArn) {
+            throw new Error("AWS Device Farm: `deviceArn` is required in the device configuration.");
+        }
+        if (!this.deviceConfig.region && !process.env.AWS_REGION) {
+            logger_1.logger.warn("AWS Device Farm: region not specified. Falling back to us-west-2.");
+        }
+        if (this.platform === types_1.Platform.IOS && !this.appBundleId) {
+            throw new Error("AWS Device Farm: `appBundleId` is required for iOS projects.");
+        }
+        this.region =
+            this.deviceConfig.region ?? process.env.AWS_REGION ?? DEFAULT_REGION;
+        this.client = new client_device_farm_1.DeviceFarmClient({ region: this.region });
+        // Priority order for upload ARN:
+        // 1. Explicit appArn from device config (highest priority)
+        // 2. Persisted ARN from environment variable (for shared instances)
+        if (this.deviceConfig.appArn) {
+            // Use explicit appArn from config
+            this.uploadArn = this.deviceConfig.appArn;
+        }
+        else {
+            // Check for persisted upload ARN from a previous globalSetup
+            const envVarKey = envVarKeyForUpload(this.project.name);
+            const persistedArn = process.env[envVarKey];
+            if (persistedArn) {
+                this.uploadArn = persistedArn;
+                logger_1.logger.log(`AWS Device Farm: Using persisted app ARN from previous upload: ${persistedArn}`);
+            }
+        }
+    }
+    async globalSetup() {
+        // Handle IAM role assumption if configured
+        if (this.deviceConfig.roleArn) {
+            await this.assumeRole();
+        }
+        const buildPath = this.project.use.buildPath;
+        const providedAppArn = this.deviceConfig.appArn;
+        if (!buildPath && !providedAppArn) {
+            throw new Error("AWS Device Farm: Either provide `buildPath` or `appArn` in the configuration.");
+        }
+        if (buildPath) {
+            this.validateBuildFile(buildPath);
+            this.uploadArn = await this.uploadApplication(buildPath);
+        }
+        else {
+            this.uploadArn = providedAppArn;
+        }
+        // Persist the upload ARN for future provider instances
+        const envVarKey = envVarKeyForUpload(this.project.name);
+        process.env[envVarKey] = this.uploadArn;
+        logger_1.logger.log(`AWS Device Farm: Persisted app ARN for project "${this.project.name}": ${this.uploadArn}`);
+    }
+    async getDevice() {
+        const remoteSession = await this.createRemoteSession();
+        const endpointUrl = this.normalizeEndpoint(remoteSession);
+        const capabilities = this.buildCapabilities(remoteSession);
+        const WebDriver = (await import("webdriver")).default;
+        const connectionOptions = {
+            protocol: endpointUrl.protocol.replace(":", ""),
+            hostname: endpointUrl.hostname,
+            port: endpointUrl.port
+                ? Number(endpointUrl.port)
+                : endpointUrl.protocol === "https:"
+                    ? 443
+                    : 80,
+            path: endpointUrl.pathname,
+        };
+        // Add query parameters if present
+        if (endpointUrl.search) {
+            const queryParams = {};
+            const searchParams = new URLSearchParams(endpointUrl.search);
+            searchParams.forEach((value, key) => {
+                queryParams[key] = value;
+            });
+            connectionOptions.queryParams = queryParams;
+        }
+        let webDriverClient;
+        try {
+            webDriverClient = await WebDriver.newSession({
+                ...connectionOptions,
+                capabilities: {
+                    alwaysMatch: capabilities,
+                    firstMatch: [{}],
+                },
+            });
+        }
+        catch (error) {
+            // Clean up the remote session if WebDriver connection fails
+            await this.stopRemoteSession();
+            throw error;
+        }
+        this.sessionId = this.remoteSessionArn ?? webDriverClient.sessionId;
+        const testOptions = {
+            expectTimeout: this.project.use.expectTimeout,
+        };
+        return new device_1.Device(webDriverClient, this.appBundleId, testOptions, this.project.use.device?.provider, this, async () => {
+            await this.stopRemoteSession();
+        });
+    }
+    async syncTestDetails() {
+        // AWS Device Farm does not currently expose an API to update session metadata like name or status.
+        // This is a no-op to satisfy the DeviceProvider interface.
+        return;
+    }
+    validateBuildFile(buildPath) {
+        const expectedExtension = this.platform === types_1.Platform.ANDROID ? ".apk" : ".ipa";
+        (0, utils_1.validateBuildPath)(buildPath, expectedExtension);
+        if (!fs_1.default.existsSync(buildPath)) {
+            throw new Error(`AWS Device Farm: build file not found at ${buildPath}`);
+        }
+    }
+    async uploadApplication(buildPath) {
+        const uploadType = this.platform === types_1.Platform.ANDROID ? "ANDROID_APP" : "IOS_APP";
+        const fileName = path_1.default.basename(buildPath);
+        const createUploadResponse = await this.client.send(new client_device_farm_1.CreateUploadCommand({
+            name: fileName,
+            projectArn: this.deviceConfig.projectArn,
+            type: uploadType,
+            contentType: "application/octet-stream",
+        }));
+        const upload = createUploadResponse.upload;
+        if (!upload?.url || !upload?.arn) {
+            throw new Error("AWS Device Farm: Failed to create upload. Upload URL or ARN missing.");
+        }
+        const fetch = (await import("node-fetch")).default;
+        const fileStream = fs_1.default.createReadStream(buildPath);
+        const putResponse = await fetch(upload.url, {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/octet-stream",
+            },
+            body: fileStream,
+        });
+        if (!putResponse.ok) {
+            throw new Error(`AWS Device Farm: Upload failed with status ${putResponse.status} ${putResponse.statusText}`);
+        }
+        await this.waitForUploadProcessing(upload.arn);
+        logger_1.logger.log(`AWS Device Farm: Uploaded ${fileName} (${upload.arn}) successfully.`);
+        return upload.arn;
+    }
+    async waitForUploadProcessing(uploadArn) {
+        await (0, async_retry_1.default)(async (bail) => {
+            const { upload } = await this.client.send(new client_device_farm_1.GetUploadCommand({ arn: uploadArn }));
+            if (!upload) {
+                return bail(new Error("AWS Device Farm: Unable to fetch upload status after upload."));
+            }
+            if (upload.status === client_device_farm_1.UploadStatus.FAILED) {
+                return bail(new Error(`AWS Device Farm: Upload processing failed. Reason: ${upload.message}`));
+            }
+            if (upload.status === client_device_farm_1.UploadStatus.SUCCEEDED) {
+                return;
+            }
+            throw new Error(`AWS Device Farm: Upload still processing (status: ${upload.status}).`);
+        }, {
+            retries: 20,
+            minTimeout: 5_000,
+            maxTimeout: 15_000,
+        });
+    }
+    async createRemoteSession() {
+        const createSessionResponse = await this.client.send(new client_device_farm_1.CreateRemoteAccessSessionCommand({
+            projectArn: this.deviceConfig.projectArn,
+            deviceArn: this.deviceConfig.deviceArn,
+            appArn: this.uploadArn,
+            interactionMode: this.deviceConfig.interactionMode ?? "VIDEO_ONLY",
+            name: this.deviceConfig.sessionName ?? `${this.project.name}-${Date.now()}`,
+            skipAppResign: this.deviceConfig.skipAppResign ?? false,
+            configuration: this.deviceConfig.configuration,
+        }));
+        const remoteSession = createSessionResponse.remoteAccessSession;
+        if (!remoteSession?.arn) {
+            throw new Error("AWS Device Farm: Remote access session ARN was not returned.");
+        }
+        this.remoteSessionArn = remoteSession.arn;
+        const session = await this.waitForRemoteSession(remoteSession.arn);
+        if (!session.endpoint) {
+            throw new Error("AWS Device Farm: Remote access session endpoint not available.");
+        }
+        return session;
+    }
+    async waitForRemoteSession(sessionArn) {
+        return await (0, async_retry_1.default)(async (bail) => {
+            const { remoteAccessSession } = await this.client.send(new client_device_farm_1.GetRemoteAccessSessionCommand({
+                arn: sessionArn,
+            }));
+            if (!remoteAccessSession) {
+                const error = new Error("AWS Device Farm: Remote access session not found.");
+                bail(error);
+                throw error;
+            }
+            if (remoteAccessSession.status === "COMPLETED" ||
+                remoteAccessSession.status === "STOPPING") {
+                const error = new Error(`AWS Device Farm: Remote access session ended before it became RUNNING (result: ${remoteAccessSession.result ?? "unknown"}).`);
+                bail(error);
+                throw error;
+            }
+            if (remoteAccessSession.status !== "RUNNING") {
+                throw new Error(`AWS Device Farm: Waiting for remote session to be ready (status: ${remoteAccessSession.status}).`);
+            }
+            return remoteAccessSession;
+        }, {
+            retries: 30,
+            minTimeout: 10_000,
+            maxTimeout: 20_000,
+        });
+    }
+    normalizeEndpoint(session) {
+        if (!session.endpoint) {
+            throw new Error("AWS Device Farm: Remote access session endpoint missing.");
+        }
+        const url = new URL(session.endpoint);
+        if (url.protocol === "wss:") {
+            url.protocol = "https:";
+        }
+        const sanitizedPath = url.pathname.endsWith("/")
+            ? url.pathname.slice(0, -1)
+            : url.pathname;
+        if (!sanitizedPath.endsWith("/wd/hub")) {
+            url.pathname = `${sanitizedPath}/wd/hub`;
+        }
+        return url;
+    }
+    buildCapabilities(session) {
+        const isAndroid = this.platform === types_1.Platform.ANDROID;
+        const automationName = isAndroid ? "UiAutomator2" : "XCUITest";
+        const capabilities = {
+            platformName: isAndroid ? "Android" : "iOS",
+            "appium:automationName": automationName,
+            "appium:newCommandTimeout": 240,
+            "appium:noReset": false,
+        };
+        // CRITICAL: Include app capability for Appium to work
+        // This is required when appPackage/appActivity are not provided
+        if (this.uploadArn) {
+            capabilities["appium:app"] = this.uploadArn;
+        }
+        if (session.device?.name) {
+            capabilities["appium:deviceName"] = session.device.name;
+        }
+        if (session.device?.os) {
+            capabilities["appium:platformVersion"] = session.device.os;
+        }
+        if (this.appBundleId && !isAndroid) {
+            capabilities["appium:bundleId"] = this.appBundleId;
+        }
+        if (this.deviceConfig.appPackage) {
+            capabilities["appium:appPackage"] = this.deviceConfig.appPackage;
+        }
+        if (this.deviceConfig.appActivity) {
+            capabilities["appium:appActivity"] = this.deviceConfig.appActivity;
+        }
+        if (this.deviceConfig.additionalCapabilities) {
+            Object.assign(capabilities, this.deviceConfig.additionalCapabilities);
+        }
+        return capabilities;
+    }
+    async assumeRole() {
+        const roleArn = this.deviceConfig.roleArn;
+        const sessionName = this.deviceConfig.roleSessionName ?? "appwright-device-farm";
+        logger_1.logger.log(`AWS Device Farm: Assuming IAM role ${roleArn}`);
+        const stsClient = new client_sts_1.STSClient({ region: this.region });
+        try {
+            const command = new client_sts_1.AssumeRoleCommand({
+                RoleArn: roleArn,
+                RoleSessionName: sessionName,
+                ExternalId: this.deviceConfig.externalId,
+            });
+            const response = await stsClient.send(command);
+            const credentials = response.Credentials;
+            if (!credentials?.AccessKeyId ||
+                !credentials?.SecretAccessKey ||
+                !credentials?.SessionToken) {
+                throw new Error("AWS Device Farm: AssumeRole returned incomplete credentials.");
+            }
+            // Recreate the Device Farm client with assumed role credentials
+            this.client = new client_device_farm_1.DeviceFarmClient({
+                region: this.region,
+                credentials: {
+                    accessKeyId: credentials.AccessKeyId,
+                    secretAccessKey: credentials.SecretAccessKey,
+                    sessionToken: credentials.SessionToken,
+                },
+            });
+            logger_1.logger.log(`AWS Device Farm: Successfully assumed role ${roleArn}`);
+        }
+        finally {
+            stsClient.destroy();
+        }
+    }
+    static async downloadVideo(sessionArn, outputDir, fileName) {
+        if (!sessionArn) {
+            logger_1.logger.warn("AWS Device Farm: session ARN missing, skipping video download.");
+            return null;
+        }
+        const region = AWSDeviceFarmProvider.extractRegionFromArn(sessionArn) ??
+            process.env.AWS_REGION ??
+            DEFAULT_REGION;
+        const client = new client_device_farm_1.DeviceFarmClient({ region });
+        const pathToVideo = path_1.default.join(outputDir, `${fileName}.mp4`);
+        const tempPath = `${pathToVideo}.part`;
+        const dir = path_1.default.dirname(pathToVideo);
+        fs_1.default.mkdirSync(dir, { recursive: true });
+        try {
+            const downloadResult = await (0, async_retry_1.default)(async () => {
+                const artifact = await AWSDeviceFarmProvider.findVideoArtifact(client, sessionArn);
+                if (!artifact?.url) {
+                    throw new Error("AWS Device Farm: Video artifact not ready yet.");
+                }
+                if (fs_1.default.existsSync(tempPath)) {
+                    fs_1.default.rmSync(tempPath, { force: true });
+                }
+                await AWSDeviceFarmProvider.downloadFromPresignedUrl(artifact.url, tempPath);
+                if (fs_1.default.existsSync(pathToVideo)) {
+                    fs_1.default.rmSync(pathToVideo, { force: true });
+                }
+                fs_1.default.renameSync(tempPath, pathToVideo);
+                return { path: pathToVideo, contentType: "video/mp4" };
+            }, {
+                retries: 10,
+                minTimeout: 5_000,
+                maxTimeout: 15_000,
+                onRetry: (error, attempt) => {
+                    if (attempt > 3) {
+                        logger_1.logger.warn(`AWS Device Farm: retrying video download (attempt ${attempt}): ${error.message}`);
+                    }
+                },
+            });
+            return downloadResult;
+        }
+        catch (error) {
+            logger_1.logger.error("AWS Device Farm: Failed to download video.", error);
+            return null;
+        }
+        finally {
+            client.destroy();
+            if (fs_1.default.existsSync(tempPath)) {
+                try {
+                    fs_1.default.rmSync(tempPath, { force: true });
+                }
+                catch (cleanupError) {
+                    logger_1.logger.warn("AWS Device Farm: Unable to clean up temporary video file.", cleanupError);
+                }
+            }
+        }
+    }
+    static async findVideoArtifact(client, sessionArn) {
+        const artifactTypesToCheck = ["FILE", "LOG"];
+        for (const type of artifactTypesToCheck) {
+            let nextToken;
+            do {
+                const response = await client.send(new client_device_farm_1.ListArtifactsCommand({
+                    arn: sessionArn,
+                    type,
+                    nextToken,
+                }));
+                const artifacts = response.artifacts ?? [];
+                const videoArtifact = artifacts.find((artifact) => {
+                    const artifactType = artifact.type ?? "";
+                    return artifactType === "VIDEO" || artifactType === "VIDEO_LOG";
+                });
+                if (videoArtifact) {
+                    return videoArtifact;
+                }
+                nextToken = response.nextToken;
+            } while (nextToken);
+        }
+        return undefined;
+    }
+    static async downloadFromPresignedUrl(url, tempPath) {
+        const fetch = (await import("node-fetch")).default;
+        const response = await fetch(url, {
+            method: "GET",
+        });
+        if (!response.ok) {
+            throw new Error(`AWS Device Farm: Unable to fetch video artifact. Status ${response.status}`);
+        }
+        // node-fetch v3 returns a Node.js Readable stream, not a Web Stream
+        // We can directly pipe it to the file
+        const { pipeline } = await import("stream/promises");
+        const fileStream = fs_1.default.createWriteStream(tempPath);
+        // Use pipeline to handle the stream properly with automatic cleanup
+        // Cast to Readable as node-fetch body is a Node.js stream
+        await pipeline(response.body, fileStream);
+    }
+    static extractRegionFromArn(arn) {
+        const arnParts = arn.split(":");
+        if (arnParts.length >= 4 && arnParts[2] === "devicefarm") {
+            return arnParts[3] || undefined;
+        }
+        return undefined;
+    }
+    async stopRemoteSession() {
+        if (!this.remoteSessionArn) {
+            return;
+        }
+        try {
+            await this.client.send(new client_device_farm_1.StopRemoteAccessSessionCommand({
+                arn: this.remoteSessionArn,
+            }));
+        }
+        catch (error) {
+            logger_1.logger.warn(`AWS Device Farm: Failed to stop remote access session (${String(error)})`);
+        }
+    }
+}
+exports.AWSDeviceFarmProvider = AWSDeviceFarmProvider;

package/dist/providers/awsDeviceFarm/index.spec.d.ts

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

package/dist/providers/awsDeviceFarm/index.spec.d.ts.map

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