buninu-browser 0.0.2 → 0.1.0

package/THIRD_PARTY_NOTICES.md

@@ -68,8 +68,10 @@ unmodified; its SHA-256 is
   `vendor/wasmpeg/source-v1.0.1.tar.gz`, mirrored from
   https://github.com/wasmpeg/wasmpeg/tree/v1.0.1
 
-The JavaScript sources, `cpu.js`, and `cpu.wasm` are copied without modification
-from the published CPU npm package. `cpu.wasm` is a separate file that users
+`cpu.js` and `cpu.wasm` are copied without modification from the published CPU
+npm package. The JavaScript sources are copied from it with the local changes
+recorded in [`patches/wasmpeg/`](patches/wasmpeg/README.md): one line of
+`src/js/gpu.js`, so the WASM path also resolves on Windows. `cpu.wasm` is a separate file that users
 can replace. The exact artifact hashes, source download, and rebuild command
 are in [`vendor/wasmpeg/VENDORING.md`](vendor/wasmpeg/VENDORING.md).
 

package/lib/renderer/host.js

@@ -33,7 +33,8 @@ const COMPOSITOR_TIMEOUT = 10_000;
 const MAX_CHANNEL_LINE = 96 * 1024 * 1024;
 const LIFECYCLE_NAMES = new Set(["DOMContentLoaded", "load"]);
 
