cypress 12.1.0 → 12.3.0

package/lib/tasks/cache.js

@@ -1,49 +1,35 @@
 "use strict";
 
 const state = require('./state');
-
 const logger = require('../logger');
-
 const fs = require('../fs');
-
 const util = require('../util');
-
 const {
   join
 } = require('path');
-
 const Table = require('cli-table3');
-
 const dayjs = require('dayjs');
-
 const relativeTime = require('dayjs/plugin/relativeTime');
-
 const chalk = require('chalk');
-
 const _ = require('lodash');
-
 const getFolderSize = require('./get-folder-size');
-
 const Bluebird = require('bluebird');
+dayjs.extend(relativeTime);
 
-dayjs.extend(relativeTime); // output colors for the table
-
+// output colors for the table
 const colors = {
   titles: chalk.white,
   dates: chalk.cyan,
   values: chalk.green,
   size: chalk.gray
 };
-
 const logCachePath = () => {
   logger.always(state.getCacheDir());
   return undefined;
 };
-
 const clear = () => {
   return fs.removeAsync(state.getCacheDir());
 };
-
 const prune = () => {
   const cacheDir = state.getCacheDir();
   const currentVersion = util.pkgVersion();
@@ -68,24 +54,20 @@ const prune = () => {
     logger.always(`No Cypress cache was found at ${cacheDir}. Nothing to prune.`);
   });
 };
-
 const fileSizeInMB = size => {
   return `${(size / 1024 / 1024).toFixed(1)}MB`;
 };
+
 /**
  * Collects all cached versions, finds when each was used
  * and prints a table with results to the terminal
  */
-
-
 const list = showSize => {
   return getCachedVersions(showSize).then(binaries => {
     const head = [colors.titles('version'), colors.titles('last used')];
-
     if (showSize) {
       head.push(colors.titles('size'));
     }
-
     const table = new Table({
       head
     });
@@ -93,18 +75,15 @@ const list = showSize => {
       const versionString = colors.values(binary.version);
       const lastUsed = binary.accessed ? colors.dates(binary.accessed) : 'unknown';
       const row = [versionString, lastUsed];
-
       if (showSize) {
         const size = colors.size(fileSizeInMB(binary.size));
         row.push(size);
       }
-
       return table.push(row);
     });
     logger.always(table.toString());
   });
 };
