@commercetools-frontend/application-cli 1.0.1 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/application-cli",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Internal CLI to manage Merchant Center application deployments across various environments.",
   "keywords": [
     "commercetools",
@@ -20,18 +20,18 @@
     "README.md"
   ],
   "dependencies": {
-    "@commercetools-frontend/application-config": "21.3.4",
+    "@commercetools-frontend/application-config": "21.21.2",
     "@manypkg/find-root": "1.1.0",
     "@manypkg/get-packages": "1.1.3",
-    "cosmiconfig": "7.0.1",
-    "dotenv": "16.0.0",
+    "cosmiconfig": "8.0.0",
+    "dotenv": "16.0.3",
     "execa": "6.1.0",
     "listr": "0.14.3",
     "listr-verbose-renderer": "0.6.0",
     "lodash.lowerfirst": "4.3.1",
     "mri": "1.2.0",
     "node-fetch": "2.6.7",
-    "prettier": "2.6.2",
+    "prettier": "2.8.1",
     "prompts": "2.4.2",
     "rcfile": "1.0.3"
   },

package/src/bin/cli.js

@@ -18,7 +18,9 @@ const cwd = process.cwd();
         'application-index-upload-script-out-file': 'upload-index.sh',
         'application-assets-upload-script-out-file': 'upload-assets.sh',
         'application-index-out-file': 'application.html',
+        'skip-menu': false,
       },
+      boolean: ['skip-menu'],
     });
     const cliCommands = cliFlags._;
 
@@ -46,6 +48,7 @@ Options:
   --application-index-upload-script-out-file   <path>    (optional) The name of the the application index upload script file. Defaults to upload-index.sh.
   --application-assets-upload-script-out-file  <path>    (optional) The name of the the assets upload script file. Defaults to upload-assets.sh.
   --ci-assets-root-path                        <path>    (optional) A replacement value for the scripts root path only used on CI (e.g. '--ci-assets-root-path=/root/') used in generated scripts.
+  --skip-menu                                            (optional) If provided, it will skip uploading the 'menu.json'.
 
 Command:
   compile-menu   Compile the menu links of an application into a 'menu.json'. This is only required for internal applications

package/src/commands/compile-deployments.js

@@ -84,6 +84,7 @@ async function compileApplicationAssets({ cliFlags, bucketRegion, paths }) {
         applicationName: cliFlags['application-name'],
       }),
       assetsPath: paths.assetsPath,
