@gasket/plugin-elastic-apm 7.4.9 → 7.5.0

package/cjs/actions.cjs

@@ -0,0 +1,65 @@
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "getApmTransaction", {
+    enumerable: true,
+    get: function() {
+        return getApmTransaction;
+    }
+});
+const _request = require("@gasket/request");
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const getApmTransaction = (0, _request.withGasketRequestCache)(async function getApmTransaction(gasket, req) {
+    const apm = await Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("elastic-apm-node")));
+    if (!apm?.default?.isStarted()) {
+        return;
+    }
+    const transaction = apm.default.currentTransaction;
+    if (!transaction) {
+        return;
+    }
+    await gasket.exec('apmTransaction', transaction, {
+        req
+    });
+    return transaction;
+});

package/cjs/configure.cjs

@@ -0,0 +1,36 @@
+/**
+ * Determines if the Elastic APM agent has sufficient config to be active
+ * @param {import('./index.js').ExtendedAgentConfigOptions} config Apm agent config
+ * @param {Record<string, string | undefined>} env Environment variables
+ * @returns {boolean} A combined config object
+ */ Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, /** @type {import('@gasket/core').HookHandler<'configure'>} */ "default", {
+    enumerable: true,
+    get: function() {
+        return configure;
+    }
+});
+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;
+};
+function configure(gasket, config) {
+    config.elasticAPM = config.elasticAPM || {};
+    // eslint-disable-next-line no-process-env
+    config.elasticAPM.active = isActive(config.elasticAPM, process.env);
+    return {
+        ...config
+    };
+}

package/cjs/cookies.cjs

@@ -0,0 +1,48 @@
+/**
+ * Returns an array of cookie names which are considered sensitive because they
+ * may contain session credential or PII
+ * @param {import('@gasket/core').GasketConfig} config the Gasket config
+ * @returns {string[]} an array of cookie names
+ */ Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    filterSensitiveCookies: function() {
+        return filterSensitiveCookies;
+    },
+    sensitiveCookies: function() {
+        return sensitiveCookies;
+    }
+});
+const sensitiveCookies = (config)=>{
+    if (typeof config.elasticAPM === 'undefined' || typeof config.elasticAPM.sensitiveCookies === 'undefined') {
+        return [];
+    }
+    return config.elasticAPM.sensitiveCookies;
+};
+const filterSensitiveCookies = function(config) {
+    return function(payload) {
+        const cookiesToRedact = sensitiveCookies(config);
+        if (payload.context && payload.context.request && payload.context.request.headers && payload.context.request.headers.cookie) {
+            let cookie = payload.context.request.headers.cookie;
+            cookiesToRedact.forEach((sc)=>{
+                cookie = cookie.replace(new RegExp(sc + '=([^;]+)'), sc + '=[REDACTED]');
+            });
+            payload.context.request.headers.cookie = cookie;
+        }
+        if (payload.context && payload.context.request && payload.context.request.cookies) {
+            cookiesToRedact.forEach((sc)=>{
+                if (sc in payload.context.request.cookies) {
+                    payload.context.request.cookies[sc] = '[REDACTED]';
+                }
+            });
+        }
+        return payload;
+    };
+};

package/cjs/create.cjs

@@ -0,0 +1,33 @@
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, /** @type {import('@gasket/core').HookHandler<'create'>} */ "default", {
+    enumerable: true,
+    get: function() {
+        return create;
+    }
+});
+const _packagejson = /*#__PURE__*/ _interop_require_default(require("../package.json"));
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const { name, version, devDependencies } = _packagejson.default;
+function create(gasket, { pkg, files, gasketConfig }) {
+    const generatorDir = new URL('../generator', require("url").pathToFileURL(__filename).toString()).pathname;
+    gasketConfig.addPlugin('pluginElasticApm', name);
+    pkg.add('dependencies', {
+        [name]: `^${version}`,
+        'dotenv': devDependencies.dotenv,
+        'elastic-apm-node': devDependencies['elastic-apm-node']
+    });
+    pkg.extend((current)=>{
+        return {
+            scripts: {
+                start: `NODE_OPTIONS=--import=./setup.js ${current.scripts.start}`
+            }
+        };
+    });
+    files.add(`${generatorDir}/*`);
+}