-
 const getCachedVersions = showSize => {
   const cacheDir = state.getCacheDir();
   return fs.readdirAsync(cacheDir).filter(util.isSemver).map(version => {
@@ -119,13 +98,11 @@ const getCachedVersions = showSize => {
     const executable = state.getPathToExecutable(binaryDir);
     return fs.statAsync(executable).then(stat => {
       const lastAccessedTime = _.get(stat, 'atime');
-
       if (!lastAccessedTime) {
         // the test runner has never been opened
         // or could be a test simulating missing timestamp
         return binary;
       }
-
       const accessed = dayjs(lastAccessedTime).fromNow();
       binary.accessed = accessed;
       return binary;
@@ -137,16 +114,15 @@ const getCachedVersions = showSize => {
     if (showSize) {
       const binaryDir = state.getBinaryDir(binary.version);
       return getFolderSize(binaryDir).then(size => {
-        return { ...binary,
+        return {
+          ...binary,
           size
         };
       });
     }
-
     return binary;
   });
 };
-
 module.exports = {
   path: logCachePath,
   clear,

package/lib/tasks/download.js

@@ -1,59 +1,39 @@
 "use strict";
 
 const la = require('lazy-ass');
-
 const is = require('check-more-types');
-
 const os = require('os');
-
 const url = require('url');
-
 const path = require('path');
-
 const debug = require('debug')('cypress:cli');
-
 const request = require('@cypress/request');
-
 const Promise = require('bluebird');
-
 const requestProgress = require('request-progress');
-
 const {
   stripIndent
 } = require('common-tags');
-
 const getProxyForUrl = require('proxy-from-env').getProxyForUrl;
-
 const {
   throwFormErrorText,
   errors
 } = require('../errors');
-
 const fs = require('../fs');
-
 const util = require('../util');
-
 const defaultBaseUrl = 'https://download.cypress.io/';
 const defaultMaxRedirects = 10;
-
 const getProxyForUrlWithNpmConfig = url => {
   return getProxyForUrl(url) || process.env.npm_config_https_proxy || process.env.npm_config_proxy || null;
 };
-
 const getBaseUrl = () => {
   if (util.getEnv('CYPRESS_DOWNLOAD_MIRROR')) {
     let baseUrl = util.getEnv('CYPRESS_DOWNLOAD_MIRROR');
-
     if (!baseUrl.endsWith('/')) {
       baseUrl += '/';
     }
-
     return baseUrl;
   }
-
   return defaultBaseUrl;
 };
-
 const getCA = () => {
   return new Promise(resolve => {
     if (process.env.npm_config_cafile) {
@@ -69,28 +49,23 @@ const getCA = () => {
     }
   });
 };
-
 const prepend = (arch, urlPath, version) => {
   const endpoint = url.resolve(getBaseUrl(), urlPath);
   const platform = os.platform();
   const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE', true);
   return pathTemplate ? pathTemplate.replace(/\\?\$\{endpoint\}/, endpoint).replace(/\\?\$\{platform\}/, platform).replace(/\\?\$\{arch\}/, arch).replace(/\\?\$\{version\}/, version) : `${endpoint}?platform=${platform}&arch=${arch}`;
 };
-
 const getUrl = (arch, version) => {
   if (is.url(version)) {
     debug('version is already an url', version);
     return version;
   }
-
   const urlPath = version ? `desktop/${version}` : 'desktop';
   return prepend(arch, urlPath, version);
 };
-
 const statusMessage = err => {
   return err.statusCode ? [err.statusCode, err.statusMessage].join(' - ') : err.toString();
 };
-
 const prettyDownloadErr = (err, url) => {
   const msg = stripIndent`
     URL: ${url}
@@ -99,12 +74,11 @@ const prettyDownloadErr = (err, url) => {
   debug(msg);
   return throwFormErrorText(errors.failedDownload)(msg);
 };
+
 /**
  * Checks checksum and file size for the given file. Allows both
  * values or just one of them to be checked.
  */
-
-
 const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
   if (expectedSize && expectedChecksum) {
     debug('verifying checksum and file size');
@@ -113,7 +87,6 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
         debug('downloaded file has the expected checksum and size ✅');
         return;
       }
-
       debug('raising error: checksum or file size mismatch');
       const text = stripIndent`
           Corrupted download
@@ -128,7 +101,6 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
       throw new Error(text);
     });
   }
-
   if (expectedChecksum) {
     debug('only checking expected file checksum %d', expectedChecksum);
     return util.getFileChecksum(filename).then(checksum => {
@@ -136,7 +108,6 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
         debug('downloaded file has the expected checksum ✅');
         return;
       }
-
       debug('raising error: file checksum mismatch');
       const text = stripIndent`
         Corrupted download
@@ -147,7 +118,6 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
       throw new Error(text);
     });
   }
-
   if (expectedSize) {
     // maybe we don't have a checksum, but at least CDN returns content length
     // which we can check against the file size
@@ -157,7 +127,6 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
         debug('downloaded file has the expected size ✅');
         return;
       }
-
       debug('raising error: file size mismatch');
       const text = stripIndent`
           Corrupted download
@@ -168,14 +137,13 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
       throw new Error(text);
     });
   }
-
   debug('downloaded file lacks checksum or size to verify');
   return Promise.resolve();
-}; // downloads from given url
+};
+
+// downloads from given url
 // return an object with
 // {filename: ..., downloaded: true}
-
-
 const downloadFromUrl = ({
   url,
   downloadDestination,
@@ -191,7 +159,6 @@ const downloadFromUrl = ({
           Maybe you got stuck in a redirect loop?
         `));
   }
-
   return new Promise((resolve, reject) => {
     const proxy = getProxyForUrlWithNpmConfig(url);
     debug('Downloading package', {
@@ -199,11 +166,9 @@ const downloadFromUrl = ({
       proxy,
       downloadDestination
     });
-
     if (ca) {
       debug('using custom CA details from npm config');
     }
-
     const reqOptions = {
       uri: url,
       ...(proxy ? {
@@ -217,8 +182,9 @@ const downloadFromUrl = ({
       method: 'GET',
       followRedirect: false
     };
-    const req = request(reqOptions); // closure
+    const req = request(reqOptions);
 
+    // closure
     let started = null;
     let expectedSize;
     let expectedChecksum;
@@ -231,21 +197,18 @@ const downloadFromUrl = ({
       // see https://github.com/cypress-io/cypress/pull/4092
       expectedSize = response.headers['x-amz-meta-size'] || response.headers['content-length'];
       expectedChecksum = response.headers['x-amz-meta-checksum'];
-
       if (expectedChecksum) {
         debug('expected checksum %s', expectedChecksum);
       }
-
       if (expectedSize) {
         // convert from string (all Amazon custom headers are strings)
         expectedSize = Number(expectedSize);
         debug('expected file size %d', expectedSize);
-      } // start counting now once we've gotten
-      // response headers
-
+      }
 
+      // start counting now once we've gotten
+      // response headers
       started = new Date();
-
       if (/^3/.test(response.statusCode)) {
         const redirectVersion = response.headers['x-version'];
         const redirectUrl = response.headers.location;
@@ -258,7 +221,9 @@ const downloadFromUrl = ({
           downloadDestination,
           version: redirectVersion,
           redirectTTL: redirectTTL - 1
-        }).then(resolve).catch(reject); // if our status code does not start with 200
+        }).then(resolve).catch(reject);
+
+        // if our status code does not start with 200
       } else if (!/^2/.test(response.statusCode)) {
         debug('response code %d', response.statusCode);
         const err = new Error(stripIndent`
@@ -266,7 +231,8 @@ const downloadFromUrl = ({
           Response code: ${response.statusCode}
           Response message: ${response.statusMessage}
         `);
-        reject(err); // status codes here are all 2xx
+        reject(err);
+        // status codes here are all 2xx
       } else {
         // We only enable this pipe connection when we know we've got a successful return
         // and handle the completion with verify and resolve
@@ -286,22 +252,23 @@ const downloadFromUrl = ({
     }).on('progress', state => {
       // total time we've elapsed
       // starting on our first progress notification
-      const elapsed = new Date() - started; // request-progress sends a value between 0 and 1
+      const elapsed = new Date() - started;
 
+      // request-progress sends a value between 0 and 1
       const percentage = util.convertPercentToPercentage(state.percent);
-      const eta = util.calculateEta(percentage, elapsed); // send up our percent and seconds remaining
+      const eta = util.calculateEta(percentage, elapsed);
 
+      // send up our percent and seconds remaining
       progress.onProgress(percentage, util.secsRemaining(eta));
     });
   });
 };
+
 /**
  * Download Cypress.zip from external versionUrl to local file.
  * @param [string] version Could be "3.3.0" or full URL
  * @param [string] downloadDestination Local filename to save as
  */
-
-
 const start = async opts => {
   let {
     version,
@@ -309,11 +276,9 @@ const start = async opts => {
     progress,
     redirectTTL
   } = opts;
-
   if (!downloadDestination) {
     la(is.unemptyString(downloadDestination), 'missing download dir', opts);
   }
-
   if (!progress) {
     progress = {
       onProgress: () => {
@@ -321,14 +286,14 @@ const start = async opts => {
       }
     };
   }
-
   const arch = await util.getRealArch();
   const versionUrl = getUrl(arch, version);
   progress.throttle = 100;
   debug('needed Cypress version: %s', version);
   debug('source url %s', versionUrl);
-  debug(`downloading cypress.zip to "${downloadDestination}"`); // ensure download dir exists
+  debug(`downloading cypress.zip to "${downloadDestination}"`);
 
+  // ensure download dir exists
   return fs.ensureDirAsync(path.dirname(downloadDestination)).then(() => {
     return getCA();
   }).then(ca => {
@@ -346,7 +311,6 @@ const start = async opts => {
     return prettyDownloadErr(err, versionUrl);
   });
 };
-
 module.exports = {
   start,
   getUrl,

package/lib/tasks/get-folder-size.js

@@ -1,12 +1,11 @@
 "use strict";
 
 const fs = require('../fs');
-
 const {
   join
 } = require('path');
-
 const Bluebird = require('bluebird');
+
 /**
  * Get the size of a folder or a file.
  *
@@ -16,26 +15,19 @@ const Bluebird = require('bluebird');
  *
  * @param {string} path path to the file or the folder.
  */
-
-
 async function getSize(path) {
   const stat = await fs.lstat(path);
-
   if (stat.isDirectory()) {
     const list = await fs.readdir(path);
     return Bluebird.resolve(list).reduce(async (prev, curr) => {
       const currPath = join(path, curr);
       const s = await fs.lstat(currPath);
-
       if (s.isDirectory()) {
         return prev + (await getSize(currPath));
       }
-
       return prev + s.size;
     }, 0);
   }
-
   return stat.size;
 }
-
 module.exports = getSize;