@sproutboat/wire 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sproutboat/wire
 
+## 0.5.0
+
+### Minor Changes
+
+- Rate limiter (baronunread/sproutboat#69): `env.<NAME>.limit({ key })` now
+  returns `{ success, resetAt }`. `resetAt` is epoch milliseconds for when the
+  fixed window rolls and the counter clears, returned on every call (hit or
+  miss), so a rejection can carry an accurate `Retry-After`:
+  `Math.ceil((resetAt - Date.now()) / 1000)`. The `ratelimit.check` op already
+  had `windowStart` and `period` in hand; it just stopped discarding them.
+  Additive: existing callers reading only `success` are unaffected.
+
 ## 0.4.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sproutboat/wire",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "type": "module",
   "main": "./src/index.ts",

package/src/broker.test.ts

@@ -745,7 +745,11 @@ test("ratelimit: fixed window per key, limit/period from the message (#69)", asy
   expect((await hit("a")).success).toBe(true); // 1
   expect((await hit("a")).success).toBe(true); // 2
   expect((await hit("a")).success).toBe(true); // 3
-  expect((await hit("a")).success).toBe(false); // 4 — over
+  const over = await hit("a"); // 4 — over
+  expect(over.success).toBe(false);
+  // resetAt is epoch ms at the window edge, so it drives a Retry-After.
+  expect(over.resetAt).toBeGreaterThan(Date.now());
+  expect(over.resetAt).toBeLessThanOrEqual(Date.now() + 60_000);
   expect((await hit("b")).success).toBe(true); // a different key has its own count
 
   await expect(b.dispatch({ op: "ratelimit.check", name: "NOPE", key: "x", limit: 1, period: 60 })).rejects.toThrow(

package/src/broker.ts

@@ -612,7 +612,7 @@ export function createBroker(opts: BrokerOptions = {}): Broker {
               "window_start = ?3 RETURNING count",
           )
           .get(name, msg.key == null ? "" : str(msg.key), windowStart);
-        return { ok: true, success: (row?.count ?? 1) <= limit };
+        return { ok: true, success: (row?.count ?? 1) <= limit, resetAt: (windowStart + period) * 1000 };
       }
 
       case "r2.put": {