@upstash/redis 0.0.0-ci.b4d4a1cc → 0.0.0-ci.b8efaf97-20230119

package/esm/pkg/redis.js

@@ -1,5 +1,8 @@
-import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LPopCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
+import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HRandFieldCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LMoveCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMIsMemberCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
 import { Pipeline } from "./pipeline.js";
+import { Script } from "./script.js";
+import { ZMScoreCommand } from "./commands/zmscore.js";
+import { ZDiffStoreCommand } from "./commands/zdiffstore.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -28,6 +31,36 @@ export class Redis {
             writable: true,
             value: void 0
         });
+        /**
+         * Wrap a new middleware around the HTTP client.
+         */
+        Object.defineProperty(this, "use", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (middleware) => {
+                const makeRequest = this.client.request.bind(this.client);
+                this.client.request = (req) => middleware(req, makeRequest);
+            }
+        });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *
@@ -37,7 +70,30 @@ export class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: () => new Pipeline(this.client, this.opts)
+            value: () => new Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: false,
+            })
+        });
+        /**
+         * Create a new transaction to allow executing multiple steps atomically.
+         *
+         * All the commands in a transaction are serialized and executed sequentially. A request sent by
+         * another client will never be served in the middle of the execution of a Redis Transaction. This
+         * guarantees that the commands are executed as a single isolated operation.
+         *
+         * @see {@link Pipeline}
+         */
+        Object.defineProperty(this, "multi", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => new Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: true,
+            })
         });
         /**
          * @see https://redis.io/commands/append
@@ -201,6 +257,15 @@ export class Redis {
             writable: true,
             value: (...args) => new GetBitCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/getdel
+         */
+        Object.defineProperty(this, "getdel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new GetDelCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -309,6 +374,16 @@ export class Redis {
             writable: true,
             value: (key, kv) => new HMSetCommand([key, kv], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => new HRandFieldCommand([key, count, withValues], this.opts)
+                .exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/hscan
          */
@@ -417,6 +492,15 @@ export class Redis {
             writable: true,
             value: (...args) => new LLenCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/lmove
+         */
+        Object.defineProperty(this, "lmove", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new LMoveCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -426,6 +510,15 @@ export class Redis {
             writable: true,
             value: (...args) => new LPopCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/lpos
+         */
+        Object.defineProperty(this, "lpos", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new LPosCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -768,6 +861,15 @@ export class Redis {
             writable: true,
             value: (key, member) => new SIsMemberCommand([key, member], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/smismember
+         */
+        Object.defineProperty(this, "smismember", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, members) => new SMIsMemberCommand([key, members], this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/smembers
          */
@@ -926,6 +1028,15 @@ export class Redis {
             writable: true,
             value: (...args) => new ZCountCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zdiffstore
+         */
+        Object.defineProperty(this, "zdiffstore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new ZDiffStoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zincrby
          */
@@ -953,6 +1064,15 @@ export class Redis {
             writable: true,
             value: (...args) => new ZLexCountCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zmscore
+         */
+        Object.defineProperty(this, "zmscore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new ZMScoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1064,4 +1184,7 @@ export class Redis {
         this.client = client;
         this.opts = opts;
     }
+    createScript(script) {
+        return new Script(this, script);
+    }
 }

package/esm/pkg/script.js

@@ -0,0 +1,77 @@
+import { sha1 as digest } from "../deps/deno.land/x/sha1@v1.0.3/mod.js";
+/**
+ * Creates a new script.
+ *
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
+ * the entire script. Afterwards, the script is cached on the server.
+ *
+ * @example
+ * ```ts
+ * const redis = new Redis({...})
+ *
+ * const script = redis.createScript<string>("return ARGV[1];")
+ * const arg1 = await script.eval([], ["Hello World"])
+ * assertEquals(arg1, "Hello World")
+ * ```
+ */
+export class Script {
+    constructor(redis, script) {
+        Object.defineProperty(this, "script", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sha1", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "redis", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.redis = redis;
+        this.sha1 = this.digest(script);
+        this.script = script;
+    }
+    /**
+     * Send an `EVAL` command to redis.
+     */
+    async eval(keys, args) {
+        return await this.redis.eval(this.script, keys, args);
+    }
+    /**
+     * Calculates the sha1 hash of the script and then calls `EVALSHA`.
+     */
+    async evalsha(keys, args) {
+        return await this.redis.evalsha(this.sha1, keys, args);
+    }
+    /**
+     * Optimistically try to run `EVALSHA` first.
+     * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
+     *
+     * Following calls will be able to use the cached script
+     */
+    async exec(keys, args) {
+        const res = await this.redis.evalsha(this.sha1, keys, args).catch(async (err) => {
+            if (err instanceof Error &&
+                err.message.toLowerCase().includes("noscript")) {
+                return await this.redis.eval(this.script, keys, args);
+            }
+            throw err;
+        });
+        return res;
+    }
+    /**
+     * Compute the sha1 hash of the script and return its hex representation.
+     */
+    digest(s) {
+        const hash = digest(s, "utf8", "hex");
+        return typeof hash === "string" ? hash : new TextDecoder().decode(hash);
+    }
+}

package/esm/platforms/cloudflare.js

@@ -1,5 +1,6 @@
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -15,7 +16,7 @@ export class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -26,9 +27,17 @@ 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 telemetry = {};
+        if (!env?.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.platform = "cloudflare";
+            telemetry.sdk = `@upstash/redis@${VERSION}`;
+        }
+        const client = new HttpClient({
+            retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
+            responseEncoding: config.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
@@ -44,9 +53,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 +65,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 }, env);
     }
 }
-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,15 @@ 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 },
+            responseEncoding: config.responseEncoding,
         });
         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,7 +1,21 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 import "isomorphic-fetch";
+// @ts-ignore Deno can't compile
+// import https from "https";
+// @ts-ignore Deno can't compile
+// import http from "http";
+// import "isomorphic-fetch";
+/**
+ * Workaround for nodejs 14, where atob is not included in the standardlib
+ */
+if (typeof atob === "undefined") {
+    global.atob = function (b64) {
+        return Buffer.from(b64, "base64").toString("utf-8");
+    };
+}
 /**
  * Serverless redis client for upstash.
  */
@@ -21,10 +35,23 @@ 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 telemetry = {};
+        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.runtime = `node@${process.version}`;
+            telemetry.platform = process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown";
+            telemetry.sdk = `@upstash/redis@${VERSION}`;
+        }
+        const client = new HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            //  agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
@@ -54,28 +81,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,15 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
+/**
+ * Workaround for nodejs 14, where atob is not included in the standardlib
+ */
+if (typeof atob === "undefined") {
+    global.atob = function (b64) {
+        return Buffer.from(b64, "base64").toString("utf-8");
+    };
+}
 /**
  * Serverless redis client for upstash.
  */
@@ -20,10 +29,23 @@ 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 telemetry = {};
+        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.runtime = `node@${process.version}`;
+            telemetry.platform = process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown";
+            telemetry.sdk = `@upstash/redis@${VERSION}`;
+        }
+        const client = new HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
@@ -53,28 +75,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/version.js

@@ -0,0 +1 @@
+export const VERSION = "v0.0.0-ci.b8efaf97-20230119";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v0.0.0-ci.b4d4a1cc",
+  "version": "v0.0.0-ci.b8efaf97-20230119",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -22,10 +22,6 @@
     "url": "https://github.com/upstash/upstash-redis/issues"
   },
   "homepage": "https://github.com/upstash/upstash-redis#readme",
-  "devDependencies": {
-    "@size-limit/preset-small-lib": "latest",
-    "size-limit": "latest"
-  },
   "dependencies": {
     "isomorphic-fetch": "^3.0.0"
   },
@@ -37,40 +33,6 @@
       "with-fetch": "./types/platforms/node_with_fetch.d.ts"
     }
   },
-  "size-limit": [
-    {
-      "path": "esm/platforms/nodejs.js",
-      "limit": "5 KB"
-    },
-    {
-      "path": "esm/platforms/fastly.js",
-      "limit": "5 KB"
-    },
-    {
-      "path": "esm/platforms/cloudflare.js",
-      "limit": "5 KB"
-    },
-    {
-      "path": "esm/platforms/node_with_fetch.js",
-      "limit": "15 KB"
-    },
-    {
-      "path": "script/platforms/nodejs.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "script/platforms/fastly.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "script/platforms/cloudflare.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "script/platforms/node_with_fetch.js",
-      "limit": "15 KB"
-    }
-  ],
   "exports": {
     ".": {
       "import": "./esm/platforms/nodejs.js",