Test suite beginning

* Readme reflects subtree zongji
* Example updated

Author: numtel

.gitignore

@@ -3,3 +3,5 @@
 *.swo
 .npm
 node_modules/mysql
+node_modules/.bin
+node_modules/nodeunit

README.md

@@ -6,16 +6,12 @@ Built using the [`zongji` Binlog Tailer](https://github.com/nevill/zongji) and [
 
 ## *Under Construction*
 
-This package is yet completed. In order to test it, please use the following command sequence as a guide:
+This package is not yet completed. In order to test it, you must clone the repo. Please use the following command sequence as a guide:
 
 ```bash
 $ git clone https://github.com/numtel/mysql-live-select.git
 $ cd mysql-live-select
 $ npm install
-$ cd node_modules
-# Updated ZongJi module not yet available on NPM, clone repo instead:
-$ git clone https://github.com/nevill/zongji.git
-$ cd ..
 # To use example as-is, copy example data into MySQL
 $ mysql < example.sql
 # Configure example to match your MySQL settings
@@ -25,24 +21,18 @@ $ vim example.js
 $ node example.js
 ```
 
-Coming soon:
-
-* Automated tests
-
 ## Installation
 
 * Enable MySQL binlog in `my.cnf`, restart MySQL server after making the changes.
 
   ```
   # binlog config
   server-id        = 1
+  binlog_format    = row
   log_bin          = /usr/local/var/log/mysql/mysql-bin.log
   binlog_do_db     = employees   # optional
   expire_logs_days = 10          # optional
   max_binlog_size  = 100M        # optional
-
-  # Very important if you want to receive write, update and delete row events
-  binlog_format    = row
   ```
 * Create an account with replication privileges:
 
@@ -67,21 +57,23 @@ Setting | Type | Description
 
 ```javascript
 // Example:
-var table = 'my_table';
+var liveConnection = new LiveMysql(settings);
+var table = 'players';
 var id = 11;
 
-liveMysqlInstance.select(function(esc, escId){
+liveConnection.select(function(esc, escId){
   return (
     'select * from ' + escId(table) +
     'where `id`=' + esc(id)
   );
-}, [
+}, [ {
   table: table,
   condition: function(row, newRow){ return row.id === id; }
-]).on('update', function(data){
+} ]).on('update', function(data){
   console.log(data);
 });
 ```
+See [`example.js`](example.js) for full source...
 
 
 ### LiveMysql.prototype.select(query, triggers)

example.js

@@ -7,26 +7,21 @@ var settings = {
   database    : 'leaderboard',
   serverId    : 34,
   minInterval : 200
-  // debug: true
 };
 
 var liveConnection = new LiveMysql(settings);
-// var result = liveConnection.select(
-//   'select * from players',
-//   [
-//     { table: 'players' }
-//   ]
-// );
-// result.on('update', function(event){
-//   // do something to update the client
-//   console.log(event);
-// });
+var table = 'players';
+var id = 11;
 
-liveConnection.select('select score from players where id=11', [
-  {
-    table: 'players',
-    condition: function(row, newRow){ return row.id === 11; }
-  }
-]).on('update', function(event){
-  console.log(event);
+liveConnection.select(function(esc, escId){
+  return (
+    'select * from ' + escId(table) +
+    'where `id`=' + esc(id)
+  );
+}, [ {
+  table: table,
+  condition: function(row, newRow){ return row.id === id; }
+} ]).on('update', function(data){
+  console.log(data);
 });
+

lib/LiveMysql.js

@@ -20,8 +20,9 @@ function LiveMysql(settings){
     if(event.getEventName() === 'tablemap') return;
 
     self._select.forEach(function(select){
-      if(select.matchRowEvent(event))
+      if(select.matchRowEvent(event)){
         select.update();
+      }
     });
   });
 
@@ -39,5 +40,11 @@ LiveMysql.prototype.select = function(query, triggers){
   return newSelect;
 };
 
+LiveMysql.prototype.end = function(){
+  var self = this;
+  self.zongji.stop();
+  self.db.destroy();
+};
+
 
 module.exports = LiveMysql;

lib/LiveMysqlSelect.js

@@ -13,10 +13,10 @@ function LiveMysqlSelect(query, triggers, base){
 
   var self = this;
   EventEmitter.call(self);
-  self.query = self._escapeQueryFun(query);
   self.triggers = triggers;
   self.base = base;
   self.lastUpdate = 0;
+  self.query = self._escapeQueryFun(query);
 
   self.update();
 }
@@ -42,6 +42,12 @@ LiveMysqlSelect.prototype.matchRowEvent = function(event){
     trigger = self.triggers[i];
     triggerDatabase = trigger.database ||
       self.base.settings.database;
+
+    if(triggerDatabase === undefined){
+      self.emit('error', new Error('no database selected'));
+      return false;
+    }
+
     if(triggerDatabase === tableMap.parentSchema &&
        trigger.table === tableMap.tableName){
       if(trigger.condition === undefined){
@@ -64,8 +70,8 @@ LiveMysqlSelect.prototype.matchRowEvent = function(event){
 
 LiveMysqlSelect.prototype.update = function(){
   var self = this;
-  if(self.base.settings.minInterval === undefined ||
-     self.lastUpdate + self.base.settings.minInterval < Date.now()){
+
+  function _update(){
     self.base.db.query(self.query, function(error, rows){
       if(error){
         self.emit('error', error);
@@ -75,6 +81,19 @@ LiveMysqlSelect.prototype.update = function(){
       }
     });
   }
+
+  if(self.base.settings.minInterval === undefined){
+    _update();
+  }else if(self.lastUpdate + self.base.settings.minInterval < Date.now()){
+    _update();
+  }else{ // Before minInterval
+    if(!self._updateTimeout){
+      self._updateTimeout = setTimeout(function(){
+        delete self._updateTimeout;
+        _update();
+      }, self.lastUpdate + self.base.settings.minInterval - Date.now());
+    }
+  }
 };
 
 module.exports = LiveMysqlSelect;

package.json

@@ -18,5 +18,8 @@
   "license": "MIT",
   "dependencies": {
     "mysql": "^2.5.4"
+  },
+  "devDependencies": {
+    "nodeunit": "^0.9.0"
   }
 }

test/helpers/connector.js

@@ -0,0 +1,39 @@
+/* mysql-live-select, MIT License [email protected]
+   test/helpers/connector.js - Connect to database */
+var EventEmitter = require('events').EventEmitter;
+var util = require('util');
+var LiveMysql = require('../../');
+var querySequence = require('./querySequence');
+
+function Connector(settings){
+  var self = this;
+  EventEmitter.call(self);
+  self.database = settings.database;
+  delete settings.database;
+  self.conn = new LiveMysql(settings);
+  self.ready = false;
+  var escId = self.conn.db.escapeId;
+  var esc = self.conn.db.escape.bind(self.conn.db);
+
+  querySequence(self.conn.db, [
+    'DROP DATABASE IF EXISTS ' + escId(self.database),
+    'CREATE DATABASE ' + escId(self.database),
+    'USE ' + escId(self.database),
+  ], function(results){
+    self.ready = true;
+    self.emit('ready', self.conn, esc, escId);
+  });
+
+  setTimeout(function(){
+    self.on('newListener', function(event, listener){
+      if(event === 'ready'){
+        if(self.ready) listener(self.conn, esc, escId);
+      }
+    });
+  }, 1);
+
+};
+
+util.inherits(Connector, EventEmitter);
+
+module.exports = Connector;

test/helpers/querySequence.js

@@ -0,0 +1,28 @@
+// Execute a sequence of queries on a node-mysql database connection
+// @param {object} connection - Node-Mysql Connection, Connected
+// @param {boolean} debug - Print queries as they execute (optional)
+// @param {[string]} queries - Queries to execute, in order
+// @param {function} callback - Call when complete
+module.exports = function(connection, debug, queries, callback){
+  if(debug instanceof Array){
+    callback = queries;
+    queries = debug;
+    debug = false;
+  }
+  var results = [];
+  var sequence = queries.map(function(queryStr, index, initQueries){
+    return function(){
+      debug && console.log('Query Sequence', index, queryStr);
+      connection.query(queryStr, function(err, rows, fields){
+        if(err) throw err;
+        results.push(rows);
+        if(index < sequence.length - 1){
+          sequence[index + 1]();
+        }else{
+          callback(results);
+        }
+      });
+    }
+  });
+  sequence[0]();
+};

test/index.js

@@ -0,0 +1,63 @@
+/* mysql-live-select, MIT License [email protected]
+   test/index.js - Test Suite */
+var LiveMysql = require('../');
+var settings = require('./settings/mysql');
+var querySequence = require('./helpers/querySequence');
+var Connector = require('./helpers/connector');
+var server = new Connector(settings);
+
+module.exports = {
+  basic: function(test){
+    var table = 'simple';
+    server.on('ready', function(conn, esc, escId){
+      querySequence(conn.db, [
+        'DROP TABLE IF EXISTS ' + escId(table),
+        'CREATE TABLE ' + escId(table) + ' (col INT UNSIGNED)',
+        'INSERT INTO ' + escId(table) + ' (col) VALUES (10)',
+      ], function(results){
+
+        conn.select('SELECT * FROM ' + escId(table), [ {
+          database: server.database,
+          table: table
+        } ]).on('update', function(data){
+          if(data[0].col === 15){
+            test.ok(true);
+            test.done();
+          }
+        });
+
+        querySequence(conn.db, [
+          'UPDATE ' + escId(table) +
+          'SET `col` = 15'
+        ], function(results){
+          // ...
+        });
+      });
+    });
+  },
+  error_no_db_selected: function(test){
+    var table = 'error_no_db';
+    server.on('ready', function(conn, esc, escId){
+      querySequence(conn.db, [
+        'DROP TABLE IF EXISTS ' + escId(table),
+        'CREATE TABLE ' + escId(table) + ' (col INT UNSIGNED)',
+        'INSERT INTO ' + escId(table) + ' (col) VALUES (10)',
+      ], function(results){
+
+        conn.select('SELECT * FROM ' + escId(table), [ {
+          table: table
+        } ]).on('error', function(error){
+          test.equal(error.toString(), 'Error: no database selected');
+          test.done();
+        });
+
+        querySequence(conn.db, [
+          'UPDATE ' + escId(table) +
+          'SET `col` = 15'
+        ], function(results){
+          // ...
+        });
+      });
+    });
+  }
+}

test/settings/mysql.js

@@ -0,0 +1,8 @@
+module.exports = {
+  host        : 'localhost',
+  user        : 'root',
+  password    : 'numtel',
+  database    : 'live_select_test',
+  serverId    : 347,
+  minInterval : 200
+};