fix: throw more useful error if OAuthClientCredentialsApiClient fails to authenticate (#58)

Fixes #52

Author: bobbyg603

package-lock.json

@@ -1,12 +1,13 @@
 export function createFakeResponseBody(
     status: number,
     json: any = {},
+    ok = true,
     headers: any = []
 ) {
     return {
-        status: status,
+        status,
+        ok,
         json: async() => (json),
-        ok: true,
         headers: { get: () => headers }
     };
 }

spec/fakes/common/response.ts

@@ -18,13 +18,13 @@ describe('BugSplatApiClient', () => {
             expect(json.user).toEqual(email);
         });
 
-        it('should throw error for incorrect email and password', async () => {
-            try {
-                await client.login(email, 'password');
-                fail('login was supposed to throw!');
-            } catch (error: any) {
-                expect(error.message).toMatch(/Invalid email or password/);
-            }
+        describe('error', () => {
+            it('should throw error for incorrect email and password', async () => {
+                await expectAsync(client.login(email, 'password')).toBeRejectedWithError(
+                    Error,
+                    /Could not authenticate, check credentials and try again/
+                );
+            });
         });
     });
 });

src/common/client/bugsplat-api-client/bugsplat-api-client.e2e.ts

@@ -21,7 +21,7 @@ describe('BugSplatApiClient', () => {
         expectedStatus = 'success';
         expectedJson = { success: 'true' };
         fakeFormData = { append: appendSpy, toString: () => 'BugSplat rocks!' };
-        fakeSuccessReponseBody = createFakeResponseBody(expectedStatus, expectedJson, cookie);
+        fakeSuccessReponseBody = createFakeResponseBody(expectedStatus, expectedJson, true, cookie);
         client = createFakeBugSplatApiClient(
             Environment.Node,
             fakeSuccessReponseBody,
@@ -122,13 +122,12 @@ describe('BugSplatApiClient', () => {
 
         describe('error', () => {
             it('should throw if response status is 401', async () => {
-                try {
-                    (<any>client)._fetch.and.returnValue({ status: 401 });
-                    await client.login(email, password);
-                    fail('login was supposed to throw!');
-                } catch (error) {
-                    expect(error).toMatch(/Invalid email or password/);
-                }
+                (<any>client)._fetch.and.returnValue({ status: 401 });
+                
+                await expectAsync(client.login(email, password)).toBeRejectedWithError(
+                    Error,
+                    /Could not authenticate, check credentials and try again/
+                );
             });
         });
     });

src/common/client/bugsplat-api-client/bugsplat-api-client.spec.ts

@@ -67,7 +67,7 @@ export class BugSplatApiClient implements ApiClient {
         });
 
         if (response.status === 401) {
-            throw new Error('Invalid email or password');
+            throw new Error('Could not authenticate, check credentials and try again');
         }
 
         if (this._environment === Environment.Node) {

src/common/client/bugsplat-api-client/bugsplat-api-client.ts

@@ -25,6 +25,17 @@ describe('OAuthClientCredentialsClient', () => {
             expect(json.access_token).toBeDefined();
             expect(json.token_type).toBeDefined();
         });
+
+        describe('error', () => {
+            it('should throw error for incorrect email and password', async () => {
+                const client = new OAuthClientCredentialsClient('BugSplat', 'rocks');
+                
+                await expectAsync(client.login()).toBeRejectedWithError(
+                    Error,
+                    /Could not authenticate, check credentials and try again/
+                );
+            });
+        });
     });
 
     describe('fetch', () => {

src/common/client/oauth-client-credentials-api-client/oauth-client-credentials-api-client.e2e.ts

@@ -68,6 +68,24 @@ describe('OAuthClientCredentialsClient', () => {
             expect(result.status).toEqual(fakeAuthorizeResponseBody.status);
             expect(json).toEqual(fakeAuthorizeResult);
         });
+
+        describe('error', () => {
+            it('should return useful error message when authenication fails', async () => {
+                const failureResponseBody = createFakeResponseBody(200, { error: 'invalid_client' });
+                sut = createFakeOAuthClientCredentialsClient(
+                    'blah',
+                    'blah',
+                    host,
+                    failureResponseBody,
+                    fakeFormData
+                );
+
+                await expectAsync(sut.login()).toBeRejectedWithError(
+                    Error,
+                    /Could not authenticate, check credentials and try again/
+                );
+            });
+        });
     });
 
     describe('fetch', () => {

src/common/client/oauth-client-credentials-api-client/oauth-client-credentials-api-client.spec.ts

@@ -44,10 +44,15 @@ export class OAuthClientCredentialsClient implements ApiClient {
 
         const response = await this.fetch(url, <RequestInit><unknown>request);
         const responseJson = await response.json();
+        const status = response.status;
+
+        if (responseJson.error === 'invalid_client') {
+            throw new Error('Could not authenticate, check credentials and try again');
+        }
+
         this._accessToken = responseJson.access_token;
         this._tokenType = responseJson.token_type;
-        
-        const status = response.status;
+
         const json = async () => responseJson;
         return {
             status,

src/common/client/oauth-client-credentials-api-client/oauth-client-credentials-api-client.ts

@@ -21,7 +21,7 @@ describe('CrashApiClient', () => {
 
         beforeEach(async () => {
             fakeCrashApiResponse = createFakeCrashApiResponse();
-            const fakeResponse = createFakeResponseBody(200, fakeCrashApiResponse, []);
+            const fakeResponse = createFakeResponseBody(200, fakeCrashApiResponse);
             fakeBugSplatApiClient = createFakeBugSplatApiClient(fakeFormData, fakeResponse);
             client = new CrashApiClient(fakeBugSplatApiClient);
 
@@ -58,7 +58,7 @@ describe('CrashApiClient', () => {
 
             try {
                 const fakeReprocessErrorBody = { message };
-                const fakeResponse = createFakeResponseBody(400, fakeReprocessErrorBody, []);
+                const fakeResponse = createFakeResponseBody(400, fakeReprocessErrorBody, false);
                 const fakeBugSplatApiClient = createFakeBugSplatApiClient(fakeFormData, fakeResponse);
                 const client = new CrashApiClient(fakeBugSplatApiClient);
 
@@ -96,7 +96,7 @@ describe('CrashApiClient', () => {
 
         beforeEach(async () => {
             fakeReprocessApiResponse = { success: true };
-            const fakeResponse = createFakeResponseBody(202, fakeReprocessApiResponse, []);
+            const fakeResponse = createFakeResponseBody(202, fakeReprocessApiResponse);
             fakeBugSplatApiClient = createFakeBugSplatApiClient(fakeFormData, fakeResponse);
             client = new CrashApiClient(fakeBugSplatApiClient);
 
@@ -132,7 +132,7 @@ describe('CrashApiClient', () => {
 
             try {
                 const fakeReprocessErrorBody = { message };
-                const fakeResponse = createFakeResponseBody(422, fakeReprocessErrorBody, []);
+                const fakeResponse = createFakeResponseBody(422, fakeReprocessErrorBody, false);
                 const fakeBugSplatApiClient = createFakeBugSplatApiClient(fakeFormData, fakeResponse);
                 const client = new CrashApiClient(fakeBugSplatApiClient);
 

src/crash/crash-api-client/crash-api-client.spec.ts

@@ -15,7 +15,7 @@ describe('CrashApiClient', () => {
     let result;
 
     beforeEach(() => {
-        const fakeResponse = createFakeResponseBody(200, fakeEventsApiResponse, []);
+        const fakeResponse = createFakeResponseBody(200, fakeEventsApiResponse);
         fakeEvents = createFakeEvents();
         fakeFormData = createFakeFormData();
         fakeBugSplatApiClient = createFakeBugSplatApiClient(fakeFormData, fakeResponse);