@percy/env 1.32.11-beta.1 → 1.32.11-beta.2

package/dist/environment.js

@@ -1,5 +1,14 @@
+import os from 'os';
 import { getCommitData, getJenkinsSha, github } from './utils.js';
 import logger from '@percy/logger';
+
+// machine ids are capped and restricted to header-safe characters on both
+// sides; percy-api rejects anything longer or outside this alphabet
+const MACHINE_ID_MAX_LENGTH = 128;
+function machineToken(value) {
+  if (value == null || value === '') return null;
+  return String(value).replace(/[^A-Za-z0-9._-]/g, '-');
+}
 export class PercyEnv {
   constructor(vars = process.env) {
     this.vars = vars;
@@ -384,6 +393,70 @@ export class PercyEnv {
     return !!partial && partial !== '0';
   }
 
+  // machine identity for slow-build diagnostics (dead-CI-machine detection on
+  // parallel builds). percy-api validates all of these server-side and may
+  // discard any of them. Deliberately excluded from the getter debug logging
+  // below (like `token`) — env debug logs are uploaded with build logs, and
+  // hostnames should not ride along in them.
+  get machine() {
+    let hostname = null;
+    try {
+      hostname = os.hostname() || null;
+    } catch {
+      hostname = null;
+    }
+
+    // the per-shard index for providers that can run several shards on one
+    // host; without it every shard on that host would share a machine id and a
+    // dead shard would look alive as long as any sibling kept uploading
+    let index = null;
+    let runUrl = null;
+    switch (this.ci) {
+      case 'circle':
+        index = this.vars.CIRCLE_NODE_INDEX;
+        runUrl = this.vars.CIRCLE_BUILD_URL;
+        break;
+      case 'buildkite':
+        index = this.vars.BUILDKITE_PARALLEL_JOB;
+        // the build url is shared by every parallel job; the job id anchor is
+        // what lets the "stopped responding" link land on the dead agent's log
+        runUrl = this.vars.BUILDKITE_BUILD_URL && this.vars.BUILDKITE_JOB_ID ? `${this.vars.BUILDKITE_BUILD_URL}#${this.vars.BUILDKITE_JOB_ID}` : this.vars.BUILDKITE_BUILD_URL;
+        break;
+      case 'github':
+        runUrl = this.vars.GITHUB_SERVER_URL && this.vars.GITHUB_REPOSITORY && this.vars.GITHUB_RUN_ID ? `${this.vars.GITHUB_SERVER_URL}/${this.vars.GITHUB_REPOSITORY}/actions/runs/${this.vars.GITHUB_RUN_ID}` : null;
+        break;
+      case 'gitlab':
+        index = this.vars.CI_NODE_INDEX;
+        runUrl = this.vars.CI_JOB_URL;
+        break;
+      case 'jenkins':
+      case 'jenkins-prb':
+        index = this.vars.EXECUTOR_NUMBER;
+        break;
+    }
+
+    // stable id: sanitized hostname, suffixed with the sanitized shard index.
+    // The id travels as an HTTP header value on every snapshot POST, so every
+    // part of it must be header-safe — an unsanitized index with a stray
+    // newline would reject the whole upload.
+    let id = machineToken(hostname);
+    let shard = machineToken(index);
+    if (id && shard) id = `${id}.n${shard}`;
+    if (id) id = id.slice(0, MACHINE_ID_MAX_LENGTH);
+    // a hostname with no ASCII alphanumerics sanitizes to dashes alone, which
+    // identifies nothing and would collide across hosts — better no id at all
+    if (id && !/[A-Za-z0-9]/.test(id)) id = null;
+    return {
+      id,
+      hostname,
+      runUrl: runUrl || null,
+      // which CI product the agent belongs to ("jenkins", "buildkite", ...);
+      // percy-web maps it to a display name in the stopped-responding copy.
+      // The generic CI/unknown marker is not a product and is dropped.
+      platform: this.ci && this.ci !== 'CI/unknown' ? this.ci : null
+    };
+  }
+
   // percy token
   get token() {
     return this.vars.PERCY_TOKEN || null;
@@ -422,7 +495,9 @@ Object.defineProperties(PercyEnv.prototype, Object.entries(Object.getOwnProperty
       Object.defineProperty(this, key, {
         value
       });
-      if (key !== 'token') {
+      // `machine` carries a hostname and these debug logs are uploaded
+      // with build logs — keep it out, like the token.
+      if (key !== 'token' && key !== 'machine') {
         this.log.debug(`Detected ${key} as ${JSON.stringify(value)}`);
       }
       return value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/env",
-  "version": "1.32.11-beta.1",
+  "version": "1.32.11-beta.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -32,7 +32,7 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/logger": "1.32.11-beta.1"
+    "@percy/logger": "1.32.11-beta.2"
   },
-  "gitHead": "c72c103d81636a59792393576a82c9471686c3c0"
+  "gitHead": "a05b0ac1efc0d136fa15c2330b55e1e207c6e797"
 }