package/cjs/index.cjs

@@ -0,0 +1,109 @@
+/// <reference types="create-gasket-app" />
+/// <reference types="@gasket/plugin-metadata" />
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+const _actions = /*#__PURE__*/ _interop_require_wildcard(require("./actions.cjs"));
+const _create = /*#__PURE__*/ _interop_require_default(require("./create.cjs"));
+const _configure = /*#__PURE__*/ _interop_require_default(require("./configure.cjs"));
+const _packagejson = /*#__PURE__*/ _interop_require_default(require("../package.json"));
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const { name, version, description } = _packagejson.default;
+/** @type {import('@gasket/core').Plugin} */ const plugin = {
+    name,
+    version,
+    description,
+    actions: _actions,
+    hooks: {
+        configure: _configure.default,
+        create: _create.default,
+        metadata (gasket, meta) {
+            return {
+                ...meta,
+                actions: [
+                    {
+                        name: 'getApmTransaction',
+                        description: 'Get the APM transaction data',
+                        link: 'README.md#getApmTransaction'
+                    }
+                ],
+                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'
+                    }
+                ]
+            };
+        }
+    }
+};
+const _default = plugin;

package/cjs/package.json

@@ -0,0 +1 @@
+{}

package/lib/actions.js

@@ -1,15 +1,15 @@
-const { withGasketRequestCache } = require('@gasket/request');
+import { withGasketRequestCache } from '@gasket/request';
 
 /** @type {import('@gasket/core').ActionHandler<'getApmTransaction'>} */
