feat: mysql2@3 support (#3301)

mysql2@3 doesn't appear to contain any changes to createConnection, query,
or execute -- the exports that are instrumented.

Fixes: #3151
Co-authored-by: Trent Mick <[email protected]>

Author: firecow

.tav.yml

@@ -41,16 +41,27 @@ mysql:
 # - v1.6.2 is broken: https://github.com/sidorares/node-mysql2/issues/869
 # - v2.2.3 has a github dep ("@types/mysql": "types/mysql") that hits
 #   npm v6 install issue https://github.com/npm/cli/issues/4896
-mysql2-old:
+# - v3: It isn't clear what the min supported Node.js version is. "engines" says
+#   8.0.0, however it uses an lru-cache that supports only node >=16.14! From
+#   trial and error the effective min supported node is v14.6.0.
+#   See https://github.com/elastic/apm-agent-nodejs/pull/3301#issuecomment-1530138870
+mysql2-v1-v1.6.0:
   name: mysql2
   versions: '>=1.0.0 <1.6.0'
   commands:
     - node test/instrumentation/modules/mysql2/mysql.test.js
     - node test/instrumentation/modules/mysql2/pool-release-1.test.js
-mysql2-new:
+mysql2-v1.6.0-v3:
   name: mysql2
   versions: '>=1.6.0 <1.6.2 || >=1.6.3 <2.2.3 || >=2.2.4 <3'
-  node: '>=6.0.0'
+  node: '>=8.0.0'
+  commands:
+    - node test/instrumentation/modules/mysql2/mysql.test.js
+    - node test/instrumentation/modules/mysql2/pool-release-1.test.js
+mysql2:
+  name: mysql2
+  versions: '>=3.0.0 <4'
+  node: '>=14.6.0'
   commands:
     - node test/instrumentation/modules/mysql2/mysql.test.js
     - node test/instrumentation/modules/mysql2/pool-release-1.test.js

CHANGELOG.asciidoc

@@ -40,6 +40,8 @@ Notes:
 [float]
 ===== Features
 
+* Add support for mysql2@3. Contributed by @firecow. ({pull}3301[#3301])
+
 * Improve error handling with AWS Lambda. When used together with the
   https://github.com/elastic/apm-aws-lambda[Elastic AWS Lambda extension]
   v1.4.0 or greater, the APM agent will pre-register a partial transaction

docs/supported-technologies.asciidoc

@@ -156,7 +156,7 @@ so those should be supported as well.
 |https://www.npmjs.com/package/mongojs[mongojs] |>=1.0.0 <2.7.0 |Supported via mongodb-core
 |https://www.npmjs.com/package/mongoose[mongoose] |>=4.0.0 <5.7.0 |Supported via mongodb-core
 |https://www.npmjs.com/package/mysql[mysql] |^2.0.0 |Will instrument all queries
-|https://www.npmjs.com/package/mysql2[mysql2] |>=1.0.0 <3.0.0 |Will instrument all queries
+|https://www.npmjs.com/package/mysql2[mysql2] |>=1.0.0 <4.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/pg[pg] |>=4.0.0 <9.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/redis[redis] |>=2.0.0 <5.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/tedious[tedious] |>=1.9 <16.0.0 | (Excluding v4.0.0.) Will instrument all queries

lib/instrumentation/modules/mysql2.js

@@ -17,7 +17,7 @@ module.exports = function (mysql2, agent, { version, enabled }) {
   if (!enabled) {
     return mysql2
   }
-  if (!semver.satisfies(version, '>=1 <3')) {
+  if (!semver.satisfies(version, '>=1 <4')) {
     agent.logger.debug('mysql2 version %s not supported - aborting...', version)
     return mysql2
   }

package-lock.json

@@ -180,7 +180,7 @@
     "mongodb": "^5.1.0",
     "mongodb-core": "^3.2.7",
     "mysql": "^2.18.1",
-    "mysql2": "^2.1.0",
+    "mysql2": "^3.2.4",
     "ndjson": "^1.5.0",
     "numeral": "^2.0.6",
     "nyc": "^15.0.0",

package.json

@@ -1053,10 +1053,10 @@ test('disableInstrumentations', function (t) {
     modules.delete('@redis/client/dist/lib/client') // redis@4 supports node >=14
     modules.delete('@redis/client/dist/lib/client/commands-queue') // redis@4 supports node >=14
   }
-
   // @node-redis only present for redis >4 <4.1 --
   modules.delete('@node-redis/client/dist/lib/client') // redis@4 supports node >=14
   modules.delete('@node-redis/client/dist/lib/client/commands-queue') // redis@4 supports node >=14
+  modules.delete('mysql2')
 
   function testSlice (t, name, selector) {
     var selection = selector(modules)

test/config.test.js

@@ -11,6 +11,14 @@ if (process.env.GITHUB_ACTIONS === 'true' && process.platform === 'win32') {
   process.exit(0)
 }
 
+const semver = require('semver')
+const { safeGetPackageVersion } = require('../../../_utils')
+const mysql2Ver = safeGetPackageVersion('mysql2')
+if (semver.gte(mysql2Ver, '3.0.0') && semver.lt(process.version, '14.6.0')) {
+  console.log(`# SKIP mysql2@${mysql2Ver} does not support node ${process.version}`)
+  process.exit()
+}
+
 var agent = require('../../../..').start({
   serviceName: 'test',
   secretToken: 'test',

test/instrumentation/modules/mysql2/mysql.test.js

@@ -11,6 +11,14 @@ if (process.env.GITHUB_ACTIONS === 'true' && process.platform === 'win32') {
   process.exit(0)
 }
 
+const semver = require('semver')
+const { safeGetPackageVersion } = require('../../../_utils')
+const mysql2Ver = safeGetPackageVersion('mysql2')
+if (semver.gte(mysql2Ver, '3.0.0') && semver.lt(process.version, '14.6.0')) {
+  console.log(`# SKIP mysql2@${mysql2Ver} does not support node ${process.version}`)
+  process.exit()
+}
+
 var agent = require('../../../..').start({
   serviceName: 'test',
   secretToken: 'test',