-const DEFAULT_ENTRY = new URL("./main.js", import.meta.url).pathname;
+// A file path, not a URL's pathname ("/C:/..." on Windows).
+const DEFAULT_ENTRY = Bun.fileURLToPath(new URL("./main.js", import.meta.url));
 
 export class RendererHost {
   #entry;
@@ -78,7 +79,10 @@ export class RendererHost {
   constructor({
     entry = DEFAULT_ENTRY, args = [], timeout = 30_000, onRestart = null, onNavigate = null, fetch: fetchImpl = fetch,
     network = new NetworkService({ fetch: fetchImpl }), onFrame = null, onLifecycle = null,
-    compositor = entry === DEFAULT_ENTRY,
+    // The compositor's channel is an extra stdio pipe used as fd 3, which
+    // Windows does not have (Bun hands out libuv pipes there, not file
+    // descriptors): there the main thread answers screenshots and scrolling.
+    compositor = entry === DEFAULT_ENTRY && process.platform !== "win32",
   } = {}) {
     this.#onFrame = onFrame;
     this.#onLifecycle = onLifecycle;
@@ -106,7 +110,8 @@ export class RendererHost {
       cmd: [process.execPath, this.#entry, ...this.#args,
         ...(logging ? [RENDERER_LOG_FLAG] : []), ...(compositor ? [COMPOSITOR_FLAG] : [])],
       // No inherited environment: nothing from the controller leaks in.
-      env: {},
+      // Windows programs need SystemRoot to load system libraries.
+      env: process.platform === "win32" && process.env.SystemRoot ? { SystemRoot: process.env.SystemRoot } : {},
       // With BUNINU_LOG, output goes through the controller into the log file.
       // fd 3 is a socket to the renderer's compositor thread.
       stdio: ["ignore", logging ? "pipe" : "inherit", logging ? "pipe" : "inherit", ...(compositor ? ["pipe"] : [])],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "buninu-browser",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Buninu Browser is a browser engine written in JavaScript and WebAssembly for Bun.",
   "keywords": [
     "buninu",

package/patches/wasmpeg/0001-windows-wasm-path.patch

@@ -0,0 +1,14 @@
+diff --git a/src/js/gpu.js b/src/js/gpu.js
+index 2bb56f8..a9f4dc6 100644
+--- a/src/js/gpu.js
++++ b/src/js/gpu.js
+@@ -51,7 +51,8 @@ async function instantiate(path) {
+     let nodeOpts = {};
+     if (isNode) {
+         const { default: fsMod } = await import('node:fs');
+-        nodeOpts = { wasmBinary: fsMod.readFileSync(new URL(path).pathname.replace(/\.js$/, '.wasm')) };
++        const { fileURLToPath } = await import('node:url');
++        nodeOpts = { wasmBinary: fsMod.readFileSync(fileURLToPath(path).replace(/\.js$/, '.wasm')) };
+     }
+     const { default: factory } = await import(/* @vite-ignore */ path);
+     return factory({

package/patches/wasmpeg/README.md

@@ -0,0 +1,28 @@
+# wasmpeg patch queue
+
+The vendored wasmpeg JavaScript is the `@wasmpeg/cpu` 1.0.1 npm release, which
+matches upstream tag `v1.0.1`, commit `173b41e30f4dd21d15f4e564c3ad26cba5d89d80`:
+
+- Upstream: <https://github.com/wasmpeg/wasmpeg>
+- Vendored tree: `vendor/wasmpeg`
+- Patch paths are relative to the root of the npm package (`vendor/wasmpeg`).
+
+The patches change only wasmpeg's JavaScript loader; `dist/cpu.js` and
+`dist/cpu.wasm` (FFmpeg) are the published files, unmodified.
+
+For the already-patched vendored tree, verify that the recorded patch can be
+removed cleanly without changing files:
+
+```sh
+git -C vendor/wasmpeg apply --reverse --check ../../patches/wasmpeg/0001-windows-wasm-path.patch
+```
+
+## Patch manifest
+
+| Patch | Modified upstream file | Reason | Verification |
+|---|---|---|---|
+| `0001-windows-wasm-path.patch` | `src/js/gpu.js` | Read `cpu.wasm` from `fileURLToPath(path)` instead of `new URL(path).pathname`, which is `/C:/...` on Windows and not a file path there. | `bun test test/page-scripts.test.js` (every renderer start loads the decoder) |
+
+Keep each local change in a separate numbered patch and add it to this table
+with its reason and focused test. When updating wasmpeg, re-check the queue
+against the new release and update `vendor/wasmpeg/VENDORING.md`.

package/vendor/wasmpeg/VENDORING.md

@@ -1,7 +1,10 @@
 # Vendored wasmpeg CPU 1.0.1
 
-This directory contains the unmodified JavaScript and CPU WebAssembly files
-from the `@wasmpeg/cpu` 1.0.1 npm release. It also keeps the release's LGPL
+This directory contains the JavaScript and CPU WebAssembly files from the
+`@wasmpeg/cpu` 1.0.1 npm release. The WebAssembly and `dist/cpu.js` are
+unmodified; the JavaScript loader carries the local patches recorded in
+[`patches/wasmpeg/`](../../patches/wasmpeg/README.md) (currently one line in
+`src/js/gpu.js`, so the WASM path works on Windows). It also keeps the release's LGPL
 license and FFmpeg notice. Buninu Browser loads only `src/js/index.js` and
 `dist/cpu.js`/`dist/cpu.wasm`; no native media bindings are used.
 
@@ -12,7 +15,8 @@ license files, and build scripts. It is a `git archive` of upstream tag
 `173b41e30f4dd21d15f4e564c3ad26cba5d89d80`.
 The source archive includes FFmpeg's optional GPL files; the shipped CPU
 binary is the upstream LGPL preset and does not link those optional codecs.
-The vendored `src/js` files match that tag byte for byte. Upstream's CPU LGPL
+The vendored `src/js` files match that tag byte for byte apart from those
+patches. Upstream's CPU LGPL
 build command is `PRESET=lgpl TARGET=cpu bash scripts/build.sh`, after setting
 up Emscripten SDK 6.0.8 as described by its build instructions. This repository
 distributes the published binary rather than rebuilding it.

package/vendor/wasmpeg/src/js/gpu.js

@@ -51,7 +51,8 @@ async function instantiate(path) {
     let nodeOpts = {};
     if (isNode) {
         const { default: fsMod } = await import('node:fs');
-        nodeOpts = { wasmBinary: fsMod.readFileSync(new URL(path).pathname.replace(/\.js$/, '.wasm')) };
+        const { fileURLToPath } = await import('node:url');
+        nodeOpts = { wasmBinary: fsMod.readFileSync(fileURLToPath(path).replace(/\.js$/, '.wasm')) };
     }
     const { default: factory } = await import(/* @vite-ignore */ path);
     return factory({