-const getApmTransaction = withGasketRequestCache(
+export const getApmTransaction = withGasketRequestCache(
   async function getApmTransaction(gasket, req) {
-    const apm = require('elastic-apm-node');
+    const apm = await import('elastic-apm-node');
 
-    if (!apm?.isStarted()) {
+    if (!apm?.default?.isStarted()) {
       return;
     }
 
-    const transaction = apm.currentTransaction;
+    const transaction = apm.default.currentTransaction;
     if (!transaction) {
       return;
     }
@@ -19,7 +19,3 @@ const getApmTransaction = withGasketRequestCache(
     return transaction;
   }
 );
-
-module.exports = {
-  getApmTransaction
-};

package/lib/configure.js

@@ -1,7 +1,7 @@
 /**
  * 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
+ * @param {import('./index.js').ExtendedAgentConfigOptions} config Apm agent config
+ * @param {Record<string, string | undefined>} env Environment variables
  * @returns {boolean} A combined config object
  */
 const isActive = (config, env) => {
@@ -24,11 +24,11 @@ const isActive = (config, env) => {
 };
 
 /** @type {import('@gasket/core').HookHandler<'configure'>} */
-module.exports = function configure(gasket, config) {
+export default function configure(gasket, config) {
   config.elasticAPM = config.elasticAPM || {};
 
   // eslint-disable-next-line no-process-env
   config.elasticAPM.active = isActive(config.elasticAPM, process.env);
 
   return { ...config };
-};
+}

package/lib/cookies.js

@@ -4,7 +4,7 @@
  * @param {import('@gasket/core').GasketConfig} config the Gasket config
  * @returns {string[]} an array of cookie names
  */
-const sensitiveCookies = (config) => {
+export const sensitiveCookies = (config) => {
   if (
     typeof config.elasticAPM === 'undefined' ||
     typeof config.elasticAPM.sensitiveCookies === 'undefined'
@@ -17,9 +17,9 @@ const sensitiveCookies = (config) => {
 
 /**
  * Redacts the contents of user-specified sensitive cookies
- * @type {import('.').filterSensitiveCookies}
+ * @type {import('./index.js').filterSensitiveCookies}
  */
-const filterSensitiveCookies = function (config) {
+export const filterSensitiveCookies = function (config) {
   return function (payload) {
     const cookiesToRedact = sensitiveCookies(config);
 
@@ -54,8 +54,3 @@ const filterSensitiveCookies = function (config) {
     return payload;
   };
 };
-
-module.exports = {
-  filterSensitiveCookies,
-  sensitiveCookies
-};

package/lib/create.js

@@ -1,8 +1,9 @@
-const { name, version, devDependencies } = require('../package.json');
+import packageJson from '../package.json' with { type: 'json' };
+const { name, version, devDependencies } = packageJson;
 
 /** @type {import('@gasket/core').HookHandler<'create'>} */
-module.exports = function create(gasket, { pkg, files, gasketConfig }) {
-  const generatorDir = `${__dirname}/../generator`;
+export default function create(gasket, { pkg, files, gasketConfig }) {
+  const generatorDir = new URL('../generator', import.meta.url).pathname;
 
   gasketConfig.addPlugin('pluginElasticApm', name);
 
@@ -21,4 +22,4 @@ module.exports = function create(gasket, { pkg, files, gasketConfig }) {
   });
 
   files.add(`${generatorDir}/*`);
-};
+}

package/lib/index.js

@@ -1,14 +1,11 @@
 /// <reference types="create-gasket-app" />
 /// <reference types="@gasket/plugin-metadata" />
 
-const actions = require('./actions');
-const create = require('./create');
-const configure = require('./configure');
-const {
-  name,
-  version,
-  description
-} = require('../package.json');
+import * as actions from './actions.js';
+import create from './create.js';
+import configure from './configure.js';
+import packageJson from '../package.json' with { type: 'json' };
+const { name, version, description } = packageJson;
 
 /** @type {import('@gasket/core').Plugin} */
 const plugin = {
@@ -58,4 +55,4 @@ const plugin = {
   }
 };
 
-module.exports = plugin;
+export default plugin;

package/package.json

@@ -1,13 +1,23 @@
 {
   "name": "@gasket/plugin-elastic-apm",
-  "version": "7.4.9",
+  "version": "7.5.0",
   "description": "Adds Elastic APM instrumentation to your application",
-  "main": "lib/index.js",
+  "type": "module",
   "types": "lib/index.d.ts",
   "files": [
     "lib",
+    "cjs",
     "EXAMPLES.md"
   ],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "require": "./cjs/index.cjs",
+      "default": "./cjs/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
   "repository": "godaddy/gasket.git",
   "publishConfig": {
     "access": "public"
@@ -28,22 +38,21 @@
   "devDependencies": {
     "dotenv": "^16.4.7",
     "elastic-apm-node": "^4.11.0",
-    "jest": "^29.7.0",
-    "nyc": "^15.1.0",
+    "vitest": "^3.2.0",
+    "@gasket/cjs": "^7.1.0",
     "@gasket/core": "^7.6.3",
-    "@gasket/plugin-metadata": "^7.5.4",
-    "create-gasket-app": "^7.4.13"
-  },
-  "jest": {
-    "testEnvironment": "node"
+    "@gasket/plugin-metadata": "^7.5.5",
+    "create-gasket-app": "^7.4.15"
   },
   "scripts": {
+    "build": "gasket-cjs ./lib",
+    "build:watch": "pnpm run build --watch",
     "lint": "eslint .",
     "lint:fix": "pnpm run lint --fix",
     "posttest": "pnpm run lint && pnpm run typecheck",
-    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict' jest",
+    "test": "vitest run --globals",
     "test:coverage": "pnpm run test --coverage",
-    "test:watch": "pnpm run test --watch",
+    "test:watch": "vitest --watch --globals",
     "typecheck": "tsc",
     "typecheck:watch": "tsc --watch"
   }