@upstash/ratelimit 0.2.0 → 0.3.0-rc.0

package/esm/deps/deno.land/x/upstash_redis@v1.19.3/pkg/script.js

@@ -0,0 +1,77 @@
+import { sha1 as digest } from "../../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/deps/deno.land/x/upstash_redis@v1.19.3/pkg/types.js

@@ -0,0 +1 @@
+export {};

package/esm/deps/deno.land/x/upstash_redis@v1.19.3/pkg/util.js

@@ -0,0 +1,31 @@
+function parseRecursive(obj) {
+    const parsed = Array.isArray(obj)
+        ? obj.map((o) => {
+            try {
+                return parseRecursive(o);
+            }
+            catch {
+                return o;
+            }
+        })
+        : JSON.parse(obj);
+    /**
+     * Parsing very large numbers can result in MAX_SAFE_INTEGER
+     * overflow. In that case we return the number as string instead.
+     */
+    if (typeof parsed === "number" && parsed.toString() != obj) {
+        return obj;
+    }
+    return parsed;
+}
+export function parseResponse(result) {
+    try {
+        /**
+         * Try to parse the response if possible
+         */
+        return parseRecursive(result);
+    }
+    catch {
+        return result;
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.19.3/version.js

@@ -0,0 +1 @@
+export const VERSION = "development";

package/esm/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js

@@ -0,0 +1,50 @@
+import { toUint8Array, fromUint8Array } from "../../../deno.land/x/base64@v0.2.1/base64url.js";
+const decoder = new TextDecoder();
+const encoder = new TextEncoder();
+/** Serializes a Uint8Array to a hexadecimal string. */
+function toHexString(buf) {
+    return buf.reduce((hex, byte) => `${hex}${byte < 16 ? "0" : ""}${byte.toString(16)}`, "");
+}
+/** Deserializes a Uint8Array from a hexadecimal string. */
+function fromHexString(hex) {
+    const len = hex.length;
+    if (len % 2 || !/^[0-9a-fA-F]+$/.test(hex)) {
+        throw new TypeError("Invalid hex string.");
+    }
+    hex = hex.toLowerCase();
+    const buf = new Uint8Array(Math.floor(len / 2));
+    const end = len / 2;
+    for (let i = 0; i < end; ++i) {
+        buf[i] = parseInt(hex.substr(i * 2, 2), 16);
+    }
+    return buf;
+}
+/** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
+export function decode(buf, encoding = "utf8") {
+    if (/^utf-?8$/i.test(encoding)) {
+        return decoder.decode(buf);
+    }
+    else if (/^base64$/i.test(encoding)) {
+        return fromUint8Array(buf);
+    }
+    else if (/^hex(?:adecimal)?$/i.test(encoding)) {
+        return toHexString(buf);
+    }
+    else {
+        throw new TypeError("Unsupported string encoding.");
+    }
+}
+export function encode(str, encoding = "utf8") {
+    if (/^utf-?8$/i.test(encoding)) {
+        return encoder.encode(str);
+    }
+    else if (/^base64$/i.test(encoding)) {
+        return toUint8Array(str);
+    }
+    else if (/^hex(?:adecimal)?$/i.test(encoding)) {
+        return fromHexString(str);
+    }
+    else {
+        throw new TypeError("Unsupported string encoding.");
+    }
+}

package/esm/multi.js

@@ -26,6 +26,7 @@ export class MultiRegionRatelimit extends Ratelimit {
             prefix: config.prefix,
             limiter: config.limiter,
             timeout: config.timeout,
+            analytics: config.analytics,
             ctx: {
                 redis: config.redis,
                 cache: config.ephemeralCache

package/esm/ratelimit.js

@@ -1,3 +1,4 @@
+import { Analytics } from "./analytics.js";
 import { Cache } from "./cache.js";
 export class TimeoutError extends Error {
     constructor() {
@@ -46,6 +47,12 @@ export class Ratelimit {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "analytics", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Determine if a request should pass or be rejected based on the identifier and previously chosen ratelimit.
          *
@@ -69,7 +76,7 @@ export class Ratelimit {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: async (identifier) => {
+            value: async (identifier, req) => {
                 const key = [this.prefix, identifier].join(":");
                 let timeoutId = null;
                 try {
@@ -87,7 +94,18 @@ export class Ratelimit {
                             }, this.timeout);
                         }));
                     }
-                    return await Promise.race(arr);
+                    const res = await Promise.race(arr);
+                    if (this.analytics) {
+                        const geo = req ? this.analytics.extractGeo(req) : undefined;
+                        const analyticsP = this.analytics.record({
+                            identifier,
+                            time: Date.now(),
+                            success: res.success,
+                            ...geo,
+                        });
+                        res.pending = Promise.all([res.pending, analyticsP]);
+                    }
+                    return res;
                 }
                 finally {
                     if (timeoutId) {
@@ -161,6 +179,14 @@ export class Ratelimit {
         this.limiter = config.limiter;
         this.timeout = config.timeout;
         this.prefix = config.prefix ?? "@upstash/ratelimit";
+        this.analytics = config.analytics !== false
+            ? new Analytics({
+                redis: Array.isArray(this.ctx.redis)
+                    ? this.ctx.redis[0]
+                    : this.ctx.redis,
+                prefix: this.prefix,
+            })
+            : undefined;
         if (config.ephemeralCache instanceof Map) {
             this.ctx.cache = new Cache(config.ephemeralCache);
         }

package/esm/single.js

@@ -24,6 +24,7 @@ export class RegionRatelimit extends Ratelimit {
             prefix: config.prefix,
             limiter: config.limiter,
             timeout: config.timeout,
+            analytics: config.analytics,
             ctx: {
                 redis: config.redis,
             },

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "name": "@upstash/ratelimit",
-  "version": "v0.2.0",
+  "version": "v0.3.0-rc.0",
   "description": "A serverless ratelimiter built on top of Upstash REST API.",
   "repository": {
     "type": "git",

package/script/analytics.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+class Analytics {
+    constructor(config) {
+        Object.defineProperty(this, "redis", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "prefix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.redis = config.redis;
+        this.prefix = config.prefix ?? "@upstash/ratelimit";
+    }
+    extractGeo(req) {
+        if (typeof req.geo !== "undefined") {
+            return req.geo;
+        }
+        return {};
+    }
+    async record(event) {
+        // Bucket is a unix timestamp in milliseconds marking the beginning of a day
+        const bucket = (new Date().setUTCHours(0, 0, 0, 0)).toFixed(0);
+        const key = [this.prefix, "events", bucket].join(":");
+        await this.redis.hincrby(key, JSON.stringify({
+            ...event,
+            time: undefined,
+        }), 1);
+    }
+    /**
+     * Aggregates the events by the given field and returns the number of successes and failures per value
+     *
+     * @param aggregateBy - The field to aggregate by
+     * @param cutoff - Timestamp in milliseconds to limit the aggregation to `cutoff` until now
+     * @returns
+     */
+    async aggregate(aggregateBy, cutoff = 0) {
+        const keys = [];
+        let cursor = 0;
+        do {
+            const [nextCursor, found] = await this.redis.scan(cursor, { match: [this.prefix, "events", "*"].join(":"), count: 1000 });
+            cursor = nextCursor;
+            for (const key of found) {
+                const timestamp = parseInt(key.split(":").pop());
+                // Take all the keys that at least overlap with the given timestamp
+                if (timestamp >= cutoff) {
+                    keys.push(key);
+                }
+            }
+        } while (cursor !== 0);
+        const days = await Promise.all(keys.sort().map(async (key) => {
+            const fields = await this.redis.hgetall(key);
+            if (!fields) {
+                return {};
+            }
+            const day = {};
+            for (const [field, count] of Object.entries(fields)) {
+                const r = JSON.parse(field);
+                for (const [k, v] of Object.entries(r)) {
+                    if (k !== aggregateBy) {
+                        continue;
+                    }
+                    if (!day[v]) {
+                        day[v] = {
+                            success: 0,
+                            blocked: 0,
+                        };
+                    }
+                    if (r.success) {
+                        day[v].success += count;
+                    }
+                    else {
+                        day[v].blocked += count;
+                    }
+                }
+            }
+            return day;
+        }));
+        return days;
+    }
+}
+exports.Analytics = Analytics;

package/script/deps/deno.land/x/base64@v0.2.1/base.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = void 0;
+function getLengths(b64) {
+    const len = b64.length;
+    // if (len % 4 > 0) {
+    //   throw new TypeError("Invalid string. Length must be a multiple of 4");
+    // }
+    // Trim off extra bytes after placeholder bytes are found
+    // See: https://github.com/beatgammit/base64-js/issues/42
+    let validLen = b64.indexOf("=");
+    if (validLen === -1) {
+        validLen = len;
+    }
+    const placeHoldersLen = validLen === len ? 0 : 4 - (validLen % 4);
+    return [validLen, placeHoldersLen];
+}
+function init(lookup, revLookup, urlsafe = false) {
+    function _byteLength(validLen, placeHoldersLen) {
+        return Math.floor(((validLen + placeHoldersLen) * 3) / 4 - placeHoldersLen);
+    }
+    function tripletToBase64(num) {
+        return (lookup[(num >> 18) & 0x3f] +
+            lookup[(num >> 12) & 0x3f] +
+            lookup[(num >> 6) & 0x3f] +
+            lookup[num & 0x3f]);
+    }
+    function encodeChunk(buf, start, end) {
+        const out = new Array((end - start) / 3);
+        for (let i = start, curTriplet = 0; i < end; i += 3) {
+            out[curTriplet++] = tripletToBase64((buf[i] << 16) + (buf[i + 1] << 8) + buf[i + 2]);
+        }
+        return out.join("");
+    }
+    return {
+        // base64 is 4/3 + up to two characters of the original data
+        byteLength(b64) {
+            return _byteLength.apply(null, getLengths(b64));
+        },
+        toUint8Array(b64) {
+            const [validLen, placeHoldersLen] = getLengths(b64);
+            const buf = new Uint8Array(_byteLength(validLen, placeHoldersLen));
+            // If there are placeholders, only get up to the last complete 4 chars
+            const len = placeHoldersLen ? validLen - 4 : validLen;
+            let tmp;
+            let curByte = 0;
+            let i;
+            for (i = 0; i < len; i += 4) {
+                tmp = (revLookup[b64.charCodeAt(i)] << 18) |
+                    (revLookup[b64.charCodeAt(i + 1)] << 12) |
+                    (revLookup[b64.charCodeAt(i + 2)] << 6) |
+                    revLookup[b64.charCodeAt(i + 3)];
+                buf[curByte++] = (tmp >> 16) & 0xff;
+                buf[curByte++] = (tmp >> 8) & 0xff;
+                buf[curByte++] = tmp & 0xff;
+            }
+            if (placeHoldersLen === 2) {
+                tmp = (revLookup[b64.charCodeAt(i)] << 2) |
+                    (revLookup[b64.charCodeAt(i + 1)] >> 4);
+                buf[curByte++] = tmp & 0xff;
+            }
+            else if (placeHoldersLen === 1) {
+                tmp = (revLookup[b64.charCodeAt(i)] << 10) |
+                    (revLookup[b64.charCodeAt(i + 1)] << 4) |
+                    (revLookup[b64.charCodeAt(i + 2)] >> 2);
+                buf[curByte++] = (tmp >> 8) & 0xff;
+                buf[curByte++] = tmp & 0xff;
+            }
+            return buf;
+        },
+        fromUint8Array(buf) {
+            const maxChunkLength = 16383; // Must be multiple of 3
+            const len = buf.length;
+            const extraBytes = len % 3; // If we have 1 byte left, pad 2 bytes
+            const len2 = len - extraBytes;
+            const parts = new Array(Math.ceil(len2 / maxChunkLength) + (extraBytes ? 1 : 0));
+            let curChunk = 0;
+            let chunkEnd;
+            // Go through the array every three bytes, we'll deal with trailing stuff later
+            for (let i = 0; i < len2; i += maxChunkLength) {
+                chunkEnd = i + maxChunkLength;
+                parts[curChunk++] = encodeChunk(buf, i, chunkEnd > len2 ? len2 : chunkEnd);
+            }
+            let tmp;
+            // Pad the end with zeros, but make sure to not forget the extra bytes
+            if (extraBytes === 1) {
+                tmp = buf[len2];
+                parts[curChunk] = lookup[tmp >> 2] + lookup[(tmp << 4) & 0x3f];
+                if (!urlsafe)
+                    parts[curChunk] += "==";
+            }
+            else if (extraBytes === 2) {
+                tmp = (buf[len2] << 8) | (buf[len2 + 1] & 0xff);
+                parts[curChunk] = lookup[tmp >> 10] +
+                    lookup[(tmp >> 4) & 0x3f] +
+                    lookup[(tmp << 2) & 0x3f];
+                if (!urlsafe)
+                    parts[curChunk] += "=";
+            }
+            return parts.join("");
+        },
+    };
+}
+exports.init = init;

package/script/deps/deno.land/x/base64@v0.2.1/base64url.js

@@ -0,0 +1,13 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromUint8Array = exports.toUint8Array = exports.byteLength = void 0;
+const base_js_1 = require("./base.js");
+const lookup = [];
+const revLookup = [];
+const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
+for (let i = 0, l = code.length; i < l; ++i) {
+    lookup[i] = code[i];
+    revLookup[code.charCodeAt(i)] = i;
+}
+_a = (0, base_js_1.init)(lookup, revLookup, true), exports.byteLength = _a.byteLength, exports.toUint8Array = _a.toUint8Array, exports.fromUint8Array = _a.fromUint8Array;

package/script/deps/deno.land/x/sha1@v1.0.3/deps.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decode = exports.encode = void 0;
+var mod_js_1 = require("../../../denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js");
+Object.defineProperty(exports, "encode", { enumerable: true, get: function () { return mod_js_1.encode; } });
+Object.defineProperty(exports, "decode", { enumerable: true, get: function () { return mod_js_1.decode; } });

package/script/deps/deno.land/x/sha1@v1.0.3/mod.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sha1 = exports.SHA1 = exports.BYTES = void 0;
+const deps_js_1 = require("./deps.js");
+function rotl(x, n) {
+    return (x << n) | (x >>> (32 - n));
+}
+/** Byte length of a SHA1 digest. */
+exports.BYTES = 20;
+/**  A class representation of the SHA1 algorithm. */
+class SHA1 {
+    /** Creates a SHA1 instance. */
+    constructor() {
+        Object.defineProperty(this, "hashSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: exports.BYTES
+        });
+        Object.defineProperty(this, "_buf", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Uint8Array(64)
+        });
+        Object.defineProperty(this, "_bufIdx", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_count", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_K", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Uint32Array([0x5a827999, 0x6ed9eba1, 0x8f1bbcdc, 0xca62c1d6])
+        });
+        Object.defineProperty(this, "_H", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_finalized", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.init();
+    }
+    /** Reduces the four input numbers to a single one. */
+    static F(t, b, c, d) {
+        if (t <= 19) {
+            return (b & c) | (~b & d);
+        }
+        else if (t <= 39) {
+            return b ^ c ^ d;
+        }
+        else if (t <= 59) {
+            return (b & c) | (b & d) | (c & d);
+        }
+        else {
+            return b ^ c ^ d;
+        }
+    }
+    /** Initializes a hash instance. */
+    init() {
+        // prettier-ignore
+        this._H = new Uint32Array([
+            0x67452301, 0xEFCDAB89, 0x98BADCFE, 0x10325476, 0xC3D2E1F0
+        ]);
+        this._bufIdx = 0;
+        this._count = new Uint32Array(2);
+        this._buf.fill(0);
+        this._finalized = false;
+        return this;
+    }
+    /** Updates a hash with additional message data. */
+    update(msg, inputEncoding) {
+        if (msg === null) {
+            throw new TypeError("msg must be a string or Uint8Array.");
+        }
+        else if (typeof msg === "string") {
+            msg = (0, deps_js_1.encode)(msg, inputEncoding);
+        }
+        // process the msg as many times as possible, the rest is stored in the buffer
+        // message is processed in 512 bit (64 byte chunks)
+        for (let i = 0; i < msg.length; i++) {
+            this._buf[this._bufIdx++] = msg[i];
+            if (this._bufIdx === 64) {
+                this.transform();
+                this._bufIdx = 0;
+            }
+        }
+        // counter update (number of message bits)
+        const c = this._count;
+        if ((c[0] += msg.length << 3) < msg.length << 3) {
+            c[1]++;
+        }
+        c[1] += msg.length >>> 29;
+        return this;
+    }
+    /** Finalizes a hash with additional message data. */
+    digest(outputEncoding) {
+        if (this._finalized) {
+            throw new Error("digest has already been called.");
+        }
+        this._finalized = true;
+        // append '1'
+        const b = this._buf;
+        let idx = this._bufIdx;
+        b[idx++] = 0x80;
+        // zeropad up to byte pos 56
+        while (idx !== 56) {
+            if (idx === 64) {
+                this.transform();
+                idx = 0;
+            }
+            b[idx++] = 0;
+        }
+        // append length in bits
+        const c = this._count;
+        b[56] = (c[1] >>> 24) & 0xff;
+        b[57] = (c[1] >>> 16) & 0xff;
+        b[58] = (c[1] >>> 8) & 0xff;
+        b[59] = (c[1] >>> 0) & 0xff;
+        b[60] = (c[0] >>> 24) & 0xff;
+        b[61] = (c[0] >>> 16) & 0xff;
+        b[62] = (c[0] >>> 8) & 0xff;
+        b[63] = (c[0] >>> 0) & 0xff;
+        this.transform();
+        // return the hash as byte array (20 bytes)
+        const hash = new Uint8Array(exports.BYTES);
+        for (let i = 0; i < 5; i++) {
+            hash[(i << 2) + 0] = (this._H[i] >>> 24) & 0xff;
+            hash[(i << 2) + 1] = (this._H[i] >>> 16) & 0xff;
+            hash[(i << 2) + 2] = (this._H[i] >>> 8) & 0xff;
+            hash[(i << 2) + 3] = (this._H[i] >>> 0) & 0xff;
+        }
+        // clear internal states and prepare for new hash
+        this.init();
+        return outputEncoding ? (0, deps_js_1.decode)(hash, outputEncoding) : hash;
+    }
+    /** Performs one transformation cycle. */
+    transform() {
+        const h = this._H;
+        let a = h[0];
+        let b = h[1];
+        let c = h[2];
+        let d = h[3];
+        let e = h[4];
+        // convert byte buffer to words
+        const w = new Uint32Array(80);
+        for (let i = 0; i < 16; i++) {
+            w[i] =
+                this._buf[(i << 2) + 3] |
+                    (this._buf[(i << 2) + 2] << 8) |
+                    (this._buf[(i << 2) + 1] << 16) |
+                    (this._buf[i << 2] << 24);
+        }
+        for (let t = 0; t < 80; t++) {
+            if (t >= 16) {
+                w[t] = rotl(w[t - 3] ^ w[t - 8] ^ w[t - 14] ^ w[t - 16], 1);
+            }
+            const tmp = (rotl(a, 5) +
+                SHA1.F(t, b, c, d) +
+                e +
+                w[t] +
+                this._K[Math.floor(t / 20)]) |
+                0;
+            e = d;
+            d = c;
+            c = rotl(b, 30);
+            b = a;
+            a = tmp;
+        }
+        h[0] = (h[0] + a) | 0;
+        h[1] = (h[1] + b) | 0;
+        h[2] = (h[2] + c) | 0;
+        h[3] = (h[3] + d) | 0;
+        h[4] = (h[4] + e) | 0;
+    }
+}
+exports.SHA1 = SHA1;
+/** Generates a SHA1 hash of the input data. */
+function sha1(msg, inputEncoding, outputEncoding) {
+    return new SHA1().update(msg, inputEncoding).digest(outputEncoding);
+}
+exports.sha1 = sha1;