testem 3.19.1 → 3.20.1

package/lib/config.js

@@ -8,14 +8,13 @@ or `testem.json` config file.
 
 */
 
-
 const os = require('os');
 const fs = require('fs');
 const yaml = require('js-yaml');
 const log = require('./log');
 const path = require('path');
-const glob = require('glob').glob;
 const url = require('url');
+const { pathToFileURL } = url;
 const querystring = require('querystring');
 const { filter, reduce } = require('./utils/promises');
 
@@ -29,7 +28,7 @@ const _ = require('lodash');
 
 const knownBrowsers = require('./utils/known-browsers');
 const { convertToPosix } = require('./utils/posix');
-const globAsync = glob;
+const expandGlobPattern = require('./utils/expand_glob_pattern');
 
 class Config {
   constructor(appMode, progOptions, config) {
@@ -39,7 +38,7 @@ class Config {
     this.fileOptions = {};
     this.config = config || {};
     this.getters = {
-      test_page: 'getTestPage'
+      test_page: 'getTestPage',
     };
 
     if (appMode === 'dev') {
@@ -71,12 +70,33 @@ class Config {
 
       // Try all testem.json, testem.yml and testem.js
       // testem.json gets precedence
-      let files = ['testem.json', '.testem.json', '.testem.yml', 'testem.yml', 'testem.js', '.testem.js', 'testem.cjs', '.testem.cjs'];
-      return filter(files.map(this.resolveConfigPath.bind(this)), fileExists).then(matched => {
+      let files = [
+        'testem.json',
+        '.testem.json',
+        '.testem.yml',
+        'testem.yml',
+        'testem.js',
+        '.testem.js',
+        'testem.mjs',
+        '.testem.mjs',
+        'testem.cjs',
+        '.testem.cjs',
+      ];
+      return filter(
+        files.map(this.resolveConfigPath.bind(this)),
+        fileExists,
+      ).then((matched) => {
         let configFile = matched[0];
         if (matched.length > 1) {
-          let baseNames = matched.map(fileName => path.basename(fileName));
-          console.warn('Found ' + matched.length + ' config files (' + baseNames + '), using ' + baseNames[0]);
+          let baseNames = matched.map((fileName) => path.basename(fileName));
+          console.warn(
+            'Found ' +
+              matched.length +
+              ' config files (' +
+              baseNames +
+              '), using ' +
+              baseNames[0],
+          );
         }
         if (configFile) {
           this.readConfigFile(configFile, callback);
@@ -99,7 +119,7 @@ class Config {
 
   client() {
     return {
-      decycle_depth: this.get('client_decycle_depth')
+      decycle_depth: this.get('client_decycle_depth'),
     };
   }
 
@@ -122,11 +142,12 @@ class Config {
   }
 
   readConfigFile(configFile, callback) {
-    if (!configFile) { // allow empty configFile for programmatic setups
+    if (!configFile) {
+      // allow empty configFile for programmatic setups
       if (callback) {
         callback.call(this);
       }
-    } else if (configFile.match(/\.c?js$/)) {
+    } else if (configFile.match(/\.(c?js|mjs)$/)) {
       this.readJS(configFile, callback);
     } else if (configFile.match(/\.json$/)) {
       this.readJSON(configFile, callback);
@@ -140,28 +161,70 @@ class Config {
     }
   }
 
+  unwrapJsExport(exported) {
+    if (
+      exported &&
+      typeof exported === 'object' &&
+      exported.__esModule === true &&
+      Object.prototype.hasOwnProperty.call(exported, 'default')
+    ) {
+      return exported.default;
+    }
+    return exported;
+  }
+
+  loadJsExportedConfig(absPath) {
+    const ext = path.extname(absPath);
+    if (ext === '.cjs') {
+      return Promise.resolve(this.unwrapJsExport(require(absPath)));
+    }
+    if (ext === '.mjs') {
+      return import(pathToFileURL(absPath).href).then((mod) =>
+        mod.default !== undefined ? mod.default : mod,
+      );
+    }
+    try {
+      return Promise.resolve(this.unwrapJsExport(require(absPath)));
+    } catch (e) {
+      if (e.code === 'ERR_REQUIRE_ESM') {
+        return import(pathToFileURL(absPath).href).then((mod) =>
+          mod.default !== undefined ? mod.default : mod,
+        );
+      }
+      throw e;
+    }
+  }
+
   readJS(configFile, callback) {
-    let exportedConfig = require(this.resolveConfigPath(configFile));
-    if (typeof exportedConfig === 'function') {
-      Promise.resolve(exportedConfig()).then(obj => {
-        this.fileOptions = obj;
+    const absPath = this.resolveConfigPath(configFile);
+    this.loadJsExportedConfig(absPath)
+      .then((exportedConfig) => {
+        if (typeof exportedConfig === 'function') {
+          return Promise.resolve(exportedConfig()).then((obj) => {
+            this.fileOptions = obj;
+          });
+        }
+        this.fileOptions = exportedConfig;
+      })
+      .catch((err) => {
+        log.error(err);
+      })
+      .then(() => {
         if (callback) {
           callback.call(this);
         }
       });
-    } else {
-      this.fileOptions = exportedConfig;
-      if (callback) {
-        callback.call(this);
-      }
-    }
   }
 
   readYAML(configFile, callback) {
-    return fs.promises.readFile(configFile)
-      .then(data => {
-        this.fileOptions = yaml.load(String(data));
-      }, () => {})
+    return fs.promises
+      .readFile(configFile)
+      .then(
+        (data) => {
+          this.fileOptions = yaml.load(String(data));
+        },
+        () => {},
+      )
       .then(() => {
         if (callback) {
           callback.call(this);
@@ -170,11 +233,15 @@ class Config {
   }
 
   readJSON(configFile, callback) {
-    return fs.promises.readFile(configFile)
-      .then(data => {
-        this.fileOptions = JSON.parse(data.toString());
-        this.progOptions.file = configFile;
-      }, () => {})
+    return fs.promises
+      .readFile(configFile)
+      .then(
+        (data) => {
+          this.fileOptions = JSON.parse(data.toString());
+          this.progOptions.file = configFile;
+        },
+        () => {},
+      )
       .then(() => {
         if (callback) {
           callback.call(this);
@@ -196,11 +263,12 @@ class Config {
 
     let urlObj = url.parse(urlString);
     let outputQueryParams = querystring.parse(urlObj.query) || {};
-    Object.keys(queryParamsObj).forEach(param => {
+    Object.keys(queryParamsObj).forEach((param) => {
       outputQueryParams[param] = queryParamsObj[param];
     });
     urlObj.query = outputQueryParams;
-    urlObj.search = querystring.stringify(outputQueryParams)
+    urlObj.search = querystring
+      .stringify(outputQueryParams)
       .replace(/=&/g, '&')
       .replace(/=$/, '');
     urlObj.path = urlObj.pathname + urlObj.search;
@@ -215,20 +283,32 @@ class Config {
       testPage = [testPage];
     }
 
-    return testPage.map(page => this.mergeUrlAndQueryParams(page, queryParams));
+    return testPage.map((page) =>
+      this.mergeUrlAndQueryParams(page, queryParams),
+    );
   }
 
   getConfigProperty(key) {
     if (this.config && key in this.config) {
       return this.config[key];
     }
-    if (key in this.progOptions && typeof this.progOptions[key] !== 'undefined') {
+    if (
+      key in this.progOptions &&
+      typeof this.progOptions[key] !== 'undefined'
+    ) {
       return this.progOptions[key];
     }
-    if (key in this.fileOptions && typeof this.fileOptions[key] !== 'undefined') {
+    if (
+      key in this.fileOptions &&
+      typeof this.fileOptions[key] !== 'undefined'
+    ) {
       return this.fileOptions[key];
     }
-    if (this.defaultOptions && key in this.defaultOptions && typeof this.defaultOptions[key] !== 'undefined') {
+    if (
+      this.defaultOptions &&
+      key in this.defaultOptions &&
+      typeof this.defaultOptions[key] !== 'undefined'
+    ) {
       return this.defaultOptions[key];
     }
     if (key in this.defaults) {
@@ -264,27 +344,35 @@ class Config {
 
   getAvailableLaunchers(cb) {
     let browsers = knownBrowsers(process.platform, this);
-    browser_launcher.getAvailableBrowsers(this, browsers, (err, availableBrowsers) => {
-      if (err) {
-        return cb(err);
-      }
+    browser_launcher.getAvailableBrowsers(
+      this,
+      browsers,
+      (err, availableBrowsers) => {
+        if (err) {
+          return cb(err);
+        }
 
-      let availableLaunchers = {};
-      availableBrowsers.forEach(browser => {
-        let newLauncher = new LauncherFactory(browser.name, browser, this);
-        availableLaunchers[browser.name.toLowerCase()] = newLauncher;
-      });
+        let availableLaunchers = {};
+        availableBrowsers.forEach((browser) => {
+          let newLauncher = new LauncherFactory(browser.name, browser, this);
+          availableLaunchers[browser.name.toLowerCase()] = newLauncher;
+        });
 
-      // add custom launchers
-      let customLaunchers = this.get('launchers');
-      if (customLaunchers) {
-        for (let name in customLaunchers) {
-          let newLauncher = new LauncherFactory(name, customLaunchers[name], this);
-          availableLaunchers[name.toLowerCase()] = newLauncher;
+        // add custom launchers
+        let customLaunchers = this.get('launchers');
+        if (customLaunchers) {
+          for (let name in customLaunchers) {
+            let newLauncher = new LauncherFactory(
+              name,
+              customLaunchers[name],
+              this,
+            );
+            availableLaunchers[name.toLowerCase()] = newLauncher;
+          }
         }
-      }
-      cb(null, availableLaunchers);
-    });
+        cb(null, availableLaunchers);
+      },
+    );
   }
 
   getLaunchers(cb) {
@@ -310,7 +398,7 @@ class Config {
     let skip = this.get('skip');
     if (skip) {
       skip = skip.toLowerCase().split(',');
-      launchers = launchers.filter(name => skip.indexOf(name) === -1);
+      launchers = launchers.filter((name) => skip.indexOf(name) === -1);
     }
     return launchers;
   }
@@ -320,7 +408,7 @@ class Config {
     let wanted = this.getWantedLauncherNames(available);
     let err = null;
 
-    wanted.forEach(name => {
+    wanted.forEach((name) => {
       let launcher = available[name.toLowerCase()];
       if (!launcher) {
         if (this.appMode === 'dev' || this.get('ignore_missing_launchers')) {
@@ -328,10 +416,12 @@ class Config {
         } else {
           err = new Error(
             'Launcher ' +
-            name +
-            ' not found. Not installed? Available: ' +
-            Object.keys(available).map(elm => `"${elm}"`).join(', ') +
-            '.'
+              name +
+              ' not found. Not installed? Available: ' +
+              Object.keys(available)
+                .map((elm) => `"${elm}"`)
+                .join(', ') +
+              '.',
           );
         }
       } else {
@@ -343,38 +433,62 @@ class Config {
 
   printLauncherInfo() {
     this.getAvailableLaunchers((err, launchers) => {
-      let launch_in_dev = (this.get('launch_in_dev') || [])
-        .map(s => s.toLowerCase());
+      let launch_in_dev = (this.get('launch_in_dev') || []).map((s) =>
+        s.toLowerCase(),
+      );
       let launch_in_ci = this.get('launch_in_ci');
       if (launch_in_ci) {
-        launch_in_ci = launch_in_ci.map(s => s.toLowerCase());
+        launch_in_ci = launch_in_ci.map((s) => s.toLowerCase());
       }
-      launchers = Object.keys(launchers).map(k => launchers[k]);
+      launchers = Object.keys(launchers).map((k) => launchers[k]);
 
-      const launcherColumnWidth = launchers.reduce((acc, current) => acc > current.name.length ? acc : current.name.length, 0);
+      const launcherColumnWidth = launchers.reduce(
+        (acc, current) =>
+          acc > current.name.length ? acc : current.name.length,
+        0,
+      );
       const launcherTitle = 'Launcher'.padEnd(launcherColumnWidth, ' ');
       const launcherTitleDivider = ''.padEnd(launcherColumnWidth, '-');
 
-      console.log('Have ' + launchers.length + ' launchers available; auto-launch info displayed on the right.');
+      console.log(
+        'Have ' +
+          launchers.length +
+          ' launchers available; auto-launch info displayed on the right.',
+      );
       console.log(); // newline
       console.log(`${launcherTitle}  Type          CI  Dev`);
       console.log(`${launcherTitleDivider}  ------------  --  ---`);
-      console.log(launchers.map(launcher => {
-        let protocol = launcher.settings.protocol;
-        let kind = protocol === 'browser' ?
-          'browser' : (
-            protocol === 'tap' ?
-              'process(TAP)' : 'process');
-        let dev = launch_in_dev.indexOf(launcher.name.toLowerCase()) !== -1 ?
-          Chars.mark :
-          ' ';
-        let ci = !launch_in_ci || launch_in_ci.indexOf(launcher.name.toLowerCase()) !== -1 ?
-          Chars.mark :
-          ' ';
-        return (pad(launcher.name, launcherColumnWidth + 2, ' ', 1) +
-          pad(kind, 12, ' ', 1) +
-          '  ' + ci + '    ' + dev + '      ');
-      }).join('\n'));
+      console.log(
+        launchers
+          .map((launcher) => {
+            let protocol = launcher.settings.protocol;
+            let kind =
+              protocol === 'browser'
+                ? 'browser'
+                : protocol === 'tap'
+                  ? 'process(TAP)'
+                  : 'process';
+            let dev =
+              launch_in_dev.indexOf(launcher.name.toLowerCase()) !== -1
+                ? Chars.mark
+                : ' ';
+            let ci =
+              !launch_in_ci ||
+              launch_in_ci.indexOf(launcher.name.toLowerCase()) !== -1
+                ? Chars.mark
+                : ' ';
+            return (
+              pad(launcher.name, launcherColumnWidth + 2, ' ', 1) +
+              pad(kind, 12, ' ', 1) +
+              '  ' +
+              ci +
+              '    ' +
+              dev +
+              '      '
+            );
+          })
+          .join('\n'),
+      );
     });
   }
 
@@ -389,7 +503,7 @@ class Config {
     // Filter glob < 6 negation patterns to still support them
     // See https://github.com/isaacs/node-glob/tree/3f883c43#comments-and-negation
     let positiveWants = [];
-    want.forEach(patternEntry => {
+    want.forEach((patternEntry) => {
       let pattern = isa(patternEntry, String) ? patternEntry : patternEntry.src;
       if (pattern.indexOf('!') === 0) {
         return dontWant.push(pattern.substring(1));
@@ -398,33 +512,51 @@ class Config {
       positiveWants.push(patternEntry);
     });
 
-    dontWant = dontWant.map(p => p ? this.resolvePath(p) : p);
-    return reduce(positiveWants, (allThatIWant, patternEntry) => {
-      let pattern = isa(patternEntry, String) ? patternEntry : patternEntry.src;
-      let attrs = patternEntry.attrs || [];
-      let patternUrl = url.parse(pattern);
-
-      if (patternUrl.protocol === 'file:') {
-        pattern = patternUrl.hostname + patternUrl.path;
-      } else if (patternUrl.protocol) {
-        return allThatIWant.concat({ src: pattern, attrs: attrs });
-      }
+    dontWant = dontWant.map((p) => (p ? this.resolvePath(p) : p));
+    return reduce(
+      positiveWants,
+      (allThatIWant, patternEntry) => {
+        let pattern = isa(patternEntry, String)
+          ? patternEntry
+          : patternEntry.src;
+        let attrs = patternEntry.attrs || [];
+        let patternUrl = url.parse(pattern);
+
+        if (patternUrl.protocol === 'file:') {
+          pattern = patternUrl.hostname + patternUrl.path;
+        } else if (patternUrl.protocol) {
+          return allThatIWant.concat({ src: pattern, attrs: attrs });
+        }
 
-      return globAsync(convertToPosix(this.resolvePath(pattern)), { ignore: dontWant.map(convertToPosix) })
-        .then(files => files.sort())
-        .then(files => allThatIWant.concat(files.map(f => {
-          f = this.reverseResolvePath(f);
-          return { src: f, attrs: attrs };
-        })));
-    }, [])
-      .then(result => _.uniqBy(result, 'src'))
-      .then(result => {
-        if (callback) { callback(null, result); }
-        return result;
-      }, err => {
-        if (callback) { callback(err); }
-        throw err;
-      });
+        return expandGlobPattern(
+          convertToPosix(this.resolvePath(pattern)),
+          dontWant.map(convertToPosix),
+        ).then((files) =>
+          allThatIWant.concat(
+            files.map((f) => {
+              f = this.reverseResolvePath(f);
+              return { src: f, attrs: attrs };
+            }),
+          ),
+        );
+      },
+      [],
+    )
+      .then((result) => _.uniqBy(result, 'src'))
+      .then(
+        (result) => {
+          if (callback) {
+            callback(null, result);
+          }
+          return result;
+        },
+        (err) => {
+          if (callback) {
+            callback(err);
+          }
+          throw err;
+        },
+      );
   }
 
   getSrcFiles(callback) {
@@ -440,10 +572,10 @@ class Config {
     return this.getFileSet(want, dontWant, callback);
   }
 
-
   getServeFiles(callback) {
     let want = this.get('serve_files') || this.get('src_files') || '*.js';
-    let dontWant = this.get('serve_files_ignore') || this.get('src_files_ignore') || '';
+    let dontWant =
+      this.get('serve_files_ignore') || this.get('src_files_ignore') || '';
     return this.getFileSet(want, dontWant, callback);
   }
 
@@ -471,13 +603,19 @@ class Config {
         return;
       }
       if (o.options) {
-        o.options.forEach(o => {
+        o.options.forEach((o) => {
           options.push(o.name());
         });
       }
       getOptions(o.parent);
     }
-    getOptions(this.progOptions);
+    const progOpts = this.progOptions;
+    // In subcommand modes, progOptions is a plain object from optsWithGlobals() with
+    // a _commander reference pointing to the Command instance for option enumeration.
+    // In dev mode (no subcommand), progOptions is the Commander program object directly.
+    getOptions(
+      progOpts && progOpts._commander ? progOpts._commander : progOpts,
+    );
     return options;
   }
 
@@ -497,16 +635,16 @@ class Config {
       ret[key] = this.config[key];
     }
 
-    const replaceSlashes = f => ({
+    const replaceSlashes = (f) => ({
       src: f.src.replace(/\\/g, '/'),
-      attrs: f.attrs
+      attrs: f.attrs,
     });
 
     try {
       const [serveFiles, cssFiles, footerScripts] = await Promise.all([
         this.getServeFiles(),
         this.getCSSFiles(),
-        this.getFooterScripts()
+        this.getFooterScripts(),
       ]);
 
       ret.serve_files = serveFiles.map(replaceSlashes);
@@ -543,10 +681,13 @@ Config.prototype.defaults = {
   client_decycle_depth: 5,
   socket_heartbeat_timeout() {
     let browserDisconnectTimeout = this.get('browser_disconnect_timeout');
-    let defaultBrowserDisconnectTimeout = this.defaults.browser_disconnect_timeout;
+    let defaultBrowserDisconnectTimeout =
+      this.defaults.browser_disconnect_timeout;
 
-    return (browserDisconnectTimeout !== defaultBrowserDisconnectTimeout) ? browserDisconnectTimeout : 5;
-  }
+    return browserDisconnectTimeout !== defaultBrowserDisconnectTimeout
+      ? browserDisconnectTimeout
+      : 5;
+  },
 };
 
 module.exports = Config;