@upstash/redis 1.5.0 → 1.6.0

package/esm/pkg/http.js

@@ -19,14 +19,30 @@ export class HttpClient {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "retry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = { "Content-Type": "application/json", ...config.headers };
-        this.options = config.options;
+        this.options = { backend: config.options?.backend };
+        if (typeof config?.retry === "boolean" && config?.retry === false) {
+            this.retry = {
+                attempts: 1,
+                backoff: () => 0,
+            };
+        }
+        else {
+            this.retry = {
+                attempts: config?.retry?.retries ?? 5,
+                backoff: config?.retry?.backoff ??
+                    ((retryCount) => Math.exp(retryCount) * 50),
+            };
+        }
     }
     async request(req) {
-        if (!req.path) {
-            req.path = [];
-        }
         const requestOptions = {
             method: "POST",
             headers: this.headers,
@@ -37,9 +53,21 @@ export class HttpClient {
              */
             backend: this.options?.backend,
         };
-        // fetch is defined by isomorphic fetch
-        // eslint-disable-next-line no-undef
-        const res = await fetch([this.baseUrl, ...req.path].join("/"), requestOptions);
+        let res = null;
+        let error = null;
+        for (let i = 0; i <= this.retry.attempts; i++) {
+            try {
+                res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
+                break;
+            }
+            catch (err) {
+                error = err;
+                await new Promise((r) => setTimeout(r, this.retry.backoff(i)));
+            }
+        }
+        if (!res) {
+            throw error ?? new Error("Exhausted all retries");
+        }
         const body = (await res.json());
         if (!res.ok) {
             throw new UpstashError(body.error);

package/esm/platforms/cloudflare.js

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient } from "../pkg/http.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -26,7 +26,8 @@ export class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
+            retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
         });
@@ -44,9 +45,8 @@ export class Redis extends core.Redis {
      * ```ts
      * const redis = Redis.fromEnv(env)
      * ```
-     *
      */
-    static fromEnv(env) {
+    static fromEnv(env, opts) {
         // @ts-ignore These will be defined by cloudflare
         const url = env?.UPSTASH_REDIS_REST_URL ?? UPSTASH_REDIS_REST_URL;
         // @ts-ignore These will be defined by cloudflare
@@ -57,26 +57,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token });
+        return new Redis({ ...opts, url, token });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/esm/platforms/fastly.js

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient } from "../pkg/http.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -27,35 +27,14 @@ export class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
             baseUrl: config.url,
+            retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
-            backend: config.backend,
+            options: { backend: config.backend },
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
         });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-expect-error fastly requires `backend`
-                backend: config.backend,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/esm/platforms/node_with_fetch.js

@@ -1,6 +1,6 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient, } from "../pkg/http.js";
 import "isomorphic-fetch";
 /**
  * Serverless redis client for upstash.
@@ -21,8 +21,9 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -54,28 +55,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/esm/platforms/nodejs.js

@@ -1,6 +1,6 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient, } from "../pkg/http.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -20,8 +20,9 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -53,28 +54,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v1.5.0",
+  "version": "v1.6.0",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -40,15 +40,15 @@
   "size-limit": [
     {
       "path": "esm/platforms/nodejs.js",
-      "limit": "5 KB"
+      "limit": "6 KB"
     },
     {
       "path": "esm/platforms/fastly.js",
-      "limit": "5 KB"
+      "limit": "6 KB"
     },
     {
       "path": "esm/platforms/cloudflare.js",
-      "limit": "5 KB"
+      "limit": "6 KB"
     },
     {
       "path": "esm/platforms/node_with_fetch.js",

package/script/pkg/http.js

@@ -22,14 +22,30 @@ class HttpClient {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "retry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = { "Content-Type": "application/json", ...config.headers };
-        this.options = config.options;
+        this.options = { backend: config.options?.backend };
+        if (typeof config?.retry === "boolean" && config?.retry === false) {
+            this.retry = {
+                attempts: 1,
+                backoff: () => 0,
+            };
+        }
+        else {
+            this.retry = {
+                attempts: config?.retry?.retries ?? 5,
+                backoff: config?.retry?.backoff ??
+                    ((retryCount) => Math.exp(retryCount) * 50),
+            };
+        }
     }
     async request(req) {
-        if (!req.path) {
-            req.path = [];
-        }
         const requestOptions = {
             method: "POST",
             headers: this.headers,
@@ -40,9 +56,21 @@ class HttpClient {
              */
             backend: this.options?.backend,
         };
