@superhero/http-request 4.0.9 → 4.1.0

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Erik Landvall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -95,11 +95,12 @@ console.log(response.body)
 
 Errors are thrown with specific error codes for easier handling:
 
-- `E_HTTP_REQUEST_CLIENT_ERROR`
-- `E_HTTP_REQUEST_CLIENT_TIMEOUT`
-- `E_HTTP_REQUEST_DOWNSTREAM_ERROR`
-- `E_HTTP_REQUEST_INVALID_RESPONSE_BODY_FORMAT`
-- `E_HTTP_REQUEST_INVALID_RESPONSE_STATUS`
+- `E_HTTP_REQUEST_FAILED`
+  - `E_HTTP_REQUEST_CLIENT_ERROR`
+  - `E_HTTP_REQUEST_CLIENT_TIMEOUT`
+  - `E_HTTP_REQUEST_DOWNSTREAM_ERROR`
+  - `E_HTTP_REQUEST_INVALID_RESPONSE_BODY_FORMAT`
+  - `E_HTTP_REQUEST_INVALID_RESPONSE_STATUS`
 
 Example:
 
@@ -334,10 +335,10 @@ pass 42
 ----------------------------------------------------------------------------------------
 file            | line % | branch % | funcs % | uncovered lines
 ----------------------------------------------------------------------------------------
-index.js        |  94.05 |    91.74 |   92.86 | 496-505 533-535 671-677 702-705 735-755
+index.js        |  89.56 |    87.39 |   86.67 | 100-104 137-139 150-153 353-357 361-365
 index.test.js   | 100.00 |    97.67 |  100.00 | 
 ----------------------------------------------------------------------------------------
