@gasket/plugin-elastic-apm 6.46.8 → 6.47.1

package/lib/configure.js

@@ -0,0 +1,51 @@
+/// <reference types="@gasket/plugin-command" />
+
+const isDefined = (o) => typeof o !== 'undefined';
+
+/**
+ * Determines if the Elastic APM agent has sufficient config to be active
+ * @param {import('./index').ExtendedAgentConfigOptions} config Apm agent config
+ * @param {NodeJS.ProcessEnv} env Environment variables
+ * @returns {boolean} A combined config object
+ */
+const isActive = (config, env) => {
+  const { active, serverUrl, secretToken } = config;
+
+  if (active || env.ELASTIC_APM_ACTIVE) {
+    return true;
+  }
+
+  const combined = {
+    serverUrl: serverUrl || env.ELASTIC_APM_SERVER_URL,
+    secretToken: secretToken || env.ELASTIC_APM_SECRET_TOKEN
+  };
+
+  if (combined.serverUrl && combined.secretToken) {
+    return true;
+  }
+
+  return false;
+};
+
+/** @type {import('@gasket/engine').HookHandler<'configure'>} */
+module.exports = async function configure(gasket, config) {
+  const { logger } = gasket;
+  config.elasticAPM = config.elasticAPM || {};
+
+  const { serverUrl, secretToken } = config.elasticAPM;
+  if (isDefined(serverUrl)) {
+    logger.notice(
+      'DEPRECATED config `elasticAPM.serverUrl`. Use env var: ELASTIC_APM_SERVER_URL'
+    );
+  }
+  if (isDefined(secretToken)) {
+    logger.notice(
+      'DEPRECATED config `elasticAPM.secretToken`. Use env var: ELASTIC_APM_SECRET_TOKEN'
+    );
+  }
+
+  // eslint-disable-next-line no-process-env
+  config.elasticAPM.active = isActive(config.elasticAPM, process.env);
+
+  return { ...config };
+};

package/lib/cookies.js

