@bigcommerce/stencil-cli 4.1.1 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 ### Draft
 
+### 5.0.0 (2022-06-07)
+
+-   fix: STRF-9835 Bump paper ([947](https://github.com/bigcommerce/stencil-cli/pull/947))
+-   feat: strf-9791 Drop Node 12 Support ([945](https://github.com/bigcommerce/stencil-cli/pull/945))
+-   feat: STRF-9807 Dockerize stencil cli ([938]https://github.com/bigcommerce/stencil-cli/pull/938)
+-   merc-8592 Fix stencil CLI Push resulting in intermittent failures ([935]https://github.com/bigcommerce/stencil-cli/pull/935)
+
 ### 4.1.1 (2022-05-24)
 
 -   fix: strf-9781 Bump dev packages for linting ([932](https://github.com/bigcommerce/stencil-cli/pull/932))

package/README.md

@@ -8,7 +8,7 @@ The BigCommerce server emulator for local theme development.
 ## Install
 
 _Note: Stencil requires the Node.js runtime environment,
-version 12.x and 14.x (Recommended) are supported.
+version 14.x is supported.
 We do not yet have support for versions greater than Node 14._
 
 Run `npm install -g @bigcommerce/stencil-cli`.
@@ -95,6 +95,20 @@ If you need any help or experience any bugs, please create a GitHub issue in thi
 If you would like to improve this project check out the [Contributing Guide](./CONTRIBUTING.md). Also, you can find
 the implementation details there.
 
+## Running in docker
+
+There is possibility to run stencil-cli in docker.
+Here are steps to have this functionality.
+First of all, build a docker image, let's name it `bc/stencil-cli`
+Run `docker build . -t bc/stencil-cli` in stencil-cli repo directory.
+
+Then, after the image is built, you want to run some commands against your theme.
+
+For example
+`docker run -p 3005:3005 -v /bigcommerce/cornerstone:/usr/src/app -it bc/stencil-cli stencil init`, where `3005` is port number definded in `config.stencil.json` and `/bigcommerce/cornerstone` path to where theme is located.
+
+`docker run -p 3005:3005 -v /bigcommerce/cornerstone:/usr/src/app -it bc/stencil-cli stencil start` and so on
+
 ## License
 
 Copyright (c) 2015-present, BigCommerce Inc.

package/lib/stencil-push.js

@@ -13,6 +13,7 @@ function stencilPush(options = {}, callback) {
             utils.notifyUserOfThemeLimitReachedIfNecessary,
             utils.promptUserToDeleteThemesIfNecessary,
             utils.deleteThemesIfNecessary,
+            utils.checkIfDeletionIsComplete(),
             utils.uploadBundleAgainIfNecessary,
             utils.notifyUserOfThemeUploadCompletion,
             utils.pollForJobCompletion((data) => ({ themeId: data.theme_id })),

package/lib/stencil-push.utils.js

@@ -87,6 +87,7 @@ utils.uploadBundle = async (options) => {
         config: { accessToken },
         bundleZipPath,
         storeHash,
+        uploadBundleAgain,
     } = options;
 
     const apiHost = options.apiHost || options.config.apiHost;
@@ -97,6 +98,7 @@ utils.uploadBundle = async (options) => {
             apiHost,
             bundleZipPath,
             storeHash,
+            uploadBundleAgain,
         });
         return {
             ...options,
@@ -188,12 +190,54 @@ utils.deleteThemesIfNecessary = async (options) => {
     return options;
 };
 
+utils.checkIfDeletionIsComplete = () => {
+    return async.retryable(
+        {
+            interval: 1000,
+            errorFilter: (err) => {
+                if (err.message === 'ThemeStillExists') {
+                    console.log(`${'warning'.yellow} -- Theme still exists;Retrying ...`);
+                    return true;
+                }
+                return false;
+            },
+            times: 5,
+        },
+        utils.checkIfThemeIsDeleted(),
+    );
+};
+
+utils.checkIfThemeIsDeleted = () => async (options) => {
+    const {
+        themeLimitReached,
+        config: { accessToken },
+        storeHash,
+        themeIdsToDelete,
+    } = options;
+
+    if (!themeLimitReached) {
+        return options;
+    }
+
+    const apiHost = options.apiHost || options.config.apiHost;
+
+    const result = await themeApiClient.getThemes({ accessToken, apiHost, storeHash });
+
+    const themeStillExists = result.some((theme) => themeIdsToDelete.includes(theme.uuid));
+
+    if (themeStillExists) {
+        throw new Error('ThemeStillExists');
+    }
+
+    return options;
+};
+
 utils.uploadBundleAgainIfNecessary = async (options) => {
     if (!options.themeLimitReached) {
         return options;
     }
 
-    return utils.uploadBundle(options);
+    return utils.uploadBundle({ ...options, uploadThemeAgain: true });
 };
 
 utils.notifyUserOfThemeUploadCompletion = async (options) => {

package/lib/theme-api-client.js

@@ -278,9 +278,10 @@ async function getVariationsByThemeId({ accessToken, apiHost, storeHash, themeId
  * @param {string} options.accessToken
  * @param {string} options.apiHost
  * @param {string} options.storeHash
+ * @param {boolean} options.uploadBundleAgain
  * @returns {Promise<object>}
  */
-async function postTheme({ bundleZipPath, accessToken, apiHost, storeHash }) {
+async function postTheme({ bundleZipPath, accessToken, apiHost, storeHash, uploadBundleAgain }) {
     const formData = new FormData();
     formData.append('file', fs.createReadStream(bundleZipPath), {
         filename: path.basename(bundleZipPath),
@@ -303,7 +304,12 @@ async function postTheme({ bundleZipPath, accessToken, apiHost, storeHash }) {
         // This status code is overloaded, so we need to check the message to determine
         // if we want to trigger the theme deletion flow.
         const uploadLimitPattern = /You have reached your upload limit/;
-        if (payload && payload.title && uploadLimitPattern.exec(payload.title)) {
+        if (
+            payload &&
+            payload.title &&
+            uploadLimitPattern.exec(payload.title) &&
+            !uploadBundleAgain
+        ) {
             return { themeLimitReached: true };
         }