feat(apollo-server-express): set custom GraphQL transaction names (#648)

Author: danieljuhl

.tav.yml

@@ -59,7 +59,7 @@ ws:
   versions: '>=1 <7'
   commands: node test/instrumentation/modules/ws.js
 graphql:
-  preinstall: rm -fr node_modules/express-graphql
+  preinstall: npm uninstall express-graphql
   versions: '>=0.7.0 <0.11.0 || >=0.11.1 <15.0.0 || ^14.0.0-rc'
   commands: node test/instrumentation/modules/graphql.js
 express:
@@ -68,70 +68,104 @@ express:
 
 express-graphql-1:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.8.2
   versions: '0.6.1'
   commands: node test/instrumentation/modules/express-graphql.js
 
 express-graphql-2:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.9.0
   versions: '>=0.6.2 <0.6.6'
   commands: node test/instrumentation/modules/express-graphql.js
 
 express-graphql-3:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.10.0
   versions: '>=0.6.6 <0.6.8'
   commands: node test/instrumentation/modules/express-graphql.js
 
 express-graphql-0.6.11_10:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.10.0
   versions: '0.6.11'
   commands: node test/instrumentation/modules/express-graphql.js
 express-graphql-0.6.11_11:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.11.0
   versions: '0.6.11'
   commands: node test/instrumentation/modules/express-graphql.js
 
 express-graphql-0.6.12_10:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.10.0
   versions: '^0.6.12'
   commands: node test/instrumentation/modules/express-graphql.js
 express-graphql-0.6.12_11:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.11.0
   versions: '^0.6.12'
   commands: node test/instrumentation/modules/express-graphql.js
 express-graphql-0.6.12_12:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.12.0
   versions: '^0.6.12'
   commands: node test/instrumentation/modules/express-graphql.js
 express-graphql-0.6.12_13:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.13.0
   versions: '^0.6.12'
   commands: node test/instrumentation/modules/express-graphql.js
 
 express-graphql-0.7,1_12:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.12.0
   versions: '^0.7.1'
   commands: node test/instrumentation/modules/express-graphql.js
 express-graphql-0.7.1_13:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^0.13.0
   versions: '^0.7.1'
   commands: node test/instrumentation/modules/express-graphql.js
 express-graphql-0.7.1_14:
   name: express-graphql
+  preinstall: npm uninstall apollo-server-express
   peerDependencies: graphql@^14.0.0
   versions: '^0.7.1'
   commands: node test/instrumentation/modules/express-graphql.js
 
+apollo-server-express-2_12:
+  name: apollo-server-express
+  preinstall: npm uninstall express-graphql
+  peerDependencies: graphql@^0.12.0
+  versions: '>=2.0.2'
+  node: '>=6'
+  commands: node test/instrumentation/modules/apollo-server-express.js
+apollo-server-express-2_13:
+  name: apollo-server-express
+  preinstall: npm uninstall express-graphql
+  peerDependencies: graphql@^0.13.0
+  versions: '>=2.0.2'
+  node: '>=6'
+  commands: node test/instrumentation/modules/apollo-server-express.js
+apollo-server-express-2_14:
+  name: apollo-server-express
+  preinstall: npm uninstall express-graphql
+  peerDependencies: graphql@^14.0.0
+  versions: '>=2.0.2'
+  node: '>=6'
+  commands: node test/instrumentation/modules/apollo-server-express.js
+
 express-queue:
   versions: '>=0.0.11'
   commands: node test/instrumentation/modules/express-queue.js

.travis.yml

@@ -89,7 +89,7 @@ jobs:
     -
       node_js: '10'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=mimic-response,got,bluebird
+      env: TAV=mimic-response,got,bluebird,apollo-server-express
       script: tav --quiet
     -
       node_js: '10'
@@ -111,7 +111,7 @@ jobs:
     -
       node_js: '9'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=mimic-response,got,bluebird
+      env: TAV=mimic-response,got,bluebird,apollo-server-express
       script: tav --quiet
     -
       node_js: '9'
@@ -133,7 +133,7 @@ jobs:
     -
       node_js: '8'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=mimic-response,got,bluebird
+      env: TAV=mimic-response,got,bluebird,apollo-server-express
       script: tav --quiet
     -
       node_js: '8'
@@ -155,7 +155,7 @@ jobs:
     -
       node_js: '6'
       if: type IN (cron, pull_request) AND NOT branch =~ ^greenkeeper/.*
-      env: TAV=mimic-response,got,bluebird
+      env: TAV=mimic-response,got,bluebird,apollo-server-express
       script: tav --quiet
     -
       node_js: '6'

docs/compatibility.asciidoc

@@ -61,6 +61,7 @@ These modules override that behavior to give better insights into specialized HT
 |=======================================================================
 |Module |Version |Note
 |https://www.npmjs.com/package/express-graphql[express-graphql] |^0.6.1 |Will name all transactions by the GraphQL query name
+|https://www.npmjs.com/package/apollo-server-express[apollo-server-express] |^2.0.2 |Will name all transactions by the GraphQL query name
 |=======================================================================
 
 [float]

lib/instrumentation/index.js

@@ -13,6 +13,7 @@ var Transaction = require('./transaction')
 var shimmer = require('./shimmer')
 
 var MODULES = [
+  'apollo-server-core',
   'bluebird',
   'cassandra-driver',
   'elasticsearch',

lib/instrumentation/modules/apollo-server-core.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const semver = require('semver')
+const shimmer = require('../shimmer')
+
+module.exports = function (apolloServerCore, agent, version, enabled) {
+  if (!enabled) return apolloServerCore
+
+  if (!semver.satisfies(version, '^2.0.2')) {
+    agent.logger.debug('apollo-server-core version %s not supported - aborting...', version)
+    return apolloServerCore
+  }
+
+  shimmer.wrap(apolloServerCore, 'runHttpQuery', function (runHttpQuery) {
+    return function wrappedRunHttpQuery () {
+      var trans = agent._instrumentation.currentTransaction
+      if (trans) trans._graphqlRoute = true
+      return runHttpQuery.apply(this, arguments)
+    }
+  })
+
+  return apolloServerCore
+}

package.json

@@ -95,6 +95,7 @@
     "@commitlint/cli": "^7.0.0",
     "@commitlint/config-conventional": "^7.0.1",
     "@commitlint/travis-cli": "^7.0.0",
+    "apollo-server-express": "^2.0.2",
     "bluebird": "^3.4.6",
     "cassandra-driver": "^3.5.0",
     "connect": "^3.6.3",

test/.jenkins_tav.yml

@@ -1,5 +1,5 @@
 TAV:
   - generic-pool+mysql+mysql2+redis+koa-router+handlebars+mongodb-core
   - ioredis+pg+cassandra-driver+tedious+restify
-  - mimic-response+got+bluebird
+  - mimic-response+got+bluebird+apollo-server-express
   - knex+ws+graphql+express-graphql+elasticsearch+hapi+express+express-queue

test/config.js

@@ -376,6 +376,7 @@ test('disableInstrumentations', function (t) {
   }
   if (semver.lt(process.version, '6.0.0')) {
     modules.delete('express-queue')
+    modules.delete('apollo-server-core')
   }
 
   function testSlice (t, name, selector) {