common: create PartialFailureError

packages/common/src/util.js

@@ -107,6 +107,30 @@ util.ApiError = function(errorBody) {
   return new ApiError(errorBody);
 };
 
+/**
+ * Custom error type for partial errors returned from the API.
+ *
+ * @param {object} b - Error object.
+ */
+var PartialFailureError = createErrorClass('PartialFailureError', function(b) {
+  var errorObject = b;
+
+  this.errors = errorObject.errors;
+  this.response = errorObject.response;
+
+  var defaultErrorMessage = 'A failure occurred during this request.';
+  this.message = errorObject.message || defaultErrorMessage;
+});
+
+/**
+ * Wrap the PartialFailureError constructor so context isn't lost.
+ *
+ * @param {object} errorBody - Error object.
+ */
+util.PartialFailureError = function(errorBody) {
+  return new PartialFailureError(errorBody);
+};
+
 /**
  * Uniformly process an API response.
  *

packages/common/test/util.js

@@ -249,6 +249,35 @@ describe('common/util', function() {
     });
   });
 
+  describe('PartialFailureError', function() {
+    it('should build correct PartialFailureError', function() {
+      var error = {
+        errors: [ new Error(), new Error() ],
+        response: { a: 'b', c: 'd' },
+        message: 'Partial failure occurred'
+      };
+
+      var partialFailureError = new util.PartialFailureError(error);
+
+      assert.strictEqual(partialFailureError.errors, error.errors);
+      assert.strictEqual(partialFailureError.response, error.response);
+      assert.strictEqual(partialFailureError.message, error.message);
+    });
+
+    it('should use default message', function() {
+      var expectedErrorMessage = 'A failure occurred during this request.';
+
+      var error = {
+        errors: [],
+        response: { a: 'b', c: 'd' }
+      };
+
+      var partialFailureError = new util.PartialFailureError(error);
+
+      assert.strictEqual(partialFailureError.message, expectedErrorMessage);
+    });
+  });
+
   describe('extendGlobalConfig', function() {
     it('should favor `keyFilename` when `credentials` is global', function() {
       var globalConfig = { credentials: {} };