-all files       |  96.57 |    94.36 |   97.17 | 
+all files       |  93.73 |    91.71 |   94.50 |
 ----------------------------------------------------------------------------------------
 ```
 

package/index.js

@@ -275,7 +275,7 @@ export default class Request
    * @throws {Error} E_HTTP_REQUEST_RETRY_HTTP2_RECONNECT
    * @throws {Error} E_HTTP_REQUEST_RETRY_ERROR
    */
-  #fetch(method, options)
+  async #fetch(method, options)
   {
     if(typeof options === 'string')
     {
@@ -300,9 +300,19 @@ export default class Request
       retryOnStatus : []
     }, this.config, options)
 
-    return options.retry
-    ? this.#resolveRetryLoop(options)
-    : this.#resolve(options)
+    try
+    {
+      return options.retry
+      ? await this.#resolveRetryLoop(options)
+      : await this.#resolve(options)
+    }
+    catch(reason)
+    {
+      const error = new Error(`Failed request ${method} ${options.url}`)
+      error.code  = 'E_HTTP_REQUEST_FAILED'
+      error.cause = reason
+      throw error
+    }
   }
 
   /**
@@ -463,9 +473,9 @@ export default class Request
    */
   async #resolveRetryLoop(options)
   {
-    const errorTrace = []
+    const reasons = []
 
-    let retry = Math.abs(Math.floor(options.retry)) + 1
+    let retry = Math.abs(Math.floor(options.retry))
 
     while(retry--)
     {
@@ -485,30 +495,32 @@ export default class Request
           return response
         }
       }
-      catch(error)
+      catch(reason)
       {
-        if(retry === 0)
+        if(retry <= 0)
         {
-          throw error
+          reasons.push(reason)
         }
         else
         {
-          await this.#resolveRetryLoopError(options, errorTrace, error)
+          await this.#resolveRetryLoopError(options, reasons, reason)
           await wait(options.retryDelay)
         }
       }
     }
 
-    if(errorTrace.every((error) => error.code === errorTrace[0].code))
+    const 
+      uniqueReasons = reasons.filter((reason, i) => [i, -1].includes(reasons.lastIndexOf(({ code }) => code === reason.code))),
+      reason        = uniqueReasons.pop()
+
+    if(uniqueReasons.length === 1)
     {
-      throw errorTrace.pop()
+      throw reason
     }
     else
     {
-      const error = new Error('Multiple types of errors occurred during the retry loop')
-      error.code  = 'E_HTTP_REQUEST_RETRY_ERROR'
-      error.cause = errorTrace
-      throw error
+      reason.previous = uniqueReasons
+      throw reason
     }
   }
 
@@ -516,18 +528,18 @@ export default class Request
    * Resolves the error in the retry loop.
    * 
    * @param {RequestOptions}  options
-   * @param {Error[]}         errorTrace
-   * @param {Error}           error
+   * @param {Error[]}         reasons
+   * @param {Error}           reason
    * 
    * @returns {Void}
    */
-  async #resolveRetryLoopError(options, errorTrace, error)
+  async #resolveRetryLoopError(options, reasons, reason)
   {
-    switch(error.code)
+    switch(reason.code)
     {
       case 'E_HTTP_REQUEST_CLIENT_ERROR':
       {
-        return errorTrace.push(error)
+        return reasons.push(reason)
       }
       case 'E_HTTP_REQUEST_HTTP2_SESSION_DESTROYED':
       case 'E_HTTP_REQUEST_HTTP2_SESSION_CLOSED':
@@ -535,67 +547,68 @@ export default class Request
         try
         {
           await this.reconnect()
+          return reasons.push(reason)
         }
         catch(reason)
         {
-          const reconnectError = new Error(`${reason.message}, retry to reconnect to the server failed`)
-          reconnectError.code  = 'E_HTTP_REQUEST_RETRY_HTTP2_RECONNECT'
-          reconnectError.cause = reason
+          const error   = new Error(`${reason.message}, retry to reconnect to the server failed`)
+          error.code    = 'E_HTTP_REQUEST_RETRY_HTTP2_RECONNECT'
+          error.cause   = reason
+          error.reasons = reasons
           throw reason
         }
-        return errorTrace.push(error)
       }
       case 'E_HTTP_REQUEST_CLIENT_TIMEOUT':
       {
         if(options.retryOnClientTimeout)
         {
-          return errorTrace.push(error)
+          return reasons.push(reason)
         }
         else
         {
-          throw error
+          throw reason
         }
       }
       case 'E_HTTP_REQUEST_DOWNSTREAM_ERROR':
       {
         if(options.retryOnDownstreamError)
         {
-          return errorTrace.push(error)
+          return reasons.push(reason)
         }
         else
         {
-          throw error
+          throw reason
         }
       }
       case 'E_HTTP_REQUEST_INVALID_RESPONSE_BODY_FORMAT':
       {
         if(options.retryOnInvalidResponseBodyFormat)
         {
-          return errorTrace.push(error)
+          return reasons.push(reason)
         }
         else
         {
-          throw error
+          throw reason
         }
       }
       case 'E_HTTP_REQUEST_INVALID_RESPONSE_STATUS':
       {
         if(options.retryOnErrorResponseStatus)
         {
-          return errorTrace.push(error)
+          return reasons.push(reason)
         }
-        else if(options.retryOnStatus.includes(error.response.status))
+        else if(options.retryOnStatus.includes(reason.response.status))
         {
-          return errorTrace.push(error)
+          return reasons.push(reason)
         }
         else
         {
-          throw error
+          throw reason
         }
       }
       default:
       {
-        throw error
+        throw reason
       }
     }
   }
@@ -603,8 +616,8 @@ export default class Request
   #createBodyHeaderDelimiter(body, isStreamed)
   {
     return isStreamed
-    ? { 'transfer-encoding': 'chunked' }
-    : { 'content-length' : body.length }
+    ? { 'transfer-encoding' : 'chunked' }
+    : { 'content-length'    : body?.length || 0 }
   }
 
   /**

package/index.test.js

@@ -199,10 +199,10 @@ suite('@superhero/http-request', () =>
         }
         await assert.rejects(
           request.get(options),
-          (error) => error.code === 'E_HTTP_REQUEST_CLIENT_TIMEOUT',
+          (error) => error.cause.code === 'E_HTTP_REQUEST_CLIENT_TIMEOUT',
           'Should throw a timeout error')
       })
-  
+
       test('Rejects invalid JSON response accurately', async () => 
       {
         // Alter the server to respond with invalid JSON
@@ -216,7 +216,7 @@ suite('@superhero/http-request', () =>
         // Make the request
         await assert.rejects(
           request.get({ url: '/invalid-json' }),
-          (error) => error.code === 'E_HTTP_REQUEST_INVALID_RESPONSE_BODY_FORMAT',
+          (error) => error.cause.code === 'E_HTTP_REQUEST_INVALID_RESPONSE_BODY_FORMAT',
           'Should throw a parse error')
       })
 
@@ -376,14 +376,14 @@ suite('@superhero/http-request', () =>
           const options =
           {
             url           : '/retry-on-status',
-            retry         : 2, 
+            retry         : 2,
             retryDelay    : 100, 
             retryOnStatus : [ 503 ]
           }
   
           await assert.rejects(
             request.get(options),
-            (error) => error.code === 'E_HTTP_REQUEST_INVALID_RESPONSE_STATUS',
+            (error) => error.cause.code === 'E_HTTP_REQUEST_INVALID_RESPONSE_STATUS',
             'Should throw an error after the second attempt')
   
           assert.equal(attempt, 2, 'Should make exactly 2 attempts')
@@ -401,7 +401,7 @@ suite('@superhero/http-request', () =>
   
           await assert.rejects(
             request.get(options),
-            (error) => error.code === 'E_HTTP_REQUEST_INVALID_RESPONSE_STATUS',
+            (error) => error.cause.code === 'E_HTTP_REQUEST_INVALID_RESPONSE_STATUS',
             'Should throw an error right away')
   
           assert.equal(attempt, 1, 'Should make exactly 1 attempt')
@@ -547,7 +547,7 @@ suite('@superhero/http-request', () =>
 
         await assert.rejects(
           request.get({ url: '/timeout-test', timeout: 100 }),
-          (error) => error.code === 'E_HTTP_REQUEST_CLIENT_TIMEOUT',
+          (error) => error.cause.code === 'E_HTTP_REQUEST_CLIENT_TIMEOUT',
           'Should throw a timeout error')
       })
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superhero/http-request",
-  "version": "4.0.9",
+  "version": "4.1.0",
   "description": "HTTP(S) request component supporting HTTP 1.1 and HTTP 2.0",
   "keywords": [
     "http request",