Merge pull request #1491 from maxmind/kevin/fetch

Use built-in fetch

Author: oschwald

CHANGELOG.md

@@ -1,9 +1,13 @@
 CHANGELOG
 =========
 
-7.1.0
+8.0.0
 -----------------
 
+* **Breaking** Internal webservice calls now use Node's built-in `fetch` instead of `http`.  This
+  will affect users who are on unsupported versions of Node, specifically Node 17 and below.
+* Two new error codes have been added: `NETWORK_TIMEOUT` and `FETCH_ERROR`, second of which is returned
+  when there's a `fetch` related error that could not be handled by other errors.
 * The minFraud Factors subscores have been deprecated. They will be removed
   in March 2025. Please see [our release notes](https://dev.maxmind.com/minfraud/release-notes/2024/#deprecation-of-risk-factor-scoressubscores)
   for more information.

README.md

@@ -151,6 +151,16 @@ returned by the web API, we also return:
   code: 'INVALID_RESPONSE_BODY',
   error: <string>
 }
+
+{
+  code: 'NETWORK_TIMEOUT',
+  error: <string>
+}
+
+{
+  code: 'FETCH_ERROR',
+  error: <string>
+}
 ```
 
 ## Example

package-lock.json

@@ -32,7 +32,7 @@
     "gh-pages": "^6.0.0",
     "globals": "^15.9.0",
     "jest": "^29.5.0",
-    "nock": "^13.0.2",
+    "nock": "^14.0.0-beta.16",
     "prettier": "^3.0.0",
     "ts-jest": "^29.1.0",
     "typedoc": "^0.26.3",

package.json

@@ -879,12 +879,33 @@ describe('WebServiceClient', () => {
   });
 
   describe('error handling', () => {
+    afterEach(() => {
+      nock.cleanAll();
+    });
+
     const transaction = new Transaction({
       device: new Device({
         ipAddress: '1.1.1.1',
       }),
     });
 
+    it('handles timeouts', () => {
+      const timeoutClient = new Client(auth.user, auth.pass, 10);
+      expect.assertions(1);
+
+      nockInstance
+        .post(fullPath('score'), score.request.basic)
+        .basicAuth(auth)
+        .delayConnection(100)
+        .reply(200, score.response.full);
+
+      return expect(timeoutClient.score(transaction)).rejects.toEqual({
+        code: 'NETWORK_TIMEOUT',
+        error: 'The request timed out',
+        url: baseUrl + fullPath('score'),
+      });
+    });
+
     it('handles 5xx level errors', () => {
       expect.assertions(1);
 
@@ -930,15 +951,12 @@ describe('WebServiceClient', () => {
       });
     });
 
-    it('handles general http.request errors', () => {
-      const error = {
-        code: 'FOO_ERR',
-        message: 'some foo error',
-      };
+    it('handles general fetch errors', () => {
+      const error = 'general error';
 
       const expected = {
-        code: error.code,
-        error: error.message,
+        code: 'FETCH_ERROR',
+        error: `Error - ${error}`,
         url: baseUrl + fullPath('score'),
       };