@gasket/plugin-elastic-apm 7.5.1 → 8.0.0-next.2

package/EXAMPLES.md

@@ -42,11 +42,11 @@ apm.start({
 Access and decorate the current APM transaction:
 
 ```js
-// In a middleware or lifecycle
+// In the express lifecycle
 export default {
   name: 'my-plugin',
   hooks: {
-    middleware(gasket, app) {
+    express(gasket, app) {
       app.use(async (req, res, next) => {
         const transaction = await gasket.actions.getApmTransaction(req);
 

package/README.md

@@ -130,7 +130,7 @@ To filter out other data, use the [APM Add Filter API].
 According to the [Elastic APM docs], the _Elastic APM agent for Node.js is a
 singleton_.
 This means that you can import and configure the singleton in various
-hooks of your Gasket app, such as with the [init] or [middleware] lifecycles.
+hooks of your Gasket app, such as with the [init] or [express]/[fastify] lifecycles.
 
 ## Actions
 
@@ -221,7 +221,8 @@ such as for sensitive cookies.
 <!-- LINKS -->
 
 [init]:/packages/gasket-core/README.md#init
-[middleware]:/packages/gasket-plugin-middleware/README.md#middleware
+[express]:/packages/gasket-plugin-express/README.md#express
+[fastify]:/packages/gasket-plugin-fastify/README.md#fastify
 [configuration options documentation]:https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html
 [start recommendations]:https://www.elastic.co/guide/en/apm/agent/nodejs/master/agent-api.html#apm-start
 [Elastic APM docs]:https://www.elastic.co/guide/en/apm/agent/nodejs/master/agent-api.html

package/lib/index.js

@@ -1,8 +1,6 @@
-/// <reference types="create-gasket-app" />
 /// <reference types="@gasket/plugin-metadata" />
 
 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;
@@ -15,7 +13,6 @@ const plugin = {
   actions,
   hooks: {
     configure,
-    create,
     metadata(gasket, meta) {
       return {
         ...meta,
@@ -47,7 +44,7 @@ const plugin = {
             method: 'exec',
             description: 'Modify the APM transaction',
             link: 'README.md#apmtransaction',
-            parent: 'middleware'
+            parent: 'express'
           }
         ]
       };

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "@gasket/plugin-elastic-apm",
-  "version": "7.5.1",
+  "version": "8.0.0-next.2",
   "description": "Adds Elastic APM instrumentation to your application",
   "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"
+      "import": "./lib/index.js"
     },
     "./package.json": "./package.json"
   },
-  "repository": "godaddy/gasket.git",
+  "repository": {
+    "type": "git",
+    "url": "godaddy/gasket.git"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -33,20 +33,16 @@
   "bugs": "https://github.com/godaddy/gasket/issues",
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-elastic-apm",
   "dependencies": {
-    "@gasket/request": "^7.5.5"
+    "@gasket/request": "^8.0.0-next.1"
   },
   "devDependencies": {
-    "dotenv": "^16.4.7",
     "elastic-apm-node": "^4.11.0",
     "vitest": "^3.2.0",
-    "@gasket/cjs": "^7.1.0",
-    "@gasket/core": "^7.7.1",
-    "@gasket/plugin-metadata": "^7.5.7",
-    "create-gasket-app": "^7.4.17"
+    "@gasket/core": "^8.0.0-next.2",
+    "@gasket/plugin-metadata": "^8.0.0-next.1",
+    "create-gasket-app": "^8.0.0-next.2"
   },
   "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",

package/cjs/actions.cjs

@@ -1,65 +0,0 @@
-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

@@ -1,36 +0,0 @@
-/**
- * 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

@@ -1,48 +0,0 @@
-/**
- * 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

@@ -1,33 +0,0 @@
-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

@@ -1,109 +0,0 @@
-/// <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

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

package/lib/create.js

@@ -1,25 +0,0 @@
-import packageJson from '../package.json' with { type: 'json' };
-const { name, version, devDependencies } = packageJson;
-
-/** @type {import('@gasket/core').HookHandler<'create'>} */
-export default function create(gasket, { pkg, files, gasketConfig }) {
-  const generatorDir = new URL('../generator', import.meta.url).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}/*`);
-}