Add debug; refactor a bit to make it easier

.github/workflows/ci.yml

@@ -70,10 +70,10 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: yarn install --frozen-lockfile --non-interactive
-      - run: yarn browserstack:connect
-      - run: yarn test:ember:browserstack
-      - run: yarn browserstack:results
-      - run: yarn browserstack:disconnect
+      - run: DEBUG=ember-cli-browserstack* yarn browserstack:connect
+      - run: DEBUG=ember-cli-browserstack* yarn test:ember:browserstack
+      - run: DEBUG=ember-cli-browserstack* yarn browserstack:results
+      - run: DEBUG=ember-cli-browserstack* yarn browserstack:disconnect
 
   publish:
     name: Publish to npm
@@ -98,4 +98,4 @@ jobs:
       - name: publish to npm
         run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

lib/commands/browserstack-results.js

@@ -1,4 +1,5 @@
 const buildNameFromEnv = require('../utils/build-name-from-env');
+const debug = require('debug')('ember-cli-browserstack:browserstack-results');
 
 module.exports = {
   name: 'browserstack:results',
@@ -8,7 +9,11 @@ module.exports = {
   availableOptions: [{ name: 'build', type: String }],
 
   run: function (commandOptions) {
+    if (commandOptions.build) {
+      debug('build name passed as option');
+    }
     let buildName = commandOptions.build || buildNameFromEnv();
+    debug('build name: %l', buildName);
     if (!buildName) {
       this.ui.writeLine('A build name is required to find results');
       return;

lib/tasks/launch-browserstack-browser.js

@@ -2,10 +2,16 @@
 /* eslint-disable no-console, no-process-exit */
 const buildNameFromEnv = require('../utils/build-name-from-env');
 const localIdentifier = require('../utils/local-identifier');
+const debug = require('debug')(
+  'ember-cli-browserstack:launch-browserstack-browser'
+);
 
 let build = buildNameFromEnv();
 
+debug('Build Name: %l', build);
+
 let name = require('crypto').randomBytes(10).toString('hex');
+debug('Name: %l', name);
 
 let argv = require('yargs')
   .option('os', {
@@ -113,6 +119,10 @@ for (let i in settings) {
   }
 }
 
+debug(
+  'Creating BrowserStack worker with settings %s',
+  JSON.stringify(settings)
+);
 client.createWorker(settings, function (error, worker) {
   if (error) {
     console.log(error);

lib/tasks/start-browserstack-tunnel.js

@@ -1,5 +1,8 @@
 const RSVP = require('rsvp');
 const fs = require('fs');
+const debug = require('debug')(
+  'ember-cli-browserstack:start-browserstack-tunnel'
+);
 const localIdentifier = require('../utils/local-identifier');
 
 module.exports = function (ui) {
@@ -13,6 +16,11 @@ module.exports = function (ui) {
 
   options.localIdentifier = localIdentifier();
 
+  debug(
+    'Starting BrowserStack Tunnel with localIdentifier: %l',
+    options.localIdentifier
+  );
+
   let bsLocal = new browserstackLocal.Local();
 
   return new RSVP.Promise(function (resolve, reject) {
@@ -21,6 +29,7 @@ module.exports = function (ui) {
         reject(error);
       }
 
+      debug('BrowserStack Tunnel PID: %l', bsLocal.pid);
       writePidFile(bsLocal.pid);
       ui.writeLine('BrowserStack Tunnel Connected');
       resolve();

lib/tasks/stop-browserstack-tunnel.js

@@ -1,4 +1,7 @@
 const fs = require('fs');
+const debug = require('debug')(
+  'ember-cli-browserstack:stop-browserstack-tunnel'
+);
 
 module.exports = function (ui) {
   let pidFile = 'browserstack-local.pid';
@@ -12,7 +15,9 @@ module.exports = function (ui) {
     return;
   }
   if (pid) {
+    debug('Stopping BrowserStack Tunnel with PID: %l', pid);
     process.kill(pid, 'SIGINT');
   }
+  debug('Removing BrowserStack Tunnel PID file');
   fs.unlinkSync(pidFile);
 };

lib/utils/build-name-from-env.js

@@ -1,36 +1,66 @@
 const crypto = require('crypto');
+const debug = require('debug')('ember-cli-browserstack:build-name-from-env');
 
 module.exports = function () {
+  const env = environmentVariables();
+
+  debug('environment variables: %o', env);
+
   let buildDesc =
-    process.env.BROWSERSTACK_BUILD_NAME ||
-    process.env.TRAVIS_JOB_NUMBER ||
-    process.env.BITBUCKET_BUILD_NUMBER ||
-    process.env.CIRCLE_BUILD_NUM ||
-    buildNameForGithubActions() ||
-    process.env.CI_JOB_ID ||
+    env.BROWSERSTACK_BUILD_NAME ||
+    env.TRAVIS_JOB_NUMBER ||
+    env.BITBUCKET_BUILD_NUMBER ||
+    env.CIRCLE_BUILD_NUM ||
+    buildNameForGithubActions({
+      runId: env.GITHUB_RUN_ID,
+      job: env.GITHUB_JOB,
+      workflow: env.GITHUB_WORKFLOW,
+      ref: env.GITHUB_REF,
+      headRef: env.GITHUB_HEAD_REF,
+    }) ||
+    env.CI_JOB_ID ||
     crypto.randomBytes(10).toString('hex');
 
-  let prefix = process.env.BROWSERSTACK_BUILD_NAME_PREFIX;
+  let prefix = env.BROWSERSTACK_BUILD_NAME_PREFIX;
   if (buildDesc && prefix) {
     return `${prefix}_${buildDesc}`;
   }
   return buildDesc;
 };
 
-function buildNameForGithubActions() {
-  if (process.env.GITHUB_RUN_ID) {
-    let runDesc = githubRunDesc();
-    let workflow = process.env.GITHUB_WORKFLOW.replace(/\s/g, '_');
-    return `${runDesc}_${workflow}_${process.env.GITHUB_RUN_ID}_${process.env.GITHUB_JOB}`;
+function buildNameForGithubActions({ runId, job, workflow, ref, headRef }) {
+  if (runId) {
+    let runDesc = githubRunDesc(ref, headRef);
+    let workflowEscaped = workflow.replace(/\s/g, '_');
+    const githubActionsBuildName = `${runDesc}_${workflowEscaped}_${runId}_${job}`;
+    debug('github actions build name: %s', githubActionsBuildName);
+    return githubActionsBuildName;
   }
 }
 
-function githubRunDesc() {
-  if (process.env.GITHUB_HEAD_REF) {
-    let matches = /(\d+)/.exec(process.env.GITHUB_REF);
+function githubRunDesc(ref, headRef) {
+  if (headRef) {
+    let matches = /(\d+)/.exec(ref);
     let pr = matches[1];
     return `PR_${pr}`;
   } else {
-    return process.env.GITHUB_REF.replace('refs/heads/', '');
+    return ref.replace('refs/heads/', '');
   }
 }
+
+function environmentVariables() {
+  return {
+    BROWSERSTACK_BUILD_NAME: process.env.BROWSERSTACK_BUILD_NAME,
+    BROWSERSTACK_BUILD_NAME_PREFIX: process.env.BROWSERSTACK_BUILD_NAME_PREFIX,
+    TRAVIS_JOB_NUMBER: process.env.TRAVIS_JOB_NUMBER,
+    BITBUCKET_BUILD_NUMBER: process.env.BITBUCKET_BUILD_NUMBER,
+    CIRCLE_BUILD_NUM: process.env.CIRCLE_BUILD_NUM,
+    CI_JOB_ID: process.env.CI_JOB_ID,
+    GITHUB_RUN_ID: process.env.GITHUB_RUN_ID,
+    GITHUB_WORKFLOW: process.env.GITHUB_WORKFLOW,
+    GITHUB_REF: process.env.GITHUB_REF,
+    GITHUB_HEAD_REF: process.env.GITHUB_HEAD_REF,
+    GITHUB_RUN_NUMBER: process.env.GITHUB_RUN_NUMBER,
+    GITHUB_JOB: process.env.GITHUB_JOB,
+  };
+}

package.json

@@ -38,6 +38,7 @@
   "dependencies": {
     "browserstack": "^1.6.1",
     "browserstack-local": "^1.4.8",
+    "debug": "^4.3.4",
     "rsvp": "^4.8.5",
     "yargs": "^17.1.1"
   },

yarn.lock

@@ -5047,6 +5047,13 @@ debug@^4.0.0, debug@^4.0.1, debug@^4.1.1:
   dependencies:
     ms "^2.1.1"
 
+debug@^4.3.4:
+  version "4.3.4"
+  resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865"
+  integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==
+  dependencies:
+    ms "2.1.2"
+
 decamelize@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"