cypress 15.2.0 → 15.4.0

package/{lib → dist}/tasks/install.js

@@ -18,10 +18,10 @@ const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const debug_1 = __importDefault(require("debug"));
 const listr2_1 = require("listr2");
-const bluebird_1 = __importDefault(require("bluebird"));
 const log_symbols_1 = __importDefault(require("log-symbols"));
 const common_tags_1 = require("common-tags");
-const fs_1 = __importDefault(require("../fs"));
+const promises_1 = __importDefault(require("timers/promises"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
 const download_1 = __importDefault(require("./download"));
 const util_1 = __importDefault(require("../util"));
 const state_1 = __importDefault(require("./state"));
@@ -90,20 +90,16 @@ const downloadAndUnzip = ({ version, installDir, downloadDir }) => {
     const tasks = new listr2_1.Listr([
         {
             options: { title: util_1.default.titleize('Downloading Cypress') },
-            task: (ctx, task) => {
+            task: (ctx, task) => __awaiter(void 0, void 0, void 0, function* () {
                 // as our download progresses indicate the status
                 progress.onProgress = progessify(task, 'Downloading Cypress');
-                return download_1.default.start({ version, downloadDestination, progress })
-                    .then((redirectVersion) => {
-                    if (redirectVersion)
-                        version = redirectVersion;
-                    debug(`finished downloading file: ${downloadDestination}`);
-                })
-                    .then(() => {
-                    // save the download destination for unzipping
-                    util_1.default.setTaskTitle(task, util_1.default.titleize(chalk_1.default.green('Downloaded Cypress')), rendererOptions.renderer);
-                });
-            },
+                const redirectVersion = yield download_1.default.start({ version, downloadDestination, progress });
+                if (redirectVersion)
+                    version = redirectVersion;
+                debug(`finished downloading file: ${downloadDestination}`);
+                // save the download destination for unzipping
+                util_1.default.setTaskTitle(task, util_1.default.titleize(chalk_1.default.green('Downloaded Cypress')), rendererOptions.renderer);
+            }),
         },
         unzipTask({
             progress,
@@ -113,27 +109,24 @@ const downloadAndUnzip = ({ version, installDir, downloadDir }) => {
         }),
         {
             options: { title: util_1.default.titleize('Finishing Installation') },
-            task: (ctx, task) => {
-                const cleanup = () => {
+            task: (ctx, task) => __awaiter(void 0, void 0, void 0, function* () {
+                const cleanup = () => __awaiter(void 0, void 0, void 0, function* () {
                     debug('removing zip file %s', downloadDestination);
-                    return fs_1.default.removeAsync(downloadDestination);
-                };
-                return cleanup()
-                    .then(() => {
-                    debug('finished installation in', installDir);
-                    util_1.default.setTaskTitle(task, util_1.default.titleize(chalk_1.default.green('Finished Installation'), chalk_1.default.gray(installDir)), rendererOptions.renderer);
+                    yield fs_extra_1.default.remove(downloadDestination);
                 });
-            },
+                yield cleanup();
+                debug('finished installation in', installDir);
+                util_1.default.setTaskTitle(task, util_1.default.titleize(chalk_1.default.green('Finished Installation'), chalk_1.default.gray(installDir)), rendererOptions.renderer);
+            }),
         },
     ], { rendererOptions });
     // start the tasks!
-    return bluebird_1.default.resolve(tasks.run());
-};
-const validateOS = () => {
-    return util_1.default.getPlatformInfo().then((platformInfo) => {
-        return platformInfo.match(/(win32-x64|win32-arm64|linux-x64|linux-arm64|darwin-x64|darwin-arm64)/);
-    });
+    return tasks.run();
 };
+const validateOS = () => __awaiter(void 0, void 0, void 0, function* () {
+    const platformInfo = yield util_1.default.getPlatformInfo();
+    return platformInfo.match(/(win32-x64|win32-arm64|linux-x64|linux-arm64|darwin-x64|darwin-arm64)/);
+});
 /**
  * Returns the version to install - either a string like `1.2.3` to be fetched
  * from the download server or a file path or HTTP URL.
@@ -202,14 +195,19 @@ const start = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (o
     if (!(yield validateOS())) {
         return (0, errors_1.throwFormErrorText)(errors_1.errors.invalidOS)();
     }
-    yield fs_1.default.ensureDirAsync(cacheDir)
-        .catch({ code: 'EACCES' }, (err) => {
-        return (0, errors_1.throwFormErrorText)(errors_1.errors.invalidCacheDirectory)((0, common_tags_1.stripIndent) `
-    Failed to access ${chalk_1.default.cyan(cacheDir)}:
+    try {
+        yield fs_extra_1.default.ensureDir(cacheDir);
+    }
+    catch (err) {
+        if (err.code === 'EACCES') {
+            return (0, errors_1.throwFormErrorText)(errors_1.errors.invalidCacheDirectory)((0, common_tags_1.stripIndent) `
+        Failed to access ${chalk_1.default.cyan(cacheDir)}:
 
-    ${err.message}
-    `);
-    });
+        ${err.message}
+      `);
+        }
+        throw err;
+    }
     const binaryPkg = yield state_1.default.getBinaryPkgAsync(binaryDir);
     const binaryVersion = yield state_1.default.getBinaryPkgVersion(binaryPkg);
     const shouldInstall = () => {
@@ -251,14 +249,14 @@ const start = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (o
     }
     const getLocalFilePath = () => __awaiter(void 0, void 0, void 0, function* () {
         // see if version supplied is a path to a binary
-        if (yield fs_1.default.pathExistsAsync(versionToInstall)) {
+        if (yield fs_extra_1.default.pathExists(versionToInstall)) {
             return path_1.default.extname(versionToInstall) === '.zip' ? versionToInstall : false;
         }
         const possibleFile = util_1.default.formAbsolutePath(versionToInstall);
         debug('checking local file', possibleFile, 'cwd', process.cwd());
         // if this exists return the path to it
         // else false
-        if ((yield fs_1.default.pathExistsAsync(possibleFile)) && path_1.default.extname(possibleFile) === '.zip') {
+        if ((yield fs_extra_1.default.pathExists(possibleFile)) && path_1.default.extname(possibleFile) === '.zip') {
             return possibleFile;
         }
         return false;
@@ -287,20 +285,18 @@ const start = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (o
     const downloadDir = os_1.default.tmpdir();
     yield downloadAndUnzip({ version: versionToInstall, installDir, downloadDir });
     // delay 1 sec for UX, unless we are testing
-    yield bluebird_1.default.delay(1000);
+    yield promises_1.default.setTimeout(1000);
     displayCompletionMsg();
 });
 const unzipTask = ({ zipFilePath, installDir, progress, rendererOptions }) => {
     return {
         options: { title: util_1.default.titleize('Unzipping Cypress') },
-        task: (ctx, task) => {
+        task: (ctx, task) => __awaiter(void 0, void 0, void 0, function* () {
             // as our unzip progresses indicate the status
             progress.onProgress = progessify(task, 'Unzipping Cypress');
-            return unzip_1.default.start({ zipFilePath, installDir, progress })
-                .then(() => {
-                util_1.default.setTaskTitle(task, util_1.default.titleize(chalk_1.default.green('Unzipped Cypress')), rendererOptions.renderer);
-            });
-        },
+            yield unzip_1.default.start({ zipFilePath, installDir, progress });
+            util_1.default.setTaskTitle(task, util_1.default.titleize(chalk_1.default.green('Unzipped Cypress')), rendererOptions.renderer);
+        }),
     };
 };
 const progessify = (task, title) => {

package/{lib → dist}/tasks/state.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,7 +17,8 @@ const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const untildify_1 = __importDefault(require("untildify"));
 const debug_1 = __importDefault(require("debug"));
-const fs_1 = __importDefault(require("../fs"));
+const process_1 = require("process");
+const fs_extra_1 = __importDefault(require("fs-extra"));
 const util_1 = __importDefault(require("../util"));
 const debug = (0, debug_1.default)('cypress:cli');
 const getPlatformExecutable = () => {
@@ -59,7 +69,7 @@ const getVersionDir = (version = util_1.default.pkgVersion(), buildInfo = util_1
  */
 const isInstallingFromPostinstallHook = () => {
     // individual folders
-    const cwdFolders = process.cwd().split(path_1.default.sep);
+    const cwdFolders = (0, process_1.cwd)().split(path_1.default.sep);
     const length = cwdFolders.length;
     return cwdFolders[length - 2] === 'node_modules' && cwdFolders[length - 1] === 'cypress';
 };
@@ -80,19 +90,17 @@ const getCacheDir = () => {
     }
     return cache_directory;
 };
-const parseRealPlatformBinaryFolderAsync = (binaryPath) => {
-    return fs_1.default.realpathAsync(binaryPath)
-        .then((realPath) => {
-        debug('CYPRESS_RUN_BINARY has realpath:', realPath);
-        if (!realPath.toString().endsWith(getPlatformExecutable())) {
-            return false;
-        }
-        if (os_1.default.platform() === 'darwin') {
-            return path_1.default.resolve(realPath, '..', '..', '..');
-        }
-        return path_1.default.resolve(realPath, '..');
-    });
-};
+const parseRealPlatformBinaryFolderAsync = (binaryPath) => __awaiter(void 0, void 0, void 0, function* () {
+    const realPath = yield fs_extra_1.default.realpath(binaryPath);
+    debug('CYPRESS_RUN_BINARY has realpath:', realPath);
+    if (!realPath.toString().endsWith(getPlatformExecutable())) {
+        return false;
+    }
+    if (os_1.default.platform() === 'darwin') {
+        return path_1.default.resolve(realPath, '..', '..', '..');
+    }
+    return path_1.default.resolve(realPath, '..');
+});
 const getDistDir = () => {
     return path_1.default.join(__dirname, '..', '..', 'dist');
 };
@@ -104,34 +112,38 @@ const getDistDir = () => {
 const getBinaryStatePath = (binaryDir) => {
     return path_1.default.join(binaryDir, '..', 'binary_state.json');
 };
-const getBinaryStateContentsAsync = (binaryDir) => {
+const getBinaryStateContentsAsync = (binaryDir) => __awaiter(void 0, void 0, void 0, function* () {
     const fullPath = getBinaryStatePath(binaryDir);
-    return fs_1.default.readJsonAsync(fullPath)
-        .catch({ code: 'ENOENT' }, SyntaxError, () => {
-        debug('could not read binary_state.json file at "%s"', fullPath);
-        return {};
-    });
-};
-const getBinaryVerifiedAsync = (binaryDir) => {
-    return getBinaryStateContentsAsync(binaryDir)
-        .tap(debug)
-        .get('verified');
-};
-const clearBinaryStateAsync = (binaryDir) => {
-    return fs_1.default.removeAsync(getBinaryStatePath(binaryDir));
-};
+    try {
+        const contents = yield fs_extra_1.default.readJson(fullPath);
+        debug('binary_state.json contents:', contents);
+        return contents;
+    }
+    catch (error) {
+        if (error.code === 'ENOENT' || error instanceof SyntaxError) {
+            debug('could not read binary_state.json file at "%s"', fullPath);
+            return {};
+        }
+        throw error;
+    }
+});
+const getBinaryVerifiedAsync = (binaryDir) => __awaiter(void 0, void 0, void 0, function* () {
+    const contents = yield getBinaryStateContentsAsync(binaryDir);
+    return contents.verified;
+});
+const clearBinaryStateAsync = (binaryDir) => __awaiter(void 0, void 0, void 0, function* () {
+    yield fs_extra_1.default.remove(getBinaryStatePath(binaryDir));
+});
 /**
  * Writes the new binary status.
  * @param {boolean} verified The new test runner state after smoke test
  * @param {string} binaryDir Folder holding the binary
  * @returns {Promise<void>} returns a promise
  */
-const writeBinaryVerifiedAsync = (verified, binaryDir) => {
-    return getBinaryStateContentsAsync(binaryDir)
-        .then((contents) => {
-        return fs_1.default.outputJsonAsync(getBinaryStatePath(binaryDir), lodash_1.default.extend(contents, { verified }), { spaces: 2 });
-    });
-};
+const writeBinaryVerifiedAsync = (verified, binaryDir) => __awaiter(void 0, void 0, void 0, function* () {
+    const contents = yield getBinaryStateContentsAsync(binaryDir);
+    yield fs_extra_1.default.outputJson(getBinaryStatePath(binaryDir), lodash_1.default.extend(contents, { verified }), { spaces: 2 });
+});
 const getPathToExecutable = (binaryDir) => {
     return path_1.default.join(binaryDir, getPlatformExecutable());
 };
@@ -139,17 +151,15 @@ const getPathToExecutable = (binaryDir) => {
  * Resolves with an object read from the binary app package.json file.
  * If the file does not exist resolves with null
  */
-const getBinaryPkgAsync = (binaryDir) => {
+const getBinaryPkgAsync = (binaryDir) => __awaiter(void 0, void 0, void 0, function* () {
     const pathToPackageJson = getBinaryPkgPath(binaryDir);
     debug('Reading binary package.json from:', pathToPackageJson);
-    return fs_1.default.pathExistsAsync(pathToPackageJson)
-        .then((exists) => {
-        if (!exists) {
-            return null;
-        }
-        return fs_1.default.readJsonAsync(pathToPackageJson);
-    });
-};
+    const exists = yield fs_extra_1.default.pathExists(pathToPackageJson);
+    if (!exists) {
+        return null;
+    }
+    return fs_extra_1.default.readJson(pathToPackageJson);
+});
 const getBinaryPkgVersion = (o) => lodash_1.default.get(o, 'version', null);
 const getBinaryElectronVersion = (o) => lodash_1.default.get(o, 'electronVersion', null);
 const getBinaryElectronNodeVersion = (o) => lodash_1.default.get(o, 'electronNodeVersion', null);

package/dist/tasks/unzip.js

@@ -0,0 +1,192 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+const child_process_1 = __importDefault(require("child_process"));
+const os_1 = __importDefault(require("os"));
+const yauzl_1 = __importDefault(require("yauzl"));
+const debug_1 = __importDefault(require("debug"));
+const extract_zip_1 = __importDefault(require("extract-zip"));
+const readline_1 = __importDefault(require("readline"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const errors_1 = require("../errors");
+const util_1 = __importDefault(require("../util"));
+const assert_1 = __importDefault(require("assert"));
+const debug = (0, debug_1.default)('cypress:cli:unzip');
+const unzipTools = {
+    extract: extract_zip_1.default,
+};
+// expose this function for simple testing
+const unzip = (_a) => __awaiter(void 0, [_a], void 0, function* ({ zipFilePath, installDir, progress }) {
+    debug('unzipping from %s', zipFilePath);
+    debug('into', installDir);
+    if (!zipFilePath) {
+        throw new Error('Missing zip filename');
+    }
+    const startTime = Date.now();
+    let yauzlDoneTime = 0;
+    yield fs_extra_1.default.ensureDir(installDir);
+    yield new Promise((resolve, reject) => {
+        return yauzl_1.default.open(zipFilePath, (err, zipFile) => {
+            yauzlDoneTime = Date.now();
+            if (err) {
+                debug('error using yauzl %s', err.message);
+                return reject(err);
+            }
+            const total = zipFile.entryCount;
+            debug('zipFile entries count', total);
+            const started = new Date();
+            let percent = 0;
+            let count = 0;
+            const notify = (percent) => {
+                const elapsed = +new Date() - +started;
+                const eta = util_1.default.calculateEta(percent, elapsed);
+                progress.onProgress(percent, util_1.default.secsRemaining(eta));
+            };
+            const tick = () => {
+                count += 1;
+                percent = ((count / total) * 100);
+                const displayPercent = percent.toFixed(0);
+                return notify(Number(displayPercent));
+            };
+            const unzipWithNode = () => __awaiter(void 0, void 0, void 0, function* () {
+                debug('unzipping with node.js (slow)');
+                const opts = {
+                    dir: installDir,
+                    onEntry: tick,
+                };
+                debug('calling Node extract tool %s %o', zipFilePath, opts);
+                try {
+                    yield unzipTools.extract(zipFilePath, opts);
+                    debug('node unzip finished');
+                    return resolve();
+                }
+                catch (err) {
+                    const error = err || new Error('Unknown error with Node extract tool');
+                    debug('error %s', error.message);
+                    return reject(error);
+                }
+            });
+            const unzipFallback = lodash_1.default.once(unzipWithNode);
+            const unzipWithUnzipTool = () => {
+                debug('unzipping via `unzip`');
+                const inflatingRe = /inflating:/;
+                const sp = child_process_1.default.spawn('unzip', ['-o', zipFilePath, '-d', installDir]);
+                sp.on('error', (err) => {
+                    debug('unzip tool error: %s', err.message);
+                    unzipFallback();
+                });
+                sp.on('close', (code) => {
+                    debug('unzip tool close with code %d', code);
+                    if (code === 0) {
+                        percent = 100;
+                        notify(percent);
+                        return resolve();
+                    }
+                    debug('`unzip` failed %o', { code });
+                    return unzipFallback();
+                });
+                sp.stdout.on('data', (data) => {
+                    if (inflatingRe.test(data)) {
+                        return tick();
+                    }
+                });
+                sp.stderr.on('data', (data) => {
+                    debug('`unzip` stderr %s', data);
+                });
+            };
+            // we attempt to first unzip with the native osx
+            // ditto because its less likely to have problems
+            // with corruption, symlinks, or icons causing failures
+            // and can handle resource forks
+            // http://automatica.com.au/2011/02/unzip-mac-os-x-zip-in-terminal/
+            const unzipWithOsx = () => {
+                debug('unzipping via `ditto`');
+                const copyingFileRe = /^copying file/;
+                const sp = child_process_1.default.spawn('ditto', ['-xkV', zipFilePath, installDir]);
+                // f-it just unzip with node
+                sp.on('error', (err) => {
+                    debug(err.message);
+                    unzipFallback();
+                });
+                sp.on('close', (code) => {
+                    if (code === 0) {
+                        // make sure we get to 100% on the progress bar
+                        // because reading in lines is not really accurate
+                        percent = 100;
+                        notify(percent);
+                        return resolve();
+                    }
+                    debug('`ditto` failed %o', { code });
+                    return unzipFallback();
+                });
+                return readline_1.default.createInterface({
+                    input: sp.stderr,
+                })
+                    .on('line', (line) => {
+                    if (copyingFileRe.test(line)) {
+                        return tick();
+                    }
+                });
+            };
+            switch (os_1.default.platform()) {
+                case 'darwin':
+                    return unzipWithOsx();
+                case 'linux':
+                    return unzipWithUnzipTool();
+                case 'win32':
+                    return unzipWithNode();
+                default:
+                    return;
+            }
+        });
+    });
+    debug('unzip completed %o', {
+        yauzlMs: yauzlDoneTime - startTime,
+        unzipMs: Date.now() - yauzlDoneTime,
+    });
+});
+function isMaybeWindowsMaxPathLengthError(err) {
+    return os_1.default.platform() === 'win32' && err.code === 'ENOENT' && err.syscall === 'realpath';
+}
+const start = (_a) => __awaiter(void 0, [_a], void 0, function* ({ zipFilePath, installDir, progress }) {
+    assert_1.default.ok(lodash_1.default.isString(installDir) && !lodash_1.default.isEmpty(installDir), 'missing installDir');
+    if (!progress) {
+        progress = { onProgress: () => {
+                return {};
+            } };
+    }
+    try {
+        const installDirExists = yield fs_extra_1.default.pathExists(installDir);
+        if (installDirExists) {
+            debug('removing existing unzipped binary', installDir);
+            yield fs_extra_1.default.remove(installDir);
+        }
+        yield unzip({ zipFilePath, installDir, progress });
+    }
+    catch (err) {
+        const errorTemplate = isMaybeWindowsMaxPathLengthError(err) ?
+            errors_1.errors.failedUnzipWindowsMaxPathLength
+            : errors_1.errors.failedUnzip;
+        yield (0, errors_1.throwFormErrorText)(errorTemplate)(err);
+    }
+});
+const unzipModule = {
+    start,
+    utils: {
+        unzip,
+        unzipTools,
+    },
+};
+exports.default = unzipModule;