+      skipMenu: cliFlags['skip-menu'],
     });
   const parsedApplicationAssetsUploadScriptFile = path.parse(
     cliFlags['application-assets-upload-script-out-file']
@@ -124,32 +125,42 @@ async function compileEnvironmentApplicationIndexes({
     applicationName: cliFlags['application-name'],
   });
 
+  const environmentVariablesForCompilation = {
+    ...loadDotenvFiles({
+      dotenvPath: paths.dotenvPath,
+      cloudEnvironment,
+    }),
+    // The trailing slash is important to indicate to the CSP directive that all the resources
+    // under that path should be allowed.
+    MC_CDN_URL: `${cdnUrl}/`,
+    ...(cliFlags['mc-url']
+      ? {
+          MC_URL: cliFlags['mc-url'],
+        }
+      : {}),
+    ...(cliFlags['mc-api-url']
+      ? {
+          MC_API_URL: cliFlags['mc-api-url'],
+        }
+      : {}),
+    // Will be used by the Application Kit for Sentry and exposed on `window.app.revision`.
+    REVISION: cliFlags['build-revision'],
+  };
+
+  /// Sentry and GTM is disabled on branch deployments
+  if (cliFlags['pr-number']) {
+    process.env.TRACKING_SENTRY = null;
+    process.env.TRACKING_GTM = null;
+    environmentVariablesForCompilation.TRACKING_SENTRY = null;
+    environmentVariablesForCompilation.TRACKING_GTM = null;
+  }
+
   // Compile the application using the loaded environment values
   const compileResult = await execa('mc-scripts', ['compile-html'], {
     encoding: 'utf8',
     preferLocal: true,
     extendEnv: true,
-    env: {
-      ...loadDotenvFiles({
-        dotenvPath: paths.dotenvPath,
-        cloudEnvironment,
-      }),
-      // The trailing slash is important to indicate to the CSP directive that all the resources
-      // under that path should be allowed.
-      MC_CDN_URL: `${cdnUrl}/`,
-      ...(cliFlags['mc-url']
-        ? {
-            MC_URL: cliFlags['mc-url'],
-          }
-        : {}),
-      ...(cliFlags['mc-api-url']
-        ? {
-            MC_API_URL: cliFlags['mc-api-url'],
-          }
-        : {}),
-      // Will be used by the Application Kit for Sentry and exposed on `window.app.revision`.
-      REVISION: cliFlags['build-revision'],
-    },
+    env: environmentVariablesForCompilation,
   });
 
   if (compileResult.failed) {

package/src/utils/create-application-assets-upload-script.js

@@ -1,4 +1,8 @@
-function createApplicationAssetsUploadScript({ bucketUrl, assetsPath }) {
+function createApplicationAssetsUploadScript({
+  bucketUrl,
+  assetsPath,
+  skipMenu,
+}) {
   const uploadScriptContent = `#!/usr/bin/env bash
 
 set -e
@@ -13,6 +17,7 @@ set -e
 #     5. The '-n' will skip uploading existing files and prevents them to
 #        be overwritten
 echo "Uploading static assets to bucket ${bucketUrl}"
+
 gsutil -m \\
   -h "Cache-Control: public, max-age=31536000, no-transform" \\
   cp -z js,css \\
@@ -20,39 +25,33 @@ gsutil -m \\
   ${assetsPath}/public/{*.css,*.js,*.js.map,*.png,*.html,robots.txt} \\
   "${bucketUrl}"
 
-echo "Uploading menu.json to bucket ${bucketUrl}"
-# NOTE: somehow the 'cache-control:private' doesn't work.
-# I mean, the file is uploaded with the correct metadata but when I fetch
-# the file the response contains the header
-# 'cache-control: public, max-age=31536000, no-transform', even though the
-# documentation clearly states that by marking the header as 'private' will
-# disable the cache (for publicly readable objects).
-# https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata#cache-control
-# However, I found out that, by requesting the file with any RANDOM
-# query parameter, will instruct the storage to return a 'fresh' object
-# (without any cache control).
-# Unofficial source: https://stackoverflow.com/a/49052895
-# This seems to be the 'easiest' option to 'disable' the cache for public
-# objects. Other alternative approaces are:
-#   * make the object private with some simple ACL (private objects are not cached)
-#   * suffix the file name with e.g. the git SHA, so we have different files
-#   for each upload ('index.html.template-\${CIRCLE_SHA1}'). The server knows
-#   the git SHA on runtime and can get the correct file when it starts.
-#   * find out why the 'private' cache control does not work
-gsutil \\
-  -h "Content-Type: application/json" \\
-  -h "Cache-Control: private, max-age=0, no-transform" \\
-  cp -z json \\
-  ${assetsPath}/menu.json \\
-  ${bucketUrl}
-
-if [[ -f "${assetsPath}/public/licenses.csv" ]]; then
-  echo "Uploading licenses.csv to bucket ${bucketUrl}"
+if ${skipMenu}; then
+  echo "Skipping menu.json upload"
+else
+  echo "Uploading menu.json to bucket ${bucketUrl}"
+  # NOTE: somehow the 'cache-control:private' doesn't work.
+  # I mean, the file is uploaded with the correct metadata but when I fetch
+  # the file the response contains the header
+  # 'cache-control: public, max-age=31536000, no-transform', even though the
+  # documentation clearly states that by marking the header as 'private' will
+  # disable the cache (for publicly readable objects).
+  # https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata#cache-control
+  # However, I found out that, by requesting the file with any RANDOM
+  # query parameter, will instruct the storage to return a 'fresh' object
+  # (without any cache control).
+  # Unofficial source: https://stackoverflow.com/a/49052895
+  # This seems to be the 'easiest' option to 'disable' the cache for public
+  # objects. Other alternative approaces are:
+  #   * make the object private with some simple ACL (private objects are not cached)
+  #   * suffix the file name with e.g. the git SHA, so we have different files
+  #   for each upload ('index.html.template-\${CIRCLE_SHA1}'). The server knows
+  #   the git SHA on runtime and can get the correct file when it starts.
+  #   * find out why the 'private' cache control does not work
   gsutil \\
-    -h "Content-Type: text/csv" \\
+    -h "Content-Type: application/json" \\
     -h "Cache-Control: private, max-age=0, no-transform" \\
-    cp -z csv \\
-    ${assetsPath}/public/licenses.csv \\
+    cp -z json \\
+    ${assetsPath}/menu.json \\
     ${bucketUrl}
 fi
 `;