@upstash/ratelimit 0.2.0 → 0.3.0-canary.0

package/script/multi.js

@@ -1,294 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MultiRegionRatelimit = void 0;
-const dntShim = __importStar(require("./_dnt.shims.js"));
-const duration_js_1 = require("./duration.js");
-const ratelimit_js_1 = require("./ratelimit.js");
-const cache_js_1 = require("./cache.js");
-/**
- * Ratelimiter using serverless redis from https://upstash.com/
- *
- * @example
- * ```ts
- * const { limit } = new MultiRegionRatelimit({
- *    redis: Redis.fromEnv(),
- *    limiter: MultiRegionRatelimit.fixedWindow(
- *      10,     // Allow 10 requests per window of 30 minutes
- *      "30 m", // interval of 30 minutes
- *    )
- * })
- *
- * ```
- */
-class MultiRegionRatelimit extends ratelimit_js_1.Ratelimit {
-    /**
-     * Create a new Ratelimit instance by providing a `@upstash/redis` instance and the algorithn of your choice.
-     */
-    constructor(config) {
-        super({
-            prefix: config.prefix,
-            limiter: config.limiter,
-            timeout: config.timeout,
-            ctx: {
-                redis: config.redis,
-                cache: config.ephemeralCache
-                    ? new cache_js_1.Cache(config.ephemeralCache)
-                    : undefined,
-            },
-        });
-    }
-    /**
-     * Each requests inside a fixed time increases a counter.
-     * Once the counter reaches a maxmimum allowed number, all further requests are
-     * rejected.
-     *
-     * **Pro:**
-     *
-     * - Newer requests are not starved by old ones.
-     * - Low storage cost.
-     *
-     * **Con:**
-     *
-     * A burst of requests near the boundary of a window can result in a very
-     * high request rate because two windows will be filled with requests quickly.
-     *
-     * @param tokens - How many requests a user can make in each time window.
-     * @param window - A fixed timeframe
-     */
-    static fixedWindow(
-    /**
-     * How many requests are allowed per window.
-     */
-    tokens, 
-    /**
-     * The duration in which `tokens` requests are allowed.
-     */
-    window) {
-        const windowDuration = (0, duration_js_1.ms)(window);
-        const script = `
-    local key     = KEYS[1]
-    local id      = ARGV[1]
-    local window  = ARGV[2]
-    
-    redis.call("SADD", key, id)
-    local members = redis.call("SMEMBERS", key)
-    if #members == 1 then
-    -- The first time this key is set, the value will be 1.
-    -- So we only need the expire command once
-      redis.call("PEXPIRE", key, window)
-    end
-    
-    return members
-`;
-        return async function (ctx, identifier) {
-            if (ctx.cache) {
-                const { blocked, reset } = ctx.cache.isBlocked(identifier);
-                if (blocked) {
-                    return {
-                        success: false,
-                        limit: tokens,
-                        remaining: 0,
-                        reset: reset,
-                        pending: Promise.resolve(),
-                    };
-                }
-            }
-            const requestID = dntShim.crypto.randomUUID();
-            const bucket = Math.floor(Date.now() / windowDuration);
-            const key = [identifier, bucket].join(":");
-            const dbs = ctx.redis.map((redis) => ({
-                redis,
-                request: redis.eval(script, [key], [requestID, windowDuration]),
-            }));
-            const firstResponse = await Promise.any(dbs.map((s) => s.request));
-            const usedTokens = firstResponse.length;
-            const remaining = tokens - usedTokens - 1;
-            /**
-             * If the length between two databases does not match, we sync the two databases
-             */
-            async function sync() {
-                const individualIDs = await Promise.all(dbs.map((s) => s.request));
-                const allIDs = Array.from(new Set(individualIDs.flatMap((_) => _)).values());
-                for (const db of dbs) {
-                    const ids = await db.request;
-                    /**
-                     * If the bucket in this db is already full, it doesn't matter which ids it contains.
-                     * So we do not have to sync.
-                     */
-                    if (ids.length >= tokens) {
-                        continue;
-                    }
-                    const diff = allIDs.filter((id) => !ids.includes(id));
-                    /**
-                     * Don't waste a request if there is nothing to send
-                     */
-                    if (diff.length === 0) {
-                        continue;
-                    }
-                    await db.redis.sadd(key, ...allIDs);
-                }
-            }
-            /**
-             * Do not await sync. This should not run in the critical path.
-             */
-            const success = remaining > 0;
-            const reset = (bucket + 1) * windowDuration;
-            if (ctx.cache && !success) {
-                ctx.cache.blockUntil(identifier, reset);
-            }
-            return {
-                success,
-                limit: tokens,
-                remaining,
-                reset,
-                pending: sync(),
-            };
-        };
-    }
-    /**
-     * Combined approach of `slidingLogs` and `fixedWindow` with lower storage
-     * costs than `slidingLogs` and improved boundary behavior by calcualting a
-     * weighted score between two windows.
-     *
-     * **Pro:**
-     *
-     * Good performance allows this to scale to very high loads.
-     *
-     * **Con:**
-     *
-     * Nothing major.
-     *
-     * @param tokens - How many requests a user can make in each time window.
-     * @param window - The duration in which the user can max X requests.
-     */
-    static slidingWindow(
-    /**
-     * How many requests are allowed per window.
-     */
-    tokens, 
-    /**
-     * The duration in which `tokens` requests are allowed.
-     */
-    window) {
-        const windowSize = (0, duration_js_1.ms)(window);
-        const script = `
-      local currentKey  = KEYS[1]           -- identifier including prefixes
-      local previousKey = KEYS[2]           -- key of the previous bucket
-      local tokens      = tonumber(ARGV[1]) -- tokens per window
-      local now         = ARGV[2]           -- current timestamp in milliseconds
-      local window      = ARGV[3]           -- interval in milliseconds
-      local requestID   = ARGV[4]           -- uuid for this request
-
-
-      local currentMembers = redis.call("SMEMBERS", currentKey)
-      local requestsInCurrentWindow = #currentMembers
-      local previousMembers = redis.call("SMEMBERS", previousKey)
-      local requestsInPreviousWindow = #previousMembers
-
-      local percentageInCurrent = ( now % window) / window
-      if requestsInPreviousWindow * ( 1 - percentageInCurrent ) + requestsInCurrentWindow >= tokens then
-        return {currentMembers, previousMembers}
-      end
-
-      redis.call("SADD", currentKey, requestID)
-      table.insert(currentMembers, requestID)
-      if requestsInCurrentWindow == 0 then 
-        -- The first time this key is set, the value will be 1.
-        -- So we only need the expire command once
-        redis.call("PEXPIRE", currentKey, window * 2 + 1000) -- Enough time to overlap with a new window + 1 second
-      end
-      return {currentMembers, previousMembers}
-      `;
-        const windowDuration = (0, duration_js_1.ms)(window);
-        return async function (ctx, identifier) {
-            if (ctx.cache) {
-                const { blocked, reset } = ctx.cache.isBlocked(identifier);
-                if (blocked) {
-                    return {
-                        success: false,
-                        limit: tokens,
-                        remaining: 0,
-                        reset: reset,
-                        pending: Promise.resolve(),
-                    };
-                }
-            }
-            const requestID = dntShim.crypto.randomUUID();
-            const now = Date.now();
-            const currentWindow = Math.floor(now / windowSize);
-            const currentKey = [identifier, currentWindow].join(":");
-            const previousWindow = currentWindow - windowSize;
-            const previousKey = [identifier, previousWindow].join(":");
-            const dbs = ctx.redis.map((redis) => ({
-                redis,
-                request: redis.eval(script, [currentKey, previousKey], [tokens, now, windowDuration, requestID]),
-            }));
-            const percentageInCurrent = (now % windowDuration) / windowDuration;
-            const [current, previous] = await Promise.any(dbs.map((s) => s.request));
-            const usedTokens = previous.length * (1 - percentageInCurrent) +
-                current.length;
-            const remaining = tokens - usedTokens;
-            /**
-             * If a database differs from the consensus, we sync it
-             */
-            async function sync() {
-                const [individualIDs] = await Promise.all(dbs.map((s) => s.request));
-                const allIDs = Array.from(new Set(individualIDs.flatMap((_) => _)).values());
-                for (const db of dbs) {
-                    const [ids] = await db.request;
-                    /**
-                     * If the bucket in this db is already full, it doesn't matter which ids it contains.
-                     * So we do not have to sync.
-                     */
-                    if (ids.length >= tokens) {
-                        continue;
-                    }
-                    const diff = allIDs.filter((id) => !ids.includes(id));
-                    /**
-                     * Don't waste a request if there is nothing to send
-                     */
-                    if (diff.length === 0) {
-                        continue;
-                    }
-                    await db.redis.sadd(currentKey, ...allIDs);
-                }
-            }
-            const success = remaining > 0;
-            const reset = (currentWindow + 1) * windowDuration;
-            if (ctx.cache && !success) {
-                ctx.cache.blockUntil(identifier, reset);
-            }
-            return {
-                success,
-                limit: tokens,
-                remaining,
-                reset,
-                pending: sync(),
-            };
-        };
-    }
-}
-exports.MultiRegionRatelimit = MultiRegionRatelimit;

