Merge branch 'dh-accept_error_handler_for_api_entity_service' into 'develop'

Accept error handler for ApiEntityService

See merge request amalgama/packages/npm/api-entity-service!15

Author: maurobender

src/errorHandlers/NullErrorHandler.ts

@@ -0,0 +1,6 @@
+export default class NullErrorHandler {
+	// eslint-disable-next-line class-methods-use-this
+	handleError( error: unknown ) {
+		throw error;
+	}
+}

src/service/ApiEntityService.ts

@@ -1,9 +1,12 @@
-import { IEntityCreator, IResponseParser, ParsedResponse } from '../types';
+import {
+	IEntityCreator, IErrorHandler, IResponseParser, ParsedResponse
+} from '../types';
 import {
 	IApi, Attributes, Params, HTTPMethod, InitParameters,
 	RequestWithBodyConfig, RequestParameters,
 	MakeRequestParameters, EntityID, EntityResponse, SingleEntityResponse, MultiEntityResponse
 } from './ApiEntityService.types';
+import NullErrorHandler from '../errorHandlers/NullErrorHandler';
 import {
 	addParamsToURL, headersForRequest, serializeRequestDataForContentType,
 	requestHasBody
@@ -15,15 +18,17 @@ export default class ApiEntityService<T> {
 	readonly parser: IResponseParser;
 	readonly creator: IEntityCreator;
 	readonly paths: { [ key: string ]: string };
+	readonly errorHandler: IErrorHandler;
 
 	constructor( {
-		api, basePath, parser, creator, paths = {}
+		api, basePath, parser, creator, paths = {}, errorHandler = new NullErrorHandler()
 	}: InitParameters ) {
 		this.api = api;
 		this.basePath = basePath;
 		this.parser = parser;
 		this.creator = creator;
 		this.paths = paths;
+		this.errorHandler = errorHandler;
 	}
 
 	create(
@@ -89,15 +94,20 @@ export default class ApiEntityService<T> {
 		params,
 		config
 	}: RequestParameters ): Promise<EntityResponse<T> | null> {
-		const response = await this
-			.makeRequest( {
-				method, url, attributes, params, includesFiles: config.includesFiles || false
-			} );
-
-		const { data } = response;
-		const parsedResponse = this.parseResponse( data );
-
-		return this.createEntities( parsedResponse );
+		try {
+			const response = await this
+				.makeRequest( {
+					method, url, attributes, params, includesFiles: config.includesFiles || false
+				} );
+
+			const { data } = response;
+			const parsedResponse = this.parseResponse( data );
+
+			return this.createEntities( parsedResponse );
+		} catch ( error ) {
+			this.errorHandler.handleError( error );
+			return null;
+		}
 	}
 
 	private makeRequest = ( {

src/service/ApiEntityService.types.ts

@@ -1,4 +1,4 @@
-import { IEntityCreator, IResponseParser } from '../types';
+import { IEntityCreator, IErrorHandler, IResponseParser } from '../types';
 
 export type Attributes = {
 	[ key: string ]: unknown
@@ -64,7 +64,8 @@ export interface InitParameters {
 	basePath: string,
 	parser: IResponseParser,
 	creator: IEntityCreator,
-	paths: { [ key: string ]: string }
+	paths: { [ key: string ]: string },
+	errorHandler: IErrorHandler
 }
 
 export type RequestWithBodyConfig = {

src/types.ts

@@ -23,3 +23,7 @@ export interface IResponseParser {
 export interface IEntityCreator {
 	create<T>( parsedResponse: ParsedResponse ): ( null | T | T[] )
 }
+
+export interface IErrorHandler {
+	handleError( error: unknown ): unknown
+}

tests/errorHandlers/NullErrorHandler.test.js

@@ -0,0 +1,12 @@
+import NullErrorHandler from '../../src/errorHandlers/NullErrorHandler';
+
+describe( 'NullErrorHandler', () => {
+	describe( '@handleError', () => {
+		it( 'throws the given error', () => {
+			const errorHandler = new NullErrorHandler();
+			const error = new Error( 'Something went wrong' );
+
+			expect( () => errorHandler.handleError( error ) ).toThrow( 'Something went wrong' );
+		} );
+	} );
+} );

tests/service/ApiEntityService.test.js

@@ -92,18 +92,24 @@ const creatorMock = {
 
 const basePath = '1/users';
 
+const errorHandlerMock = {
+	handleError: jest.fn()
+};
+
 describe( 'ApiEntityService', () => {
 	const createService = ( {
 		api = apiMock,
 		parser = parserMock,
 		creator = creatorMock,
-		paths = {}
+		paths = {},
+		errorHandler = errorHandlerMock
 	} = {} ) => new ApiEntityService( {
 		api,
 		basePath,
 		parser,
 		creator,
-		paths
+		paths,
+		errorHandler
 	} );
 
 	beforeEach( () => jest.clearAllMocks() );
@@ -129,7 +135,7 @@ describe( 'ApiEntityService', () => {
 
 		const hasResponse = !!response.data;
 
-		beforeEach( () => apiMock[ expectedApiMethod ].mockResolvedValueOnce( response ) );
+		beforeEach( () => apiMock[ expectedApiMethod ].mockResolvedValue( response ) );
 
 		if ( attributes ) {
 			it( 'calls the correct api method with the correct path, attributes and config', () => {
@@ -188,6 +194,18 @@ describe( 'ApiEntityService', () => {
 			} );
 		} );
 
+		describe( 'when the api throws an error', () => {
+			it( 'calls the error handlers handleError method with the error', async () => {
+				const error = new Error( 'Invalid entity' );
+				apiMock[ expectedApiMethod ].mockRejectedValue( error );
+				const service = createService();
+
+				await callService( service );
+
+				expect( errorHandlerMock.handleError ).toHaveBeenCalledWith( error );
+			} );
+		} );
+
 		if ( hasResponse ) {
 			it( 'calls the parser with the received response', async () => {
 				const service = createService();