Merge pull request #1783 from maxmind/kevin/http-status

Add http status code to WebServiceClientError

Author: mm-kevcenteno

CHANGELOG.md

@@ -23,6 +23,10 @@ CHANGELOG
     network_error, http_error, parked, pre_development).
   * `lastVisitedOn` - The date the automated visit was completed.
   * `hasRedirect` - Whether the domain redirects to another URL.
+* Added the `status` property to `WebServiceClientError`. This property
+  contains the HTTP status code when the error is the result of an HTTP
+  response error. Network errors (timeouts, fetch errors) will not have a
+  status code.
 
 8.1.0 (2025-05-23)
 ------------------

src/types.ts

@@ -1,5 +1,6 @@
 export interface WebServiceClientError {
   code: string;
   error: string;
+  status?: number;
   url: string;
 }

src/webServiceClient.spec.ts

@@ -939,6 +939,7 @@ describe('WebServiceClient', () => {
       return expect(client.score(transaction)).rejects.toEqual({
         code: 'SERVER_ERROR',
         error: 'Received a server error with HTTP status code: 500',
+        status: 500,
         url: baseUrl + fullPath('score'),
       });
     });
@@ -954,6 +955,7 @@ describe('WebServiceClient', () => {
       return expect(client.score(transaction)).rejects.toEqual({
         code: 'HTTP_STATUS_CODE_ERROR',
         error: 'Received an unexpected HTTP status code: 300',
+        status: 300,
         url: baseUrl + fullPath('score'),
       });
     });
@@ -969,6 +971,7 @@ describe('WebServiceClient', () => {
       return expect(client.score(transaction)).rejects.toEqual({
         code: 'INVALID_RESPONSE_BODY',
         error: 'Received an invalid or unparseable response body',
+        status: 401,
         url: baseUrl + fullPath('score'),
       });
     });
@@ -1013,6 +1016,7 @@ describe('WebServiceClient', () => {
       return expect(client.score(transaction)).rejects.toEqual({
         code,
         error,
+        status,
         url: baseUrl + fullPath('score'),
       });
     });

src/webServiceClient.ts

@@ -150,18 +150,22 @@ export default class WebServiceClient {
     response: Response,
     url: string
   ): Promise<WebServiceClientError> {
-    if (response.status && response.status >= 500 && response.status < 600) {
+    const status = response.status;
+
+    if (status && status >= 500 && status < 600) {
       return {
         code: 'SERVER_ERROR',
-        error: `Received a server error with HTTP status code: ${response.status}`,
+        error: `Received a server error with HTTP status code: ${status}`,
+        status,
         url,
       };
     }
 
-    if (response.status && (response.status < 400 || response.status >= 600)) {
+    if (status && (status < 400 || status >= 600)) {
       return {
         code: 'HTTP_STATUS_CODE_ERROR',
-        error: `Received an unexpected HTTP status code: ${response.status}`,
+        error: `Received an unexpected HTTP status code: ${status}`,
+        status,
         url,
       };
     }
@@ -171,12 +175,12 @@ export default class WebServiceClient {
       data = (await response.json()) as ResponseError;
 
       if (!data.code || !data.error) {
-        return { ...invalidResponseBody, url };
+        return { ...invalidResponseBody, status, url };
       }
     } catch {
-      return { ...invalidResponseBody, url };
+      return { ...invalidResponseBody, status, url };
     }
 
-    return { ...data, url } as WebServiceClientError;
+    return { ...data, status, url } as WebServiceClientError;
   }
 }