Merge pull request #67 from Simperium/fix/bucket-update-emit

Pass additional arguments to the bucket.update emit

Author: roundhill

src/simperium/bucket.js

@@ -149,8 +149,8 @@ export default function Bucket( name, storeProvider, channel ) {
 	 */
 	this.onChannelIndex = this.emit.bind( this, 'index' );
 	this.onChannelError = this.emit.bind( this, 'error' );
-	this.onChannelUpdate = ( id, data ) => {
-		this.update( id, data, { sync: false } );
+	this.onChannelUpdate = ( id, data, original, patch, isIndexing ) => {
+		this.update( id, data, { original, patch, isIndexing }, { sync: false } );
 	};
 
 	this.onChannelIndexingStateChange = ( isIndexing ) => {
@@ -209,13 +209,13 @@ Bucket.prototype.reload = function() {
  * Stores an object in the bucket and syncs it to simperium. Generates an
  * object ID to represent the object in simperium.
  *
- * @param {Object} object - plain js object literal to be saved/synced
+ * @param {Object} data - plain js object literal to be saved/synced
  * @param {?bucketStoreGetCallback} callback - runs when object has been saved
  * @return {Promise<Object>} data stored in the bucket
  */
-Bucket.prototype.add = function( object, callback ) {
+Bucket.prototype.add = function( data, callback ) {
 	var id = uuid();
-	return this.update( id, object, callback );
+	return this.update( id, data, callback );
 };
 
 /**
@@ -234,13 +234,21 @@ Bucket.prototype.get = function( id, callback ) {
  *
  * @param {String} id - the bucket id for the object to update
  * @param {Object} data - object literal to replace the object data with
+ * @param {Object} remoteUpdateInfo - object containing data about a remote change
+ * @param {Object} [updateInfo.original] - the original object before the udpate
+ * @param {Object} [updateInfo.patch] - the JSONDiff patch to apply to the object
+ * @param {Boolean} [updateInfo.isIndexing] - true if the bucket is currently indexing
  * @param {Object} [options] - optional settings
  * @param {Boolean} [options.sync=true] - false if object should not be synced with this update
  * @param {?bucketStoreGetCallback} callback - executed when object is updated localy
  * @returns {Promise<Object>} - update data
  */
-Bucket.prototype.update = function( id, data, options, callback ) {
-	if ( typeof options === 'function' ) {
+Bucket.prototype.update = function( id, data, remoteUpdateInfo, options, callback ) {
+	// Callback could be 3rd or 4th argument
+	if ( typeof remoteUpdateInfo === 'function' ) {
+		callback = remoteUpdateInfo;
+		options = { sync: true };
+	} else if ( typeof options === 'function' ) {
 		callback = options;
 		options = { sync: true };
 	}
@@ -251,7 +259,7 @@ Bucket.prototype.update = function( id, data, options, callback ) {
 
 	const task = this.storeAPI.update( id, data, this.isIndexing )
 		.then( bucketObject => {
-			this.emit( 'update', id, bucketObject.data );
+			this.emit( 'update', id, bucketObject.data, remoteUpdateInfo );
 			this.channel.update( bucketObject, options.sync );
 			return bucketObject;
 		} );

test/simperium/bucket_test.js

@@ -37,23 +37,23 @@ describe( 'Bucket', () => {
 
 	it( 'should store object update callback', ( done ) => {
 		const id = 'thing',
-			object = {one: 'two'};
+			data = {one: 'two'};
 
-		bucket.update( id, object, function() {
+		bucket.update( id, data, function() {
 			bucket.get( id, function( err, savedObject ) {
-				deepEqual( object, savedObject );
+				deepEqual( data, savedObject );
 				done();
 			} );
 		} );
 	} );
 
 	it( 'should update with options callback', ( done ) => {
 		const id = 'thing',
-			object = {one: 'two'}
+			data = {one: 'two'}
 
-		bucket.update( id, object, {}, function() {
+		bucket.update( id, data, function() {
 			bucket.get( id, function( err, savedObject ) {
-				deepEqual( object, savedObject );
+				deepEqual( data, savedObject );
 				done();
 			} )
 		} )
@@ -99,4 +99,3 @@ describe( 'Bucket', () => {
 		} );
 	} );
 } );
-

test/simperium/channel_test.js

@@ -108,7 +108,7 @@ describe( 'Channel', function() {
 				done();
 			} );
 
-			bucket.update( '12345', {content: 'Hola mundo!'} );
+			bucket.update( '12345', {content: 'Hola mundo!'});
 		} );
 
 		it( 'should not send a change with an empty diff', function( done ) {
@@ -131,20 +131,20 @@ describe( 'Channel', function() {
 				checkSent = function() {
 					throw new Error( 'Sent too many changes' );
 				},
-				objectId = '123456';
+				id = '123456';
 
 			channel.on( 'send', fn.counts( 1, checkSent ) );
 
 			channel.on( 'send', function() {
-				bucket.update( objectId, data2 );
+				bucket.update( id, data2 );
 			} )
 
+			const objectId = '123456';
 			channel.localQueue.on( 'wait', function( id ) {
 				equal( id, objectId );
 				done();
 			} );
 
-			objectId = '123456';
 			bucket.update( objectId, data );
 		} );
 
@@ -225,13 +225,14 @@ describe( 'Channel', function() {
 
 			channel.localQueue.on( 'wait', validate );
 
+			const id = '123';
 			channel.once( 'send', function() {
-				bucket.update( '123', {title: 'hello again world'} );
-				bucket.remove( '123' );
+				bucket.update( id, {title: 'hello again world'} );
+				bucket.remove( id );
 			} );
 
 			store.put( '123', 3, {title: 'hello world'} ).then( function() {
-				bucket.update( '123', {title: 'goodbye world'} );
+				bucket.update( id, {title: 'goodbye world'} );
 			} );
 		} );
 
@@ -319,8 +320,9 @@ describe( 'Channel', function() {
 				} );
 			} );
 
-			store.put( '123', 3, {title: 'hello world'} ).then( function() {
-				bucket.update( '123', {title: 'goodbye world!!'} );
+			const id = '123';
+			store.put( id, 3, {title: 'hello world'} ).then( function() {
+				bucket.update( id, {title: 'goodbye world!!'} );
 			} );
 		} );