@sproutboat/wire 0.15.0 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @sproutboat/wire
 
+## 0.16.0
+
+### Minor Changes
+
+- 9be9c74: R2 matches workerd from compatibility date `2026-10-26`:
+  
+  - `get`, `put`, `head`, `delete`, `list` and `createMultipartUpload` return Promises, and errors reject them.
+  - An object's `etag` is the MD5 of its bytes, with `checksums.md5`. Objects written before keep their old etag.
+  - Objects have `uploaded` as a `Date`, `version`, `storageClass`, `range` and `writeHttpMetadata(headers)`. A body has `body` (a `ReadableStream`), `bodyUsed`, `text()`, `json()`, `arrayBuffer()` and `blob()`.
+  - `get(key, { range, onlyIf })` takes `{ offset, length }`, `{ suffix }` or a `Range` header, and `etagMatches`, `etagDoesNotMatch`, `uploadedBefore`, `uploadedAfter` or `If-*` headers. When the condition fails it returns the object without a body.
+  - `put(key, value, { onlyIf, httpMetadata })` takes a `ReadableStream` or a `Blob`, and `httpMetadata` as `Headers`. When the condition fails it returns `null`.
+  - `delete([keys])` deletes several keys.
+  - `list({ prefix, limit, cursor, delimiter, include })` pages at up to 1,000 entries, groups keys into `delimitedPrefixes`, and returns `httpMetadata` and `customMetadata` only when `include` asks for them.
+  - A value of the wrong type and a key longer than 1,024 bytes fail with R2's errors.
+  
+  Earlier dates keep the synchronous shim. One change applies at every date: **a `list()` prefix now matches exactly.** It used SQL `LIKE`, so it ignored case and read `_` and `%` as wildcards. Both transports store an object's MD5 in a new column, added to existing stores when they open.
+  
+  Against miniflare 4.20260730, `conformance/bindings/r2.js` in sproutd passes 48/48 at `2026-10-26` (16/48 before).
+
+### Patch Changes
+
+- Updated dependencies [9be9c74]
+  - @sproutboat/runtime@0.27.0
+
 ## 0.15.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sproutboat/wire",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -23,6 +23,6 @@
   },
   "dependencies": {
     "@sproutboat/assets": "^0.3.0",
-    "@sproutboat/runtime": "^0.26.0"
+    "@sproutboat/runtime": "^0.27.0"
   }
 }

package/src/broker.test.ts

@@ -424,6 +424,28 @@ test("R2: put / get / head / list / delete on a bound bucket", async () => {
   await expect(b.dispatch({ op: "r2.put", bucket: "NOPE", key: "x", body: "y" })).rejects.toThrow("not bound");
 });
 
