@sproutboat/runtime 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sproutboat/runtime
 
+## 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/runtime",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "type": "module",
   "main": "./src/index.ts",

package/src/native-fetch-prelude.js

@@ -1106,9 +1106,11 @@ globalThis.__sbInstallBindings = function (target, bindings) {
     target[b.binding] = __sbMakeDONamespace(b.binding, b.className);
   }
 
-  // #69 — env.<NAME>.limit({ key }) -> { success }. Fixed window: at most
-  // `limit` calls per `period` seconds for a given key. limit/period travel in
-  // the message so the op stays stateless (the transport has no config).
+  // #69 — env.<NAME>.limit({ key }) -> { success, resetAt }. Fixed window: at
+  // most `limit` calls per `period` seconds for a given key. limit/period
+  // travel in the message so the op stays stateless (the transport has no
+  // config). `resetAt` is epoch ms when the window rolls and the count clears,
+  // so a 429 can send `Retry-After: ceil((resetAt - Date.now()) / 1000)`.
   // Returns sync like the other shims (CF's is a Promise; the runtime is sync).
   for (let i = 0; i < (bindings.ratelimiters || []).length; i++) {
     const rl = bindings.ratelimiters[i];
@@ -1116,7 +1118,7 @@ globalThis.__sbInstallBindings = function (target, bindings) {
       limit(options) {
         const key = options && options.key != null ? String(options.key) : "";
         const r = __sbRpc("ratelimit.check", { name: rl.binding, key, limit: rl.limit, period: rl.period });
-        return { success: !!r.success };
+        return { success: !!r.success, resetAt: Number(r.resetAt) || 0 };
       },
     };
   }

package/src/transport-embedded.js

@@ -1539,7 +1539,7 @@ function __sbEmbeddedDispatch(msg) {
       [String(msg.name), String(msg.key == null ? "" : msg.key), windowStart],
     );
     const count = r.rows.length ? Number(r.rows[0][0]) : 1;
-    return { ok: true, success: count <= limit };
+    return { ok: true, success: count <= limit, resetAt: (windowStart + period) * 1000 };
   }
 
   throw new Error("unknown op: " + op);