1.0.1: Fix added rows in diff calculation

* multipleQueries test created

Author: numtel

README.md

@@ -1,9 +1,5 @@
 # mysql-live-select [![Build Status](https://travis-ci.org/numtel/mysql-live-select.svg?branch=master)](https://travis-ci.org/numtel/mysql-live-select)
 
-### :boom: :exclamation: Notice!
-
-This readme is for the updated 1.0 release but has not been included in `numtel:mysql` yet and is not quite ready for use. I have found that the updated diff calculation provides superfluous data for `added` rows. Please wait to update from `0.0.24`. **See [the readme for the current stable version on this page](https://github.com/numtel/mysql-live-select/blob/89691160b7e1fbfde1ae7055980668ceb4182f8a/README.md).**
-
 NPM Package to provide events when a MySQL select statement result set changes.
 
 Built using the [`zongji` Binlog Tailer](https://github.com/nevill/zongji) and [`node-mysql`](https://github.com/felixge/node-mysql) projects.

lib/QueryCache.js

@@ -111,7 +111,7 @@ QueryCache.prototype.invalidate = function() {
       self.initialized = true;
       self.lastUpdate = Date.now();
 
-      if(self.needUpdate) update();
+      if(self.needUpdate === true) update();
     });
   }
 

lib/differ.js

