Merge pull request #1 from Sideko-Inc/retries

Feature: Retries

Author: eliasposen

.prettierrc

@@ -1,8 +1,8 @@
 {
   "semi": true,
   "trailingComma": "es5",
-  "singleQuote": true,
+  "singleQuote": false,
   "printWidth": 80,
   "tabWidth": 2,
   "useTabs": false
-}
+}

CHANGELOG.md

@@ -5,7 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## v0.2.0
+
+### Added
+- `RetryStrategy` configuration as part of the `CoreClient` and `RequestOptions` (prioritized)
+- `RetryStrategy` used to automatically retry requests according to configuration
+
+### Changed
+n/a
+
+### Deprecated
+n/a
+
+### Removed
+n/a
+
+### Fixed
+n/a
+
+### Security
+n/a
+
+## v0.1.0
 
 ### Added
 - Initial release
@@ -19,11 +40,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Automated NPM publishing
 
 ### Changed
+n/a
 
 ### Deprecated
+n/a
 
 ### Removed
+n/a
 
 ### Fixed
+n/a
 
-### Security
+### Security
+n/a

README.md

@@ -1,6 +1,6 @@
 # make-api-request-js
 
-[![CI](https://github.com/sideko-inc/make-api-request-js/workflows/CI/badge.svg)](https://github.com/sideko-inc/make-api-request-js/actions)
+[![CI](https://github.com/sideko-inc/make-request-js/workflows/CI/badge.svg)](https://github.com/sideko-inc/make-request-js/actions)
 [![npm version](https://badge.fury.io/js/make-api-request-js.svg)](https://badge.fury.io/js/make-api-request-js)
 [![codecov](https://codecov.io/gh/sideko-inc/make-api-request-js/branch/main/graph/badge.svg)](https://codecov.io/gh/sideko-inc/make-api-request-js)
 

src/api-error.ts

@@ -1,5 +1,3 @@
-
-
 import type { RequestConfig } from "./core-client";
 
 export class ApiError extends Error {
@@ -8,7 +6,7 @@ export class ApiError extends Error {
 
   constructor(request: RequestConfig, response: Response) {
     super(
-      `${response.status} was returned from ${request.method} ${request.path}`,
+      `${response.status} was returned from ${request.method} ${request.path}`
     );
     this.request = request;
     this.response = response;

src/api-promise.ts

@@ -62,13 +62,13 @@ export class ApiPromise<T>
       default:
         return new BinaryResponse(
           await response.blob(),
-          contentType,
+          contentType
         ) as unknown as T;
     }
   }
 
   private async *handleNodeStream(
-    stream: NodeJS.ReadableStream,
+    stream: NodeJS.ReadableStream
   ): AsyncIterableIterator<T> {
     const { responseSchema } = this.responseProps;
     const parser = new EventSourceParser();
@@ -87,7 +87,7 @@ export class ApiPromise<T>
   }
 
   private async *handleWebStream(
-    stream: ReadableStream<Uint8Array>,
+    stream: ReadableStream<Uint8Array>
   ): AsyncIterableIterator<T> {
     const { responseSchema } = this.responseProps;
     const reader = stream.getReader();
@@ -177,7 +177,7 @@ export class ApiPromise<T>
     onrejected?:
       | ((reason: any) => Result2 | PromiseLike<Result2>)
       | undefined
-      | null,
+      | null
   ): Promise<Result1 | Result2> {
     if (this.responseProps.responseStream) {
       return Promise.resolve(this.asEventStream() as unknown as Result1);
@@ -189,7 +189,7 @@ export class ApiPromise<T>
     onrejected?:
       | ((reason: any) => Result | PromiseLike<Result>)
       | undefined
-      | null,
+      | null
   ): Promise<T | Result> {
     return this.parseResponse().catch(onrejected);
   }

src/auth.ts

@@ -71,7 +71,7 @@ export class AuthKey implements AuthProvider {
   constructor(
     name: string,
     location: "query" | "header" | "cookie",
-    key?: string,
+    key?: string
   ) {
     this.name = name;
     this.location = location;
@@ -176,7 +176,7 @@ export class OAuth2 implements AuthProvider {
   }
 
   async refresh(
-    form: OAuth2Password | OAuth2ClientCredentials,
+    form: OAuth2Password | OAuth2ClientCredentials
   ): Promise<{ accessToken: string; expiresAt: Date }> {
     const {
       baseUrl,
@@ -247,7 +247,7 @@ export class OAuth2 implements AuthProvider {
           body: reqData,
           contentType: reqHeaders["content-type"],
         },
-        tokenRes as any,
+        tokenRes as any
       );
     }
 
@@ -277,6 +277,8 @@ export class OAuth2 implements AuthProvider {
   }
 
   setValue(_val?: string | undefined): void {
-    throw new Error("an OAuth2 auth provider cannot be used as a requestMutator");
+    throw new Error(
+      "an OAuth2 auth provider cannot be used as a requestMutator"
+    );
   }
 }

src/binary-response.ts

@@ -1,5 +1,3 @@
-
-
 import type { Blob as NodeBlob } from "node-fetch";
 
 export class BinaryResponse {

src/core-client.ts

@@ -14,11 +14,13 @@ import {
   MULTIPART_FORM,
   URL_FORM,
 } from "./content-type";
+import { RetryStrategy, RetryConfig, sleep } from "./retry";
 
 export interface CoreClientProps {
   baseUrl: string | Record<string, string | undefined>;
   timeout?: number | undefined;
   auths?: Record<string, AuthProvider>;
+  retries?: RetryStrategy;
 }
 
 export type ApiResponse = Response | NodeResponse;
@@ -48,6 +50,7 @@ export interface RequestOptions {
   timeout?: number;
   additionalHeaders?: Record<string, string>;
   additionalQuery?: Record<string, string>;
+  retries?: RetryStrategy;
 }
 
 const _DEFAULT_SERVICE_NAME = "__default_service__";
@@ -56,6 +59,7 @@ export class CoreClient {
   private baseUrl: Record<string, string | undefined>;
   private auths: Record<string, AuthProvider>;
   private timeout: number | undefined;
+  private retries?: RetryStrategy | undefined;
 
   constructor(props: CoreClientProps) {
     this.baseUrl =
@@ -64,6 +68,7 @@ export class CoreClient {
         : props.baseUrl;
     this.auths = props.auths ?? {};
     this.timeout = props.timeout;
+    this.retries = props.retries;
   }
 
   private async applyAuths(cfg: RequestConfig): Promise<RequestConfig> {
@@ -116,7 +121,7 @@ export class CoreClient {
 
   private encodeBodyByContentType(
     cfg: RequestConfig,
-    reqInit: RequestInit,
+    reqInit: RequestInit
   ): RequestInit {
     const contentTypeOverride =
       cfg.opts?.additionalHeaders?.["content-type"] ??
@@ -136,9 +141,8 @@ export class CoreClient {
 
       if (RUNTIME.type === "node") {
         // explicitly set boundary
-        headers[
-          "content-type"
-        ] = `${MULTIPART_FORM}; boundary=${form.getBoundary()}`;
+        headers["content-type"] =
+          `${MULTIPART_FORM}; boundary=${form.getBoundary()}`;
       } else {
         // the browser should automatically set the content type
         delete headers["content-type"];
@@ -149,7 +153,7 @@ export class CoreClient {
     } else if (contentType === URL_FORM) {
       if (typeof cfg.body !== "object") {
         throw new TypeError(
-          "x-www-form-urlencoded data must be an object at the top level",
+          "x-www-form-urlencoded data must be an object at the top level"
         );
       }
 
@@ -182,29 +186,56 @@ export class CoreClient {
     return reqInit;
   }
 
-  private async request(cfg: RequestConfig): Promise<ApiResponse> {
-    const fetcherFn =
-      RUNTIME.type === "node" || typeof fetch !== "function"
-        ? nodeFetch
-        : fetch;
-
-    cfg = await this.applyAuths(cfg);
-    const reqInit = this.buildRequestInit(cfg);
-    const url = this.buildUrlFromCfg(cfg);
-
-    const timeout = cfg.opts?.timeout ?? this.timeout;
+  private async sendRequest({
+    url,
+    reqInit,
+    timeout,
+  }: {
+    url: string;
+    reqInit: RequestInit;
+    timeout?: number | undefined;
+  }): Promise<ApiResponse> {
     const controller = new AbortController();
     let timeoutId;
     if (typeof timeout !== "undefined") {
       timeoutId = setTimeout(() => controller.abort(), timeout);
     }
     reqInit.signal = controller.signal;
 
+    const fetcherFn =
+      RUNTIME.type === "node" || typeof fetch !== "function"
+        ? nodeFetch
+        : fetch;
     const response = await fetcherFn(url, reqInit as any);
 
     if (timeoutId) {
       clearTimeout(timeoutId);
     }
+    return response;
+  }
+
+  private async request(cfg: RequestConfig): Promise<ApiResponse> {
+    cfg = await this.applyAuths(cfg);
+    const reqInit = this.buildRequestInit(cfg);
+    const url = this.buildUrlFromCfg(cfg);
+    const timeout = cfg.opts?.timeout ?? this.timeout;
+    const sendRequestData = { url, reqInit, timeout };
+
+    let response = await this.sendRequest(sendRequestData);
+    if (cfg.opts?.retries || this.retries) {
+      const retry = new RetryConfig({
+        override: cfg.opts?.retries,
+        base: this.retries,
+      });
+      let attempt = 1;
+      let delay = retry.initialDelay;
+      while (retry.shouldRetry({ attempt, statusCode: response.status })) {
+        await sleep(delay);
+        response = await this.sendRequest(sendRequestData);
+        delay = retry.calcNextDelay({ currDelay: delay });
+        attempt++;
+      }
+    }
 
     if (!response.ok) {
       throw new ApiError(cfg, response as any);

src/index.ts

@@ -21,4 +21,5 @@ export {
 export { createForm, isUploadFile, UploadFile } from "./form-data";
 export { encodeQueryParam } from "./query";
 export { RUNTIME } from "./runtime";
+export { RetryStrategy } from "./retry";
 export { zodRequiredAny, zodTransform, zodUploadFile } from "./zod";

src/query.ts

@@ -36,7 +36,7 @@ function encodeForm(name: string, value: any, explode: boolean): string {
   if (Array.isArray(value)) {
     return qs.stringify(
       { [name]: value },
-      { arrayFormat: explode ? "repeat" : "comma" },
+      { arrayFormat: explode ? "repeat" : "comma" }
     );
   } else if (typeof value === "object" && value != null) {
     if (explode) {
@@ -49,7 +49,7 @@ function encodeForm(name: string, value: any, explode: boolean): string {
       // non-explode form objects should be encoded like /users?id=key0,val0,key1,val1
       return qs.stringify(
         { [name]: Object.entries(value).flat() },
-        { arrayFormat: "comma" },
+        { arrayFormat: "comma" }
       );
     }
   } else {
@@ -60,7 +60,7 @@ function encodeForm(name: string, value: any, explode: boolean): string {
 function encodeSpaceDelimited(
   name: string,
   value: any,
-  explode: boolean,
+  explode: boolean
 ): string {
   if (Array.isArray(value) && !explode) {
     // non-explode spaceDelimited arrays should be encoded like /users?id=3%204%205
@@ -76,7 +76,7 @@ function encodeSpaceDelimited(
 function encodePipeDelimited(
   name: string,
   value: any,
-  explode: boolean,
+  explode: boolean
 ): string {
   if (Array.isArray(value) && !explode) {
     // non-explode pipeDelimited arrays should be encoded like /users?id=3|4|5