feat(hapi): support new @hapi/hapi module (#1246)

Author: Qard

.tav.yml

@@ -210,16 +210,21 @@ hapi-no-async-await:
   name: hapi
   versions: '>=9.0.1 <17.0.0'
   commands:
-    - node test/instrumentation/modules/hapi/basic.js
+    - node test/instrumentation/modules/hapi/basic-legacy-path.js
     - node test/instrumentation/modules/hapi/set-framework.js
 hapi-async-await:
   name: hapi
   node: '>=8.2'
   versions: '>=17.0.0'
   commands:
-    - node test/instrumentation/modules/hapi/basic.js
+    - node test/instrumentation/modules/hapi/basic-legacy-path.js
     - node test/instrumentation/modules/hapi/set-framework.js
-
+'@hapi/hapi':
+  node: '>=8.2'
+  versions: '>=17.0.0'
+  commands: 
+    - node test/instrumentation/modules/hapi/basic.js
+    - node test/instrumentation/modules/hapi/set-framework-2.js
 tedious:
   name: tedious
   versions: '>=1.9 <2.7 || 3.x || >4.0.0'

.travis.yml

@@ -115,7 +115,7 @@ jobs:
     -
       node_js: '12'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,express,express-queue
+      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,@hapi/hapi,express,express-queue
       script: tav --quiet
     -
       node_js: '12'
@@ -142,7 +142,7 @@ jobs:
     -
       node_js: '11'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,express,express-queue
+      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,@hapi/hapi,express,express-queue
       script: tav --quiet
     -
       node_js: '11'
@@ -169,7 +169,7 @@ jobs:
     -
       node_js: '10'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,express,express-queue
+      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,@hapi/hapi,express,express-queue
       script: tav --quiet
     -
       node_js: '10'
@@ -196,7 +196,7 @@ jobs:
     -
       node_js: '8'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,express,express-queue
+      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,@hapi/hapi,express,express-queue
       script: tav --quiet
     -
       node_js: '8'
@@ -223,7 +223,7 @@ jobs:
     -
       node_js: '6'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,express,express-queue
+      env: TAV=ws,graphql,express-graphql,elasticsearch,hapi,@hapi/hapi,express,express-queue
       script: tav --quiet
     -
       node_js: '6'

docs/agent-api.asciidoc

@@ -690,12 +690,12 @@ Optionally, a type may also be provided to group lambdas together. By default,
 Read more lambda support in the <<lambda,Lambda>> article.
 
 [[apm-add-patch]]
-==== `apm.addPatch(name, handler)`
+==== `apm.addPatch(modules, handler)`
 
 [small]#Added in: v2.7.0#
 
-* `name` +{type-string}+
-Name of module to apply the patch to, when required.
+* `modules` +{type-string}+ | +{type-string-array}+
+Name of module(s) to apply the patch to, when required.
 * `handler` +{type-function}+ | +{type-string}+
 Must be a patch function or a path to a module exporting a patch function
 ** `exports` +{type-object}+ The original export object of the module
@@ -726,11 +726,26 @@ apm.addPatch('timers', (exports, agent, { version, enabled }) => {
 
 // or ...
 
+apm.addPatch(['hapi', '@hapi/hapi'], (exports, agent, { version, enabled }) => {
+  const setTimeout = exports.setTimeout
+  exports.setTimeout = (fn, ms) => {
+    const span = agent.createSpan('set-timeout')
+    return setTimeout(() => {
+      span.end()
+      fn()
+    }, ms)
+  }
+
+  return exports
+})
+
+// or ...
+
 apm.addPatch('timers', './timer-patch')
 ----
 
 [[apm-remove-patch]]
-==== `apm.removePatch(name, handler)`
+==== `apm.removePatch(modules, handler)`
 
 [small]#Added in: v2.7.0#
 
@@ -744,6 +759,10 @@ apm.removePatch('timers', './timers-patch')
 
 // or ...
 
+apm.removePatch(['timers'], './timers-patch')
+
+// or ...
+
 apm.removePatch('timers', timerPatchFunction)
 ----
 

docs/index.asciidoc

@@ -3,6 +3,7 @@
 include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 
 :type-string: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type[<string>]
+:type-string-array: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type[<string[]>]
 :type-boolean: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type[<boolean>]
 :type-object: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object[<Object>]
 :type-number: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type[<number>]

docs/supported-technologies.asciidoc

@@ -46,6 +46,7 @@ These are the frameworks that we officially support:
 |Framework |Version |Note
 |<<express,Express>> |^4.0.0 |
 |<<hapi,hapi>> |>=9.0.0 <19.0.0 |
+|<<hapi,@hapi/hapi>> |>=17.9.0 <19.0.0 |
 |<<koa,Koa>> via koa-router |>=5.2.0 <8.0.0 |Koa doesn't have a built in router,
 so we can't support Koa directly since we rely on router information for full support.
 We currently support the most popular Koa router called https://github.com/alexmingoia/koa-router[koa-router]

lib/instrumentation/index.js

@@ -23,7 +23,7 @@ var MODULES = [
   'generic-pool',
   'graphql',
   'handlebars',
-  'hapi',
+  ['hapi', '@hapi/hapi'],
   'http',
   'https',
   'http2',
@@ -70,30 +70,41 @@ function Instrumentation (agent) {
   this._patches = new NamedArray()
 
   for (let mod of MODULES) {
+    if (!Array.isArray(mod)) mod = [mod]
+    const pathName = mod[0]
+
     this.addPatch(mod, (exports, name, version, enabled) => {
       // Lazy require so that we don't have to use `require.resolve` which
       // would fail in combination with Webpack. For more info see:
       // https://github.com/elastic/apm-agent-nodejs/pull/957
-      const patch = require(`./modules/${mod}`)
+      const patch = require(`./modules/${pathName}`)
       return patch(exports, name, version, enabled)
     })
   }
 }
 
-Instrumentation.prototype.addPatch = function (name, handler) {
-  const type = typeof handler
-  if (type !== 'function' && type !== 'string') {
-    this._agent.logger.error('Invalid patch handler type:', type)
-    return
-  }
+Instrumentation.prototype.addPatch = function (modules, handler) {
+  if (!Array.isArray(modules)) modules = [modules]
 
-  this._patches.add(name, handler)
-  this._startHook()
+  modules.forEach(mod => {
+    const type = typeof handler
+    if (type !== 'function' && type !== 'string') {
+      this._agent.logger.error('Invalid patch handler type:', type)
+      return
+    }
+
+    this._patches.add(mod, handler)
+    this._startHook()
+  })
 }
 
-Instrumentation.prototype.removePatch = function (name, handler) {
-  this._patches.delete(name, handler)
-  this._startHook()
+Instrumentation.prototype.removePatch = function (modules, handler) {
+  if (!Array.isArray(modules)) modules = [modules]
+
+  modules.forEach(mod => {
+    this._patches.delete(mod, handler)
+    this._startHook()
+  })
 }
 
 Instrumentation.prototype.clearPatches = function (name) {

package.json

@@ -130,6 +130,7 @@
     "graphql": "^14.3.1",
     "handlebars": "^4.0.12",
     "hapi": "^18.1.0",
+    "@hapi/hapi": "^18.2.0",
     "https-pem": "^2.0.0",
     "inquirer": "^0.12.0",
     "ioredis": "^4.10.0",

test/config.js

@@ -630,7 +630,8 @@ test('disableInstrumentations', function (t) {
   var mysql2Version = require('mysql2/package.json').version
   var wsVersion = require('ws/package.json').version
 
-  var modules = new Set(Instrumentation.modules)
+  var flattenedModules = Instrumentation.modules.reduce((acc, val) => acc.concat(val), [])
+  var modules = new Set(flattenedModules)
   if (semver.lt(process.version, '8.6.0')) {
     modules.delete('restify')
   }
@@ -640,6 +641,9 @@ test('disableInstrumentations', function (t) {
   if (semver.lt(process.version, '8.9.0') && semver.gte(hapiVersion, '17.0.0')) {
     modules.delete('hapi')
   }
+  if (semver.lt(process.version, '8.9.0')) {
+    modules.delete('@hapi/hapi')
+  }
   if (semver.lt(process.version, '6.0.0') && semver.gte(mysql2Version, '1.6.0')) {
     modules.delete('mysql2')
   }

test/instrumentation/modules/hapi/basic-legacy-path.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('./shared')('hapi')