feat: Retry "408: Request Timeout" by Default

README.md

@@ -132,7 +132,7 @@ interface GaxiosOptions = {
     httpMethodsToRetry?: string[];
 
     // The HTTP response status codes that will automatically be retried.
-    // Defaults to: [[100, 199], [429, 429], [500, 599]]
+    // Defaults to: [[100, 199], [408, 408], [429, 429], [500, 599]]
     statusCodesToRetry?: number[][];
 
     // Function to invoke when a retry attempt is made.

src/common.ts

@@ -119,15 +119,15 @@
 }
 
 export interface Headers {
   [index: string]: any;
 }
 export type GaxiosPromise<T = any> = Promise<GaxiosResponse<T>>;
 
 export interface GaxiosXMLHttpRequest {
   responseURL: string;
 }
 
 export interface GaxiosResponse<T = any> {
   config: GaxiosOptions;
   data: T;
   status: number;
@@ -149,7 +149,7 @@
    * Optional method to override making the actual HTTP request. Useful
    * for writing tests.
    */
   adapter?: <T = any>(
     options: GaxiosOptions,
     defaultAdapter: (options: GaxiosOptions) => GaxiosPromise<T>
   ) => GaxiosPromise<T>;
@@ -170,8 +170,8 @@
     | 'TRACE'
     | 'PATCH';
   headers?: Headers;
   data?: any;
   body?: any;
   /**
    * The maximum size of the http response content in bytes allowed.
    */
@@ -185,13 +185,13 @@
    * A collection of parts to send as a `Content-Type: multipart/related` request.
    */
   multipart?: GaxiosMultipartOptions[];
   params?: any;
   paramsSerializer?: (params: {[index: string]: string | number}) => string;
   timeout?: number;
   /**
    * @deprecated ignored
    */
   onUploadProgress?: (progressEvent: any) => void;
   responseType?:
     | 'arraybuffer'
     | 'blob'
@@ -205,7 +205,7 @@
   retry?: boolean;
   // Should be instance of https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
   // interface. Left as 'any' due to incompatibility between spec and abort-controller.
   signal?: any;
   size?: number;
   /**
    * Implementation of `fetch` to use when making the API call. By default,
@@ -272,7 +272,7 @@
  *
  * @experimental
  */
 export type RedactableGaxiosResponse<T = any> = Pick<
   GaxiosResponse<T>,
   'config' | 'data' | 'headers'
 >;
@@ -304,7 +304,7 @@
 
   /**
    * The HTTP response status codes that will automatically be retried.
-   * Defaults to: [[100, 199], [429, 429], [500, 599]]
+   * Defaults to: [[100, 199], [408, 408], [429, 429], [500, 599]]
    */
   statusCodesToRetry?: number[][];
 

src/retry.ts

@@ -42,9 +42,11 @@ export async function getRetryConfig(err: GaxiosError) {
     // 2xx - Do not retry (Success)
     // 3xx - Do not retry (Redirect)
     // 4xx - Do not retry (Client errors)
+    // 408 - Retry ("Request Timeout")
     // 429 - Retry ("Too Many Requests")
     // 5xx - Retry (Server errors)
     [100, 199],
+    [408, 408],
     [429, 429],
     [500, 599],
   ];

test/test.retry.ts

@@ -51,6 +51,7 @@ describe('🛸 retry & exponential backoff', () => {
       }
       const expectedStatusCodes = [
         [100, 199],
+        [408, 408],
         [429, 429],
         [500, 599],
       ];