Pass id and data as regular function arguments, updateInfo as an object.

Author: roundhill

src/simperium/bucket.js

@@ -150,7 +150,7 @@ 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, original, patch, isIndexing ) => {
-		this.update( { id, data, original, patch, isIndexing }, { sync: false } );
+		this.update( id, data, { original, patch, isIndexing }, { sync: false } );
 	};
 
 	this.onChannelIndexingStateChange = ( isIndexing ) => {
@@ -232,20 +232,21 @@ Bucket.prototype.get = function( id, callback ) {
 /**
  * Update the bucket object of `id` with the given data.
  *
- * @param {Object} args - the function arguments
- * @param {String} [args.id] - the bucket id for the object to update
- * @param {Object} [args.data] - object literal to replace the object data with
- * @param {Object} [args.original] - the original object before the udpate
- * @param {Object} [args.patch] - the JSONDiff patch to apply to the object
- * @param {Boolean} [args.isIndexing] - true if the bucket is currently indexing
+ * @param {String} id - the bucket id for the object to update
+ * @param {Object} data - object literal to replace the object data with
+  * @param {Object} updateInfo - 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, original, patch, isIndexing = false }, options, callback ) {
-	if ( typeof options === 'function' ) {
-		callback = options;
+Bucket.prototype.update = function( id, data, updateInfo, options, callback ) {
+	// Callback could be 3rd or 4th argument
+	if ( typeof updateInfo === 'function' || typeof options === 'function' ) {
+		callback = typeof updateInfo === 'function' ? updateInfo : options;
 		options = { sync: true };
 	}
 
@@ -255,7 +256,7 @@ Bucket.prototype.update = function( { id, data, original, patch, isIndexing = fa
 
 	const task = this.storeAPI.update( id, data, this.isIndexing )
 		.then( bucketObject => {
-			this.emit( 'update', id, bucketObject.data, original, patch, isIndexing );
+			this.emit( 'update', id, bucketObject.data, updateInfo );
 			this.channel.update( bucketObject, options.sync );
 			return bucketObject;
 		} );

test/simperium/bucket_test.js

@@ -39,7 +39,7 @@ describe( 'Bucket', () => {
 		const id = 'thing',
 			data = {one: 'two'};
 
-		bucket.update( { id, data }, function() {
+		bucket.update( id, data, function() {
 			bucket.get( id, function( err, savedObject ) {
 				deepEqual( data, savedObject );
 				done();
@@ -51,7 +51,7 @@ describe( 'Bucket', () => {
 		const id = 'thing',
 			data = {one: 'two'}
 
-		bucket.update( { id, data }, function() {
+		bucket.update( id, data, function() {
 			bucket.get( id, function( err, savedObject ) {
 				deepEqual( data, savedObject );
 				done();

test/simperium/channel_test.js

@@ -108,8 +108,7 @@ describe( 'Channel', function() {
 				done();
 			} );
 
-			const updateArgs = {id: '12345', data: {content: 'Hola mundo!'}}
-			bucket.update( updateArgs );
+			bucket.update( '12345', {content: 'Hola mundo!'});
 		} );
 
 		it( 'should not send a change with an empty diff', function( done ) {
@@ -122,7 +121,7 @@ describe( 'Channel', function() {
 					channel.once( 'unmodified', function() {
 						done();
 					} );
-					bucket.update( {id: 'thing', data} );
+					bucket.update( 'thing', data );
 				} );
 		} );
 
@@ -137,16 +136,16 @@ describe( 'Channel', function() {
 			channel.on( 'send', fn.counts( 1, checkSent ) );
 
 			channel.on( 'send', function() {
-				bucket.update( { id, data: data2 } );
+				bucket.update( id, data2 );
 			} )
 
+			const objectId = '123456';
 			channel.localQueue.on( 'wait', function( id ) {
 				equal( id, objectId );
 				done();
 			} );
 
-			const objectId = '123456';
-			bucket.update( {id: objectId, data} );
+			bucket.update( objectId, data );
 		} );
 
 		it( 'should acknowledge sent change', function( done ) {
@@ -161,7 +160,7 @@ describe( 'Channel', function() {
 				acknowledge( channel, msg );
 			} );
 
-			bucket.update( { id: 'mock-id', data } );
+			bucket.update( 'mock-id', data );
 		} );
 
 		it( 'should ignore duplicate change error if nothing to acknowledge', ( done ) => {
@@ -228,12 +227,12 @@ describe( 'Channel', function() {
 
 			const id = '123';
 			channel.once( 'send', function() {
-				bucket.update( {id, data: {title: 'hello again world'}} );
+				bucket.update( id, {title: 'hello again world'} );
 				bucket.remove( id );
 			} );
 
 			store.put( '123', 3, {title: 'hello world'} ).then( function() {
-				bucket.update( {id, data: {title: 'goodbye world'}} );
+				bucket.update( id, {title: 'goodbye world'} );
 			} );
 		} );
 
@@ -268,7 +267,7 @@ describe( 'Channel', function() {
 				}, reject );
 			} );
 
-			bucket.update( {id: key, data: {title: 'hello world'}}, function() {
+			bucket.update( key, {title: 'hello world'}, function() {
 				channel.handleMessage( 'c:' + JSON.stringify( [{
 					o: '-', ev: 1, cv: 'cv1', id: key
 				}] ) );
@@ -323,7 +322,7 @@ describe( 'Channel', function() {
 
 			const id = '123';
 			store.put( id, 3, {title: 'hello world'} ).then( function() {
-				bucket.update( {id, data: {title: 'goodbye world!!'}} );
+				bucket.update( id, {title: 'goodbye world!!'} );
 			} );
 		} );
 
@@ -355,7 +354,7 @@ describe( 'Channel', function() {
 			}] ) );
 
 			// We're changing "Hello world" to "Goodbye world"
-			bucket.update( {id: key, data: {title: 'Goodbye world'}} );
+			bucket.update( key, {title: 'Goodbye world'} );
 		} ) );
 
 		it( 'should emit errors on the bucket instance', ( done ) => {
@@ -429,7 +428,7 @@ describe( 'Channel', function() {
 					acknowledge( channel, msg );
 				} );
 
-				bucket.update( {id: 'mock-id', data} );
+				bucket.update( 'mock-id', data );
 			} );
 
 			it( 'should get version', ( done ) => {

test/simperium/default_storage_test.js

@@ -14,7 +14,7 @@ describe( 'default store', () => {
 		const id = 'thing',
 			data = {one: 'two'};
 
-		return bucket.update( {id, data} )
+		return bucket.update( id, data )
 			.then( () => bucket.get( id ) )
 			.then( ( object ) => {
 				deepEqual( object, { data, id } );
@@ -25,7 +25,7 @@ describe( 'default store', () => {
 		const id = 'thing',
 			data = {one: 'two'}
 
-		return bucket.update( {id, data} )
+		return bucket.update( id, data )
 			.then( () => bucket.get( id ) )
 			.then( ( object ) => {
 				deepEqual( object, { data, id } );