@upstash/redis 0.0.0-ci.ba39ba1e → 0.0.0-ci.bafaa360-20230119

package/script/pkg/commands/smismember.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMIsMemberCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/smismember
+ */
+class SMIsMemberCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        super(["smismember", cmd[0], ...cmd[1]], opts);
+    }
+}
+exports.SMIsMemberCommand = SMIsMemberCommand;

package/script/pkg/commands/zdiffstore.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZDiffStoreCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/zdiffstore
+ */
+class ZDiffStoreCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        super(["zdiffstore", ...cmd], opts);
+    }
+}
+exports.ZDiffStoreCommand = ZDiffStoreCommand;

package/script/pkg/commands/zmscore.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZMScoreCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/zmscore
+ */
+class ZMScoreCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        const [key, members] = cmd;
+        super(["zmscore", key, ...members], opts);
+    }
+}
+exports.ZMScoreCommand = ZMScoreCommand;

package/script/pkg/commands/zrange.js

@@ -15,6 +15,12 @@ class ZRangeCommand extends command_js_1.Command {
         if (opts?.byLex) {
             command.push("bylex");
         }
+        if (opts?.rev) {
+            command.push("rev");
+        }
+        if (typeof opts?.count !== "undefined" && typeof opts?.offset !== "undefined") {
+            command.push("limit", opts.offset, opts.count);
+        }
         if (opts?.withScores) {
             command.push("withscores");
         }

package/script/pkg/http.js

@@ -28,9 +28,28 @@ class HttpClient {
             writable: true,
             value: void 0
         });
+        this.options = {
+            backend: config.options?.backend,
+            agent: config.agent,
+            responseEncoding: config.responseEncoding ?? "base64", // default to base64
+        };
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
-        this.headers = { "Content-Type": "application/json", ...config.headers };
-        this.options = { backend: config.options?.backend };
+        this.headers = {
+            "Content-Type": "application/json",
+            ...config.headers,
+        };
+        if (config.telemetry?.runtime) {
+            this.headers["Upstash-Telemetry-Runtime"] = config.telemetry.runtime;
+        }
+        if (config.telemetry?.platform) {
+            this.headers["Upstash-Telemetry-Platform"] = config.telemetry.platform;
+        }
+        if (config.telemetry?.sdk) {
+            this.headers["Upstash-Telemetry-Sdk"] = config.telemetry.sdk;
+        }
+        if (this.options.responseEncoding === "base64") {
+            this.headers["Upstash-Encoding"] = "base64";
+        }
         if (typeof config?.retry === "boolean" && config?.retry === false) {
             this.retry = {
                 attempts: 1,
@@ -45,12 +64,30 @@ class HttpClient {
             };
         }
     }
