feat(common): CHECKOUT-2749 Add common custom error types

Author: davidchin

src/core/checkout/checkout-service.js

@@ -1,3 +1,5 @@
+import { MissingDataError } from '../common/error/errors';
+
 export default class CheckoutService {
     /**
      * @constructor
@@ -142,7 +144,7 @@ export default class CheckoutService {
         const method = checkout.getPaymentMethod(payment.name, payment.gateway);
 
         if (!method) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         return this._paymentStrategyRegistry.getStrategyByMethod(method).execute(payload, options);
@@ -179,7 +181,7 @@ export default class CheckoutService {
         const method = checkout.getPaymentMethod(order.payment.id, order.payment.gateway);
 
         if (!method) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         return this._paymentStrategyRegistry.getStrategyByMethod(method).finalize(options);
@@ -217,7 +219,7 @@ export default class CheckoutService {
         const method = checkout.getPaymentMethod(methodId, gatewayId);
 
         if (!method) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         return this._paymentStrategyRegistry.getStrategyByMethod(method).initialize(options);
@@ -233,7 +235,7 @@ export default class CheckoutService {
         const method = checkout.getPaymentMethod(methodId, gatewayId);
 
         if (!method) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         return this._paymentStrategyRegistry.getStrategyByMethod(method).deinitialize();
@@ -376,7 +378,7 @@ export default class CheckoutService {
         const { checkout } = this._store.getState();
 
         if (!checkout.getConfig() || !checkout.getCustomer()) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         const { storeId } = checkout.getConfig();
@@ -395,7 +397,7 @@ export default class CheckoutService {
         const { checkout } = this._store.getState();
 
         if (!checkout.getConfig() || !checkout.getCustomer()) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         const { storeId } = checkout.getConfig();
@@ -414,7 +416,7 @@ export default class CheckoutService {
         const { checkout } = this._store.getState();
 
         if (!checkout.getConfig() || !checkout.getCustomer()) {
-            throw new Error('Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+            throw new MissingDataError();
         }
 
         const { storeId } = checkout.getConfig();

src/core/checkout/checkout-service.spec.js

@@ -11,6 +11,7 @@ import { PaymentMethodActionCreator } from '../payment';
 import { InstrumentActionCreator } from '../payment/instrument';
 import { QuoteActionCreator } from '../quote';
 import { ShippingAddressActionCreator, ShippingCountryActionCreator, ShippingOptionActionCreator } from '../shipping';
+import { MissingDataError } from '../common/error/errors';
 import { getBillingAddress, getBillingAddressResponseBody } from '../billing/billing-address.mock';
 import { getCartResponseBody } from '../cart/carts.mock';
 import { getCountriesResponseBody } from '../geography/countries.mock';
@@ -226,8 +227,8 @@ describe('CheckoutService', () => {
             expect(paymentStrategy.execute).toHaveBeenCalledWith(getOrderRequestBody(), options);
         });
 
-        it('throws error if payment method is not found or loaded', async () => {
-            expect(() => checkoutService.submitOrder(getOrderRequestBody())).toThrow();
+        it('throws error if payment method is not found or loaded', () => {
+            expect(() => checkoutService.submitOrder(getOrderRequestBody())).toThrow(MissingDataError);
         });
     });
 
@@ -370,7 +371,7 @@ describe('CheckoutService', () => {
         });
 
         it('throws error if payment method has not been loaded', () => {
-            expect(() => checkoutService.initializePaymentMethod('braintree')).toThrow();
+            expect(() => checkoutService.initializePaymentMethod('braintree')).toThrow(MissingDataError);
         });
     });
 
@@ -390,7 +391,7 @@ describe('CheckoutService', () => {
         });
 
         it('throws error if payment method has not been loaded', () => {
-            expect(() => checkoutService.deinitializePaymentMethod('braintree')).toThrow();
+            expect(() => checkoutService.deinitializePaymentMethod('braintree')).toThrow(MissingDataError);
         });
     });
 
@@ -543,7 +544,7 @@ describe('CheckoutService', () => {
         });
 
         it('throws error if customer data is missing', () => {
-            expect(() => checkoutService.loadInstruments()).toThrow();
+            expect(() => checkoutService.loadInstruments()).toThrow(MissingDataError);
         });
     });
 
@@ -564,7 +565,7 @@ describe('CheckoutService', () => {
         it('throws error if customer data is missing', () => {
             const instrument = vaultInstrumentRequestBody();
 
-            expect(() => checkoutService.vaultInstrument(instrument)).toThrow();
+            expect(() => checkoutService.vaultInstrument(instrument)).toThrow(MissingDataError);
         });
     });
 
@@ -583,7 +584,7 @@ describe('CheckoutService', () => {
         });
 
         it('throws error if customer data is missing', () => {
-            expect(() => checkoutService.deleteInstrument(456)).toThrow();
+            expect(() => checkoutService.deleteInstrument(456)).toThrow(MissingDataError);
         });
     });
 });

src/core/common/error/errors/index.js

@@ -0,0 +1,5 @@
+export { default as MissingDataError } from './missing-data-error';
+export { default as NotImplementedError } from './not-implemented-error';
+export { default as RequestError } from './request-error';
+export { default as StandardError } from './standard-error';
+export { default as UnrecoverableError } from './unrecoverable-error';

src/core/common/error/errors/missing-data-error.js

@@ -0,0 +1,13 @@
+import StandardError from './standard-error';
+
+export default class MissingDataError extends StandardError {
+    /**
+     * @constructor
+     * @param {string} [message]
+     */
+    constructor(message) {
+        super(message || 'Unable to call this method because the data required for the call is not available. Please refer to the documentation to see what you need to do in order to obtain the required data.');
+
+        this.type = 'missing_data';
+    }
+}

