cypress 15.0.0 → 15.2.0

package/lib/errors.js

@@ -1,78 +1,78 @@
 "use strict";
-
-const chalk = require('chalk');
-const {
-  stripIndent,
-  stripIndents
-} = require('common-tags');
-const la = require('lazy-ass');
-const is = require('check-more-types');
-const util = require('./util');
-const state = require('./tasks/state');
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errors = exports.exitWithError = exports.throwFormErrorText = exports.raise = exports.hr = void 0;
+exports.getError = getError;
+exports.formErrorText = formErrorText;
+const chalk_1 = __importDefault(require("chalk"));
+const common_tags_1 = require("common-tags");
+const lazy_ass_1 = __importDefault(require("lazy-ass"));
+const check_more_types_1 = __importDefault(require("check-more-types"));
+const util_1 = __importDefault(require("./util"));
+const state_1 = __importDefault(require("./tasks/state"));
 const docsUrl = 'https://on.cypress.io';
 const requiredDependenciesUrl = `${docsUrl}/required-dependencies`;
 const runDocumentationUrl = `${docsUrl}/cypress-run`;
-
 // TODO it would be nice if all error objects could be enforced via types
 // to only have description + solution properties
-
-const hr = '----------';
-const genericErrorSolution = stripIndent`
+exports.hr = '----------';
+const genericErrorSolution = (0, common_tags_1.stripIndent) `
   Search for an existing issue or open a GitHub issue at
 
-    ${chalk.blue(util.issuesUrl)}
+    ${chalk_1.default.blue(util_1.default.issuesUrl)}
 `;
-
 // common errors Cypress application can encounter
 const unknownError = {
-  description: 'Unknown Cypress CLI error',
-  solution: genericErrorSolution
+    description: 'Unknown Cypress CLI error',
+    solution: genericErrorSolution,
 };
 const invalidRunProjectPath = {
-  description: 'Invalid --project path',
-  solution: stripIndent`
+    description: 'Invalid --project path',
+    solution: (0, common_tags_1.stripIndent) `
     Please provide a valid project path.
 
-    Learn more about ${chalk.cyan('cypress run')} at:
+    Learn more about ${chalk_1.default.cyan('cypress run')} at:
 
-      ${chalk.blue(runDocumentationUrl)}
-  `
+      ${chalk_1.default.blue(runDocumentationUrl)}
+  `,
 };
 const invalidOS = {
-  description: 'The Cypress App could not be installed. Your machine does not meet the operating system requirements.',
-  solution: stripIndent`
+    description: 'The Cypress App could not be installed. Your machine does not meet the operating system requirements.',
+    solution: (0, common_tags_1.stripIndent) `
 
-  ${chalk.blue('https://on.cypress.io/app/get-started/install-cypress#System-requirements')}`
+  ${chalk_1.default.blue('https://on.cypress.io/app/get-started/install-cypress#System-requirements')}`,
 };
 const failedDownload = {
-  description: 'The Cypress App could not be downloaded.',
-  solution: stripIndent`
+    description: 'The Cypress App could not be downloaded.',
+    solution: (0, common_tags_1.stripIndent) `
   Does your workplace require a proxy to be used to access the Internet? If so, you must configure the HTTP_PROXY environment variable before downloading Cypress. Read more: https://on.cypress.io/proxy-configuration
 
-  Otherwise, please check network connectivity and try again:`
+  Otherwise, please check network connectivity and try again:`,
 };
 const failedUnzip = {
-  description: 'The Cypress App could not be unzipped.',
-  solution: genericErrorSolution
+    description: 'The Cypress App could not be unzipped.',
+    solution: genericErrorSolution,
 };
 const failedUnzipWindowsMaxPathLength = {
-  description: 'The Cypress App could not be unzipped.',
-  solution: `This is most likely because the maximum path length is being exceeded on your system.
+    description: 'The Cypress App could not be unzipped.',
+    solution: `This is most likely because the maximum path length is being exceeded on your system.
 
-  Read here for solutions to this problem: https://on.cypress.io/win-max-path-length-error`
+  Read here for solutions to this problem: https://on.cypress.io/win-max-path-length-error`,
 };
