@gasket/plugin-elastic-apm 7.0.0-next.42 → 7.0.0-next.45

package/README.md

@@ -4,28 +4,22 @@ Adds Elastic APM instrumentation to your application
 
 ## Installation
 
-#### New apps
-
 ```
-gasket create <app-name> --plugins @gasket/plugin-elastic-apm
+npm i @gasket/plugin-elastic-apm
 ```
 
-#### Existing apps
+Update your `gasket` file plugin configuration:
 
-```
-npm install @gasket/plugin-elastic-apm elastic-apm-node
-```
+```diff
+// gasket.js
 
-Modify `plugins` section of your `gasket.config.js`:
++ import pluginElasticApm from '@gasket/plugin-elastic-apm';
 
-```diff
-module.exports = {
-  plugins: {
-    add: [
-+      '@gasket/plugin-elastic-apm'
-    ]
-  }
-}
+export default makeGasket({
+  plugins: [
++   pluginElasticApm
+  ]
+});
 ```
 
 Add a `--require` flag to a `package.json` start script:
@@ -77,14 +71,14 @@ configured under `elasticAPM` in the `gasket.config.js`.
 If your application’s users send session credentials or any other sensitive
 information in their cookies, you may wish to filter them out before they are
 stored in Elasticsearch. Specify a list of cookie names to redact in
-`gasket.config.js`:
+`gasket.js`:
 
 ```js
-module.exports = {
+export default makeGasket({
   elasticAPM: {
     sensitiveCookies: ['my_jwt', 'userFullName']
   }
-};
+});
 ```
 
 #### Custom Filtering Sensitive Fields
@@ -131,10 +125,15 @@ request details are as follows:
 | `res`    | The HTTP response or framework-specific wrapper around it |
 
 ```javascript
