bigtable: tests & docs

Author: stephenplusplus

packages/bigtable/src/table.js

@@ -683,30 +683,21 @@ Table.prototype.getRows = function(options, callback) {
  *     See {module:bigtable/table#mutate}.
  * @param {function} callback - The callback function.
  * @param {?error} callback.err - An error returned while making this request.
- * @param {object[]} callback.insertErrors - A status object for each failed
- *     insert.
+ * @param {object[]} callback.err.errors - If present, these represent partial
+ *     failures. It's possible for part of your request to be completed
+ *     successfully, while the other part was not.
  *
  * @example
- * var callback = function(err, insertErrors) {
+ * var callback = function(err) {
  *   if (err) {
- *     // Error handling omitted.
- *   }
+ *     // An API error or partial failure occurred.
  *
- *   // insertErrors = [
- *   //   {
- *   //     code: 500,
- *   //     message: 'Internal Server Error',
- *   //     entry: {
- *   //       key: 'gwashington',
- *   //       data: {
- *   //         follows: {
- *   //           jadams: 1
- *   //         }
- *   //       }
- *   //     }
- *   //   },
- *   //   ...
- *   // ]
+ *     if (err.name === 'PartialFailureError') {
+ *       // err.errors[].code = 'Response code'
+ *       // err.errors[].message = 'Error message'
+ *       // err.errors[].entry = The original entry
+ *     }
+ *   }
  * };
  *
  * var entries = [
@@ -769,8 +760,9 @@ Table.prototype.insert = function(entries, callback) {
  *     deleted.
  * @param {function} callback - The callback function.
  * @param {?error} callback.err - An error returned while making this request.
- * @param {object[]} callback.mutationErrors - A status object for each failed
- *     mutation.
+ * @param {object[]} callback.err.errors - If present, these represent partial
+ *     failures. It's possible for part of your request to be completed
+ *     successfully, while the other part was not.
  *
  * @example
  * //-

packages/bigtable/system-test/bigtable.js

@@ -405,11 +405,7 @@ describe('Bigtable', function() {
           }
         }];
 
-        TABLE.insert(rows, function(err, insertErrors) {
-          assert.ifError(err);
-          assert.strictEqual(insertErrors.length, 0);
-          done();
-        });
+        TABLE.insert(rows, done);
       });
 
       it('should create an individual row', function(done) {

packages/bigtable/test/table.js

@@ -976,13 +976,20 @@ describe('Bigtable/Table', function() {
           };
         });
 
-        it('should populate the mutationErrors array', function(done) {
+        it('should return a PartialFailureError', function(done) {
           table.mutate(entries, function(err, mutationErrors) {
-            assert.ifError(err);
-            assert.strictEqual(mutationErrors[0], parsedStatuses[0]);
-            assert.strictEqual(mutationErrors[0].entry, entries[0]);
-            assert.strictEqual(mutationErrors[1], parsedStatuses[1]);
-            assert.strictEqual(mutationErrors[1].entry, entries[1]);
+            assert.strictEqual(err.name, 'PartialFailureError');
+
+            assert.deepEqual(err.errors, [
+              extend({
+                entry: entries[0]
+              }, parsedStatuses[0]),
+
+              extend({
+                entry: entries[1]
+              }, parsedStatuses[1])
+            ]);
+
             done();
           });
         });
@@ -1039,14 +1046,6 @@ describe('Bigtable/Table', function() {
         };
       });
 
-      it('should return an empty array to the callback', function(done) {
-        table.mutate(entries, function(err, mutateErrors) {
-          assert.ifError(err);
-          assert.strictEqual(mutateErrors.length, 0);
-          done();
-        });
-      });
-
       it('should emit the appropriate stream events', function(done) {
         var emitter = table.mutate(entries);