DSN support, fixes #115

Sannis · Sannis · commit 658b8f9e12d4 · 2012-09-02T22:01:24.000+04:00
diff --git a/lib/mysql-libmysqlclient.js b/lib/mysql-libmysqlclient.js
@@ -71,26 +71,71 @@ for (var key in bindings) {
  * Asynchronous MySQL bindings for Node.js
  **/
 
+/** internal
+ * parseDSN(dsn) -> Array
+ * -dsn(String): DSN
+ *
+ * Parses DSN to connect() arguments array
+ */
+function parseDSN(dsn) {
+  var args;
+
+  var components = require('url').parse(dsn);
+
+  // DSN is not a plain hostname?
+  if (typeof components.hostname !== 'undefined') {
+    // Guard protocol
+    if (components.protocol !== 'mysql:') {
+      throw new Error("mysql-libmysqlclient supports only connections to MySQL server");
+    }
+
+    var
+      hostname = components.hostname,
+      port     = components.port,
+      auth     = components.auth.split(':'),
+      user     = auth.shift(),
+      password = auth.shift(),
+      database = (typeof components.pathname != 'undefined')
+               ? components.pathname.substr(1).replace(/\/.*$/, '').replace(/\?.*$/, '')
+               : null,
+      socket = null,
+      flags = null;
+
+    args = [hostname, user, password, database, port, socket, flags];
+  } else {
+    args = [arguments[0]];
+  }
+
+  return args;
+}
+
 /** section: Exports
- * MysqlLibmysqlclient.createConnectionSync(hostname[, user[, password[, database[, port[, socket]]]]]) -> MysqlConnection
+ * MysqlLibmysqlclient.createConnectionSync(hostname[, user[, password[, database[, port[, socket[, flags]]]]]]) -> MysqlConnection
  *
  * Creates connection to database
  *
  * Synchronous version
  **/
 exports.createConnectionSync = function createConnectionSync() {
-  var connection = new bindings.MysqlConnection();
+  var connection = new bindings.MysqlConnection(), args;
 
-  if (arguments.length > 0) {
+  // DSN support
+  if (arguments.length === 1) {
+    args = parseDSN(arguments[0]);
+  } else {
+    args = Array.prototype.slice.call(arguments, 0, 7);
+  }
+
+  if (args.length > 0) {
     // connection.constructor.prototype == bindings.MysqlConnection.prototype;
-    bindings.MysqlConnection.prototype.connectSync.apply(connection, Array.prototype.slice.call(arguments, 0, 6));
+    bindings.MysqlConnection.prototype.connectSync.apply(connection, args);
   }
 
   return connection;
 };
 
 /** section: Exports
- * MysqlLibmysqlclient.createConnection(hostname[, user[, password[, database[, port[, socket]]]]][, callback])
+ * MysqlLibmysqlclient.createConnection(hostname[, user[, password[, database[, port[, socket[, flags]]]]][, callback])
  *
  * Creates connection to database
  *
@@ -115,6 +160,13 @@ exports.createConnection = function createConnection() {
       callback(null, connection);
     };
 
+    // DSN support
+    if (args.length === 1) {
+      args = parseDSN(args[0]);
+    } else {
+      args = Array.prototype.slice.call(args, 0, 7);
+    }
+
     // + callback
     args.push(actualCallback);
 
@@ -266,11 +318,18 @@ exports.MysqlConnectionQueued = MysqlConnectionQueued;
  * Synchronous version
  **/
 exports.createConnectionQueuedSync = function createConnectionQueuedSync() {
-  var connection = new MysqlConnectionQueued();
+  var connection = new MysqlConnectionQueued(), args;
+
+  // DSN support
+  if (arguments.length === 1) {
+    args = parseDSN(arguments[0]);
+  } else {
+    args = Array.prototype.slice.call(arguments, 0, 7);
+  }
 
-  if (arguments.length > 0) {
+  if (args.length > 0) {
     // connection.constructor.prototype == bindings.MysqlConnection.prototype
-    bindings.MysqlConnection.prototype.connectSync.apply(connection, Array.prototype.slice.call(arguments, 0, 6));
+    bindings.MysqlConnection.prototype.connectSync.apply(connection, args);
   }
 
   return connection;
@@ -302,6 +361,13 @@ exports.createConnectionQueued = function createConnectionQueued() {
       callback(null, connection);
     };
 
+    // DSN support
+    if (args.length === 1) {
+      args = parseDSN(args[0]);
+    } else {
+      args = Array.prototype.slice.call(arguments, 0, 7);
+    }
+
     // + callback
     args.push(actualCallback);
 
@@ -379,11 +445,18 @@ MysqlConnectionHighlevel.prototype.query = function query(query, callback) {
  * Synchronous version
  **/
 exports.createConnectionHighlevelSync = function createConnectionHighlevelSync() {
-  var connection = new MysqlConnectionHighlevel();
+  var connection = new MysqlConnectionHighlevel(), args;
+
+  // DSN support
+  if (arguments.length === 1) {
+    args = parseDSN(arguments[0]);
+  } else {
+    args = Array.prototype.slice.call(arguments, 0, 7);
+  }
 
-  if (arguments.length > 0) {
+  if (args.length > 0) {
     // connection.constructor.prototype == bindings.MysqlConnection.prototype;
-    MysqlConnectionHighlevel.prototype.connectSync.apply(connection, Array.prototype.slice.call(arguments, 0, 6));
+    MysqlConnectionHighlevel.prototype.connectSync.apply(connection, args);
   }
 
   return connection;
@@ -415,6 +488,13 @@ exports.createConnectionHighlevel = function createConnectionHighlevel() {
       callback(null, connection);
     };
 
+    // DSN support
+    if (args.length === 1) {
+      args = parseDSN(arguments[0]);
+    } else {
+      args = Array.prototype.slice.call(arguments, 0, 7);
+    }
+
     // + callback
     args.push(actualCallback);
 
diff --git a/tests/config.js b/tests/config.js
@@ -22,6 +22,7 @@ module.exports = {
 
   // Database connection settings
   host:     process.env["TRAVIS"] ? "localhost" : "localhost",
+  port:     process.env["TRAVIS"] ? 3306        : 3306,
   user:     process.env["TRAVIS"] ? "test_user" : "test",
   password: process.env["TRAVIS"] ? "1234"      : "",
   database: "test",
diff --git a/tests/high-level/test-createconnection-highlevel.js b/tests/high-level/test-createconnection-highlevel.js
@@ -42,6 +42,30 @@ exports.mysql_libmysqlclient_createConnectionHighlevelSync_4 = function (test) {
   test.done();
 };
 
+exports.mysql_libmysqlclient_createConnectionHighlevelSync_DSN = function (test) {
+  test.expect(4);
+
+  var
+    dsn = require('util').format("mysql://%s:%s@%s:%s/%s/zxcvbn?qwerty=1234", cfg.user, cfg.password, cfg.host, cfg.port, cfg.database),
+    conn = cfg.mysql_libmysqlclient.createConnectionHighlevelSync(dsn),
+    isConnected;
+  test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+  test.ok(conn instanceof cfg.mysql_libmysqlclient.MysqlConnectionQueued);
+  test.ok(conn instanceof cfg.mysql_libmysqlclient.MysqlConnectionHighlevel);
+
+  isConnected = conn.connectedSync();
+  test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnectionHighlevelSync(dsn(user, password, host, port, database)) connects");
+
+  if (!isConnected) {
+    // Extra debug output
+    console.log("Error:" + conn.connectError);
+  } else {
+    conn.closeSync();
+  }
+
+  test.done();
+};
+
 exports.mysql_libmysqlclient_createConnectionHighlevel_0 = function (test) {
   test.expect(1);
 
@@ -91,3 +115,28 @@ exports.mysql_libmysqlclient_createConnectionHighlevel_5 = function (test) {
     test.done();
   });
 };
+
+exports.mysql_libmysqlclient_createConnectionHighlevel_DSN = function (test) {
+  test.expect(5);
+
+  var dsn = require('util').format("mysql://%s:%s@%s:%s/%s/zxcvbn?qwerty=1234", cfg.user, cfg.password, cfg.host, cfg.port, cfg.database);
+
+  cfg.mysql_libmysqlclient.createConnectionHighlevel(dsn, function (err, conn) {
+    test.ok(err === null, "Error object is not present");
+    test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+    test.ok(conn instanceof cfg.mysql_libmysqlclient.MysqlConnectionQueued);
+    test.ok(conn instanceof cfg.mysql_libmysqlclient.MysqlConnectionHighlevel);
+
+    isConnected = conn.connectedSync();
+    test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnectionHighlevel(dsn(user, password, host, port, database), callback) connects");
+
+    if (!isConnected) {
+      // Extra debug output
+      console.log("Error:" + conn.connectError);
+    } else {
+      conn.closeSync();
+    }
+
+    test.done();
+  });
+};
diff --git a/tests/high-level/test-createconnection-queued.js b/tests/high-level/test-createconnection-queued.js
@@ -40,6 +40,28 @@ exports.mysql_libmysqlclient_createConnectionQueuedSync_4 = function (test) {
   test.done();
 };
 
+exports.mysql_libmysqlclient_createConnectionQueuedSync_DSN = function (test) {
+  test.expect(2);
+
+  var
+    dsn = require('util').format("mysql://%s:%s@%s:%s/%s/zxcvbn?qwerty=1234", cfg.user, cfg.password, cfg.host, cfg.port, cfg.database),
+    conn = cfg.mysql_libmysqlclient.createConnectionQueuedSync(dsn),
+    isConnected;
+  test.ok(conn instanceof cfg.mysql_libmysqlclient.MysqlConnectionQueued, "cfg.mysql_libmysqlclient.createConnectionQueuedSync(dsn(user, password, host, port, database))");
+
+  isConnected = conn.connectedSync();
+  test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnectionQueuedSync(dsn(user, password, host, port, database)) connects");
+
+  if (!isConnected) {
+    // Extra debug output
+    console.log("Error:" + conn.connectError);
+  } else {
+    conn.closeSync();
+  }
+
+  test.done();
+};
+
 exports.mysql_libmysqlclient_createConnectionQueued_0 = function (test) {
   test.expect(1);
 
@@ -87,3 +109,27 @@ exports.mysql_libmysqlclient_createConnectionQueued_5 = function (test) {
     test.done();
   });
 };
+
+exports.mysql_libmysqlclient_createConnectionQueued_DSN = function (test) {
+  test.expect(4);
+
+  var dsn = require('util').format("mysql://%s:%s@%s:%s/%s/zxcvbn?qwerty=1234", cfg.user, cfg.password, cfg.host, cfg.port, cfg.database);
+
+  cfg.mysql_libmysqlclient.createConnectionQueued(dsn, function (err, conn) {
+    test.ok(err === null, "Error object is not present");
+    test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+    test.ok(conn instanceof cfg.mysql_libmysqlclient.MysqlConnectionQueued);
+
+    isConnected = conn.connectedSync();
+    test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnectionQueued(dsn(user, password, host, port, database), callback) connects");
+
+    if (!isConnected) {
+      // Extra debug output
+      console.log("Error:" + conn.connectError);
+    } else {
+      conn.closeSync();
+    }
+
+    test.done();
+  });
+};
diff --git a/tests/low-level-async/test-createconnection-async.js b/tests/low-level-async/test-createconnection-async.js
@@ -143,9 +143,30 @@ exports.mysql_libmysqlclient_createConnection_5_AccessDenied = function (test) {
 exports.mysql_libmysqlclient_createConnection_6 = function (test) {
   test.expect(3);
 
+  cfg.mysql_libmysqlclient.createConnection(cfg.host, cfg.user, cfg.password, cfg.database, cfg.port, function (err, conn) {
+    test.ok(err === null, "Error object is not present");
+    test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+
+    var isConnected = conn.connectedSync();
+    test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnection(host, user, password, database, flags, callback)");
+
+    if (!isConnected) {
+      // Extra debug output
+      console.log("Error:" + conn.connectError);
+    } else {
+      conn.closeSync();
+    }
+
+    test.done();
+  });
+};
+
+exports.mysql_libmysqlclient_createConnection_8 = function (test) {
+  test.expect(3);
+
   var compress_flag = cfg.mysql_bindings.CLIENT_COMPRESS;
 
-  cfg.mysql_libmysqlclient.createConnection(cfg.host, cfg.user, cfg.password, cfg.database, compress_flag, function (err, conn) {
+  cfg.mysql_libmysqlclient.createConnection(cfg.host, cfg.user, cfg.password, cfg.database, null, null, compress_flag, function (err, conn) {
     test.ok(err === null, "Error object is not present");
     test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
 
@@ -162,3 +183,72 @@ exports.mysql_libmysqlclient_createConnection_6 = function (test) {
     test.done();
   });
 };
+
+exports.mysql_libmysqlclient_createConnectionSync_DSN_1 = function (test) {
+  test.expect(3);
+
+  var dsn = require('util').format("mysql://%s:%s@%s:%s", cfg.user, cfg.password, cfg.host, cfg.port);
+
+  cfg.mysql_libmysqlclient.createConnection(dsn, function (err, conn) {
+    test.ok(err === null, "Error object is not present");
+    test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+
+    var isConnected = conn.connectedSync();
+    test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnection(dsn(user, password, host, port), callback)");
+
+    if (!isConnected) {
+      // Extra debug output
+      console.log("Error:" + conn.connectError);
+    } else {
+      conn.closeSync();
+    }
+
+    test.done();
+  });
+};
+
+exports.mysql_libmysqlclient_createConnectionSync_DSN_2 = function (test) {
+  test.expect(3);
+
+  var dsn = require('util').format("mysql://%s:%s@%s:%s?qwerty=1234", cfg.user, cfg.password, cfg.host, cfg.port);
+
+  cfg.mysql_libmysqlclient.createConnection(dsn, function (err, conn) {
+    test.ok(err === null, "Error object is not present");
+    test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+
+    var isConnected = conn.connectedSync();
+    test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnection(dsn(user, password, host, port), callback)");
+
+    if (!isConnected) {
+      // Extra debug output
+      console.log("Error:" + conn.connectError);
+    } else {
+      conn.closeSync();
+    }
+
+    test.done();
+  });
+};
+
+exports.mysql_libmysqlclient_createConnectionSync_DSN_3 = function (test) {
+  test.expect(3);
+
+  var dsn = require('util').format("mysql://%s:%s@%s:%s/%s/zxcvbn?qwerty=1234", cfg.user, cfg.password, cfg.host, cfg.port, cfg.database);
+
+  cfg.mysql_libmysqlclient.createConnection(dsn, function (err, conn) {
+    test.ok(err === null, "Error object is not present");
+    test.ok(conn instanceof cfg.mysql_bindings.MysqlConnection);
+
+    var isConnected = conn.connectedSync();
+    test.ok(isConnected, "cfg.mysql_libmysqlclient.createConnection(dsn(user, password, host, port, database), callback)");
+
+    if (!isConnected) {
+      // Extra debug output
+      console.log("Error:" + conn.connectError);
+    } else {
+      conn.closeSync();
+    }
+
+    test.done();
+  });
+};
diff --git a/tests/low-level-sync/test-createconnection-sync.js b/tests/low-level-sync/test-createconnection-sync.js
