Merge pull request #641 from MaxGenash/STRF-8674_update_async

feat: (strf-8674) update "async" npm package
bigcommerce · Sep 21, 2020 · ee467f1 · ee467f1
2 parents 4dea617 + 9f64096
commit ee467f1
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 38 deletions.
diff --git a/bin/stencil-download.js b/bin/stencil-download.js
@@ -3,7 +3,6 @@
 require('colors');
 const inquirer = require('inquirer');
 const program = require('../lib/commander');
-const { promisify } = require("util");
 
 const { API_HOST, PACKAGE_INFO, DOT_STENCIL_FILE_PATH } = require('../constants');
 const stencilDownload = require('../lib/stencil-download');
@@ -50,7 +49,7 @@ async function run (opts) {
  console.log(`${'ok'.green} -- ${overwriteType} will be overwritten by change`);
 
  try {
- await promisify(stencilDownload)(opts);
+ await stencilDownload(opts);
  } catch (err) {
  printCliResultError(err);
  return;

diff --git a/lib/stencil-download.js b/lib/stencil-download.js
@@ -6,16 +6,15 @@ let stencilDownloadUtil = require('./stencil-download.utils');
 
 module.exports = stencilDownload;
 
-function stencilDownload(options, callback) {
- async.waterfall(
- [
- async.constant(options),
- stencilPushUtils.readStencilConfigFile,
- stencilPushUtils.getStoreHash,
- stencilPushUtils.getThemes,
- stencilPullUtils.selectActiveTheme,
- stencilPullUtils.startThemeDownloadJob,
- stencilPushUtils.pollForJobCompletion(({download_url: downloadUrl}) => ({downloadUrl})),
- stencilDownloadUtil.downloadThemeFiles,
- ], callback);
+function stencilDownload(options) {
+ return async.waterfall([
+ async.constant(options),
+ stencilPushUtils.readStencilConfigFile,
+ stencilPushUtils.getStoreHash,
+ stencilPushUtils.getThemes,
+ stencilPullUtils.selectActiveTheme,
+ stencilPullUtils.startThemeDownloadJob,
+ stencilPushUtils.pollForJobCompletion(({ download_url: downloadUrl }) => ({ downloadUrl })),
+ stencilDownloadUtil.downloadThemeFiles,
+ ]);
 }
diff --git a/lib/stencil-push.spec.js b/lib/stencil-push.spec.js
@@ -3,7 +3,7 @@
 const fetchMock = require('node-fetch');
 const { promisify } = require('util');
 
-const StencilPush = require('./stencil-push');
+const stencilPush = require('./stencil-push');
 const utils = require('./stencil-push.utils.js');
 const { MockDB } = require('../test/_mocks/MockDB');
 
@@ -36,25 +36,23 @@ describe('stencil push', () => {
  mockDb.data = {};
  });
 
- it('should throw an error if dotStencilFilePath is not provided', () => {
- const throws = () => {
- StencilPush();
- };
-
- expect(throws).toThrow('dotStencilFilePath is required!');
+ it('should throw an error if dotStencilFilePath is not provided', async () => {
+ await expect(
+ promisify(stencilPush)({}),
+ ).rejects.toThrow('dotStencilFilePath is required!');
  });
 
  it('should return an error if dotStencilFilePath does not map to a file', async () => {
  await expect(
- promisify(StencilPush)({ dotStencilFilePath: 'DNE' }),
+ promisify(stencilPush)({ dotStencilFilePath: 'DNE' }),
  ).rejects.toThrow(/ENOENT/);
  });
 
  it('should return an error if it fails to retrieve the store hash', async () => {
  const dotStencilFilePath = `${__dirname}/../test/_mocks/bin/dotStencilFile.json`;
 
  await expect(
- promisify(StencilPush)({ dotStencilFilePath }),
+ promisify(stencilPush)({ dotStencilFilePath }),
  ).rejects.toThrow('Received empty store_hash value in the server response');
  });
 });
diff --git a/lib/stencil-push.utils.js b/lib/stencil-push.utils.js
@@ -90,7 +90,7 @@ utils.generateBundle = (options, callback) => {
  };
 
  if (options.bundleZipPath) {
- return async.nextTick(callback.bind(null, null, options));
+ return callback(null, options);
  }
 
  if (options.saveBundleName) {
@@ -134,12 +134,12 @@ utils.uploadBundle = async options => {
  }
 };
 
-utils.notifyUserOfThemeLimitReachedIfNecessary = (options, callback) => {
+utils.notifyUserOfThemeLimitReachedIfNecessary = async options => {
  if (options.themeLimitReached && !options.deleteOldest) {
  console.log('warning'.yellow + ` -- You have reached your upload limit. In order to proceed, you'll need to delete at least one theme.`);
  }
 
- return async.nextTick(callback.bind(null, null, options));
+ return options;
 };
 
 utils.promptUserToDeleteThemesIfNecessary = async options => {
@@ -198,17 +198,18 @@ utils.deleteThemesIfNecessary = async options => {
  return options;
 };
 
-utils.uploadBundleAgainIfNecessary = (options, callback) => {
+utils.uploadBundleAgainIfNecessary = async options => {
  if (!options.themeLimitReached) {
- return async.nextTick(callback.bind(null, null, options));
+ return options;
  }
 
- utils.uploadBundle(options, callback);
+ return utils.uploadBundle(options);
 };
 
-utils.notifyUserOfThemeUploadCompletion = (options, callback) => {
+utils.notifyUserOfThemeUploadCompletion = async options => {
  console.log('ok'.green + ' -- Theme Upload Finished');
- return async.nextTick(callback.bind(null, null, options));
+
+ return options;
 };
 
 utils.markJobProgressPercentage = percentComplete => {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
  "accept-language-parser": "^1.5.0",
  "ajv": "^6.12.4",
  "archiver": "^5.0.0",
- "async": "^2.4.0",
+ "async": "^3.2.0",
  "browser-sync": "^2.26.12",
  "cheerio": "^0.22.0",
  "colors": "^1.4.0",