Add default connection attributes (#1825)

feat: add default connection attributes

Author: Daemonxiao

lib/connection_config.js

@@ -10,6 +10,7 @@
 const { URL } = require('url');
 const ClientConstants = require('./constants/client');
 const Charsets = require('./constants/charsets');
+const { version } = require('../package.json')
 let SSLProfiles = null;
 
 const validOptions = {
@@ -169,7 +170,13 @@ class ConnectionConfig {
       ConnectionConfig.getDefaultFlags(options),
       options.flags || ''
     );
-    this.connectAttributes = options.connectAttributes;
+    // Default connection attributes
+    // https://dev.mysql.com/doc/refman/8.0/en/performance-schema-connection-attribute-tables.html
+    const defaultConnectAttributes =  {
+      _client_name: 'Node-MySQL-2',
+      _client_version: version
+    };
+    this.connectAttributes = { ...defaultConnectAttributes, ...(options.connectAttributes || {})};
     this.maxPreparedStatements = options.maxPreparedStatements || 16000;
   }
 
@@ -217,17 +224,15 @@ class ConnectionConfig {
       'SECURE_CONNECTION',
       'MULTI_RESULTS',
       'TRANSACTIONS',
-      'SESSION_TRACK'
+      'SESSION_TRACK',
+      'CONNECT_ATTRS'
     ];
     if (options && options.multipleStatements) {
       defaultFlags.push('MULTI_STATEMENTS');
     }
     defaultFlags.push('PLUGIN_AUTH');
     defaultFlags.push('PLUGIN_AUTH_LENENC_CLIENT_DATA');
 
-    if (options && options.connectAttributes) {
-      defaultFlags.push('CONNECT_ATTRS');
-    }
     return defaultFlags;
   }
 

test/integration/test-auth-switch.js

@@ -3,10 +3,17 @@
 const mysql = require('../../index.js');
 const Command = require('../../lib/commands/command.js');
 const Packets = require('../../lib/packets/index.js');
+const {version} = require('../../package.json')
 
 const assert = require('assert');
 
-const connectAttributes = { foo: 'bar', baz: 'foo' };
+const connectAttributes = {foo: 'bar', baz: 'foo'};
+
+const defaultConnectAttributes = {
+  _client_name: 'Node-MySQL-2',
+  _client_version: version
+};
+
 let count = 0;
 
 class TestAuthSwitchHandshake extends Command {
@@ -36,7 +43,8 @@ class TestAuthSwitchHandshake extends Command {
     assert.equal(clientHelloReply.user, 'test_user');
     assert.equal(clientHelloReply.database, 'test_database');
     assert.equal(clientHelloReply.authPluginName, 'mysql_native_password');
-    assert.deepEqual(clientHelloReply.connectAttributes, connectAttributes);
+    assert.deepEqual(clientHelloReply.connectAttributes,
+      {...connectAttributes, ...defaultConnectAttributes});
     const asr = new Packets.AuthSwitchRequest(this.args);
     connection.writePacket(asr.toPacket());
     return TestAuthSwitchHandshake.prototype.readClientAuthSwitchResponse;