@crewhaus/rate-limiter 0.1.1 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewhaus/rate-limiter",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "description": "Multi-dimensional token-bucket / leaky-bucket rate limiter (per-tenant, per-provider, per-tool)",
   "main": "src/index.ts",
@@ -12,13 +12,13 @@
     "test": "bun test src"
   },
   "dependencies": {
-    "@crewhaus/errors": "0.1.1"
+    "@crewhaus/errors": "0.1.2"
   },
   "license": "Apache-2.0",
   "author": {
     "name": "Max Meier",
-    "email": "max@studiomax.io",
-    "url": "https://studiomax.io"
+    "email": "max@crewhaus.ai",
+    "url": "https://crewhaus.ai"
   },
   "repository": {
     "type": "git",
@@ -30,12 +30,7 @@
     "url": "https://github.com/crewhaus/factory/issues"
   },
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
-  "files": [
-    "src",
-    "README.md",
-    "LICENSE",
-    "NOTICE"
-  ]
+  "files": ["src", "README.md", "LICENSE", "NOTICE"]
 }

package/src/index.test.ts

@@ -11,6 +11,7 @@ import {
   RateLimitError,
   bucketKeyOf,
   createRateLimiter,
+  tokenBucketAvailable,
 } from "./index";
 
 describe("rate-limiter — T1 token-bucket", () => {
@@ -18,15 +19,19 @@ describe("rate-limiter — T1 token-bucket", () => {
     const buckets = new Map<string, BucketConfig>([
       ["tenant:t1", { kind: "token-bucket", capacity: 10, refillPerSec: 1 }],
     ]);
-    const rl = createRateLimiter({ buckets });
+    // Inject a frozen clock so the bucket's refill is computed against virtual
+    // time. With the real clock, the few ms between acquire and inspect refill
+    // a fraction of a token (1/sec), nudging `available` to ~5.05 — enough to
+    // trip the old toBeCloseTo(5, 1) 0.05 tolerance on loaded CI runners.
+    // Frozen time makes the post-acquire balance exactly 5, deterministically.
+    const nowMs = 1_000_000;
+    const rl = createRateLimiter({ buckets, now: (): number => nowMs });
     const t0 = Date.now();
     await rl.acquire([{ dimension: "tenant", id: "t1" }], 5);
-    // 250 ms threshold: "immediate" relative to the bucket's 1-token-per-second
-    // refill rate, while tolerating CI scheduler jitter (we saw 51 ms flakes
-    // against a 50 ms cap on shared GitHub runners).
+    // "immediate": acquiring below capacity must not block (real wall-clock).
     expect(Date.now() - t0).toBeLessThan(250);
     const inspect = rl.inspect({ dimension: "tenant", id: "t1" });
-    expect(inspect?.available).toBeCloseTo(5, 1);
+    expect(inspect?.available).toBe(5);
   });
 
   test("burst tolerance: capacity available immediately at start", async () => {
@@ -177,3 +182,30 @@ describe("rate-limiter — bucketKeyOf", () => {
     expect(bucketKeyOf(k)).toBe("provider:anthropic");
   });
 });
+
+describe("rate-limiter — tokenBucketAvailable static helper", () => {
+  const config: BucketConfig = { kind: "token-bucket", capacity: 10, refillPerSec: 1 };
+
+  test("returns true when enough tokens are present without refill", () => {
+    // Fresh state at full capacity, now == lastRefill so no time elapses.
+    const state = { tokens: 5, lastRefillMs: 1_000 };
+    expect(tokenBucketAvailable(state, 5, 1_000, config)).toBe(true);
+    // Pure capacity check must not mutate the balance when no time passes.
+    expect(state.tokens).toBe(5);
+  });
+
+  test("returns false when tokens are insufficient even after available refill", () => {
+    const state = { tokens: 0, lastRefillMs: 1_000 };
+    // 500ms later → 0.5 token refilled at 1/sec, still < cost of 5.
+    expect(tokenBucketAvailable(state, 5, 1_500, config)).toBe(false);
+    expect(state.tokens).toBeCloseTo(0.5, 5);
+  });
+
+  test("refills (and mutates state) based on elapsed virtual time before comparing", () => {
+    const state = { tokens: 0, lastRefillMs: 1_000 };
+    // 6s later at 1/sec → 6 tokens refilled, now >= cost of 5.
+    expect(tokenBucketAvailable(state, 5, 7_000, config)).toBe(true);
+    expect(state.tokens).toBeCloseTo(6, 5);
+    expect(state.lastRefillMs).toBe(7_000);
+  });
+});