@mindful-web/marko-web 1.28.0 → 1.43.0

package/express/bot-scores.js

@@ -0,0 +1,109 @@
+const { asyncRoute, cleanPath } = require('@mindful-web/utils');
+const fetch = require('node-fetch');
+
+const { error } = console;
+
+module.exports = function botScores({
+  apiKey,
+  app,
+  enabled,
+  url,
+}) {
+  const hasRequiredProps = Boolean(apiKey && url);
+
+  /** @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('/__bmsc/1', asyncRoute(async (req, res) => {
+    if (!$botScores.enabled) return res.set({ 'x-meta': '{}' }).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-token': token }) });
+
+    res.set({ 'x-meta': JSON.stringify(headers) });
+    return res.send('');
+  }));
+
+  app.post('/__bmsc/2', 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';
+    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;
+
+      return res.send({ ok: true, info });
+    } catch (e) {
+      // @todo better logging
+      error(`error collecting bot score info: ${e.message}`);
+      return res.send({ ok: false, ...(showInfo && { info: e.message }) });
+    }
+  }));
+
+  return (_, res, next) => {
+    res.locals.$botScores = $botScores;
+    next();
+  };
+};
+
+/**
+ * @typedef BotScores
+ * @prop {BuildFetchHeadersFn} buildFetchHeaders
+ * @prop {boolean} enabled
+ */
+/**
+ * @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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindful-web/marko-web",
-  "version": "1.28.0",
+  "version": "1.43.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": "021bf1a470ddc22990cc680dc1a218f93cd115ed"
 }