@@ -9,7 +9,9 @@ exports.generate = function(oldHashes, newData) {
 
   // Need copy of curHashes so duplicates can be checked off
   var curHashes2 = curHashes.slice();
-  var addedRows = newData.map(function(row) {
+  var addedRows = newData.filter(function(row) {
+    return oldHashes.indexOf(row._hash) === -1;
+  }).map(function(row) {
     // Prepare row meta-data
     row._index = curHashes2.indexOf(row._hash) + 1;
 
@@ -74,6 +76,11 @@ exports.generate = function(oldHashes, newData) {
 }
 
 exports.apply = function(data, diff) {
+  data = _.clone(data, true).map(function(row, index) {
+    row._index = index + 1;
+    return row;
+  });
+
   var newResults = data.slice();
 
   diff.removed !== null && diff.removed.forEach(
@@ -98,5 +105,11 @@ exports.apply = function(data, diff) {
   diff.added !== null && diff.added.forEach(
     function(added) { newResults[added._index - 1] = added; });
 
-  return newResults.filter(function(row) { return row !== undefined; });
+  var result = newResults.filter(function(row) { return row !== undefined; });
+
+  return result.map(function(row) {
+    row = _.clone(row);
+    delete row._index;
+    return row;
+  });
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-live-select",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Live updating MySQL SELECT statements",
   "main": "lib/LiveMysql.js",
   "repository": "https://github.com/numtel/mysql-live-select",

test/fixtures/multipleQueries.js

@@ -0,0 +1,75 @@
+exports.characters = {
+  columns: { id: 'INT UNSIGNED', name: 'VARCHAR(45)', visits: 'INT UNSIGNED' },
+  initial: [
+    { id: 1, name: 'Celie', visits: 10 },
+    { id: 2, name: 'Nettie', visits: 15 },
+    { id: 3, name: 'Harpo', visits: 20 },
+    { id: 4, name: 'Shug', visits: 25 },
+  ],
+  select: 'SELECT * FROM $table$ ORDER BY visits DESC',
+  // Optional 'condition' function (not specified on this case)
+  // Execute a query after initialization and each update thereafter
+  queries: [
+    'UPDATE $table$ SET visits=visits+5 WHERE id=4',
+    'UPDATE $table$ SET visits=visits+15 WHERE id=1',
+    'INSERT INTO $table$ (id, name, visits) VALUES (5, \'Squeak\', 4)',
+    'DELETE FROM $table$ WHERE id=3'
+  ],
+  // Required, an array of diff objects: one for initial data and one for each
+  //  query
+  expectedDiffs: [
+    { removed: null,
+      moved: null,
+      copied: null,
+      added: 
+       [ { id: 4, name: 'Shug', visits: 25, _index: 1 },
+         { id: 3, name: 'Harpo', visits: 20, _index: 2 },
+         { id: 2, name: 'Nettie', visits: 15, _index: 3 },
+         { id: 1, name: 'Celie', visits: 10, _index: 4 } ] },
+    { removed: [ { _index: 1 } ],
+      moved: null,
+      copied: null,
+      added: [ { id: 4, name: 'Shug', visits: 30, _index: 1 } ] },
+    { removed: [ { _index: 2 } ],
+      moved: 
+       [ { old_index: 2, new_index: 3 },
+         { old_index: 3, new_index: 4 } ],
+      copied: null,
+      added: [ { id: 1, name: 'Celie', visits: 25, _index: 2 } ] },
+    { removed: null,
+      moved: null,
+      copied: null,
+      added: [ { id: 5, name: 'Squeak', visits: 4, _index: 5 } ] },
+    { removed: [ { _index: 5 } ],
+      moved: 
+       [ { old_index: 4, new_index: 3 },
+         { old_index: 5, new_index: 4 } ],
+      copied: null,
+      added: null }
+  ],
+  // Optionally, specify an array of expected data for each event,
+  //  in order to test the differ's correctness
+  expectedDatas: [
+    [ { id: 4, name: 'Shug', visits: 25 },
+      { id: 3, name: 'Harpo', visits: 20 },
+      { id: 2, name: 'Nettie', visits: 15 },
+      { id: 1, name: 'Celie', visits: 10 } ],
+    [ { id: 4, name: 'Shug', visits: 30 },
+      { id: 3, name: 'Harpo', visits: 20 },
+      { id: 2, name: 'Nettie', visits: 15 },
+      { id: 1, name: 'Celie', visits: 10 } ],
+    [ { id: 4, name: 'Shug', visits: 30 },
+      { id: 1, name: 'Celie', visits: 25 },
+      { id: 3, name: 'Harpo', visits: 20 },
+      { id: 2, name: 'Nettie', visits: 15 } ],
+    [ { id: 4, name: 'Shug', visits: 30 },
+      { id: 1, name: 'Celie', visits: 25 },
+      { id: 3, name: 'Harpo', visits: 20 },
+      { id: 2, name: 'Nettie', visits: 15 },
+      { id: 5, name: 'Squeak', visits: 4 } ],
+    [ { id: 4, name: 'Shug', visits: 30 },
+      { id: 1, name: 'Celie', visits: 25 },
+      { id: 2, name: 'Nettie', visits: 15 },
+      { id: 5, name: 'Squeak', visits: 4 } ]
+  ]
+}

test/index.js

@@ -1,9 +1,11 @@
 /* mysql-live-select, MIT License [email protected]
    test/index.js - Test Suite */
+var _ = require('lodash');
 var LiveMysql = require('../');
 var settings = require('./settings/mysql');
 var querySequence = require('./helpers/querySequence');
 var Connector = require('./helpers/connector');
+var multipleQueriesData = require('./fixtures/multipleQueries');
 var server = new Connector(settings);
 
 module.exports = {
@@ -148,15 +150,82 @@ module.exports = {
       });
     });
   },
-  pauseAndResume: function(test){
+  // Cases specified in test/fixtures/multipleQueries.js
+  multipleQueries: function(test) {
+    var tablePrefix = 'multiple_queries_';
+    // Milliseconds between each query execution
+    var queryWaitTime = 100;
+    server.on('ready', function(conn, esc, escId, queries) {
+      Object.keys(multipleQueriesData).forEach(function(queryName) {
+        var table = tablePrefix + queryName;
+        var tableEsc = escId(table);
+        var details = multipleQueriesData[queryName];
+
+        var columnDefStr = _.map(details.columns, function(typeStr, name) {
+          return escId(name) + ' ' + typeStr;
+        }).join(', ');
+        var columnList = Object.keys(details.columns);
+        var initDataStr = details.initial.map(function(rowData) {
+          return '(' + columnList.map(function(column) {
+            return esc(rowData[column]);
+          }).join(', ') + ')';
+        }).join(', ');
+        var replaceTable = function(query) {
+          return query.replace(/\$table\$/g, tableEsc);
+        };
+        querySequence(conn.db, [
+          'DROP TABLE IF EXISTS ' + tableEsc,
+          'CREATE TABLE ' + tableEsc + ' (' + columnDefStr + ')',
+          'INSERT INTO ' + tableEsc + ' (' + columnList.map(escId).join(', ') +
+            ') VALUES ' + initDataStr,
+        ], function(results) {
+          var actualDiffs = [];
+          var actualDatas = [];
+          var curQuery = 0;
+          var oldData = [];
+          conn.select(replaceTable(details.select), [ {
+            table: table,
+            database: server.database,
+            condition: details.condition
+          } ]).on('update', function(diff, rows) {
+            actualDiffs.push(diff);
+            actualDatas.push(LiveMysql.applyDiff(oldData, diff));
+
+            oldData = rows;
+
+            if(curQuery < details.queries.length) {
+              setTimeout(function() {
+                querySequence(conn.db,
+                  [ replaceTable(details.queries[curQuery++]) ],
+                  function(results){ /* do nothing with results */ });
+              }, queryWaitTime);
+            }
+
+            if(actualDiffs.length === details.expectedDiffs.length) {
+              test.deepEqual(actualDiffs, details.expectedDiffs,
+                'Diff Mismatch on ' + queryName);
+
+              if(details.expectedDatas) {
+                test.deepEqual(actualDatas, details.expectedDatas,
+                  'Data Mismatch on ' + queryName);
+              }
+              test.done();
+            }
+          });
+
+        });
+      });
+    });
+  },
+  pauseAndResume: function(test) {
     var waitTime = 500;
     var table = 'pause_resume';
-    server.on('ready', function(conn, esc, escId, queries){
+    server.on('ready', function(conn, esc, escId, queries) {
       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){
+      ], function(results) {
         var pauseTime = Date.now();
         conn.select('SELECT * FROM ' + escId(table), [ {
           table: table,