+test("R2: exact list prefix at every date; md5, paged list and delimiter for the shim from 2026-10-26", async () => {
+  const b = make({ bindings: { r2: ["ASSETS"] } });
+  for (const key of ["a_x", "ab", "AB", "d/1", "d/2", "e/1", "f"]) await b.dispatch({ op: "r2.put", bucket: "ASSETS", key, body: "v" });
+  // LIKE listed "ab" for "a_" and "AB" for "a".
+  expect(arr((await b.dispatch({ op: "r2.list", bucket: "ASSETS", prefix: "a_" })).objects).map((o) => obj(o).key)).toEqual(["a_x"]);
+  expect(arr((await b.dispatch({ op: "r2.list", bucket: "ASSETS", prefix: "a" })).objects).map((o) => obj(o).key)).toEqual(["a_x", "ab"]);
+  const put = await b.dispatch({ op: "r2.put", bucket: "ASSETS", key: "m", body: "hello" });
+  await b.dispatch({ op: "r2.md5", bucket: "ASSETS", key: "m", etag: obj(put.object).etag, md5: "5d41402abc4b2a76b9719d911017c592" });
+  expect(obj((await b.dispatch({ op: "r2.head", bucket: "ASSETS", key: "m" })).object).md5).toBe("5d41402abc4b2a76b9719d911017c592");
+  // A stale etag (the object was written again since) records nothing.
+  await b.dispatch({ op: "r2.md5", bucket: "ASSETS", key: "m", etag: "stale", md5: "x" });
+  expect(obj((await b.dispatch({ op: "r2.head", bucket: "ASSETS", key: "m" })).object).md5).toBe("5d41402abc4b2a76b9719d911017c592");
+  const page = (cursor: string) => b.dispatch({ op: "r2.list", bucket: "ASSETS", page: true, prefix: "", cursor, limit: 3, delimiter: "/" });
+  const first = await page("");
+  expect(arr(first.objects).map((o) => obj(o).key)).toEqual(["AB", "a_x", "ab"]);
+  expect(first).toMatchObject({ truncated: true, cursor: "ab", delimitedPrefixes: [] });
+  const second = await page("ab");
+  expect(arr(second.objects).map((o) => obj(o).key)).toEqual(["f"]);
+  expect(second).toMatchObject({ truncated: true, delimitedPrefixes: ["d/", "e/"] });
+  expect(await page(String(second.cursor))).toMatchObject({ objects: [{ key: "m" }], truncated: false, cursor: "" });
+});
+
 test("R2 direct transfer: streamed upload, metadata, one-use ticket and ranged download", async () => {
   const root = mkdtempSync(join(tmpdir(), "sb-r2-transfer-"));
   try {

package/src/broker.ts

@@ -150,6 +150,7 @@ type R2Row = {
   http_json: string;
   custom_json: string;
   blob_id: string | null;
+  md5?: string | null;
 };
 type R2UploadRow = {
   key: string;
@@ -317,6 +318,8 @@ export function createBroker(opts: BrokerOptions = {}): Broker {
     );
     const r2Columns = conn.query<{ name: string }, []>("PRAGMA table_info(r2)").all();
     if (!r2Columns.some((column) => column.name === "blob_id")) conn.exec("ALTER TABLE r2 ADD COLUMN blob_id TEXT");
+    // The MD5 of an object's bytes, its etag from compatibility date 2026-10-26 (r2.md5).
+    if (!r2Columns.some((column) => column.name === "md5")) conn.exec("ALTER TABLE r2 ADD COLUMN md5 TEXT");
     conn.exec(
       "CREATE TABLE IF NOT EXISTS r2_upload (bucket TEXT NOT NULL, key TEXT NOT NULL, upload_id TEXT NOT NULL, " +
         "uploaded TEXT NOT NULL, http_json TEXT NOT NULL DEFAULT '{}', custom_json TEXT NOT NULL DEFAULT '{}', " +
@@ -1095,6 +1098,38 @@ export function createBroker(opts: BrokerOptions = {}): Broker {
     return r2Row(row);
   };
 
+  // One page of r2.list for the shim from 2026-10-26: at most LIMIT entries after CURSOR,
+  // keys under PREFIX, those holding DELIMITER after it grouped into delimitedPrefixes (a
+  // group counts as one entry). Same rules as the embedded transport's __sbR2ListPage.
+  // ponytail: with a delimiter every key after the cursor is read; an index on the
+  // delimited prefix if buckets grow past ~100k keys.
+  const r2ListPage = (store: Database, bucket: string, prefix: string, cursor: string, limit: number, delimiter: string) => {
+    const rows = store
+      .query<R2Row, [string, string, string]>(
+        "SELECT * FROM r2 WHERE bucket = ?1 AND substr(key, 1, length(?2)) = ?2 AND key > ?3 ORDER BY key" +
+          (delimiter ? "" : ` LIMIT ${limit + 1}`),
+      )
+      .all(bucket, prefix, cursor);
+    const objects: ReturnType<typeof r2Row>[] = [];
+    const delimitedPrefixes: string[] = [];
+    let last = "";
+    let truncated = false;
+    for (const row of rows) {
+      const at = delimiter ? row.key.indexOf(delimiter, prefix.length) : -1;
+      const group = at < 0 ? "" : row.key.slice(0, at + delimiter.length);
+      if (!group || delimitedPrefixes[delimitedPrefixes.length - 1] !== group) {
+        if (objects.length + delimitedPrefixes.length >= limit) {
+          truncated = true;
+          break;
+        }
+        if (group) delimitedPrefixes.push(group);
+        else objects.push(r2Row(row));
+      }
+      last = row.key;
+    }
+    return { ok: true, objects, delimitedPrefixes, truncated, cursor: truncated ? last : "" };
+  };
+
   const r2Row = (r: R2Row) => ({
     key: r.key,
     size: r.size,
@@ -1102,6 +1137,7 @@ export function createBroker(opts: BrokerOptions = {}): Broker {
     uploaded: r.uploaded,
     httpMetadata: parseJsonValue(r.http_json),
     customMetadata: parseJsonValue(r.custom_json),
+    md5: r.md5 ?? null,
   });
 
   /**
@@ -1543,14 +1579,22 @@ export function createBroker(opts: BrokerOptions = {}): Broker {
         if (row) r2DeleteBlob(store, bucket, key, row.blob_id);
         return { ok: true };
       }
+      case "r2.md5": {
+        // Recorded after the put that wrote these bytes (etag): the shim from 2026-10-26 hashes them.
+        const { store, part: bucket } = storeFor("r2", requireR2(msg.bucket));
+        store.query("UPDATE r2 SET md5 = ?1 WHERE bucket = ?2 AND key = ?3 AND etag = ?4").run(str(msg.md5), bucket, str(msg.key), str(msg.etag));
+        return { ok: true };
+      }
       case "r2.list": {
+        // The prefix matches exactly at every date: LIKE ignored case and read "_" and "%" as wildcards.
         const { store, part: bucket } = storeFor("r2", requireR2(msg.bucket));
         const prefix = str(msg.prefix);
         const cursor = str(msg.cursor);
-        const limit = Math.min(Math.max(Number(msg.limit) || 1000, 1), 1000);
+        const limit = Math.min(Math.max(Math.floor(Number(msg.limit)) || 1000, 1), 1000);
+        if (msg.page === true) return r2ListPage(store, bucket, prefix, cursor, limit, str(msg.delimiter));
         const rows = store
           .query<R2Row, [string, string, string, number]>(
-            "SELECT * FROM r2 WHERE bucket = ? AND key LIKE ? || '%' AND key > ? ORDER BY key LIMIT ?",
+            "SELECT * FROM r2 WHERE bucket = ?1 AND substr(key, 1, length(?2)) = ?2 AND key > ?3 ORDER BY key LIMIT ?4",
           )
           .all(bucket, prefix, cursor, limit + 1);
         const truncated = rows.length > limit;
@@ -1876,6 +1920,7 @@ export function createBroker(opts: BrokerOptions = {}): Broker {
     "r2.multipart.abort",
     "r2.transfer.create",
     "r2.delete",
+    "r2.md5",
     "do.storage.put",
     "do.storage.delete",
     "do.storage.delete_all",