@bookshop/hugo-engine 3.4.1 → 3.5.0

package/full-hugo-renderer/wasm_exec.js

@@ -48,7 +48,11 @@
 				outputBuf += decoder.decode(buf);
 				const nl = outputBuf.lastIndexOf("\n");
 				if (nl != -1) {
-					// Disable all logs from the WASM side
+					// Track logs for Bookshop to pick up later
+					window.hugo_wasm_logging = window.hugo_wasm_logging || [];
+					window.hugo_wasm_logging.push(outputBuf.substr(0, nl));
+
+					// Disable console logs from the WASM side
 					if (window.log_hugo_wasm) {
 						console.log(outputBuf.substr(0, nl));
 					}

package/lib/engine.js

@@ -201,6 +201,53 @@ export class Engine {
         window.writeHugoFiles(JSON.stringify(files));
     }
 
+    /**
+     * Tries to parse an error message and patch up the components
+     * in a rudimentary way before a rebuild.
+     */
+    async componentQuack(error_string = "", log_messages = []) {
+        try {
+            const component_regex = /execute of template failed: template: ([^:]+):\d/ig;
+            let file_stack = [...error_string.matchAll(component_regex)].map(([, file]) => `layouts/${file}`);
+            if (file_stack.length) {
+                const deepest_errored_component = file_stack[file_stack.length-1];
+                const error_chunks = error_string.split("execute of template failed:");
+                const error_msg = error_chunks[error_chunks.length-1] ?? "template error";
+                window.writeHugoFiles(JSON.stringify({
+                    [deepest_errored_component]: [
+                        `<div style="padding: 10px; background-color: lightcoral; color: black; font-weight: bold;">`,
+                        `Failed to render ${deepest_errored_component}. <br/>`,
+                        `<pre style="margin-top: 10px; background-color: lightcoral; border: solid 1px black; white-space: pre-line;">`,
+                        `<code style="font-family: monospace; color: black;">${error_msg.replace(/</, '&lt;')}</code></pre>`,
+                        `</div>`
+                    ].join('\n')
+                }));
+                return deepest_errored_component;
+            }
+
+            const error_logs = log_messages.filter(log => log.startsWith("ERROR")).join("\n");
+            const missing_regex = /Component "([^"]+)" does not exist/ig;
+            file_stack = [...error_logs.matchAll(missing_regex)].map(([, file]) => {
+                let filename = file.split('/').pop();
+                return `layouts/partials/bookshop/components/${file}/${filename}.hugo.html`;
+            });
+            if (file_stack.length) {
+                const deepest_errored_component = file_stack[file_stack.length-1];
+                window.writeHugoFiles(JSON.stringify({
+                    [deepest_errored_component]: [
+                        `<div class="bookshop_error" style="padding: 10px; background-color: lightcoral; color: black; font-weight: bold;">`,
+                        `Failed to find component ${deepest_errored_component}`,
+                        `</div>`
+                    ].join('\n')
+                }));
+                return deepest_errored_component;
+            }
+        } catch (e) {
+            console.error(`ComponentQuack failed to patch things up: ${e}`);
+            return null;
+        }
+    }
+
     async render(target, name, props, globals, logger) {
         while (!window.buildHugo) {
             logger?.log?.(`Waiting for the Hugo WASM to be available...`);
@@ -233,9 +280,22 @@ export class Engine {
         }, null, 2) + "\n";
         window.writeHugoFiles(JSON.stringify(writeFiles));
 
-        const buildResult = window.buildHugo();
-        if (buildResult) {
-            console.error(buildResult);
+        window.hugo_wasm_logging = [];
+        let render_attempts = 1;
+        let buildError = window.buildHugo();
+        while (buildError && render_attempts < 5) {
+            if (this.componentQuack(buildError, window.hugo_wasm_logging) === null) {
+                // Can't find a template to overwrite and re-render
+                break;
+            }
+            // Try render again with the problem template stubbed out
+            window.hugo_wasm_logging = [];
+            buildError = window.buildHugo();
+            render_attempts += 1;
+        }
+
+        if (buildError) {
+            console.error(buildError);
             return;
         }
 
@@ -245,16 +305,6 @@ export class Engine {
 
         target.innerHTML = output["public/index.html"];
         return;
-
-        const outputs = window.renderHugo(source, JSON.stringify(props));
-        if (/BKSHERR/.test(output)) {
-            logger?.log?.(`Failed to render ${output}`);
-            console.error(output);
-        } else {
-            target.innerHTML = output;
-            logger?.log?.(`Rendered ${name} as:`);
-            logger?.log?.(target.innerHTML);
-        }
     }
 
     async eval(str, props = [{}], logger) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bookshop/hugo-engine",
   "packageManager": "yarn@3.0.0",
-  "version": "3.4.1",
+  "version": "3.5.0",
   "description": "Bookshop frontend Hugo renderer",
   "type": "module",
   "sideEffects": false,
@@ -30,7 +30,7 @@
     "nyc": "^15.1.0"
   },
   "dependencies": {
-    "@bookshop/helpers": "3.4.1",
+    "@bookshop/helpers": "3.5.0",
     "esbuild": "^0.13.10",
     "fflate": "^0.7.3",
     "liquidjs": "9.28.0"

package/.nyc_output/processinfo/229a6434-8446-4f8b-98c5-2b71c6b2eb87.json

@@ -1 +0,0 @@
-{"parent":"2405260d-8f87-4702-a513-c39fc37b2ae7","pid":5484,"argv":["/opt/hostedtoolcache/node/16.19.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1679549944033,"ppid":5467,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/229a6434-8446-4f8b-98c5-2b71c6b2eb87.json","externalId":"","uuid":"229a6434-8446-4f8b-98c5-2b71c6b2eb87","files":[]}

package/.nyc_output/processinfo/2405260d-8f87-4702-a513-c39fc37b2ae7.json

@@ -1 +0,0 @@
-{"parent":null,"pid":5467,"argv":["/opt/hostedtoolcache/node/16.19.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1679549943598,"ppid":5456,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/2405260d-8f87-4702-a513-c39fc37b2ae7.json","externalId":"","uuid":"2405260d-8f87-4702-a513-c39fc37b2ae7","files":[]}

package/.nyc_output/processinfo/27ed531c-5699-42a6-8c8c-2debe705576a.json

@@ -1 +0,0 @@
-{"parent":"2405260d-8f87-4702-a513-c39fc37b2ae7","pid":5500,"argv":["/opt/hostedtoolcache/node/16.19.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1679549944390,"ppid":5467,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/27ed531c-5699-42a6-8c8c-2debe705576a.json","externalId":"","uuid":"27ed531c-5699-42a6-8c8c-2debe705576a","files":[]}

package/.nyc_output/processinfo/2e2d9437-5bb4-4cfc-9850-fddb27cec721.json

@@ -1 +0,0 @@
-{"parent":"2405260d-8f87-4702-a513-c39fc37b2ae7","pid":5506,"argv":["/opt/hostedtoolcache/node/16.19.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1679549944400,"ppid":5467,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/2e2d9437-5bb4-4cfc-9850-fddb27cec721.json","externalId":"","uuid":"2e2d9437-5bb4-4cfc-9850-fddb27cec721","files":[]}

package/.nyc_output/processinfo/d293db7a-a9b9-470c-9ca5-5beabc3f323f.json

@@ -1 +0,0 @@
-{"parent":"2405260d-8f87-4702-a513-c39fc37b2ae7","pid":5478,"argv":["/opt/hostedtoolcache/node/16.19.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1679549944028,"ppid":5467,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/d293db7a-a9b9-470c-9ca5-5beabc3f323f.json","externalId":"","uuid":"d293db7a-a9b9-470c-9ca5-5beabc3f323f","files":[]}