-        // fetch is defined by isomorphic fetch
-        // eslint-disable-next-line no-undef
-        const res = await fetch([this.baseUrl, ...req.path].join("/"), requestOptions);
+        let res = null;
+        let error = null;
+        for (let i = 0; i <= this.retry.attempts; i++) {
+            try {
+                res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
+                break;
+            }
+            catch (err) {
+                error = err;
+                await new Promise((r) => setTimeout(r, this.retry.backoff(i)));
+            }
+        }
+        if (!res) {
+            throw error ?? new Error("Exhausted all retries");
+        }
         const body = (await res.json());
         if (!res.ok) {
             throw new error_js_1.UpstashError(body.error);

package/script/platforms/cloudflare.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -52,7 +52,8 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
+            retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
         });
@@ -70,9 +71,8 @@ class Redis extends core.Redis {
      * ```ts
      * const redis = Redis.fromEnv(env)
      * ```
-     *
      */
-    static fromEnv(env) {
+    static fromEnv(env, opts) {
         // @ts-ignore These will be defined by cloudflare
         const url = env?.UPSTASH_REDIS_REST_URL ?? UPSTASH_REDIS_REST_URL;
         // @ts-ignore These will be defined by cloudflare
@@ -83,27 +83,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token });
+        return new Redis({ ...opts, url, token });
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/script/platforms/fastly.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -53,10 +53,11 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
             baseUrl: config.url,
+            retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
-            backend: config.backend,
+            options: { backend: config.backend },
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
@@ -64,25 +65,3 @@ class Redis extends core.Redis {
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-expect-error fastly requires `backend`
-                backend: config.backend,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/script/platforms/node_with_fetch.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 require("isomorphic-fetch");
 /**
  * Serverless redis client for upstash.
@@ -47,8 +47,9 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -80,29 +81,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/script/platforms/nodejs.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -46,8 +46,9 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -79,29 +80,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/types/pkg/http.d.ts

@@ -12,12 +12,31 @@ export declare type UpstashResponse<TResult> = {
 export interface Requester {
     request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
 }
+export declare type RetryConfig = false | {
+    /**
+     * The number of retries to attempt before giving up.
+     *
+     * @default 5
+     */
+    retries?: number;
+    /**
+     * A backoff function receives the current retry cound and returns a number in milliseconds to wait before retrying.
+     *
+     * @default
+     * ```ts
+     * Math.exp(retryCount) * 50
+     * ```
+     */
+    backoff?: (retryCount: number) => number;
+};
+declare type Options = {
+    backend?: string;
+};
 export declare type HttpClientConfig = {
     headers?: Record<string, string>;
     baseUrl: string;
-    options?: {
-        backend?: string;
-    };
+    options?: Options;
+    retry?: RetryConfig;
 };
 export declare class HttpClient implements Requester {
     baseUrl: string;
@@ -25,6 +44,11 @@ export declare class HttpClient implements Requester {
     readonly options?: {
         backend?: string;
     };
+    readonly retry: {
+        attempts: number;
+        backoff: (retryCount: number) => number;
+    };
     constructor(config: HttpClientConfig);
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }
+export {};

package/types/platforms/cloudflare.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,6 +14,10 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.
@@ -34,5 +38,5 @@ export declare class Redis extends core.Redis {
     static fromEnv(env?: {
         UPSTASH_REDIS_REST_URL: string;
         UPSTASH_REDIS_REST_TOKEN: string;
-    }): Redis;
+    }, opts?: Omit<RedisConfigCloudflare, "url" | "token">): Redis;
 }

package/types/platforms/fastly.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -20,6 +20,10 @@ export declare type RedisConfigFastly = {
      * referenced by name.
      */
     backend: string;
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.

package/types/platforms/node_with_fetch.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 import "isomorphic-fetch";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
@@ -15,6 +15,25 @@ export declare type RedisConfigNodejs = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * An agent allows you to reuse connections to reduce latency for multiple sequential requests.
+     *
+     * This is a node specific implementation and is not supported in various runtimes like Vercel
+     * edge functions.
+     *
+     * @example
+     * ```ts
+     * import https from "https"
+     *
+     * const options: RedisConfigNodejs = {
+     *  agent: new https.Agent({ keepAlive: true })
+     * }
+     * ```
+     */
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.

package/types/platforms/nodejs.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,6 +14,25 @@ export declare type RedisConfigNodejs = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * An agent allows you to reuse connections to reduce latency for multiple sequential requests.
+     *
+     * This is a node specific implementation and is not supported in various runtimes like Vercel
+     * edge functions.
+     *
+     * @example
+     * ```ts
+     * import https from "https"
+     *
+     * const options: RedisConfigNodejs = {
+     *  agent: new https.Agent({ keepAlive: true })
+     * }
+     * ```
+     */
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.