@mindful-web/marko-web 1.91.0 → 1.92.1

package/express/client-errors.js

@@ -0,0 +1,114 @@
+const express = require('express');
+const { newrelicAgent } = require('@mindful-web/utils');
+
+/**
+ * Receives client-side error reports and records them as New Relic `ClientError`
+ * custom events.
+ *
+ * Browser failures are otherwise invisible: there is no New Relic Browser agent on the
+ * fleet, and a `fetch` that is challenged or blocked at the edge never reaches the
+ * origin, so nothing appears in server-side telemetry either. This route is the seam
+ * that makes those failures countable.
+ *
+ * Two rules govern everything here:
+ *
+ * 1. **Never fail.** The response is always 204, whatever the body contains and whether
+ *    or not a New Relic agent exists. A reporting endpoint that can error is a reporting
+ *    endpoint that generates the errors it is meant to measure.
+ * 2. **Never trust the body.** Identity (host/tenant/site) is supplied by the server, not
+ *    by the payload, so a report cannot attribute itself to another site.
+ */
+
+const MAX_MESSAGE = 500;
+const MAX_STACK = 1000;
+const MAX_URL = 1000;
+const MAX_SOURCE = 100;
+
+// Ceiling on events recorded per process per minute. The browser helper already
+// de-duplicates and caps per page view; this is the backstop for the case that cap cannot
+// cover — many clients failing at once, or a forged payload. A single global counter is
+// deliberate: per-IP state would grow unbounded and store client addresses to no benefit,
+// and the question this data answers ("how often does this happen") survives a ceiling.
+const MAX_EVENTS_PER_MINUTE = 600;
+
+let windowStart = 0;
+let windowCount = 0;
+
+const withinRateLimit = () => {
+  const now = Date.now();
+  if (now - windowStart >= 60000) {
+    windowStart = now;
+    windowCount = 0;
+  }
+  windowCount += 1;
+  return windowCount <= MAX_EVENTS_PER_MINUTE;
+};
+
+/**
+ * New Relic drops nested values, so every attribute must be a primitive. Non-strings are
+ * discarded rather than coerced — `[object Object]` rows are worse than absent ones.
+ */
+const str = (value, max) => {
+  if (typeof value !== 'string' || !value) return undefined;
+  return value.slice(0, max);
+};
+
+const int = (value) => (Number.isFinite(value) ? Math.trunc(value) : undefined);
+
+/**
+ * @param {import('express').Express} app
+ * @param {object} params
+ * @param {string} [params.tenantKey]
+ * @param {string} [params.siteId]
+ * @param {string} [params.mountPoint]
+ */
+module.exports = (app, { tenantKey, siteId, mountPoint = '/__client-error' } = {}) => {
+  const parseJson = express.json({ limit: '8kb' });
+
+  app.post(mountPoint, (req, res) => {
+    // The parser is invoked directly rather than mounted as middleware so that its own
+    // failures stay here. Mounted, a malformed body yields a 400 and an oversized one a
+    // 413, both thrown onward into the app's error handler — which would have this route
+    // manufacturing the very errors it exists to measure.
+    parseJson(req, res, (parseError) => {
+      // Answer before doing any work: the client is already in a failure state and must
+      // never be made to wait on telemetry.
+      res.status(204).end();
+      if (parseError) return;
+
+      try {
+        if (!withinRateLimit()) return;
+        const body = req.body && typeof req.body === 'object' ? req.body : {};
+        const { config } = app.locals;
+
+        newrelicAgent.recordCustomEvent('ClientError', {
+          message: str(body.message, MAX_MESSAGE) || 'Unknown client error',
+          name: str(body.name, 100),
+          source: str(body.source, MAX_SOURCE) || 'unknown',
+          componentName: str(body.componentName, 100),
+          stack: str(body.stack, MAX_STACK),
+          pageUrl: str(body.pageUrl, MAX_URL),
+          // Distinguishes an edge challenge (403 + HTML) from a genuine application error.
+          statusCode: int(body.statusCode),
+          cfRay: str(body.cfRay, 50),
+          cfMitigated: str(body.cfMitigated, 50),
+          // Caller-supplied context (e.g. the leaders section that failed).
+          sectionId: str(body.sectionId, 100),
+          sectionName: str(body.sectionName, 200),
+          // Set by the global `window.onerror` handler.
+          pageSource: str(body.pageSource, MAX_URL),
+          lineNumber: int(body.lineNumber),
+          // Identity comes from the server, never the payload. Named `siteHost` because
+          // New Relic reserves `host` for the reporting machine and silently overwrites
+          // it — the first production week recorded 211 pod names and zero site hosts.
+          siteHost: config ? config.website('host') : undefined,
+          tenantKey,
+          siteId,
+          userAgent: str(req.get('user-agent'), 500),
+        });
+      } catch (e) {
+        // Telemetry must never break a request — the response has already been sent.
+      }
+    });
+  });
+};

package/express/index.js

@@ -6,6 +6,7 @@ const path = require('path');
 const helmet = require('helmet');
 const { nanoid } = require('nanoid');
 const apollo = require('./apollo');
+const clientErrors = require('./client-errors');
 const graphqlProxy = require('./graphql-proxy');
 const embeddedMedia = require('./embedded-media');
 const loadObject = require('./load-object');
@@ -110,6 +111,9 @@ module.exports = (config = {}) => {
   });
   graphqlProxy(app, { graphqlUri, headers });
 
+  // Register the client-side error beacon.
+  clientErrors(app, { tenantKey, siteId });
+
   // Set website context.
   app.use(websiteContext(app.locals.config));
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindful-web/marko-web",
-  "version": "1.91.0",
+  "version": "1.92.1",
   "description": "Core Marko+Express components for Mindful Web websites",
   "author": "Jacob Bare <jacob@parameter1.com>",
   "main": "index.js",
@@ -26,19 +26,19 @@
     "@godaddy/terminus": "^4.11.2",
     "@mindful-web/apollo-ssr": "^1.0.0",
     "@mindful-web/dayjs": "^1.49.2",
-    "@mindful-web/embedded-media": "^1.84.0",
+    "@mindful-web/embedded-media": "^1.92.0",
     "@mindful-web/express-apollo": "^1.0.0",
     "@mindful-web/graphql-fragment-types": "^1.0.0",
     "@mindful-web/html": "^1.84.0",
-    "@mindful-web/image": "^1.84.0",
+    "@mindful-web/image": "^1.92.0",
     "@mindful-web/inflector": "^1.0.0",
     "@mindful-web/marko-express": "^1.70.3",
-    "@mindful-web/marko-node-require": "^1.83.1",
-    "@mindful-web/marko-web-deferred-script-loader": "^1.83.1",
-    "@mindful-web/object-path": "^1.83.1",
+    "@mindful-web/marko-node-require": "^1.92.0",
+    "@mindful-web/marko-web-deferred-script-loader": "^1.92.0",
+    "@mindful-web/object-path": "^1.92.0",
     "@mindful-web/tenant-context": "^1.0.0",
-    "@mindful-web/utils": "^1.83.1",
-    "@mindful-web/web-common": "^1.86.0",
+    "@mindful-web/utils": "^1.92.0",
+    "@mindful-web/web-common": "^1.92.0",
     "async": "^3.2.4",
     "cheerio": "^1.0.0-rc.12",
     "cookie-parser": "^1.4.6",
@@ -62,5 +62,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c1e3970f3c20e31a94eb5cd0a910316f4f8c4980"
+  "gitHead": "2f871b393fbf9fbf0cefcedd70c7f356cb457d0f"
 }