Fix linting and add note to readme

Author: maxmcd

.github/workflows/ci.yaml

@@ -11,6 +11,8 @@ jobs:
         node-version: [22.x, 24.x]
         deno-version: [1.40.x]
     runs-on: ${{ matrix.os }}
+    env:
+      CI: true
     steps:
       - uses: actions/checkout@v5
       - name: Use Node.js ${{ matrix.node-version }}
@@ -23,13 +25,9 @@ jobs:
           deno-version: ${{ matrix.deno-version }}
       - name: npm install
         run: npm ci
-        env:
-          CI: true
       - name: prepare
         run: npm run prepare
-        env:
-          CI: true
+      - name: lint
+        run: npm run lint
       - name: vitest
         run: npm run test
-        env:
-          CI: true

README.md

@@ -2,37 +2,52 @@
 
 [![NPM version](https://img.shields.io/npm/v/deno-http-worker.svg?style=flat)](https://npmjs.org/package/deno-http-worker)
 
-Similarly to [deno-vm](https://github.com/casual-simulation/node-deno-vm), deno-http-worker lets you securely spawn Deno http servers.
+Similarly to [deno-vm](https://github.com/casual-simulation/node-deno-vm),
+deno-http-worker lets you securely spawn Deno http servers.
 
 ## Usage
 
 ```ts
-import { newDenoHTTPWorker } from 'deno-http-worker';
+import { newDenoHTTPWorker } from "deno-http-worker";
 
 let worker = await newDenoHTTPWorker(
     `export default {
         async fetch(req: Request): Promise<Response> {
             return Response.json({ ok: req.url });
         },
     }`,
-    { printOutput: true, runFlags: ["--allow-net"] }
+    { printOutput: true, runFlags: ["--allow-net"] },
 );
 
 const req = await worker.request({
     url: "https://hello/world?query=param",
-    method: "GET"
-})
-const body = await req.body.json()
+    method: "GET",
+});
+const body = await req.body.json();
 
-console.log(body) // => {"ok":"https://hello/world?query=param"}
+console.log(body); // => {"ok":"https://hello/world?query=param"}
 
 worker.terminate();
 ```
 
 ## Internals
 
-Deno-http-worker connects to the Deno process over a Unix socket via undici to make requests.  As a result, the worker does not provide an address or url, but instead returns `undici.ResponseData` that uses `undici.Pool.request` under the hood, but modifies the request attributes to work over the socket, and we expose parts of [request and response interface](./src/types.ts).
-
-You can also connect to the Deno process over a WebSocket connection, which uses the same `undici.Pool`. We modify the inbound Request objects to preserve various headers. Unfortunately Deno doesn't let you copy a request and then modify properties, so we patch `Deno.upgradeWebSocket` when you use the WebSockets functionality to use the original request for the upgrade, which may be slightly different.
-
-If you need more advanced usage here, or run into bugs, please open an issue.
+> [!TIP]
+> This package globally patches Deno.upgradeWebSocket to enable websocket
+> proxying. You can provide your own bootstrap script if different behavior is
+> desired.
+
+Deno-http-worker connects to the Deno process over a Unix socket via undici to
+make requests. As a result, the worker does not provide an address or url, but
+instead returns `undici.ResponseData` that uses `undici.Pool.request` under the
+hood, but modifies the request attributes to work over the socket, and we expose
+parts of [request and response interface](./src/types.ts).
+
+You can also connect to the Deno process over a WebSocket connection, which uses
+the same `undici.Pool`. We modify the inbound Request objects to preserve
+various headers. Unfortunately Deno doesn't let you copy a request and then
+modify properties, so we patch `Deno.upgradeWebSocket` when you use the
+WebSockets functionality to use the original request for the upgrade, which may
+be slightly different.
+
+If you need more advanced usage here, or run into bugs, please open an issue.

biome.json

@@ -5,7 +5,7 @@
     "indentStyle": "space"
   },
   "files": {
-    "includes": ["**", "!**/dist"]
+    "includes": ["**", "!**/dist", "!**/deno-bootstrap", "!**/src/test"]
   },
   "assist": { "actions": { "source": { "organizeImports": "off" } } },
   "linter": {

deno-bootstrap/index.ts

@@ -1,17 +1,10 @@
-declare global {
-  interface Request {
-    [originalRequestProp]: Request;
-  }
-}
-
 const socketFile = Deno.args[0];
 const scriptType = Deno.args[1];
 const script = Deno.args[2];
 
-const importURL =
-  scriptType === "import"
-    ? script
-    : `data:text/tsx,${encodeURIComponent(script)}`;
+const importURL = scriptType === "import"
+  ? script
+  : `data:text/tsx,${encodeURIComponent(script)}`;
 
 const mod = await import(importURL);
 if (!mod.default) {
@@ -21,13 +14,12 @@ if (typeof mod.default.fetch !== "function") {
   throw new Error("Default export does not have a fetch function.");
 }
 
-const onError =
-  mod.default.onError ??
+const onError = mod.default.onError ??
   ((error: unknown) => {
     console.error(error);
     return new Response("Internal Server Error", { status: 500 });
   });
-const onListen = mod.default.onListen ?? ((_localAddr: Deno.NetAddr) => { });
+const onListen = mod.default.onListen ?? ((_localAddr: Deno.NetAddr) => {});
 
 const originalRequestProp = Symbol("originalRequest");
 
@@ -36,7 +28,11 @@ const originalRequestProp = Symbol("originalRequest");
 const originalUpgrade = Deno.upgradeWebSocket;
 Object.defineProperty(Deno, "upgradeWebSocket", {
   value: (req: Request) => {
-    return originalUpgrade(req[originalRequestProp]);
+    return originalUpgrade(
+      (req as unknown as { [originalRequestProp]: Request })[
+        originalRequestProp
+      ],
+    );
   },
 });
 
@@ -62,7 +58,9 @@ const server = Deno.serve(
     const req = new Request(url.toString(), originalReq);
 
     // Add the original request so that we can use it during Deno.upgradeWebSocket
-    req[originalRequestProp] = originalReq;
+    (req as unknown as { [originalRequestProp]: Request })[
+      originalRequestProp
+    ] = originalReq;
 
     // Restore host and connection headers.
     req.headers.delete("host");
@@ -74,7 +72,7 @@ const server = Deno.serve(
     if (req.headers.has("X-Deno-Worker-Connection")) {
       req.headers.set(
         "connection",
-        req.headers.get("X-Deno-Worker-Connection")!
+        req.headers.get("X-Deno-Worker-Connection")!,
       );
     }
 
@@ -83,7 +81,7 @@ const server = Deno.serve(
     req.headers.delete("X-Deno-Worker-Connection");
 
     return mod.default.fetch(req);
-  }
+  },
 );
 
 addEventListener("error", (e) => {

package.json

@@ -7,9 +7,9 @@
   "scripts": {
     "test": "vitest run",
     "test:watch": "vitest",
-    "lint": "eslint . && npm run lint:deno-bootstrap && npm run lint:deno-test-files",
-    "lint:deno-bootstrap": "cd deno-bootstrap && deno lint",
-    "lint:deno-test-files": "cd src/test && deno lint",
+    "lint": "biome check && eslint . && npm run lint:deno-bootstrap && npm run lint:deno-test-files",
+    "lint:deno-bootstrap": "cd deno-bootstrap && deno lint && deno fmt --check && deno check",
+    "lint:deno-test-files": "cd src/test && deno lint && deno fmt --check && deno check",
     "build": "tsc --build",
     "prepare": "npm run lint && npm run build"
   },

src/DenoHTTPWorker.test.ts

@@ -182,9 +182,9 @@ describe("DenoHTTPWorker", { timeout: 1000 }, () => {
     );
     jsonRequest(worker, "https://localhost/hello?isee=you", {
       headers: { accept: "application/json" },
-    }).catch(() => { });
+    }).catch(() => {});
 
-    for (; ;) {
+    for (;;) {
       const stderr = worker.stderr.read();
       if (stderr) {
         expect(stderr.toString()).toContain("Error: uncaught!");
@@ -210,9 +210,9 @@ describe("DenoHTTPWorker", { timeout: 1000 }, () => {
     );
     jsonRequest(worker, "https://localhost/hello?isee=you", {
       headers: { accept: "application/json" },
-    }).catch(() => { });
+    }).catch(() => {});
 
-    for (; ;) {
+    for (;;) {
       const stderr = worker.stderr.read();
       if (stderr) {
         expect(stderr.toString()).toContain("Error: uncaught!");
@@ -246,11 +246,11 @@ describe("DenoHTTPWorker", { timeout: 1000 }, () => {
       });
     });
     const json = await jsonRequest(worker, "https://localhost/hello?isee=you");
-    console.log(json)
+    console.log(json);
     expect(json).toEqual({
       ok: "https://localhost/hello?isee=you",
     });
-    console.log("OKK")
+    console.log("OKK");
     void worker.shutdown();
     await exitPromise;
   });
@@ -422,12 +422,16 @@ describe("DenoHTTPWorker", { timeout: 1000 }, () => {
   });
 
   it("can upgrade websocket", async () => {
-    const webSocketScriptStr = fs.readFileSync(echoWebsocketFile, { encoding: "utf-8" });
-    const worker = await newDenoHTTPWorker(webSocketScriptStr, { printOutput: true });
+    const webSocketScriptStr = fs.readFileSync(echoWebsocketFile, {
+      encoding: "utf-8",
+    });
+    const worker = await newDenoHTTPWorker(webSocketScriptStr, {
+      printOutput: true,
+    });
 
     const messages: string[] = [];
     const ws = await worker.websocket("ws://localhost/echo");
-    const event = await new Promise<Event>(res => {
+    const event = await new Promise<Event>((res) => {
       ws.addEventListener("open", (event) => {
         console.log("WebSocket connection opened");
         ws.send("message1");
@@ -458,8 +462,12 @@ describe("DenoHTTPWorker", { timeout: 1000 }, () => {
   });
 
   it("can upgrade many websockets at the same time, and identify them uniquely", async () => {
-    const webSocketScriptStr = fs.readFileSync(echoWebsocketFile, { encoding: "utf-8" });
-    const worker = await newDenoHTTPWorker(webSocketScriptStr, { printOutput: true });
+    const webSocketScriptStr = fs.readFileSync(echoWebsocketFile, {
+      encoding: "utf-8",
+    });
+    const worker = await newDenoHTTPWorker(webSocketScriptStr, {
+      printOutput: true,
+    });
 
     const ws1 = await worker.websocket("ws://localhost/echo");
     const ws2 = await worker.websocket("ws://localhost/echo");
@@ -497,5 +505,5 @@ describe("DenoHTTPWorker", { timeout: 1000 }, () => {
     );
 
     await worker.terminate();
-  } );
+  });
 });