cypress 4.12.1 → 5.3.0

package/lib/cli.js

@@ -55,6 +55,10 @@ function unknownOption(flag) {
 
 commander.Command.prototype.unknownOption = unknownOption;
 
+var coerceFalseOrString = function coerceFalseOrString(arg) {
+  return arg !== 'false' ? arg : false;
+};
+
 var coerceFalse = function coerceFalse(arg) {
   return arg !== 'false';
 };
@@ -196,7 +200,7 @@ var castCypressRunOptions = function castCypressRunOptions(opts) {
   // boolean arguments
   var result = R.evolve({
     port: coerceAnyStringToInt,
-    configFile: coerceFalse
+    configFile: coerceFalseOrString
   })(opts);
   return result;
 };

package/lib/errors.js

@@ -121,7 +121,7 @@ function _templateObject6() {
 }
 
 function _templateObject5() {
-  var data = _taggedTemplateLiteral(["\n\n    Reasons this may happen:\n\n    - node was installed as 'root' or with 'sudo'\n    - the cypress npm package as 'root' or with 'sudo'\n\n    Please check that you have the appropriate user permissions.\n  "], ["\\n\n    Reasons this may happen:\n\n    - node was installed as 'root' or with 'sudo'\n    - the cypress npm package as 'root' or with 'sudo'\n\n    Please check that you have the appropriate user permissions.\n  "]);
+  var data = _taggedTemplateLiteral(["\n\n    Reasons this may happen:\n\n    - node was installed as 'root' or with 'sudo'\n    - the cypress npm package as 'root' or with 'sudo'\n\n    Please check that you have the appropriate user permissions.\n\n    You can also try clearing the cache with 'cypress cache clear' and reinstalling. \n  "], ["\\n\n    Reasons this may happen:\n\n    - node was installed as 'root' or with 'sudo'\n    - the cypress npm package as 'root' or with 'sudo'\n\n    Please check that you have the appropriate user permissions.\n\n    You can also try clearing the cache with 'cypress cache clear' and reinstalling. \n  "]);
 
   _templateObject5 = function _templateObject5() {
     return data;

package/lib/tasks/install.js

@@ -1,5 +1,7 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
 function _templateObject7() {
   var data = _taggedTemplateLiteral(["\n          ", " Warning: Forcing a binary version different than the default.\n\n            The CLI expected to install version: ", "\n\n            Instead we will install version: ", "\n\n            These versions may not work properly together.\n        "]);
 
@@ -20,6 +22,18 @@ function _templateObject6() {
   return data;
 }
 
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
 function _templateObject5() {
   var data = _taggedTemplateLiteral(["\n    Failed to access ", ":\n\n    ", "\n    "]);
 
@@ -72,10 +86,32 @@ function _templateObject() {
 
 function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 
+function _wrapRegExp(re, groups) { _wrapRegExp = function _wrapRegExp(re, groups) { return new BabelRegExp(re, undefined, groups); }; var _RegExp = _wrapNativeSuper(RegExp); var _super = RegExp.prototype; var _groups = new WeakMap(); function BabelRegExp(re, flags, groups) { var _this = _RegExp.call(this, re, flags); _groups.set(_this, groups || _groups.get(re)); return _this; } _inherits(BabelRegExp, _RegExp); BabelRegExp.prototype.exec = function (str) { var result = _super.exec.call(this, str); if (result) result.groups = buildGroups(result, this); return result; }; BabelRegExp.prototype[Symbol.replace] = function (str, substitution) { if (typeof substitution === "string") { var groups = _groups.get(this); return _super[Symbol.replace].call(this, str, substitution.replace(/\$<([^>]+)>/g, function (_, name) { return "$" + groups[name]; })); } else if (typeof substitution === "function") { var _this = this; return _super[Symbol.replace].call(this, str, function () { var args = []; args.push.apply(args, arguments); if (_typeof(args[args.length - 1]) !== "object") { args.push(buildGroups(args, _this)); } return substitution.apply(this, args); }); } else { return _super[Symbol.replace].call(this, str, substitution); } }; function buildGroups(result, re) { var g = _groups.get(re); return Object.keys(g).reduce(function (groups, name) { groups[name] = result[g[name]]; return groups; }, Object.create(null)); } return _wrapRegExp.apply(this, arguments); }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _wrapNativeSuper(Class) { var _cache = typeof Map === "function" ? new Map() : undefined; _wrapNativeSuper = function _wrapNativeSuper(Class) { if (Class === null || !_isNativeFunction(Class)) return Class; if (typeof Class !== "function") { throw new TypeError("Super expression must either be null or a function"); } if (typeof _cache !== "undefined") { if (_cache.has(Class)) return _cache.get(Class); _cache.set(Class, Wrapper); } function Wrapper() { return _construct(Class, arguments, _getPrototypeOf(this).constructor); } Wrapper.prototype = Object.create(Class.prototype, { constructor: { value: Wrapper, enumerable: false, writable: true, configurable: true } }); return _setPrototypeOf(Wrapper, Class); }; return _wrapNativeSuper(Class); }
+
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+
+function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
 var _ = require('lodash');
 
 var os = require('os');
 
+var url = require('url');
+
 var path = require('path');
 
 var chalk = require('chalk');
@@ -109,6 +145,102 @@ var _require2 = require('../errors'),
     throwFormErrorText = _require2.throwFormErrorText,
     errors = _require2.errors;
 
+var getNpmArgv = function getNpmArgv() {
+  var json = process.env.npm_config_argv;
+
+  if (!json) {
+    return;
+  }
+
+  debug('found npm argv json %o', json);
+
+  try {
+    return JSON.parse(json).original || [];
+  } catch (e) {
+    return [];
+  }
+}; // attempt to discover the version specifier used to install Cypress
+// for example: "^5.0.0", "https://cdn.cypress.io/...", ...
+
+
+var getVersionSpecifier = function getVersionSpecifier() {
+  var startDir = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : path.resolve(__dirname, '../..');
+  var argv = getNpmArgv();
+
+  if (argv) {
+    var tgz = _.find(argv, function (t) {
+      return t.endsWith('cypress.tgz');
+    });
+
+    if (tgz) {
+      return tgz;
+    }
+  }
+
+  var getVersionSpecifierFromPkg = function getVersionSpecifierFromPkg(dir) {
+    debug('looking for versionSpecifier %o', {
+      dir: dir
+    });
+
+    var tryParent = function tryParent() {
+      var parentPath = path.resolve(dir, '..');
+
+      if (parentPath === dir) {
+        debug('reached FS root with no versionSpecifier found');
+        return;
+      }
+
+      return getVersionSpecifierFromPkg(parentPath);
+    };
+
+    return fs.readJSON(path.join(dir, 'package.json'))["catch"](function () {
+      return {};
+    }).then(function (pkg) {
+      var specifier = _.chain(['dependencies', 'devDependencies', 'optionalDependencies']).map(function (prop) {
+        return _.get(pkg, "".concat(prop, ".cypress"));
+      }).compact().first().value();
+
+      return specifier || tryParent();
+    });
+  }; // recurse through parent directories until package.json with `cypress` is found
+
+
+  return getVersionSpecifierFromPkg(startDir).then(function (versionSpecifier) {
+    debug('finished looking for versionSpecifier', {
+      versionSpecifier: versionSpecifier
+    });
+    return versionSpecifier;
+  });
+};
+
+var betaNpmUrlRe = /*#__PURE__*/_wrapRegExp(/^\/beta\/npm\/([\.0-9]+)\/([\0-\.0-\uFFFF]+)\/cypress\.tgz$/, {
+  version: 1,
+  artifactSlug: 2
+}); // convert a prerelease NPM package .tgz URL to the corresponding binary .zip URL
+
+
+var getBinaryUrlFromPrereleaseNpmUrl = function getBinaryUrlFromPrereleaseNpmUrl(npmUrl) {
+  var parsed;
+
+  try {
+    parsed = url.parse(npmUrl);
+  } catch (e) {
+    return;
+  }
+
+  var matches = betaNpmUrlRe.exec(parsed.pathname);
+
+  if (parsed.hostname !== 'cdn.cypress.io' || !matches) {
+    return;
+  }
+
+  var _matches$groups = matches.groups,
+      version = _matches$groups.version,
+      artifactSlug = _matches$groups.artifactSlug;
+  parsed.pathname = "/beta/binary/".concat(version, "/").concat(os.platform(), "-").concat(os.arch(), "/").concat(artifactSlug, "/cypress.zip");
+  return parsed.format();
+};
+
 var alreadyInstalledMsg = function alreadyInstalledMsg() {
   if (!util.isPostInstall()) {
     logger.log(stripIndent(_templateObject(), chalk.yellow('--force')));
@@ -204,6 +336,7 @@ var start = function start() {
 
   var pkgVersion = util.pkgVersion();
   var needVersion = pkgVersion;
+  var binaryUrlOverride;
   debug('version in package.json is', needVersion); // let this environment variable reset the binary version we need
 
   if (util.getEnv('CYPRESS_INSTALL_BINARY')) {
@@ -218,14 +351,9 @@ var start = function start() {
       logger.log(stripIndent(_templateObject3(), chalk.yellow('Note:')));
       logger.log();
       return Promise.resolve();
-    } // if this doesn't match the expected version
-    // then print warning to the user
-
-
-    if (envVarVersion !== needVersion) {
-      // reset the version to the env var version
-      needVersion = envVarVersion;
     }
+
+    binaryUrlOverride = envVarVersion;
   }
 
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
@@ -242,14 +370,32 @@ var start = function start() {
   }, function (err) {
     return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent(_templateObject5(), chalk.cyan(cacheDir), err.message));
   }).then(function () {
-    return state.getBinaryPkgVersionAsync(binaryDir);
-  }).then(function (binaryVersion) {
+    return Promise.all([state.getBinaryPkgVersionAsync(binaryDir), getVersionSpecifier()]);
+  }).then(function (_ref2) {
+    var _ref3 = _slicedToArray(_ref2, 2),
+        binaryVersion = _ref3[0],
+        versionSpecifier = _ref3[1];
+
+    if (!binaryUrlOverride && versionSpecifier) {
+      var computedBinaryUrl = getBinaryUrlFromPrereleaseNpmUrl(versionSpecifier);
+
+      if (computedBinaryUrl) {
+        debug('computed binary url from version specifier %o', {
+          computedBinaryUrl: computedBinaryUrl,
+          needVersion: needVersion
+        });
+        binaryUrlOverride = computedBinaryUrl;
+      }
+    }
+
+    needVersion = binaryUrlOverride || needVersion;
+    debug('installed version is', binaryVersion, 'version needed is', needVersion);
+
     if (!binaryVersion) {
       debug('no binary installed under cli version');
       return true;
     }
 
-    debug('installed version is', binaryVersion, 'version needed is', needVersion);
     logger.log();
     logger.log(stripIndent(_templateObject6(), chalk.green(binaryVersion), chalk.cyan(installDir)));
     logger.log();
@@ -332,14 +478,16 @@ var start = function start() {
 };
 
 module.exports = {
-  start: start
+  start: start,
+  _getVersionSpecifier: getVersionSpecifier,
+  _getBinaryUrlFromPrereleaseNpmUrl: getBinaryUrlFromPrereleaseNpmUrl
 };
 
-var unzipTask = function unzipTask(_ref2) {
-  var zipFilePath = _ref2.zipFilePath,
-      installDir = _ref2.installDir,
-      progress = _ref2.progress,
-      rendererOptions = _ref2.rendererOptions;
+var unzipTask = function unzipTask(_ref4) {
+  var zipFilePath = _ref4.zipFilePath,
+      installDir = _ref4.installDir,
+      progress = _ref4.progress,
+      rendererOptions = _ref4.rendererOptions;
   return {
     title: util.titleize('Unzipping Cypress'),
     task: function task(ctx, _task3) {

package/lib/util.js

@@ -449,20 +449,19 @@ var util = {
   },
   getEnv: function getEnv(varName, trim) {
     la(is.unemptyString(varName), 'expected environment variable name, not', varName);
-    var envVar = process.env[varName];
-    var configVar = process.env["npm_config_".concat(varName)];
-    var packageConfigVar = process.env["npm_package_config_".concat(varName)];
+    var configVarName = "npm_config_".concat(varName);
+    var packageConfigVarName = "npm_package_config_".concat(varName);
     var result;
 
-    if (envVar) {
+    if (process.env.hasOwnProperty(varName)) {
       debug("Using ".concat(varName, " from environment variable"));
-      result = envVar;
-    } else if (configVar) {
+      result = process.env[varName];
+    } else if (process.env.hasOwnProperty(configVarName)) {
       debug("Using ".concat(varName, " from npm config"));
-      result = configVar;
-    } else if (packageConfigVar) {
+      result = process.env[configVarName];
+    } else if (process.env.hasOwnProperty(packageConfigVarName)) {
       debug("Using ".concat(varName, " from package.json config"));
-      result = packageConfigVar;
+      result = process.env[packageConfigVarName];
     } // environment variables are often set double quotes to escape characters
     // and on Windows it can lead to weird things: for example
     //  set FOO="C:\foo.txt" && node -e "console.log('>>>%s<<<', process.env.FOO)"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "4.12.1",
+  "version": "5.3.0",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
@@ -13,26 +13,27 @@
     "@types/sinonjs__fake-timers": "^6.0.1",
     "@types/sizzle": "^2.3.2",
     "arch": "^2.1.2",
+    "blob-util": "2.0.2",
     "bluebird": "^3.7.2",
     "cachedir": "^2.3.0",
-    "chalk": "^2.4.2",
+    "chalk": "^4.1.0",
     "check-more-types": "^2.24.0",
-    "cli-table3": "~0.5.1",
+    "cli-table3": "~0.6.0",
     "commander": "^4.1.1",
     "common-tags": "^1.8.0",
     "debug": "^4.1.1",
     "eventemitter2": "^6.4.2",
-    "execa": "^1.0.0",
+    "execa": "^4.0.2",
     "executable": "^4.1.1",
     "extract-zip": "^1.7.0",
-    "fs-extra": "^8.1.0",
+    "fs-extra": "^9.0.1",
     "getos": "^3.2.1",
     "is-ci": "^2.0.0",
     "is-installed-globally": "^0.3.2",
     "lazy-ass": "^1.6.0",
     "listr": "^0.14.3",
     "lodash": "^4.17.19",
-    "log-symbols": "^3.0.0",
+    "log-symbols": "^4.0.0",
     "minimist": "^1.2.5",
     "moment": "^2.27.0",
     "ospath": "^1.2.2",
@@ -40,7 +41,7 @@
     "ramda": "~0.26.1",
     "request-progress": "^3.0.0",
     "supports-color": "^7.1.0",
-    "tmp": "~0.1.0",
+    "tmp": "~0.2.1",
     "untildify": "^4.0.0",
     "url": "^0.11.0",
     "yauzl": "^2.10.0"
@@ -49,13 +50,14 @@
     "bin",
     "lib",
     "index.js",
-    "types/**/*.d.ts"
+    "types/**/*.d.ts",
+    "types/net-stubbing.ts"
   ],
   "bin": {
     "cypress": "bin/cypress"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=10.0.0"
   },
   "types": "types",
   "description": "Cypress.io end to end testing tool",

package/types/cy-blob-util.d.ts

@@ -3,7 +3,7 @@
 // so that Cypress can get and use the Blob type
 
 // tslint:disable-next-line:no-implicit-dependencies
-import * as blobUtil from './blob-util'
+import * as blobUtil from 'blob-util'
 
 export = BlobUtil
 export as namespace BlobUtil

package/types/cypress-npm-api.d.ts

@@ -7,6 +7,12 @@
 // but for now describe it as an ambient module
 
 declare namespace CypressCommandLine {
+  type HookName = 'before' | 'beforeEach' | 'afterEach' | 'after'
+  interface TestError {
+    name: string
+    message: string
+    stack: string
+  }
   /**
    * All options that one can pass to "cypress.run"
    * @see https://on.cypress.io/module-api#cypress-run
@@ -154,39 +160,36 @@ declare namespace CypressCommandLine {
   // small utility types to better express meaning of other types
   type dateTimeISO = string
   type ms = number
-  type hookId = string
-  type testId = string
   type pixels = number
 
   /**
    * Cypress single test result
    */
   interface TestResult {
-    testId: testId
     title: string[]
     state: string
     body: string
-    /**
-     * Error stack string if there is an error
-     */
-    stack: string | null
-    /**
-     * Error message if there is an error
+     /**
+     * Error string as it's presented in console if the test fails
      */
-    error: string | null
-    timings: any
-    failedFromHookId: hookId | null
-    wallClockStartedAt: dateTimeISO
-    wallClockDuration: ms
+    displayError: string | null
+    attempts: AttemptResult[]
+  }
+
+  interface AttemptResult {
+    state: string
+    error: TestError | null
+    startedAt: dateTimeISO
+    duration: ms
     videoTimestamp: ms
+    screenshots: ScreenshotInformation[]
   }
 
   /**
    * Information about a single "before", "beforeEach", "afterEach" and "after" hook.
   */
   interface HookInformation {
-    hookId: hookId
-    hookName: 'before' | 'beforeEach' | 'afterEach' | 'after'
+    hookName: HookName
     title: string[]
     body: string
   }
@@ -195,9 +198,7 @@ declare namespace CypressCommandLine {
    * Information about a single screenshot.
    */
   interface ScreenshotInformation {
-    screenshotId: string
     name: string
-    testId: testId
     takenAt: dateTimeISO
     /**
      * Absolute path to the saved image
@@ -221,9 +222,9 @@ declare namespace CypressCommandLine {
       pending: number
       skipped: number
       failures: number
-      wallClockStartedAt: dateTimeISO
-      wallClockEndedAt: dateTimeISO
-      wallClockDuration: ms
+      startedAt: dateTimeISO
+      endedAt: dateTimeISO
+      duration: ms
     },
     /**
      * Reporter name like "spec"
@@ -238,7 +239,6 @@ declare namespace CypressCommandLine {
     tests: TestResult[]
     error: string | null
     video: string | null
-    screenshots: ScreenshotInformation[]
     /**
      * information about the spec test file.
     */
@@ -264,6 +264,7 @@ declare namespace CypressCommandLine {
    * @see https://on.cypress.io/module-api
    */
   interface CypressRunResult {
+    status: 'finished'
     startedTestsAt: dateTimeISO
     endedTestsAt: dateTimeISO
     totalDuration: ms
@@ -294,7 +295,8 @@ declare namespace CypressCommandLine {
      * @example
       ```
       const result = await cypress.run()
-      if (result.failures) {
+      if (result.status === 'failed') {
+        console.error('failures %d', result.failures)
         console.error(result.message)
         process.exit(result.failures)
       }
@@ -302,6 +304,7 @@ declare namespace CypressCommandLine {
      *
   **/
   interface CypressFailedRunResult {
+    status: 'failed'
     failures: number
     message: string
   }
@@ -347,7 +350,11 @@ declare module 'cypress' {
      cypress.run({
        spec: 'cypress/integration/admin*-spec.js'
      }).then(results => {
-       // inspect results object
+       if (results.status === 'failed') {
+          // Cypress could not run
+        } else {
+          // inspect results object
+       }
      })
      ```
      */