@sproutboat/runtime 0.12.0 → 0.12.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @sproutboat/runtime
 
+## 0.12.1
+
+### Patch Changes
+
+- ed9640a: Point Porffor patch diagnostics, runtime comments, and historical notes to the
+  shared upstream notes in the Sproutboat platform repository.
+
 ## 0.12.0
 
 ### Minor Changes
@@ -131,11 +138,11 @@
   
   Verified end-to-end against both transports (kitchen-sink's full conformance suite, 24/24 standalone + 27/27 broker) and with new unit tests for file-backed persistence, the `:memory:` fallback, and a real binary round-trip over the v1 wire protocol.
   
-  **Known limitation found while verifying this, not fixed here:** a binary `put()` body (bytes ≥ 0x80) is corrupted on the way *in*, before it ever reaches storage — `porf_native_fetch_read_value` (the function every inline-C string read in the runtime goes through) always UTF-8-encodes a Latin-1-range string on read, which is correct for genuine text but wrong for opaque bytes coming off a raw HTTP body. This predates this change (the old SQLite-blob path had the identical corruption) and is not something the storage backend can fix — it needs an input-side counterpart to `#176`'s `x-sb-raw-body` marker, or real `ArrayBuffer`/`Uint8Array` body support (the upstream ask already filed as Draft G in `patches/UPSTREAM.md`).
+  **Known limitation found while verifying this, not fixed here:** a binary `put()` body (bytes ≥ 0x80) is corrupted on the way *in*, before it ever reaches storage: `porf_native_fetch_read_value` (the function every inline-C string read in the runtime goes through) always UTF-8-encodes a Latin-1-range string on read, which is correct for genuine text but wrong for opaque bytes coming off a raw HTTP body. This predates this change (the old SQLite-blob path had the identical corruption) and is not something the storage backend can fix. It needs an input-side counterpart to `#176`'s `x-sb-raw-body` marker, or real `ArrayBuffer`/`Uint8Array` body support (the upstream ask was filed as Porffor #386 and later retracted; see `https://github.com/baronunread/sproutboat/blob/main/patches/upstream/request-body-report-386.md`).
 
 ### Patch Changes
 
-- 188d8e4: Fix (baronunread/sproutboat#184): a `put()` body (R2, both transports) with bytes ≥ 0x80 was corrupted on the way *in*, before storage — `porf_native_fetch_read_value` (the one function every inline-C string read in the runtime funnels through) always UTF-8-encodes a Latin-1-range value, correct for genuine text, wrong for opaque bytes off a raw HTTP upload. A 256-byte binary upload landed as 384 stored bytes.
+- 188d8e4: Fix (baronunread/sproutboat#184): a `put()` body (R2, both transports) with bytes ≥ 0x80 was corrupted on the way *in*, before storage: `porf_native_fetch_read_value` (the one function every inline-C string read in the runtime funnels through) always UTF-8-encodes a Latin-1-range value, correct for genuine text, wrong for opaque bytes off a raw HTTP upload. A 256-byte binary upload landed as 384 stored bytes.
   
   `__sbR2PutRaw` (embedded) and `__sbCallBin` (broker, the only caller that ever passes it a real body) now try `porf_native_fetch_read_raw_bytes` first, falling back to the normal encoding path only for a genuine multi-byte JS string (which isn't a "bytestring" and so isn't eligible for the raw read anyway). This predates the #56 storage change — the old SQLite-blob `put()` called the identical `read_value`, so it was equally corrupted; the existing R2 conformance check never caught it because it only ever exercises a plain ASCII string.
   

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sproutboat/runtime",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "license": "MIT",
   "type": "module",
   "repository": {

package/src/native-fetch-prelude.js

@@ -1,5 +1,5 @@
 // Prepended to every handler by tools/compile.ts, before Porffor's native-fetch
-// esbuild bundle. Porffor's runtime/fetch-globals.js (checked through alpha-4)
+// bundled handler. Porffor's runtime/fetch-globals.js (checked through alpha-4)
 // gives URL (href/origin/pathname/search only) and Response without a static
 // json(). This adds, additively, the rest of the WHATWG surface Worker code
 // expects: URLSearchParams (read + write), URL.prototype.searchParams and the
@@ -9,10 +9,12 @@
 // formData()/bytes() (#60). Each is feature-detected; delete a block once
 // Porffor ships that global. crypto.scryptVerify (#153) is a Sproutboat
 // extension, not WHATWG, and stays.
-// Tracked upstream in patches/UPSTREAM.md.
+// Tracked in the platform's upstream notes:
+// https://github.com/baronunread/sproutboat/blob/main/patches/upstream/whatwg-fetch-globals.md
 //
 // Declared before it is referenced: a getter body that names a later top-level
-// class throws ReferenceError in Porffor (see patches/UPSTREAM.md draft B).
+// class throws ReferenceError in Porffor. See:
+// https://github.com/baronunread/sproutboat/blob/main/patches/upstream/class-declaration-scope.md
 
 // Duck-typing helpers, `typeof`-free (the repo's anti-slop lint bans `typeof`;
 // these express the same spec-mandated checks and are verified under Porffor
@@ -386,7 +388,8 @@ if (!("bytes" in Response.prototype)) {
 // Porffor's URL exposes href / origin / pathname / search only. Add the rest of
 // the WHATWG read surface, derived from `origin` (scheme://host[:port]).
 // `hash` is always '' server-side — browsers strip the fragment before the
-// request, so there is nothing to recover. Tracked upstream (patches/UPSTREAM.md).
+// request, so there is nothing to recover. See:
+// https://github.com/baronunread/sproutboat/blob/main/patches/upstream/whatwg-fetch-globals.md
 function __sbDefineURLAccessor(name, get) {
   if (!(name in URL.prototype)) Object.defineProperty(URL.prototype, name, { configurable: true, get });
 }
@@ -1816,7 +1819,8 @@ function __sbTriggerAuthed(request) {
 // #163 — the connection's remote address, for `request.cf.clientIp`.
 //
 // `x-sb-remote-addr` is the TCP peer, appended by the server (see
-// patches/UPSTREAM.md #163) and stripped from anything a client sends, so it
+// https://github.com/baronunread/sproutboat/blob/main/patches/upstream/remote-address.md)
+// and stripped from anything a client sends, so it
 // cannot be forged. With no proxy in front, that is the client. Behind one, set
 // `SB_TRUSTED_PROXIES` to a comma-separated list of trusted CIDRs (or bare IPs):
 // when the peer is trusted, the client is the rightmost `x-forwarded-for` entry

package/test/native-crypto.ts

@@ -1,7 +1,7 @@
 import assert from "node:assert/strict";
 import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
+import { join, resolve } from "node:path";
 import { ensurePorffor } from "../../toolchain/src/acquire";
 import { preludePath, TRANSPORT_MARKER, transportPath, wrapNativeFetchHandler } from "../src/wrap";
 
@@ -18,6 +18,7 @@ const expected = {
 };
 
 const handler = `
+import { keyBytes } from "./crypto-helper.js";
 const hex = (buffer) => {
   const bytes = new Uint8Array(buffer);
   let out = "";
@@ -28,7 +29,7 @@ export default {
   async fetch() {
     const key = await crypto.subtle.importKey(
       "raw",
-      new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]),
+      keyBytes(),
       { name: "HMAC", hash: "SHA-256" },
       false,
       ["sign"],
@@ -67,9 +68,8 @@ const workdir = await mkdtemp(join(tmpdir(), "sb-native-crypto-"));
 let server: ReturnType<typeof Bun.spawn> | undefined;
 try {
   const porffor = await ensurePorffor({ cacheRoot: workdir });
-  const esbuild = Bun.which("esbuild");
   const node = Bun.which("node");
-  if (!esbuild || !node) throw new Error("native crypto test needs esbuild and node on PATH");
+  if (!node) throw new Error("native crypto test needs node on PATH");
 
   const [core, broker] = await Promise.all([
     readFile(preludePath, "utf8"),
@@ -79,12 +79,15 @@ try {
   const prelude = core.replace(TRANSPORT_MARKER, broker);
   const generated = join(workdir, "crypto.generated.js");
   const binary = join(workdir, "crypto-native");
+  // This is a direct ESM import into Porffor, with no bundler in front of it.
+  await writeFile(join(workdir, "crypto-helper.js"),
+    "export const keyBytes = () => Uint8Array.from({ length: 16 }, (_, index) => index + 1);\n");
   await writeFile(generated, wrapNativeFetchHandler(handler, prelude));
   await rm(binary, { force: true });
 
   const compile = Bun.spawn([node, resolve(porffor, "runtime/index.js"), "native", generated, "-o", binary, "-s", "-O0"], {
     cwd: workdir,
-    env: { ...process.env, PATH: `${dirname(esbuild)}:${process.env.PATH ?? ""}` },
+    env: process.env,
     stdout: "pipe",
     stderr: "pipe",
   });