Merge pull request newrelic#2 from newrelic/nwolfe/mysql2-promise

lykkin · web-flow · commit 6162673b7406 · 2018-10-25T11:41:52.000-07:00
Added mysql2 promise support and tests
diff --git a/lib/instrumentation.js b/lib/instrumentation.js
@@ -43,8 +43,12 @@ exports.callbackInitialize = function callbackInitialize(shim, mysql) {
   }
 }
 
-exports.promiseInitialize = function promiseInitialize(shim, mysql) {
+exports.promiseInitialize = function promiseInitialize(shim) {
+  const callbackAPI = shim.require('./index')
 
+  if (callbackAPI && !shim.isWrapped(callbackAPI.createConnection)) {
+    exports.callbackInitialize(shim, callbackAPI)
+  }
 }
 
 function wrapGetConnection(shim, connectable) {
diff --git a/tests/versioned/common/basic-pool.js b/tests/versioned/common/basic-pool.js
@@ -7,17 +7,15 @@ const urltils = require('newrelic/lib/util/urltils') // TODO: Expose via test ut
 const utils = require('@newrelic/test-utilities')
 
 const params = setup.params
-const DBUSER = 'root'
-const DBNAME = 'agent_integration'
 
 var config = getConfig({})
 function getConfig(extras) {
   var conf = {
     connectionLimit: 10,
-    host: params.mysql_host,
-    port: params.mysql_port,
-    user: DBUSER,
-    database: DBNAME
+    host: params.host,
+    port: params.port,
+    user: params.user,
+    database: params.database
   }
 
   for (var key in extras) { // eslint-disable-line guard-for-in
@@ -43,8 +41,8 @@ module.exports = (t, requireMySQL) => {
     var badConfig = {
       connectionLimit: 10,
       host: 'nohost',
-      user: DBUSER,
-      database: DBNAME
+      user: params.user,
+      database: params.database
     }
 
     t.tearDown(() => {
@@ -129,7 +127,7 @@ module.exports = (t, requireMySQL) => {
           )
           t.equal(
             seg.parameters.database_name,
-            DBNAME,
+            params.database,
             'set database name'
           )
           t.equal(
@@ -160,7 +158,7 @@ module.exports = (t, requireMySQL) => {
           )
           t.equal(
             seg.parameters.database_name,
-            DBNAME,
+            params.database,
             'should set database name'
           )
           helper.agent.config.datastore_tracer.instance_reporting.enabled = true
@@ -219,7 +217,7 @@ module.exports = (t, requireMySQL) => {
           )
           t.equal(
             seg.parameters.database_name,
-            DBNAME,
+            params.database,
             'set database name'
           )
           t.equal(seg.parameters.port_path_or_id, String(defaultConfig.port), 'set port')
@@ -248,7 +246,7 @@ module.exports = (t, requireMySQL) => {
           )
           t.equal(
             seg.parameters.database_name,
-            DBNAME,
+            params.database,
             'should set database name'
           )
           t.equal(
@@ -381,7 +379,7 @@ module.exports = (t, requireMySQL) => {
               )
               t.equal(
                 seg.parameters.database_name,
-                DBNAME,
+                params.database,
                 'set database name'
               )
               txn.end(socketPool.end.bind(socketPool, t.end))
diff --git a/tests/versioned/common/basic.js b/tests/versioned/common/basic.js
@@ -157,7 +157,7 @@ module.exports = (t, requireMySQL) => {
       })
     })
 
-    t.test('ensure database name changes with a use statement', (t) => {
+    t.test('database name should change with use statement', (t) => {
       helper.runInTransaction((txn) => {
         withRetry.getClient((err, client) => {
           if (!t.error(err)) {
@@ -177,9 +177,9 @@ module.exports = (t, requireMySQL) => {
                 t.ok(seg, 'there is a segment')
                 t.equal(
                   seg.parameters.host,
-                  urltils.isLocalhost(params.mysql_host)
+                  urltils.isLocalhost(params.host)
                     ? helper.agent.config.getHostnameSafe()
-                    : params.mysql_host,
+                    : params.host,
                   'set host'
                 )
                 t.equal(
@@ -354,46 +354,6 @@ module.exports = (t, requireMySQL) => {
         })
       })
     })
-
-    t.test('ensure database name changes with a use statement', (t) => {
-      helper.runInTransaction((txn) => {
-        withRetry.getClient((err, client) => {
-          client.query('create database if not exists test_db;', (err) => {
-            t.error(err)
-            client.query('use test_db;', (err) => {
-              t.error(err)
-              client.query('SELECT 1 + 1 AS solution', (err) => {
-                var seg = helper.agent.tracer.getSegment().parent
-                t.error(err)
-                if (t.ok(seg, 'should have a segment')) {
-                  t.equal(
-                    seg.parameters.host,
-                    urltils.isLocalhost(params.mysql_host)
-                      ? helper.agent.config.getHostnameSafe()
-                      : params.mysql_host,
-                    'should set host parameter'
-                  )
-                  t.equal(
-                    seg.parameters.database_name,
-                    'test_db',
-                    'should use new database name'
-                  )
-                  t.equal(
-                    seg.parameters.port_path_or_id,
-                    '3306',
-                    'should set port parameter'
-                  )
-                }
-                client.query('drop test_db;', () => {
-                  withRetry.release(client)
-                  txn.end(t.end)
-                })
-              })
-            })
-          })
-        })
-      })
-    })
   })
 }
 
diff --git a/tests/versioned/common/pooling.js b/tests/versioned/common/pooling.js
@@ -5,10 +5,6 @@ const setup = require('./setup')
 const utils = require('@newrelic/test-utilities')
 
 
-const DBNAME = 'agent_integration'
-const DBTABLE = 'test'
-
-
 module.exports = (t, requireMySQL) => {
   t.test('MySQL instrumentation with a connection pool', {timeout: 30000}, (t) => {
     let helper = utils.TestAgent.makeInstrumented()
@@ -64,10 +60,7 @@ module.exports = (t, requireMySQL) => {
             return
           }
 
-          var query =
-            'SELECT *' +
-            '  FROM ' + DBNAME + '.' + DBTABLE +
-            ' WHERE id = ?'
+          var query = `SELECT * FROM ${setup.params.database}.test WHERE id = ?`
           client.query(query, [params.id], (err, results) => {
             withRetry.release(client) // always release back to the pool
 
@@ -104,22 +97,26 @@ module.exports = (t, requireMySQL) => {
               return
             }
 
-            t.equals(row.id, 1, 'node-mysql should still work (found id)')
-            t.equals(row.test_value, 'hamburgefontstiv',
-                     'mysql driver should still work (found value)')
+            t.equals(row.id, 1, 'mysql should still work (found id)')
+            t.equals(
+              row.test_value,
+              'hamburgefontstiv',
+              'mysql driver should still work (found value)'
+            )
 
             txn.end()
 
             var trace = txn.trace
             t.ok(trace, 'trace should exist')
             t.ok(trace.root, 'root element should exist.')
-            t.equals(trace.root.children.length, 1, 'There should be only one child.')
 
-            var selectSegment = trace.root.children[0]
+            t.ok(trace.root.children.length < 3, 'should have one or two children')
+
+            var selectSegment = trace.root.children[trace.root.children.length - 1]
             t.ok(selectSegment, 'trace segment for first SELECT should exist')
             t.equals(
               selectSegment.name,
-              'Datastore/statement/MySQL/agent_integration.test/select',
+              `Datastore/statement/MySQL/${setup.params.database}.test/select`,
               'should register as SELECT'
             )
 
diff --git a/tests/versioned/common/setup.js b/tests/versioned/common/setup.js
@@ -6,8 +6,10 @@ const async = require('async')
 module.exports = exports = setup
 exports.pool = setupPool
 const params = exports.params = {
-  mysql_host: process.env.NR_NODE_TEST_MYSQL_HOST || 'localhost',
-  mysql_port: process.env.NR_NODE_TEST_MYSQL_PORT || 3306
+  host: process.env.NR_NODE_TEST_MYSQL_HOST || 'localhost',
+  port: process.env.NR_NODE_TEST_MYSQL_PORT || 3306,
+  user: 'test_user',
+  database: 'agent_integration_' + Math.floor(Math.random() * 1000)
 }
 
 function setup(mysql, cb) {
@@ -22,9 +24,9 @@ function setup(mysql, cb) {
       })
 
       async.eachSeries([
-        'CREATE USER test_user',
-        'GRANT ALL ON *.* TO `test_user`',
-        'CREATE DATABASE IF NOT EXISTS `agent_integration`'
+        `CREATE USER ${params.user}`,
+        `GRANT ALL ON *.* TO ${params.user}`,
+        `CREATE DATABASE IF NOT EXISTS ${params.database}`
       ], (sql, cb) => {
         client.query(sql, (err) => {
           // Travis uses MySQL 5.4 which does not support `IF NOT EXISTS` for
@@ -45,12 +47,7 @@ function setup(mysql, cb) {
 
     // 2. Create the table and data as test user.
     (cb) => {
-      var client = mysql.createConnection({
-        host: params.mysql_host,
-        port: params.mysql_port,
-        user: 'test_user',
-        database: 'agent_integration'
-      })
+      var client = mysql.createConnection(params)
 
       async.eachSeries([
         [
@@ -83,12 +80,7 @@ function setupPool(mysql, logger) {
     log: (message) => logger.info(message),
 
     create: (callback) => {
-      var client = mysql.createConnection({
-        user: 'test_user',
-        database: 'agent_integration',
-        host: params.mysql_host,
-        port: params.mysql_port
-      })
+      var client = mysql.createConnection(params)
 
       client.on('error', (err) => {
         logger.error('MySQL connection errored out, destroying connection')
diff --git a/tests/versioned/common/transactions.js b/tests/versioned/common/transactions.js
@@ -5,8 +5,6 @@ const utils = require('@newrelic/test-utilities')
 
 
 const params = setup.params
-const DBUSER = 'test_user'
-const DBNAME = 'agent_integration'
 
 
 module.exports = (t, requireMySQL) => {
@@ -15,24 +13,14 @@ module.exports = (t, requireMySQL) => {
 
     // set up the instrumentation before loading MySQL
     const helper = utils.TestAgent.makeInstrumented()
-    helper.registerInstrumentation({
-      moduleName: 'mysql',
-      type: 'datastore',
-      onRequire: require('../../../lib/instrumentation').callbackInitialize
-    })
     const mysql = requireMySQL(helper)
 
     t.tearDown(() => helper.unload())
 
     setup(mysql, function(error) {
       t.error(error)
 
-      const client = mysql.createConnection({
-        user: DBUSER,
-        database: DBNAME,
-        host: params.mysql_host,
-        port: params.mysql_port
-      })
+      const client = mysql.createConnection(params)
 
       t.tearDown(() => client.end())
 
diff --git a/tests/versioned/mysql/newrelic.js b/tests/versioned/mysql/newrelic.js
@@ -1,9 +1,11 @@
+'use strict'
+
 exports.config = {
-  app_name           : ['My Application'],
-  license_key        : 'license key here',
-  logging            : {
-    level : 'debug',
-    filepath : '../../../newrelic_agent.log'
+  app_name: ['My Application'],
+  license_key: 'license key here',
+  logging: {
+    level: 'debug',
+    filepath: '../../../newrelic_agent.log'
   },
   utilization: {
     detect_aws: false,
@@ -13,11 +15,11 @@ exports.config = {
     detect_docker: false
   },
   slow_sql: {
-    enabled: true,
+    enabled: true
   },
-  transaction_tracer : {
+  transaction_tracer: {
     record_sql: 'raw',
     explain_threshold: 0,
-    enabled : true
+    enabled: true
   }
 }
diff --git a/tests/versioned/mysql2/newrelic.js b/tests/versioned/mysql2/newrelic.js
@@ -1,9 +1,11 @@
+'use strict'
+
 exports.config = {
-  app_name           : ['My Application'],
-  license_key        : 'license key here',
-  logging            : {
-    level : 'debug',
-    filepath : '../../../newrelic_agent.log'
+  app_name: ['My Application'],
+  license_key: 'license key here',
+  logging: {
+    level: 'debug',
+    filepath: '../../../newrelic_agent.log'
   },
   utilization: {
     detect_aws: false,
@@ -13,11 +15,11 @@ exports.config = {
     detect_docker: false
   },
   slow_sql: {
-    enabled: true,
+    enabled: true
   },
-  transaction_tracer : {
+  transaction_tracer: {
     record_sql: 'raw',
     explain_threshold: 0,
-    enabled : true
+    enabled: true
   }
 }
diff --git a/tests/versioned/mysql2/package.json b/tests/versioned/mysql2/package.json
@@ -14,7 +14,8 @@
         "basic-pool.tap.js",
         "basic.tap.js",
         "pooling.tap.js",
-        "transactions.tap.js"
+        "transactions.tap.js",
+        "promises.tap.js"
       ]
     },
     {
@@ -28,7 +29,8 @@
         "basic-pool.tap.js",
         "basic.tap.js",
         "pooling.tap.js",
-        "transactions.tap.js"
+        "transactions.tap.js",
+        "promises.tap.js"
       ]
     }
   ],
diff --git a/tests/versioned/mysql2/promises.tap.js b/tests/versioned/mysql2/promises.tap.js

Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,12 @@ exports.callbackInitialize = function callbackInitialize(shim, mysql) {`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`-exports.promiseInitialize = function promiseInitialize(shim, mysql) {`
	`46`	`+exports.promiseInitialize = function promiseInitialize(shim) {`
	`47`	`+ const callbackAPI = shim.require('./index')`
`47`	`48`
	`49`	`+ if (callbackAPI && !shim.isWrapped(callbackAPI.createConnection)) {`
	`50`	`+ exports.callbackInitialize(shim, callbackAPI)`
	`51`	`+ }`
`48`	`52`	`}`
`49`	`53`
`50`	`54`	`function wrapGetConnection(shim, connectable) {`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@`
`14`	`14`	`"basic-pool.tap.js",`
`15`	`15`	`"basic.tap.js",`
`16`	`16`	`"pooling.tap.js",`
`17`		`- "transactions.tap.js"`
	`17`	`+ "transactions.tap.js",`
	`18`	`+ "promises.tap.js"`
`18`	`19`	`]`
`19`	`20`	`},`
`20`	`21`	`{`
`@@ -28,7 +29,8 @@`
`28`	`29`	`"basic-pool.tap.js",`
`29`	`30`	`"basic.tap.js",`
`30`	`31`	`"pooling.tap.js",`
`31`		`- "transactions.tap.js"`
	`32`	`+ "transactions.tap.js",`
	`33`	`+ "promises.tap.js"`
`32`	`34`	`]`
`33`	`35`	`}`
`34`	`36`	`],`