@mindful-web/marko-web 1.42.0 → 1.44.0

package/express/bot-scores.js

@@ -1,6 +1,5 @@
 const { asyncRoute, cleanPath } = require('@mindful-web/utils');
 const fetch = require('node-fetch');
-const { extname } = require('path');
 
 const { error } = console;
 
@@ -11,12 +10,59 @@ module.exports = function botScores({
   url,
 }) {
   const hasRequiredProps = Boolean(apiKey && url);
-  const isEnabled = hasRequiredProps ? enabled : false;
 
-  app.post('/__bmsc', asyncRoute(async (req, res) => {
-    if (!isEnabled) return;
+  /** @type {BotScores} */
+  const $botScores = {
+    buildFetchHeaders: () => {
+      const [org] = app.locals.tenantKey.split('_');
+      return {
+        'content-type': 'application/json',
+        'x-host': app.locals.config.website('host'),
+        'x-org-key': org,
+        'x-requested-with': 'XMLHttpRequest',
+      };
+    },
+    enabled: hasRequiredProps ? enabled : false,
+  };
+
+  const loadToken = async () => {
+    if (!$botScores.enabled) return null;
+    try {
+      const response = await fetch(`${cleanPath(url)}/token`, {
+        method: 'GET',
+        headers: { authorization: `Bearer ${apiKey}` },
+      });
+      if (!response.ok) throw new Error(`Bad response: ${response.status}`);
+      const { token } = await response.json();
+      return token;
+    } catch (e) {
+      // @todo better logging
+      error(`error retrieving bot scores token: ${e.message}`);
+      return null;
+    }
+  };
+
+  app.post('/__bs/:event(gam|gtm)', asyncRoute(async (req, res) => {
+    const { event } = req.params;
+    if (!$botScores.enabled) return res.set({ 'x-send': JSON.stringify({ event, ...$botScores.buildFetchHeaders() }) }).send('');
+
+    const token = await loadToken();
+
+    const headers = ['asn', 'vbc', 'bmsc', 'bmvb'].reduce((o, k) => {
+      const header = `x-${k}`;
+      const v = req.headers[header];
+      return { ...o, ...(v && { [header]: v }) };
+    }, { ...(token && { 'x-event': event, 'x-token': token, ...$botScores.buildFetchHeaders() }) });
+
+    res.set({ 'x-send': JSON.stringify(headers) });
+    return res.send('');
+  }));
+
+  app.post('/__bs/:event(gam|gtm)/s', asyncRoute(async (req, res) => {
+    if (!$botScores.enabled) return res.send({ noop: true });
+
     const env = process.env.NODE_ENV;
-    const showInfo = env === 'development' || req.query.debug === 'true';
+    const showInfo = env === 'development' || req.headers['x-debug'] === 'true';
     try {
       // remove incoming host header
       const { host, ...headers } = req.headers;
@@ -35,51 +81,15 @@ module.exports = function botScores({
       if (!response.ok) throw new Error(`Bad response: ${response.status}`);
       const info = showInfo ? await response.json() : undefined;
 
-      res.send({ ok: true, info });
+      return res.send({ ok: true, info });
     } catch (e) {
       // @todo better logging
       error(`error collecting bot score info: ${e.message}`);
-      res.send({ ok: false, ...(showInfo && { info: e.message }) });
+      return res.send({ ok: false, ...(showInfo && { info: e.message }) });
     }
   }));
 
   return (_, res, next) => {
-    /** @type {BotScores} */
-    const $botScores = {
-      buildFetchHeaders() {
-        const [org] = app.locals.tenantKey.split('_');
-        return {
-          'content-type': 'application/json',
-          'x-host': app.locals.config.website('host'),
-          'x-org-key': org,
-          'x-requested-with': 'XMLHttpRequest',
-          'x-token': this.token,
-        };
-      },
-      enabled: isEnabled,
-      isValidRequestPath: (path) => {
-        if (!path) return false;
-        if (path.startsWith('/__') || path.startsWith('/dist') || path.startsWith('/print/content')) return false;
-        if (extname(path)) return false;
-        return true;
-      },
-      loadToken: async () => {
-        if (!isEnabled) return;
-        if ($botScores.token) return;
-        try {
-          const response = await fetch(`${cleanPath(url)}/token`, {
-            method: 'GET',
-            headers: { authorization: `Bearer ${apiKey}` },
-          });
-          if (!response.ok) throw new Error(`Bad response: ${response.status}`);
-          const { token } = await response.json();
-          $botScores.token = token;
-        } catch (e) {
-          // @todo better logging
-          error(`error retrieving bot scores token: ${e.message}`);
-        }
-      },
-    };
     res.locals.$botScores = $botScores;
     next();
   };
@@ -89,13 +99,6 @@ module.exports = function botScores({
  * @typedef BotScores
  * @prop {BuildFetchHeadersFn} buildFetchHeaders
  * @prop {boolean} enabled
- * @prop {IsValidRequestPathFn} isValidRequestPath
- * @prop {BotScoresLoadTokenFn} loadToken
- * @prop {string} [token]
- */
-/**
- * @callback BotScoresLoadTokenFn
- * @returns {Promise<void>}
  */
 /**
  * @callback BuildFetchHeadersFn

package/express/website-context.js

@@ -3,15 +3,8 @@ const { asyncRoute } = require('@mindful-web/utils');
 const { setDayjsLocale } = require('@mindful-web/dayjs/utils');
 
 module.exports = (coreConfig) => asyncRoute(async (req, res, next) => {
-  /** @type {{ apollo: any; $botScores?: import("./bot-scores").BotScores }} */
-  const { apollo, $botScores } = res.locals;
-  const [websiteContext] = await Promise.all([
-    loadWebsite(apollo),
-    (async () => {
-      if (!$botScores || !$botScores.isValidRequestPath(req.path)) return null;
-      return $botScores.loadToken();
-    })(),
-  ]);
+  const { apollo } = res.locals;
+  const websiteContext = await loadWebsite(apollo);
   coreConfig.setWebsiteContext(websiteContext);
 
   const locale = coreConfig.website('date.locale');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindful-web/marko-web",
-  "version": "1.42.0",
+  "version": "1.44.0",
   "description": "Core Marko+Express components for Mindful Web websites",
   "author": "Jacob Bare <jacob@parameter1.com>",
   "main": "index.js",
@@ -60,5 +60,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "278285910cc076501cd92f2c942e08aeea7a77cf"
+  "gitHead": "e3023eb179d3a67663791eb2f3d13bd9fc255f4a"
 }