-const missingApp = binaryDir => {
-  return {
-    description: `No version of Cypress is installed in: ${chalk.cyan(binaryDir)}`,
-    solution: stripIndent`
-    \nPlease reinstall Cypress by running: ${chalk.cyan('cypress install')}
-  `
-  };
+const missingApp = (binaryDir) => {
+    return {
+        description: `No version of Cypress is installed in: ${chalk_1.default.cyan(binaryDir)}`,
+        solution: (0, common_tags_1.stripIndent) `
+    \nPlease reinstall Cypress by running: ${chalk_1.default.cyan('cypress install')}
+  `,
+    };
 };
-const binaryNotExecutable = executable => {
-  return {
-    description: `Cypress cannot run because this binary file does not have executable permissions here:\n\n${executable}`,
-    solution: stripIndent`\n
+const binaryNotExecutable = (executable) => {
+    return {
+        description: `Cypress cannot run because this binary file does not have executable permissions here:\n\n${executable}`,
+        solution: (0, common_tags_1.stripIndent) `\n
     Reasons this may happen:
 
     - node was installed as 'root' or with 'sudo'
@@ -81,141 +81,140 @@ const binaryNotExecutable = executable => {
     Please check that you have the appropriate user permissions.
 
     You can also try clearing the cache with 'cypress cache clear' and reinstalling.
-  `
-  };
+  `,
+    };
 };
-const notInstalledCI = executable => {
-  return {
-    description: 'The cypress npm package is installed, but the Cypress binary is missing.',
-    solution: stripIndent`\n
-    We expected the binary to be installed here: ${chalk.cyan(executable)}
+const notInstalledCI = (executable) => {
+    return {
+        description: 'The cypress npm package is installed, but the Cypress binary is missing.',
+        solution: (0, common_tags_1.stripIndent) `\n
+    We expected the binary to be installed here: ${chalk_1.default.cyan(executable)}
 
     Reasons it may be missing:
 
-    - You're caching 'node_modules' but are not caching this path: ${util.getCacheDir()}
-    - You ran 'npm install' at an earlier build step but did not persist: ${util.getCacheDir()}
+    - You're caching 'node_modules' but are not caching this path: ${util_1.default.getCacheDir()}
+    - You ran 'npm install' at an earlier build step but did not persist: ${util_1.default.getCacheDir()}
 
     Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.
 
     Alternatively, you can run 'cypress install' to download the binary again.
 
-    ${chalk.blue('https://on.cypress.io/not-installed-ci-error')}
-  `
-  };
+    ${chalk_1.default.blue('https://on.cypress.io/not-installed-ci-error')}
+  `,
+    };
 };
 const nonZeroExitCodeXvfb = {
-  description: 'Xvfb exited with a non zero exit code.',
-  solution: stripIndent`
+    description: 'Xvfb exited with a non zero exit code.',
+    solution: (0, common_tags_1.stripIndent) `
     There was a problem spawning Xvfb.
 
     This is likely a problem with your system, permissions, or installation of Xvfb.
-    `
+    `,
 };
 const missingXvfb = {
-  description: 'Your system is missing the dependency: Xvfb',
-  solution: stripIndent`
+    description: 'Your system is missing the dependency: Xvfb',
+    solution: (0, common_tags_1.stripIndent) `
     Install Xvfb and run Cypress again.
 
     Read our documentation on dependencies for more information:
 
-      ${chalk.blue(requiredDependenciesUrl)}
+      ${chalk_1.default.blue(requiredDependenciesUrl)}
 
     If you are using Docker, we provide containers with all required dependencies installed.
-    `
+    `,
 };
 const smokeTestFailure = (smokeTestCommand, timedOut) => {
-  return {
-    description: `Cypress verification ${timedOut ? 'timed out' : 'failed'}.`,
-    solution: stripIndent`
+    return {
+        description: `Cypress verification ${timedOut ? 'timed out' : 'failed'}.`,
+        solution: (0, common_tags_1.stripIndent) `
     This command failed with the following output:
 
     ${smokeTestCommand}
 
-    `
-  };
+    `,
+    };
 };
 const invalidSmokeTestDisplayError = {
-  code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR',
-  description: 'Cypress verification failed.',
-  solution(msg) {
-    return stripIndent`
+    code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR',
+    description: 'Cypress verification failed.',
+    solution(msg) {
+        return (0, common_tags_1.stripIndent) `
       Cypress failed to start after spawning a new Xvfb server.
 
       The error logs we received were:
 
-      ${hr}
+      ${exports.hr}
 
       ${msg}
 
-      ${hr}
+      ${exports.hr}
 
-      This may be due to a missing library or dependency. ${chalk.blue(requiredDependenciesUrl)}
+      This may be due to a missing library or dependency. ${chalk_1.default.blue(requiredDependenciesUrl)}
 
       Please refer to the error above for more detail.
     `;
-  }
+    },
 };
 const missingDependency = {
-  description: 'Cypress failed to start.',
-  // this message is too Linux specific
-  solution: stripIndent`
-    This may be due to a missing library or dependency. ${chalk.blue(requiredDependenciesUrl)}
+    description: 'Cypress failed to start.',
+    // this message is too Linux specific
+    solution: (0, common_tags_1.stripIndent) `
+    This may be due to a missing library or dependency. ${chalk_1.default.blue(requiredDependenciesUrl)}
 
     Please refer to the error below for more details.
-  `
+  `,
 };
 const invalidCacheDirectory = {
-  description: 'Cypress cannot write to the cache directory due to file permissions',
-  solution: stripIndent`
+    description: 'Cypress cannot write to the cache directory due to file permissions',
+    solution: (0, common_tags_1.stripIndent) `
     See discussion and possible solutions at
-    ${chalk.blue(util.getGitHubIssueUrl(1281))}
-  `
+    ${chalk_1.default.blue(util_1.default.getGitHubIssueUrl(1281))}
+  `,
 };
 const versionMismatch = {
-  description: 'Installed version does not match package version.',
-  solution: 'Install Cypress and verify app again'
+    description: 'Installed version does not match package version.',
+    solution: 'Install Cypress and verify app again',
 };
 const incompatibleHeadlessFlags = {
-  description: '`--headed` and `--headless` cannot both be passed.',
-  solution: 'Either pass `--headed` or `--headless`, but not both.'
+    description: '`--headed` and `--headless` cannot both be passed.',
+    solution: 'Either pass `--headed` or `--headless`, but not both.',
 };
-const solutionUnknown = stripIndent`
+const solutionUnknown = (0, common_tags_1.stripIndent) `
   Please search Cypress documentation for possible solutions:
 
-    ${chalk.blue(docsUrl)}
+    ${chalk_1.default.blue(docsUrl)}
 
   Check if there is a GitHub issue describing this crash:
 
-    ${chalk.blue(util.issuesUrl)}
+    ${chalk_1.default.blue(util_1.default.issuesUrl)}
 
   Consider opening a new issue.
 `;
 const unexpected = {
-  description: 'An unexpected error occurred while verifying the Cypress executable.',
-  solution: solutionUnknown
+    description: 'An unexpected error occurred while verifying the Cypress executable.',
+    solution: solutionUnknown,
 };
 const invalidCypressEnv = {
-  description: chalk.red('The environment variable with the reserved name "CYPRESS_INTERNAL_ENV" is set.'),
-  solution: chalk.red('Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.'),
-  exitCode: 11
+    description: chalk_1.default.red('The environment variable with the reserved name "CYPRESS_INTERNAL_ENV" is set.'),
+    solution: chalk_1.default.red('Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.'),
+    exitCode: 11,
 };
 const invalidTestingType = {
-  description: 'Invalid testingType',
-  solution: `Please provide a valid testingType. Valid test types are ${chalk.cyan('\'e2e\'')} and ${chalk.cyan('\'component\'')}.`
+    description: 'Invalid testingType',
+    solution: `Please provide a valid testingType. Valid test types are ${chalk_1.default.cyan('\'e2e\'')} and ${chalk_1.default.cyan('\'component\'')}.`,
 };
 const incompatibleTestTypeFlags = {
-  description: '`--e2e` and `--component` cannot both be passed.',
-  solution: 'Either pass `--e2e` or `--component`, but not both.'
+    description: '`--e2e` and `--component` cannot both be passed.',
+    solution: 'Either pass `--e2e` or `--component`, but not both.',
 };
 const incompatibleTestingTypeAndFlag = {
-  description: 'Set a `testingType` and also passed `--e2e` or `--component` flags.',
-  solution: 'Either set `testingType` or pass a testing type flag, but not both.'
+    description: 'Set a `testingType` and also passed `--e2e` or `--component` flags.',
+    solution: 'Either set `testingType` or pass a testing type flag, but not both.',
 };
 const invalidConfigFile = {
-  description: '`--config-file` cannot be false.',
-  solution: 'Either pass a relative path to a valid Cypress config file or remove this option.'
+    description: '`--config-file` cannot be false.',
+    solution: 'Either pass a relative path to a valid Cypress config file or remove this option.',
 };
-
 /**
  * This error happens when CLI detects that the child Test Runner process
  * was killed with a signal, like SIGBUS
@@ -224,29 +223,25 @@ const invalidConfigFile = {
  * @param {string} signal Signal that closed the child process, like "SIGBUS"
 */
 const childProcessKilled = (eventName, signal) => {
-  return {
-    description: `The Test Runner unexpectedly exited via a ${chalk.cyan(eventName)} event with signal ${chalk.cyan(signal)}`,
-    solution: solutionUnknown
-  };
-};
-const CYPRESS_RUN_BINARY = {
-  notValid: value => {
-    const properFormat = `**/${state.getPlatformExecutable()}`;
     return {
-      description: `Could not run binary set by environment variable: CYPRESS_RUN_BINARY=${value}`,
-      solution: `Ensure the environment variable is a path to the Cypress binary, matching ${properFormat}`
+        description: `The Test Runner unexpectedly exited via a ${chalk_1.default.cyan(eventName)} event with signal ${chalk_1.default.cyan(signal)}`,
+        solution: solutionUnknown,
     };
-  }
+};
+const CYPRESS_RUN_BINARY = {
+    notValid: (value) => {
+        const properFormat = `**/${state_1.default.getPlatformExecutable()}`;
+        return {
+            description: `Could not run binary set by environment variable: CYPRESS_RUN_BINARY=${value}`,
+            solution: `Ensure the environment variable is a path to the Cypress binary, matching ${properFormat}`,
+        };
+    },
 };
 function addPlatformInformation(info) {
-  return util.getPlatformInfo().then(platform => {
-    return {
-      ...info,
-      platform
-    };
-  });
+    return util_1.default.getPlatformInfo().then((platform) => {
+        return Object.assign(Object.assign({}, info), { platform });
+    });
 }
-
 /**
  * Given an error object (see the errors above), forms error message text with details,
  * then resolves with Error instance you can throw or reject with.
@@ -260,109 +255,102 @@ function addPlatformInformation(info) {
   ```
  */
 function getError(errorObject) {
-  return formErrorText(errorObject).then(errorMessage => {
-    const err = new Error(errorMessage);
-    err.known = true;
-    return err;
-  });
+    return formErrorText(errorObject).then((errorMessage) => {
+        const err = new Error(errorMessage);
+        err.known = true;
+        return err;
+    });
 }
-
 /**
  * Forms nice error message with error and platform information,
  * and if possible a way to solve it. Resolves with a string.
  */
 function formErrorText(info, msg, prevMessage) {
-  return addPlatformInformation(info).then(obj => {
-    const formatted = [];
-    function add(msg) {
-      formatted.push(stripIndents(msg));
-    }
-    la(is.unemptyString(obj.description), 'expected error description to be text', obj.description);
-
-    // assuming that if there the solution is a function it will handle
-    // error message and (optional previous error message)
-    if (is.fn(obj.solution)) {
-      const text = obj.solution(msg, prevMessage);
-      la(is.unemptyString(text), 'expected solution to be text', text);
-      add(`
+    return addPlatformInformation(info).then((obj) => {
+        const formatted = [];
+        function add(msg) {
+            formatted.push((0, common_tags_1.stripIndents)(msg));
+        }
+        (0, lazy_ass_1.default)(check_more_types_1.default.unemptyString(obj.description), 'expected error description to be text', obj.description);
+        // assuming that if there the solution is a function it will handle
+        // error message and (optional previous error message)
+        if (check_more_types_1.default.fn(obj.solution)) {
+            const text = obj.solution(msg, prevMessage);
+            (0, lazy_ass_1.default)(check_more_types_1.default.unemptyString(text), 'expected solution to be text', text);
+            add(`
         ${obj.description}
 
         ${text}
 
       `);
-    } else {
-      la(is.unemptyString(obj.solution), 'expected error solution to be text', obj.solution);
-      add(`
+        }
+        else {
+            (0, lazy_ass_1.default)(check_more_types_1.default.unemptyString(obj.solution), 'expected error solution to be text', obj.solution);
+            add(`
         ${obj.description}
 
         ${obj.solution}
 
       `);
-      if (msg) {
-        add(`
-          ${hr}
+            if (msg) {
+                add(`
+          ${exports.hr}
 
           ${msg}
 
         `);
-      }
-    }
-    add(`
-      ${hr}
+            }
+        }
+        add(`
+      ${exports.hr}
 
       ${obj.platform}
     `);
-    if (obj.footer) {
-      add(`
+        if (obj.footer) {
+            add(`
 
-        ${hr}
+        ${exports.hr}
 
         ${obj.footer}
       `);
-    }
-    return formatted.join('\n\n');
-  });
+        }
+        return formatted.join('\n\n');
+    });
 }
-const raise = info => {
-  return text => {
-    const err = new Error(text);
-    if (info.code) {
-      err.code = info.code;
-    }
-    err.known = true;
-    throw err;
-  };
+const raise = (info) => {
+    return (text) => {
+        const err = new Error(text);
+        if (info.code) {
+            err.code = info.code;
+        }
+        err.known = true;
+        throw err;
+    };
 };
-const throwFormErrorText = info => {
-  return (msg, prevMessage) => {
-    return formErrorText(info, msg, prevMessage).then(raise(info));
-  };
+exports.raise = raise;
+const throwFormErrorText = (info) => {
+    return (msg, prevMessage) => {
+        return formErrorText(info, msg, prevMessage).then((0, exports.raise)(info));
+    };
 };
-
+exports.throwFormErrorText = throwFormErrorText;
 /**
  * Forms full error message with error and OS details, prints to the error output
  * and then exits the process.
  * @param {ErrorInformation} info Error information {description, solution}
  * @example return exitWithError(errors.invalidCypressEnv)('foo')
  */
-const exitWithError = info => {
-  return msg => {
-    return formErrorText(info, msg).then(text => {
-      // eslint-disable-next-line no-console
-      console.error(text);
-      process.exit(info.exitCode || 1);
-    });
-  };
+const exitWithError = (info) => {
+    return (msg) => {
+        return formErrorText(info, msg).then((text) => {
+            // eslint-disable-next-line no-console
+            console.error(text);
+            process.exit(info.exitCode || 1);
+        });
+    };
 };
-module.exports = {
-  raise,
-  exitWithError,
-  // formError,
-  formErrorText,
-  throwFormErrorText,
-  getError,
-  hr,
-  errors: {
+exports.exitWithError = exitWithError;
+exports.errors = {
     unknownError,
     nonZeroExitCodeXvfb,
     missingXvfb,
@@ -387,6 +375,5 @@ module.exports = {
     invalidTestingType,
     incompatibleTestTypeFlags,
     incompatibleTestingTypeAndFlag,
-    invalidConfigFile
-  }
-};
+    invalidConfigFile,
+};