@upstash/redis 0.0.0-ci.d96841bb → 0.0.0-ci.dc584c15-20231010

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, JsonArrAppendCommand, JsonArrIndexCommand, JsonArrInsertCommand, JsonArrLenCommand, JsonArrPopCommand, JsonArrTrimCommand, JsonClearCommand, JsonDelCommand, JsonForgetCommand, JsonGetCommand, JsonMGetCommand, JsonNumIncrByCommand, JsonNumMultByCommand, JsonObjKeysCommand, JsonObjLenCommand, JsonRespCommand, JsonSetCommand, JsonStrAppendCommand, JsonStrLenCommand, JsonToggleCommand, JsonTypeCommand, 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, XAddCommand, XRangeCommand, 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,45 @@ export class Redis {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "enableTelemetry", {
+            enumerable: true,
+            configurable: true,
+            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) => {
+                if (!this.enableTelemetry) {
+                    return;
+                }
+                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 +79,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 +266,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 +383,15 @@ 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 +500,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 +518,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 +869,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
          */
@@ -894,6 +1004,24 @@ export class Redis {
             writable: true,
             value: (...args) => new UnlinkCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/xadd
+         */
+        Object.defineProperty(this, "xadd", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new XAddCommand(args, this.opts).exec(this.client)
+        });
+        /**
+         * @see https://redis.io/commands/xrange
+         */
+        Object.defineProperty(this, "xrange", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new XRangeCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zadd
          */
@@ -926,6 +1054,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 +1090,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
          */
@@ -1063,5 +1209,97 @@ export class Redis {
         });
         this.client = client;
         this.opts = opts;
+        this.enableTelemetry = opts?.enableTelemetry ?? true;
+    }
+    get json() {
+        return {
+            /**
+             * @see https://redis.io/commands/json.arrappend
+             */
+            arrappend: (...args) => new JsonArrAppendCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrindex
+             */
+            arrindex: (...args) => new JsonArrIndexCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrinsert
+             */
+            arrinsert: (...args) => new JsonArrInsertCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrlen
+             */
+            arrlen: (...args) => new JsonArrLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrpop
+             */
+            arrpop: (...args) => new JsonArrPopCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrtrim
+             */
+            arrtrim: (...args) => new JsonArrTrimCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.clear
+             */
+            clear: (...args) => new JsonClearCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.del
+             */
+            del: (...args) => new JsonDelCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.forget
+             */
+            forget: (...args) => new JsonForgetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.get
+             */
+            get: (...args) => new JsonGetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.mget
+             */
+            mget: (...args) => new JsonMGetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.numincrby
+             */
+            numincrby: (...args) => new JsonNumIncrByCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.nummultby
+             */
+            nummultby: (...args) => new JsonNumMultByCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.objkeys
+             */
+            objkeys: (...args) => new JsonObjKeysCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.objlen
+             */
+            objlen: (...args) => new JsonObjLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.resp
+             */
+            resp: (...args) => new JsonRespCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.set
+             */
+            set: (...args) => new JsonSetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.strappend
+             */
+            strappend: (...args) => new JsonStrAppendCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.strlen
+             */
+            strlen: (...args) => new JsonStrLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.toggle
+             */
+            toggle: (...args) => new JsonToggleCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.type
+             */
+            type: (...args) => new JsonTypeCommand(args, this.opts).exec(this.client),
+        };
+    }
+    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 { 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)) {
@@ -30,10 +31,17 @@ export class Redis extends core.Redis {
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
+            responseEncoding: config.responseEncoding,
         });
         super(client, {
+            enableTelemetry: !env?.UPSTASH_DISABLE_TELEMETRY,
             automaticDeserialization: config.automaticDeserialization,
         });
+        // This is only added of the user has not disabled telemetry
+        this.addTelemetry({
+            platform: "cloudflare",
+            sdk: `@upstash/redis@${VERSION}`,
+        });
     }
     /*
      * Create a new Upstash Redis instance from environment variables on cloudflare.
@@ -57,6 +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({ ...opts, url, token });
+        return new Redis({ ...opts, url, token }, env);
     }
 }

package/esm/platforms/fastly.js

@@ -1,5 +1,6 @@
 import * as core from "../pkg/redis.js";
 import { HttpClient } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -32,9 +33,14 @@ export class Redis extends core.Redis {
             retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
             options: { backend: config.backend },
+            responseEncoding: config.responseEncoding,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
         });
+        this.addTelemetry({
+            sdk: `@upstash/redis@${VERSION}`,
+            platform: "fastly",
+        });
     }
 }

package/esm/platforms/node_with_fetch.js

@@ -1,7 +1,21 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.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.
  */
@@ -25,10 +39,21 @@ export class Redis extends core.Redis {
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            //  agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${VERSION}`,
         });
     }
     /**

package/esm/platforms/nodejs.js

@@ -1,6 +1,15 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.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.
  */
@@ -24,10 +33,24 @@ export class Redis extends core.Redis {
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            cache: configOrRequester.cache || "no-store",
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: typeof EdgeRuntime === "string"
+                ? "edge-light"
+                : `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${VERSION}`,
         });
     }
     /**

package/esm/version.js

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