Merge pull request #37 from Relewise/feat/improve-error-handling

feat: improve error handling

Author: mzanoni

lib/src/relewise.client.ts

@@ -5,6 +5,28 @@ export interface RelewiseClientOptions {
     serverUrl?: string;
 }
 
+export class ProblemDetailsError extends Error {
+    private _details?: HttpProblemDetails;
+
+    public get details(): HttpProblemDetails | undefined {
+        return this._details;
+    }
+
+    constructor(message: string, details?: HttpProblemDetails) {
+        super(message);
+        this._details = details;
+    }
+}
+
+export interface HttpProblemDetails {
+    type: string;
+    title: string;
+    status: number;
+    traceId: string;
+    detail?: string;
+    errors?: Record<string, string>;
+}
+
 export abstract class RelewiseClient {
     private readonly _serverUrl: string = 'https://api.relewise.com';
     private readonly _urlPath: string = 'v1';
@@ -36,9 +58,18 @@ export abstract class RelewiseClient {
             body: JSON.stringify(data),
         });
 
+        if (!response.ok) {
+            let responseMessage = null;
+            try { responseMessage = await response.json(); } catch (_) { console.log(responseMessage)}
+
+            throw new ProblemDetailsError('Error when calling the Relewise API. Read more in the details property if there is error response or look in the network tab.', responseMessage);
+        }
+
         try {
-            return await response.json() as TResponse;
-        } catch(err) {
+            const responseMessage = await response.json();
+
+            return responseMessage as TResponse;
+        } catch (err) {
             return undefined;
         }
     }

lib/tests/integration-tests/tracker.integration.test.ts

@@ -1,4 +1,5 @@
-import { DataValueFactory, Tracker, UserFactory } from '../../src';
+import { error  } from 'console';
+import { DataValueFactory, ProblemDetailsError, Tracker, UserFactory } from '../../src';
 import { test, expect } from '@jest/globals'
 
 const { npm_config_API_KEY: API_KEY, npm_config_DATASET_ID: DATASET_ID, npm_config_SERVER_URL: SERVER_URL } = process.env;
@@ -19,10 +20,10 @@ test('Track Order', async() => {
                 productId: '2',
                 quantity: 1,
                 variantId: 'v1',
-            }        ],
+            }],
         subtotal: {
             amount: 100,
-            currency: 'DKK', 
+            currency: 'DKK',
         },
         orderNumber: '',
         trackingNumber: '',
@@ -50,7 +51,7 @@ test('Track Cart', async() => {
         ],
         subtotal: {
             amount: 100,
-            currency: 'DKK', 
+            currency: 'DKK',
         },
         user: UserFactory.anonymous(),
         data: { 'basketId': DataValueFactory.string('basketid') },
@@ -149,15 +150,49 @@ test('Track Search Term', async() => {
 });
 
 test('Track User Update', async() => {
-    const user = UserFactory.byTemporaryId('tempId', { 
-        email: 'integrationtests@relewise.com', 
+    const user = UserFactory.byTemporaryId('tempId', {
+        email: 'integrationtests@relewise.com',
         identifiers: {
             'emailIntegrationId': 'abc',
-        }});
+        },
+    });
 
     const result = await tracker.trackUserUpdate({
         user: user,
     });
 
     expect(result).toBeUndefined();
+});
+
+test('Track Product View with invalid key', async() => {
+
+    await new Tracker(DATASET_ID!, '12').trackProductView({
+        productId: '2',
+        user: UserFactory.anonymous(),
+    }).catch((e) => {
+        expect(e).toBeDefined();
+        expect((e as ProblemDetailsError).details?.title).toEqual('Unauthorized');
+        expect(e.message).toEqual('Error when calling the Relewise API. Read more in the details property if there is error response or look in the network tab.')
+    });
+});
+
+test('Track Product View without id', async() => {
+    await expect(async() => {
+        return await tracker.trackProductView({
+            productId: null,
+            user: UserFactory.anonymous(),
+        } as any)
+    }).rejects.toThrow();
+});
+
+test('Track Product View without id', async() => {
+    try {
+        await tracker.trackProductView({
+            productId: null,
+            user: UserFactory.anonymous(),
+        } as any);
+    }
+    catch (e) {
+        expect(e).toBeDefined();
+    }
 });