feat: add support for @koa/router (#1346)

The `koa-router` module is abandoned and a fork is being maintained
under `@koa/router` instead.

This fork is published as a major bump (v8.0.0) of the original, but
our patch still works fine on that version.

Closes #1343

Author: watson

.ci/.jenkins_tav.yml

@@ -1,30 +1,31 @@
 TAV:
+  - '@koa/router'
+  - apollo-server-express
+  - bluebird
+  - cassandra-driver
+  - elasticsearch
+  - express
+  - express-graphql
+  - express-queue
+  - fastify
+  - finalhandler
   - generic-pool
-  - mysql
-  - mysql2
-  - redis
-  - koa-router
+  - got
+  - graphql
   - handlebars
+  - hapi
+  - ioredis
   - jade
-  - pug
+  - knex
+  - koa-router
+  - memcached
+  - mimic-response
   - mongodb-core
-  - finalhandler
-  - ioredis
+  - mysql
+  - mysql2
   - pg
-  - cassandra-driver
-  - tedious
+  - pug
+  - redis
   - restify
-  - fastify
-  - mimic-response
-  - got
-  - bluebird
-  - apollo-server-express
-  - knex
+  - tedious
   - ws
-  - graphql
-  - express-graphql
-  - elasticsearch
-  - hapi
-  - express
-  - express-queue
-  - memcached

.tav.yml

@@ -201,7 +201,13 @@ koa-router:
   node: '>=6.0.0'
   peerDependencies: koa@2
   versions: '>=5.2.0 <8'
-  commands: node test/instrumentation/modules/koa-router/index.js
+  commands: node test/instrumentation/modules/koa-router/old-name.js
+'@koa/router':
+  node: '>=8.0.0'
+  peerDependencies: koa@2
+  versions: '>=8 <9'
+  commands: node test/instrumentation/modules/koa-router/new-name.js
+
 elasticsearch:
   versions: '>=8.0.0'
   commands: node test/instrumentation/modules/elasticsearch.js

docs/supported-technologies.asciidoc

@@ -47,7 +47,7 @@ These are the frameworks that we officially support:
 |<<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,
+|<<koa,Koa>> via koa-router or @koa/router |>=5.2.0 <9.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]
 |<<restify,Restify>> |>=5.2.0 |

lib/instrumentation/index.js

@@ -31,7 +31,7 @@ var MODULES = [
   'jade',
   'knex',
   'koa',
-  'koa-router',
+  ['koa-router', '@koa/router'],
   'memcached',
   'mimic-response',
   'mongodb-core',

lib/instrumentation/modules/koa-router.js

@@ -6,7 +6,7 @@ var shimmer = require('../shimmer')
 
 module.exports = function (Router, agent, { version, enabled }) {
   if (!enabled) return Router
-  if (!semver.satisfies(version, '>=5.2.0 <8')) {
+  if (!semver.satisfies(version, '>=5.2.0 <9')) {
     agent.logger.debug('koa-router version %s not supported - aborting...', version)
     return Router
   }

package.json

@@ -112,6 +112,7 @@
     "@commitlint/config-conventional": "^8.0.0",
     "@commitlint/travis-cli": "^8.0.0",
     "@hapi/hapi": "^18.2.0",
+    "@koa/router": "^8.0.1",
     "@types/node": "^12.0.8",
     "apollo-server-express": "^2.6.3",
     "aws-sdk": "^2.477.0",

test/instrumentation/modules/koa-router/index.js

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

test/instrumentation/modules/koa-router/new-name.js

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