src/core/common/error/errors/not-implemented-error.js

@@ -0,0 +1,13 @@
+import StandardError from './standard-error';
+
+export default class NotImplementedError extends StandardError {
+    /**
+     * @constructor
+     * @param {string} [message]
+     */
+    constructor(message) {
+        super(message || 'Not implemented.');
+
+        this.type = 'not_implemented';
+    }
+}

src/core/common/error/errors/request-error.js

@@ -0,0 +1,33 @@
+import StandardError from './standard-error';
+
+export default class RequestError extends StandardError {
+    /**
+     * @constructor
+     * @param {Response} response
+     * @param {string} [message] - Fallback message
+     */
+    constructor({ body = {}, headers, status, statusText }, message) {
+        super(joinErrors(body.errors) || body.detail || body.title || message || 'An unexpected error has occurred.');
+
+        this.type = 'request';
+        this.body = body;
+        this.headers = headers;
+        this.status = status;
+        this.statusText = statusText;
+    }
+}
+
+/**
+ * @private
+ * @param {string[] | Array<{ code: string, message: string }>} errors
+ * @return {?string}
+ */
+function joinErrors(errors) {
+    if (!Array.isArray(errors)) {
+        return;
+    }
+
+    return errors.map(error =>
+        typeof error === 'object' ? error.message : error
+    ).join(' ');
+}

src/core/common/error/errors/request-error.spec.js

@@ -0,0 +1,64 @@
+import RequestError from './request-error';
+import { getErrorResponse, getErrorResponseBody } from '../../http-request/responses.mock';
+
+describe('RequestError', () => {
+    it('sets error type', () => {
+        const error = new RequestError(getErrorResponse());
+
+        expect(error.type).toEqual('request');
+    });
+
+    it('sets error message with errors contained in response', () => {
+        const response = getErrorResponse();
+        const error = new RequestError(response);
+
+        expect(error.message).toEqual(response.body.errors.join(' '));
+    });
+
+    it('sets error message with error objects contained in response', () => {
+        const response = getErrorResponse({
+            ...getErrorResponseBody(),
+            errors: [
+                { code: 'invalid_cvv', message: 'Invalid CVV.' },
+                { code: 'invalid_account', message: 'Invalid account.' },
+            ],
+        });
+        const error = new RequestError(response);
+
+        expect(error.message).toEqual('Invalid CVV. Invalid account.');
+    });
+
+    it('sets error message with detail contained in response', () => {
+        const response = getErrorResponse({
+            ...getErrorResponseBody(),
+            errors: null,
+        });
+        const error = new RequestError(response);
+
+        expect(error.message).toEqual(response.body.detail);
+    });
+
+    it('sets error message with title contained in response', () => {
+        const response = getErrorResponse({
+            ...getErrorResponseBody(),
+            detail: null,
+            errors: null,
+        });
+        const error = new RequestError(response);
+
+        expect(error.message).toEqual(response.body.title);
+    });
+
+    it('sets fallback error message if error message not contained in response', () => {
+        const message = 'Hello world';
+        const error = new RequestError(getErrorResponse({}), message);
+
+        expect(error.message).toEqual(message);
+    });
+
+    it('sets default error message if none is provided', () => {
+        const error = new RequestError({});
+
+        expect(error.message).toBeDefined();
+    });
+});

src/core/common/error/errors/standard-error.js

@@ -0,0 +1,17 @@
+export default class StandardError extends Error {
+    /**
+     * @constructor
+     * @param {string} [message]
+     */
+    constructor(message) {
+        super(message || 'An unexpected error has occurred.');
+
+        Object.setPrototypeOf(this, new.target.prototype);
+
+        if (typeof Error.captureStackTrace === 'function') {
+            Error.captureStackTrace(this, new.target);
+        } else {
+            this.stack = (new Error(this.message)).stack;
+        }
+    }
+}

src/core/common/error/errors/standard-error.spec.js

@@ -0,0 +1,18 @@
+import StandardError from './standard-error';
+
+describe('StandardError', () => {
+    it('omits error constructor in stack trace', () => {
+        try {
+            throw new StandardError();
+        } catch (error) {
+            expect(error.stack).not.toContain('StandardError');
+        }
+    });
+
+    it('sets error message if provided', () => {
+        const message = 'Hello world';
+        const error = new StandardError(message);
+
+        expect(error.message).toEqual(message);
+    });
+});

src/core/common/error/errors/unrecoverable-error.js

@@ -0,0 +1,14 @@
+import RequestError from './request-error';
+
+export default class UnrecoverableError extends RequestError {
+    /**
+     * @constructor
+     * @param {Response} response
+     * @param {string} [message]
+     */
+    constructor(response, message) {
+        super(response, message || 'An unexpected error has occurred. The checkout process cannot continue as a result.');
+
+        this.type = 'unrecoverable';
+    }
+}