package/script/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/script/ratelimit.js

@@ -1,176 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ratelimit = exports.TimeoutError = void 0;
-const cache_js_1 = require("./cache.js");
-class TimeoutError extends Error {
-    constructor() {
-        super("Timeout");
-        this.name = "TimeoutError";
-    }
-}
-exports.TimeoutError = TimeoutError;
-/**
- * Ratelimiter using serverless redis from https://upstash.com/
- *
- * @example
- * ```ts
- * const { limit } = new Ratelimit({
- *    redis: Redis.fromEnv(),
- *    limiter: Ratelimit.slidingWindow(
- *      10,     // Allow 10 requests per window of 30 minutes
- *      "30 m", // interval of 30 minutes
- *    ),
- * })
- *
- * ```
- */
-class Ratelimit {
-    constructor(config) {
-        Object.defineProperty(this, "limiter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "ctx", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "prefix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "timeout", {
-            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.
-         *
-         * Use this if you want to reject all requests that you can not handle right now.
-         *
-         * @example
-         * ```ts
-         *  const ratelimit = new Ratelimit({
-         *    redis: Redis.fromEnv(),
-         *    limiter: Ratelimit.slidingWindow(10, "10 s")
-         *  })
-         *
-         *  const { success } = await ratelimit.limit(id)
-         *  if (!success){
-         *    return "Nope"
-         *  }
-         *  return "Yes"
-         * ```
-         */
-        Object.defineProperty(this, "limit", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: async (identifier) => {
-                const key = [this.prefix, identifier].join(":");
-                let timeoutId = null;
-                try {
-                    const arr = [this.limiter(this.ctx, key)];
-                    if (this.timeout) {
-                        arr.push(new Promise((resolve) => {
-                            timeoutId = setTimeout(() => {
-                                resolve({
-                                    success: true,
-                                    limit: 0,
-                                    remaining: 0,
-                                    reset: 0,
-                                    pending: Promise.resolve(),
-                                });
-                            }, this.timeout);
-                        }));
-                    }
-                    return await Promise.race(arr);
-                }
-                finally {
-                    if (timeoutId) {
-                        clearTimeout(timeoutId);
-                    }
-                }
-            }
-        });
-        /**
-         * Block until the request may pass or timeout is reached.
-         *
-         * This method returns a promsie that resolves as soon as the request may be processed
-         * or after the timeoue has been reached.
-         *
-         * Use this if you want to delay the request until it is ready to get processed.
-         *
-         * @example
-         * ```ts
-         *  const ratelimit = new Ratelimit({
-         *    redis: Redis.fromEnv(),
-         *    limiter: Ratelimit.slidingWindow(10, "10 s")
-         *  })
-         *
-         *  const { success } = await ratelimit.blockUntilReady(id, 60_000)
-         *  if (!success){
-         *    return "Nope"
-         *  }
-         *  return "Yes"
-         * ```
-         */
-        Object.defineProperty(this, "blockUntilReady", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: async (
-            /**
-             * An identifier per user or api.
-             * Choose a userID, or api token, or ip address.
-             *
-             * If you want to limit your api across all users, you can set a constant string.
-             */
-            identifier, 
-            /**
-             * Maximum duration to wait in milliseconds.
-             * After this time the request will be denied.
-             */
-            timeout) => {
-                if (timeout <= 0) {
-                    throw new Error("timeout must be positive");
-                }
-                let res;
-                const deadline = Date.now() + timeout;
-                while (true) {
-                    res = await this.limit(identifier);
-                    if (res.success) {
-                        break;
-                    }
-                    if (res.reset === 0) {
-                        throw new Error("This should not happen");
-                    }
-                    const wait = Math.min(res.reset, deadline) - Date.now();
-                    await new Promise((r) => setTimeout(r, wait));
-                    if (Date.now() > deadline) {
-                        break;
-                    }
-                }
-                return res;
-            }
-        });
-        this.ctx = config.ctx;
-        this.limiter = config.limiter;
-        this.timeout = config.timeout;
-        this.prefix = config.prefix ?? "@upstash/ratelimit";
-        if (config.ephemeralCache instanceof Map) {
-            this.ctx.cache = new cache_js_1.Cache(config.ephemeralCache);
-        }
-        else if (typeof config.ephemeralCache === "undefined") {
-            this.ctx.cache = new cache_js_1.Cache(new Map());
-        }
-    }
-}
-exports.Ratelimit = Ratelimit;