@bigcommerce/stencil-cli 10.0.0 → 10.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/stencil-cli",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "type": "module",
   "description": "CLI tool to run BigCommerce Stores locally for theme development.",
   "main": "index.js",
@@ -73,6 +73,7 @@
     "front-matter": "^4.0.2",
     "glob": "^7.1.6",
     "graceful-fs": "^4.2.4",
+    "http-proxy": "^1.18.1",
     "husky": "^8.0.1",
     "image-size": "^0.9.1",
     "inquirer": "^8.1.5",
@@ -92,6 +93,7 @@
     "recursive-readdir": "^2.2.2",
     "semver": "^7.3.2",
     "simple-git": "^3.26.0",
+    "tar": "^7.5.2",
     "tarjan-graph": "^2.0.0",
     "tmp-promise": "^3.0.2",
     "upath": "^1.2.0",

package/server/index.js

@@ -8,7 +8,7 @@ import 'colors';
 
 const getDirname = dirname(fileURLToPath(import.meta.url));
 
-function buildManifest(srcManifest, options) {
+export function buildManifest(srcManifest, options) {
     const resManifest = _.cloneDeep(srcManifest);
     const pluginsByName = resManifest.register.plugins;
     const parsedSecureUrl = new URL(options.dotStencilFile.storeUrl); // The url to a secure page (prompted as login page)
@@ -42,6 +42,12 @@ function buildManifest(srcManifest, options) {
         (pluginsArr, opts, plugin) => [...pluginsArr, { plugin, options: opts }],
         [],
     );
+    if (options.previewSecret) {
+        resManifest.register.plugins.unshift({
+            plugin: './plugins/preview-auth/preview-auth.module.js',
+            options: { secret: options.previewSecret },
+        });
+    }
     return resManifest;
 }
 async function create(options) {

package/server/plugins/preview-auth/preview-auth.module.js

@@ -0,0 +1,38 @@
+import { createHash, timingSafeEqual } from 'node:crypto';
+import Boom from '@hapi/boom';
+
+const PREVIEW_SECRET_HEADER = 'x-stencil-preview-secret';
+
+// Hash both values so the comparison takes the same time for any input length.
+function secretsMatch(expected, supplied) {
+    const digest = (value) => createHash('sha256').update(value).digest();
+    return timingSafeEqual(digest(expected), digest(supplied));
+}
+
+/**
+ * Loaded only in Makeswift preview mode.
+ */
+function register(server, { secret }) {
+    if (typeof secret !== 'string' || !secret) {
+        throw new Error('PreviewAuth requires a non-empty secret');
+    }
+    server.ext('onRequest', (request, h) => {
+        const supplied = request.headers[PREVIEW_SECRET_HEADER];
+        if (typeof supplied !== 'string') {
+            return Boom.unauthorized();
+        }
+        if (!secretsMatch(secret, supplied)) {
+            return Boom.forbidden();
+        }
+        delete request.headers[PREVIEW_SECRET_HEADER];
+        return h.continue;
+    });
+}
+export const name = 'PreviewAuth';
+export const version = '0.0.1';
+export { register };
+export default {
+    register,
+    name,
+    version,
+};

package/server/plugins/renderer/responses/pencil-response.js

@@ -56,6 +56,15 @@ const isSupportedHandlebarsVersion = (version) =>
  * @param {string} version
  */
 const compatibilizeTemplateEngine = (version) => version.replace('_', '-');
+/**
+ * Storefront headers that the Makeswift worker reads from the rendered page to find its
+ * Makeswift content.
+ */
+const MAKESWIFT_PAGE_HEADERS = [
+    'x-makeswift-stable-page-reference',
+    'x-makeswift-page-locale',
+    'x-makeswift-storefront-token',
+];
 /**
  * Output post-processing
  *
@@ -134,6 +143,11 @@ class PencilResponse {
             if (this.data.headers['set-cookie']) {
                 response.header('set-cookie', this.data.headers['set-cookie']);
             }
+            for (const name of MAKESWIFT_PAGE_HEADERS) {
+                if (this.data.headers[name]) {
+                    response.header(name, this.data.headers[name]);
+                }
+            }
             return response;
         } catch (err) {
             console.error(err.message.red);