-// /lifecycles/apm-transaction.js
-
-module.exports = (gasket, transaction, { req, res }) => {
-  transaction.setLabel('language', req.headers['accept-language']);
+// example-plugin.js
+
+export default {
+  name: 'example-plugin',
+  hooks: {
+    apmTransaction(gasket, transaction, { req, res }) => {
+      transaction.setLabel('language', req.headers['accept-language']);
+    }
+  }
 }
 ```
 

package/lib/actions.js

@@ -0,0 +1,21 @@
+/** @type {import('@gasket/core').HookHandler<'actions'>} */
+module.exports = function actions(gasket) {
+  return {
+    async getApmTransaction(req) {
+      const apm = require('elastic-apm-node');
+
+      if (!apm?.isStarted()) {
+        return;
+      }
+
+      const transaction = apm.currentTransaction;
+      if (!transaction) {
+        return;
+      }
+
+      await gasket.exec('apmTransaction', transaction, { req });
+
+      return transaction;
+    }
+  };
+};

package/lib/create.js

@@ -0,0 +1,24 @@
+const { name, version, devDependencies } = require('../package.json');
+
+/** @type {import('@gasket/core').HookHandler<'create'>} */
+module.exports = function create(gasket, { pkg, files, gasketConfig }) {
+  const generatorDir = `${__dirname}/../generator`;
+
+  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/lib/index.d.ts

@@ -2,6 +2,8 @@ import type { IncomingMessage, ServerResponse } from 'http';
 import type { AgentConfigOptions, Transaction, Payload } from 'elastic-apm-node';
 import type { MaybeAsync, GasketConfig } from '@gasket/core';
 import type { GasketData } from '@gasket/data';
+import type { GasketRequest } from '@gasket/core';
+import type { Request } from 'express';
 
 export function filterSensitiveCookies(config: GasketConfig): function(Payload): Payload;
 
@@ -18,18 +20,17 @@ declare module '@gasket/core' {
     apm?: Agent;
   }
 
+  export interface GasketActions {
+    async getApmTransaction(
+      req: IncomingMessage | Request
+    ): Promise<Transaction | void>
+  }
+
   export interface HookExecTypes {
     apmTransaction(
       transaction: Transaction,
-      details: {
-        req: IncomingMessage;
-        res: ServerResponse & {
-          locals?: {
-            gasketData: GasketData & {
-              locale?: string;
-            };
-          };
-        };
+      context: {
+        req: IncomingMessage | Request;
       }
     ): MaybeAsync<void>;
   }

package/lib/index.js

@@ -1,14 +1,14 @@
 /// <reference types="create-gasket-app" />
 /// <reference types="@gasket/plugin-metadata" />
 
+const actions = require('./actions');
+const create = require('./create');
 const middleware = require('./middleware');
-const preboot = require('./preboot');
 const configure = require('./configure');
 const {
   name,
   version,
-  description,
-  devDependencies
+  description
 } = require('../package.json');
 
 /** @type {import('@gasket/core').Plugin} */
@@ -17,22 +17,9 @@ const plugin = {
   version,
   description,
   hooks: {
+    actions,
     configure,
-    // @ts-expect-error - TODO: will be cleaned up in the apm tune up ticket
-    // https://godaddy-corp.atlassian.net/browse/PFX-628
-    preboot,
-    create(gasket, { pkg, files }) {
-      const generatorDir = `${__dirname}/../generator`;
-
-      pkg.add('dependencies', {
-        'elastic-apm-node': devDependencies['elastic-apm-node']
-      });
-      pkg.add('scripts', {
-        start: 'gasket start --require ./setup.js'
-      });
-
-      files.add(`${generatorDir}/*`);
-    },
+    create,
     middleware,
     metadata(gasket, meta) {
       return {

package/lib/middleware.js

@@ -4,11 +4,9 @@
  * Middleware for customizing transactions
  * @param {import('@gasket/core').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;
-
+async function customizeTransaction(gasket, req) {
+  const apm = require('elastic-apm-node');
   if (!apm?.isStarted()) {
     return;
   }
@@ -18,7 +16,7 @@ async function customizeTransaction(gasket, req, res) {
     return;
   }
 
-  await gasket.exec('apmTransaction', transaction, { req, res });
+  await gasket.exec('apmTransaction', transaction, { req });
 }
 
 /**
@@ -26,11 +24,14 @@ async function customizeTransaction(gasket, req, res) {
  * @type {import('@gasket/core').HookHandler<'middleware'>}
  */
 module.exports = function middleware(gasket) {
+  const apm = require('elastic-apm-node');
+  // eslint-disable-next-line no-undefined
+  const isStarted = apm.isStarted() || undefined;
   return (
-    gasket.apm &&
+    isStarted &&
     async function apmTransactionMiddleware(req, res, next) {
       try {
-        customizeTransaction(gasket, req, res);
+        customizeTransaction(gasket, req);
       } catch (error) {
         return next(error);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-elastic-apm",
-  "version": "7.0.0-next.42",
+  "version": "7.0.0-next.45",
   "description": "Adds Elastic APM instrumentation to your application",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -42,7 +42,8 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-elastic-apm",
   "devDependencies": {
-    "@gasket/core": "^7.0.0-next.42",
+    "@gasket/core": "^7.0.0-next.45",
+    "dotenv": "^16.4.5",
     "elastic-apm-node": "^4.4.1",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.0",
@@ -70,5 +71,5 @@
   "jest": {
     "testEnvironment": "node"
   },
-  "gitHead": "d96c86a52f608ea702f9b91a5a72f3b19389877c"
+  "gitHead": "cca9f460bdf2859d000443b25a76927251560f48"
 }

package/lib/preboot.js

@@ -1,30 +0,0 @@
-/// <reference types="@gasket/plugin-logger" />
-
-const { filterSensitiveCookies } = require('./cookies');
-
-// @ts-expect-error - TODO: will be cleaned up in the apm tune up ticket
-// https://godaddy-corp.atlassian.net/browse/PFX-628
-/** @type {import('@gasket/core').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()) {
-    logger.warn(
-      'Elastic APM agent is not started. Use `--require ./setup.js`'
-    );
-  }
-
-  apm.addFilter(filterSensitiveCookies(config));
-
-  gasket.apm = apm;
-};