@mindful-web/marko-web 1.28.0 → 1.42.0

package/express/bot-scores.js

@@ -0,0 +1,108 @@
+const { asyncRoute, cleanPath } = require('@mindful-web/utils');
+const fetch = require('node-fetch');
+const { extname } = require('path');
+
+const { error } = console;
+
+module.exports = function botScores({
+  apiKey,
+  app,
+  enabled,
+  url,
+}) {
+  const hasRequiredProps = Boolean(apiKey && url);
+  const isEnabled = hasRequiredProps ? enabled : false;
+
+  app.post('/__bmsc', asyncRoute(async (req, res) => {
+    if (!isEnabled) return;
+    const env = process.env.NODE_ENV;
+    const showInfo = env === 'development' || req.query.debug === 'true';
+    try {
+      // remove incoming host header
+      const { host, ...headers } = req.headers;
+      const response = await fetch(`${cleanPath(url)}/collect`, {
+        method: 'POST',
+        headers: {
+          ...headers,
+          ...(env === 'development' && {
+            origin: `https://${app.locals.config.website('host')}`,
+          }),
+          authorization: `Bearer ${apiKey}`,
+          'x-env': env,
+        },
+        body: JSON.stringify({}),
+      });
+      if (!response.ok) throw new Error(`Bad response: ${response.status}`);
+      const info = showInfo ? await response.json() : undefined;
+
+      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, 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();
+  };
+};
+
+/**
+ * @typedef BotScores
+ * @prop {BuildFetchHeadersFn} buildFetchHeaders
+ * @prop {boolean} enabled
+ * @prop {IsValidRequestPathFn} isValidRequestPath
+ * @prop {BotScoresLoadTokenFn} loadToken
+ * @prop {string} [token]
+ */
+/**
+ * @callback BotScoresLoadTokenFn
+ * @returns {Promise<void>}
+ */
+/**
+ * @callback BuildFetchHeadersFn
+ * @return {Record<string, string>}
+ */
+/**
+ * @callback IsValidRequestPathFn
+ * @param {string} path
+ * @return {boolean}
+ */

package/express/index.js

@@ -7,6 +7,7 @@ const path = require('path');
 const helmet = require('helmet');
 const { nanoid } = require('nanoid');
 const apollo = require('./apollo');
+const botScores = require('./bot-scores');
 const graphqlProxy = require('./graphql-proxy');
 const embeddedMedia = require('./embedded-media');
 const loadObject = require('./load-object');
@@ -116,6 +117,14 @@ module.exports = (config = {}) => {
     });
   }
 
+  // must be loaded _before_ website context
+  app.use(botScores({
+    apiKey: process.env.BOT_SCORES_API_KEY,
+    app,
+    enabled: process.env.BOT_SCORES_DISABLE !== 'true',
+    url: process.env.BOT_SCORES_URL,
+  }));
+
   // Set website context.
   app.use(websiteContext(app.locals.config));
 

package/express/website-context.js

@@ -3,8 +3,15 @@ const { asyncRoute } = require('@mindful-web/utils');
 const { setDayjsLocale } = require('@mindful-web/dayjs/utils');
 
 module.exports = (coreConfig) => asyncRoute(async (req, res, next) => {
-  const { apollo } = res.locals;
-  const websiteContext = await loadWebsite(apollo);
+  /** @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();
+    })(),
+  ]);
   coreConfig.setWebsiteContext(websiteContext);
 
   const locale = coreConfig.website('date.locale');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindful-web/marko-web",
-  "version": "1.28.0",
+  "version": "1.42.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": "49740ec41e40566786bb521ab657f418c0538609"
+  "gitHead": "278285910cc076501cd92f2c942e08aeea7a77cf"
 }