+    mergeTelemetry(telemetry) {
+        function merge(obj, key, value) {
+            if (!value) {
+                return obj;
+            }
+            if (obj[key]) {
+                obj[key] = [obj[key], value].join(",");
+            }
+            else {
+                obj[key] = value;
+            }
+            return obj;
+        }
+        this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
+    }
     async request(req) {
         const requestOptions = {
             method: "POST",
             headers: this.headers,
             body: JSON.stringify(req.body),
             keepalive: true,
+            agent: this.options?.agent,
             /**
              * Fastly specific
              */
@@ -75,7 +112,67 @@ class HttpClient {
         if (!res.ok) {
             throw new error_js_1.UpstashError(body.error);
         }
+        if (this.options?.responseEncoding === "base64") {
+            return Array.isArray(body) ? body.map(decode) : decode(body);
+        }
         return body;
     }
 }
 exports.HttpClient = HttpClient;
+function base64decode(b64) {
+    let dec = "";
+    try {
+        /**
+         * Using only atob() is not enough because it doesn't work with unicode characters
+         */
+        const binString = atob(b64);
+        const size = binString.length;
+        const bytes = new Uint8Array(size);
+        for (let i = 0; i < size; i++) {
+            bytes[i] = binString.charCodeAt(i);
+        }
+        dec = new TextDecoder().decode(bytes);
+    }
+    catch {
+        dec = b64;
+    }
+    return dec;
+    // try {
+    //   return decodeURIComponent(dec);
+    // } catch {
+    //   return dec;
+    // }
+}
+function decode(raw) {
+    let result = undefined;
+    switch (typeof raw.result) {
+        case "undefined":
+            return raw;
+        case "number": {
+            result = raw.result;
+            break;
+        }
+        case "object": {
+            if (Array.isArray(raw.result)) {
+                result = raw.result.map((v) => typeof v === "string"
+                    ? base64decode(v)
+                    : Array.isArray(v)
+                        ? v.map(base64decode)
+                        : v);
+            }
+            else {
+                // If it's not an array it must be null
+                // Apparently null is an object in javascript
+                result = null;
+            }
+            break;
+        }
+        case "string": {
+            result = raw.result === "OK" ? "OK" : base64decode(raw.result);
+            break;
+        }
+        default:
+            break;
+    }
+    return { result, error: raw.error };
+}

package/script/pkg/pipeline.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Pipeline = void 0;
 const mod_js_1 = require("./commands/mod.js");
 const error_js_1 = require("./error.js");
+const zmscore_js_1 = require("./commands/zmscore.js");
+const hrandfield_js_1 = require("./commands/hrandfield.js");
+const zdiffstore_js_1 = require("./commands/zdiffstore.js");
 /**
  * Upstash REST API supports command pipelining to send multiple commands in
  * batch, instead of sending each command one by one and waiting for a response.
@@ -19,7 +22,7 @@ const error_js_1 = require("./error.js");
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -42,7 +45,7 @@ const error_js_1 = require("./error.js");
  * ```
  */
 class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -61,6 +64,12 @@ class Pipeline {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "multiExec", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Send the pipeline request to upstash.
          *
@@ -79,8 +88,9 @@ class Pipeline {
                 if (this.commands.length === 0) {
                     throw new Error("Pipeline is empty");
                 }
+                const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
                 const res = (await this.client.request({
-                    path: ["pipeline"],
+                    path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
                 return res.map(({ error, result }, i) => {
@@ -127,6 +137,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.BitPosCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zdiffstore
+         */
+        Object.defineProperty(this, "zdiffstore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new zdiffstore_js_1.ZDiffStoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/dbsize
          */
@@ -253,6 +272,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.GetBitCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/getdel
+         */
+        Object.defineProperty(this, "getdel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.GetDelCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -361,6 +389,15 @@ class Pipeline {
             writable: true,
             value: (key, kv) => this.chain(new mod_js_1.HMSetCommand([key, kv], this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => this.chain(new hrandfield_js_1.HRandFieldCommand([key, count, withValues], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/hscan
          */
@@ -469,6 +506,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.LLenCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/lmove
+         */
+        Object.defineProperty(this, "lmove", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.LMoveCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -478,6 +524,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.LPopCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/lpos
+         */
+        Object.defineProperty(this, "lpos", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.LPosCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -829,6 +884,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.SMembersCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/smismember
+         */
+        Object.defineProperty(this, "smismember", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, members) => this.chain(new mod_js_1.SMIsMemberCommand([key, members], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/smove
          */
@@ -1005,6 +1069,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZLexCountCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zmscore
+         */
+        Object.defineProperty(this, "zmscore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new zmscore_js_1.ZMScoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1113,9 +1186,10 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
+        this.client = opts.client;
         this.commands = [];
-        this.commandOptions = commandOptions;
+        this.commandOptions = opts.commandOptions;
+        this.multiExec = opts.multiExec ?? false;
     }
     /**
      * Pushes a command into the pipelien and returns a chainable instance of the

package/script/pkg/redis.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const mod_js_1 = require("./commands/mod.js");
 const pipeline_js_1 = require("./pipeline.js");
+const script_js_1 = require("./script.js");
+const zmscore_js_1 = require("./commands/zmscore.js");
+const zdiffstore_js_1 = require("./commands/zdiffstore.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -31,6 +34,36 @@ 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.
          *
@@ -40,7 +73,30 @@ class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: () => new pipeline_js_1.Pipeline(this.client, this.opts)
+            value: () => new pipeline_js_1.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_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: true,
+            })
         });
         /**
          * @see https://redis.io/commands/append
@@ -204,6 +260,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.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 mod_js_1.GetDelCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -312,6 +377,16 @@ class Redis {
             writable: true,
             value: (key, kv) => new mod_js_1.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 mod_js_1.HRandFieldCommand([key, count, withValues], this.opts)
+                .exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/hscan
          */
@@ -420,6 +495,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.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 mod_js_1.LMoveCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -429,6 +513,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.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 mod_js_1.LPosCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -771,6 +864,15 @@ class Redis {
             writable: true,
             value: (key, member) => new mod_js_1.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 mod_js_1.SMIsMemberCommand([key, members], this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/smembers
          */
@@ -929,6 +1031,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.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 zdiffstore_js_1.ZDiffStoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zincrby
          */
@@ -956,6 +1067,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.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 zmscore_js_1.ZMScoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1067,5 +1187,8 @@ class Redis {
         this.client = client;
         this.opts = opts;
     }
+    createScript(script) {
+        return new script_js_1.Script(this, script);
+    }
 }
 exports.Redis = Redis;

package/script/pkg/script.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Script = void 0;
+const mod_js_1 = require("../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")
+ * ```
+ */
+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 = (0, mod_js_1.sha1)(s, "utf8", "hex");
+        return typeof hash === "string" ? hash : new TextDecoder().decode(hash);
+    }
+}
+exports.Script = Script;

package/script/platforms/cloudflare.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -41,7 +42,7 @@ class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -52,10 +53,17 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
+        const telemetry = {};
+        if (!env?.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.platform = "cloudflare";
+            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
+        }
         const client = new http_js_1.HttpClient({
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
+            responseEncoding: config.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
@@ -83,7 +91,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({ ...opts, url, token });
+        return new Redis({ ...opts, url, token }, env);
     }
 }
 exports.Redis = Redis;

package/script/platforms/fastly.js

@@ -58,6 +58,7 @@ 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,