@@ -1,8 +1,7 @@
 /**
  * Returns an array of cookie names which are considered sensitive because they
  * may contain session credential or PII
- *
- * @param {*} config the Gasket config object
+ * @param {import('@gasket/engine').GasketConfig} config the Gasket config
  * @returns {string[]} an array of cookie names
  */
 const sensitiveCookies = (config) => {
@@ -18,28 +17,30 @@ const sensitiveCookies = (config) => {
 
 /**
  * Redacts the contents of user-specified sensitive cookies
- *
- * @param {object} config The Gasket config
- * @param {object} payload The APM payload
- * @returns {object} a modified version of the incoming APM payload
+ * @type {import('./index').filterSensitiveCookies}
  */
-const filterSensitiveCookies = (config) => (payload) => {
-  if (
-    payload.context &&
-    payload.context.request &&
-    payload.context.request.headers &&
-    payload.context.request.headers.cookie
-  ) {
-    let cookie = payload.context.request.headers.cookie;
+const filterSensitiveCookies = function (config) {
+  return function (payload) {
+    if (
+      payload.context &&
+      payload.context.request &&
+      payload.context.request.headers &&
+      payload.context.request.headers.cookie
+    ) {
+      let cookie = payload.context.request.headers.cookie;
 
-    sensitiveCookies(config).forEach((sc) => {
-      cookie = cookie.replace(new RegExp(sc + '=([^;]+)'), sc + '=[REDACTED]');
-    });
+      sensitiveCookies(config).forEach((sc) => {
+        cookie = cookie.replace(
+          new RegExp(sc + '=([^;]+)'),
+          sc + '=[REDACTED]'
+        );
+      });
 
-    payload.context.request.headers.cookie = cookie;
-  }
+      payload.context.request.headers.cookie = cookie;
+    }
 
-  return payload;
+    return payload;
+  };
 };
 
 module.exports = {

package/lib/index.d.ts

@@ -1,12 +1,17 @@
 import type { IncomingMessage, ServerResponse } from 'http';
-import type { Agent, AgentConfigOptions, Transaction } from 'elastic-apm-node';
-import type { MaybeAsync } from '@gasket/engine';
+import type { Agent, AgentConfigOptions, Transaction, Payload } from 'elastic-apm-node';
+import type { MaybeAsync, GasketConfig } from '@gasket/engine';
+import type { GasketData } from '@gasket/data';
+
+export function filterSensitiveCookies(config: GasketConfig): function(Payload): Payload;
+
+interface ExtendedAgentConfigOptions extends AgentConfigOptions {
+  sensitiveCookies?: Array<string>;
+}
 
 declare module '@gasket/engine' {
   export interface GasketConfig {
-    elasticAPM?: AgentConfigOptions & {
-      sensitiveCookies?: Array<string>
-    },
+    elasticAPM?: ExtendedAgentConfigOptions;
   }
 
   export interface Gasket {
@@ -17,9 +22,15 @@ declare module '@gasket/engine' {
     apmTransaction(
       transaction: Transaction,
       details: {
-        req: IncomingMessage,
-        res: ServerResponse
+        req: IncomingMessage;
+        res: ServerResponse & {
+          locals?: {
+            gasketData: GasketData & {
+              locale?: string;
+            };
+          };
+        };
       }
-    ): MaybeAsync<void>
+    ): MaybeAsync<void>;
   }
 }

package/lib/index.js

@@ -1,78 +1,17 @@
-const { filterSensitiveCookies } = require('./cookies');
-const middleware = require('./middleware');
-const { dependencies } = require('../package.json');
-
-const isDefined = o => typeof o !== 'undefined';
-
-/**
- * Determines if the Elastic APM agent has sufficient config to be active
- * @param {object} config gasket config
- * @param {object<string,any>} env environment variables
- * @returns {boolean} A combined config object
- */
-const isActive = (config, env) => {
-  const { active, serverUrl, secretToken } = config;
-
-  if (active || env.ELASTIC_APM_ACTIVE) {
-    return true;
-  }
-
-  const combined = {
-    serverUrl: serverUrl || env.ELASTIC_APM_SERVER_URL,
-    secretToken: secretToken || env.ELASTIC_APM_SECRET_TOKEN
-  };
+/// <reference types="@gasket/cli" />
+/// <reference types="@gasket/plugin-metadata" />
 
-  if (combined.serverUrl && combined.secretToken) {
-    return true;
-  }
-
-  return false;
-};
+const middleware = require('./middleware');
+const preboot = require('./preboot');
+const configure = require('./configure');
+const { dependencies, name } = require('../package.json');
 
-module.exports = {
+/** @type {import('@gasket/engine').Plugin} */
+const plugin = {
+  name,
   hooks: {
-    configure: {
-      handler: async (gasket, config) => {
-        const { logger } = gasket;
-        config.elasticAPM = config.elasticAPM || {};
-
-        const { serverUrl, secretToken } = config.elasticAPM;
-        if (isDefined(serverUrl)) {
-          logger.notice('DEPRECATED config `elasticAPM.serverUrl`. Use env var: ELASTIC_APM_SERVER_URL');
-        }
-        if (isDefined(secretToken)) {
-          logger.notice('DEPRECATED config `elasticAPM.secretToken`. Use env var: ELASTIC_APM_SECRET_TOKEN');
-        }
-
-        // eslint-disable-next-line no-process-env
-        config.elasticAPM.active = isActive(config.elasticAPM, process.env);
-
-        return { ...config };
-      }
-    },
-    preboot: {
-      handler: async (gasket) => {
-        const { config, logger, command } = gasket;
-
-        if (command && command.id === 'local') return;
-
-        // prefer app-level dependency in case of duplicates
-        const apm = require(
-          require.resolve('elastic-apm-node', { paths: [config.root, __dirname] })
-        );
-
-        if (!apm.isStarted()) {
-          apm.start({
-            ...config.elasticAPM
-          });
-          logger.notice('DEPRECATED started Elastic APM agent late. Use `--require elastic-apm-node/start`');
-        }
-
-        apm.addFilter(filterSensitiveCookies(config));
-
-        gasket.apm = apm;
-      }
-    },
+    configure,
+    preboot,
     create: {
       timing: {
         after: ['@gasket/plugin-start']
@@ -90,26 +29,33 @@ module.exports = {
     metadata(gasket, meta) {
       return {
         ...meta,
-        configurations: [{
-          name: 'elasticAPM',
-          link: 'README.md#configuration',
-          description: 'Configuration to provide additional setup helpers',
-          type: 'object'
-        }, {
-          name: 'elasticAPM.sensitiveCookies',
-          link: 'README.md#configuration',
-          description: 'List of sensitive cookies to filter',
-          type: 'string[]',
-          default: '[]'
-        }],
-        lifecycles: [{
-          name: 'apmTransaction',
-          method: 'exec',
-          description: 'Modify the APM transaction',
-          link: 'README.md#apmtransaction',
-          parent: 'middleware'
-        }]
+        configurations: [
+          {
+            name: 'elasticAPM',
+            link: 'README.md#configuration',
+            description: 'Configuration to provide additional setup helpers',
+            type: 'object'
+          },
+          {
+            name: 'elasticAPM.sensitiveCookies',
+            link: 'README.md#configuration',
+            description: 'List of sensitive cookies to filter',
+            type: 'string[]',
+            default: '[]'
+          }
+        ],
+        lifecycles: [
+          {
+            name: 'apmTransaction',
+            method: 'exec',
+            description: 'Modify the APM transaction',
+            link: 'README.md#apmtransaction',
+            parent: 'middleware'
+          }
+        ]
       };
     }
   }
 };
+
+module.exports = plugin;

package/lib/middleware.js

@@ -1,22 +1,10 @@
-/* eslint-disable spaced-comment */
-// @ts-check
-/// <reference types="./index" />
-/// <reference types="../../gasket-plugin-nextjs" />
-
-/**
- * @typedef {import('@gasket/engine').Gasket} Gasket
- * @typedef {import('http').IncomingMessage}  Request
- * @typedef {import('http').ServerResponse}   Response
- */
-
-const { callbackify } = require('util');
+/// <reference types="@gasket/plugin-express" />
 
 /**
  * Middleware for customizing transactions
- *
- * @param {Gasket}    gasket  The Gasket engine
- * @param {Request}   req     The HTTP request being handled
- * @param {Response}  res     The server response
+ * @param {import('@gasket/engine').Gasket} gasket - The Gasket engine
+ * @param {import('http').IncomingMessage} req - The HTTP request being handled
+ * @param {import('http').ServerResponse} res - The server response
  */
 async function customizeTransaction(gasket, req, res) {
   const apm = gasket.apm;
@@ -33,9 +21,20 @@ async function customizeTransaction(gasket, req, res) {
   await gasket.exec('apmTransaction', transaction, { req, res });
 }
 
-module.exports = (gasket) => {
+/**
+ * Add middleware to gather config details
+ * @type {import('@gasket/engine').HookHandler<'middleware'>}
+ */
+module.exports = function middleware(gasket) {
   return (
-    gasket.apm
-    && [callbackify(async (req, res) => customizeTransaction(gasket, req, res))]
+    gasket.apm &&
+    async function apmTransactionMiddleware(req, res, next) {
+      try {
+        customizeTransaction(gasket, req, res);
+      } catch (error) {
+        return next(error);
+      }
+      next();
+    }
   );
 };

package/lib/preboot.js

@@ -0,0 +1,32 @@
+/// <reference types="@gasket/plugin-start" />
+/// <reference types="@gasket/plugin-log" />
+
+const { filterSensitiveCookies } = require('./cookies');
+
+/** @type {import('@gasket/engine').HookHandler<'preboot'>} */
+module.exports = async function preboot(gasket) {
+  const { config, logger, command } = gasket;
+
+  if (command && command.id === 'local') return;
+
+  /**
+   * @type {import('elastic-apm-node')}
+   * Note: Prefer app-level dependency in case of duplicates
+   */
+  const apm = require(require.resolve('elastic-apm-node', {
+    paths: [config.root, __dirname]
+  }));
+
+  if (!apm.isStarted()) {
+    apm.start({
+      ...config.elasticAPM
+    });
+    logger.notice(
+      'DEPRECATED started Elastic APM agent late. Use `--require elastic-apm-node/start`'
+    );
+  }
+
+  apm.addFilter(filterSensitiveCookies(config));
+
+  gasket.apm = apm;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-elastic-apm",
-  "version": "6.46.8",
+  "version": "6.47.1",
   "description": "Adds Elastic APM instrumentation to your application",
   "main": "lib",
   "types": "lib/index.d.ts",
@@ -14,9 +14,9 @@
     "test:runner": "jest test/*.test.js",
     "test:watch": "npm run test:runner -- --watch",
     "test:coverage": "npm run test:runner -- --coverage --coverageReporters text",
-    "posttest": "npm run lint",
+    "posttest": "npm run lint && npm run typecheck",
     "report": "npm run test:runner -- --coverage --coverageReporters lcov",
-    "typecheck:skip": "tsc",
+    "typecheck": "tsc",
     "typecheck:watch": "tsc --watch"
   },
   "repository": {
@@ -45,7 +45,7 @@
     "elastic-apm-node": "^3.50.0"
   },
   "devDependencies": {
-    "@gasket/engine": "^6.46.8",
+    "@gasket/engine": "^6.47.1",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
@@ -72,5 +72,5 @@
   "jest": {
     "testEnvironment": "node"
   },
-  "gitHead": "a4b0d22e57ca4c3e5b944d7153ac25c30ca094f3"
+  "gitHead": "9bf7fe135d46371e32afe289e69307d44574ff7c"
 }