@samsara-dev/appwright 0.7.0 → 0.7.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # appwright
 
+## 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/package.json

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