@hono/node-server 0.3.0 → 0.5.0

package/README.md

@@ -77,7 +77,7 @@ app.get('/', (c) => c.json({ 'Hono meets': 'Node.js' }))
 serve(app)
 ```
 
-### Serve Static Middleware
+## Serve Static Middleware
 
 Use Serve Static Middleware that has been created for Node.js.
 
@@ -89,7 +89,23 @@ import { serveStatic } from '@hono/node-server/serve-static'
 app.use('/static/*', serveStatic({ root: './' }))
 ```
 
-Note that `root` must be *relative* to the current working directory - absolute paths are not supported.
+Note that `root` must be _relative_ to the current working directory - absolute paths are not supported.
+
+### Options
+
+#### `rewriteRequestPath`
+
+If you want to serve files in `./.foojs` with the request path `/__foo/*`, you can write like the following.
+
+```ts
+app.use(
+  '/__foo/*',
+  serveStatic({
+    root: './.foojs/',
+    rewriteRequestPath: (path: string) => path.replace(/^\/__foo/, ''),
+  })
+)
+```
 
 ## Related projects
 

package/dist/globals.js

@@ -9,9 +9,12 @@ const web_stream_1 = require("@remix-run/web-stream");
 const base64_1 = require("./base64");
 const fetch_1 = require("./fetch");
 function installGlobals() {
-    global.atob = base64_1.atob;
-    global.btoa = base64_1.btoa;
-    global.Blob = fetch_1.Blob;
+    if (typeof base64_1.atob === 'undefined')
+        global.atob = base64_1.atob;
+    if (typeof base64_1.btoa === 'undefined')
+        global.btoa = base64_1.btoa;
+    if (typeof Blob === 'undefined')
+        global.Blob = fetch_1.Blob;
     global.File = fetch_1.File;
     global.Headers = fetch_1.Headers;
     global.Request = fetch_1.Request;
@@ -20,8 +23,15 @@ function installGlobals() {
     global.FormData = fetch_1.FormData;
     global.ReadableStream = web_stream_1.ReadableStream;
     global.WritableStream = web_stream_1.WritableStream;
-    if (typeof global.crypto === "undefined") {
-        global.crypto = node_crypto_1.default;
+    if (typeof global.crypto === 'undefined') {
+        // If crypto.subtle is undefined, we're in a Node.js v16 environment
+        if (typeof node_crypto_1.default.subtle === 'undefined') {
+            // We can use the webcrypto polyfill
+            global.crypto = require('crypto').webcrypto;
+        }
+        else {
+            global.crypto = node_crypto_1.default;
+        }
     }
 }
 exports.installGlobals = installGlobals;

package/dist/listener.js

@@ -34,11 +34,21 @@ const getRequestListener = (fetchCallback) => {
         try {
             res = (await fetchCallback(new Request(url.toString(), init)));
         }
-        catch {
+        catch (e) {
             res = new fetch_1.Response(null, { status: 500 });
+            if (e instanceof Error) {
+                // timeout error emits 504 timeout
+                if (e.name === 'TimeoutError' || e.constructor.name === 'TimeoutError') {
+                    res = new fetch_1.Response(null, { status: 504 });
+                }
+            }
         }
         const contentType = res.headers.get('content-type') || '';
+        // nginx buffering variant
+        const buffering = res.headers.get('x-accel-buffering') || '';
         const contentEncoding = res.headers.get('content-encoding');
+        const contentLength = res.headers.get('content-length');
+        const transferEncoding = res.headers.get('transfer-encoding');
         for (const [k, v] of res.headers) {
             if (k === 'set-cookie') {
                 outgoing.setHeader(k, res.headers.getAll(k));
@@ -49,14 +59,34 @@ const getRequestListener = (fetchCallback) => {
         }
         outgoing.statusCode = res.status;
         if (res.body) {
-            if (!contentEncoding && contentType.startsWith('text')) {
-                outgoing.end(await res.text());
-            }
-            else if (!contentEncoding && contentType.startsWith('application/json')) {
-                outgoing.end(await res.text());
+            try {
+                /**
+                 * If content-encoding is set, we assume that the response should be not decoded.
+                 * Else if transfer-encoding is set, we assume that the response should be streamed.
+                 * Else if content-length is set, we assume that the response content has been taken care of.
+                 * Else if x-accel-buffering is set to no, we assume that the response should be streamed.
+                 * Else if content-type is not application/json nor text/* but can be text/event-stream,
+                 * we assume that the response should be streamed.
+                 */
+                if (contentEncoding ||
+                    transferEncoding ||
+                    contentLength ||
+                    /^no$/i.test(buffering) ||
+                    !/^(application\/json\b|text\/(?!event-stream\b))/i.test(contentType)) {
+                    await (0, stream_1.writeReadableStreamToWritable)(res.body, outgoing);
+                }
+                else {
+                    const text = await res.text();
+                    outgoing.setHeader('Content-Length', Buffer.byteLength(text));
+                    outgoing.end(text);
+                }
             }
-            else {
-                await (0, stream_1.writeReadableStreamToWritable)(res.body, outgoing);
+            catch (e) {
+                // try to catch any error, to avoid crash
+                console.error(e);
+                const err = e instanceof Error ? e : new Error('unknown error', { cause: e });
+                // destroy error must accept an instance of Error
+                outgoing.destroy(err);
             }
         }
         else {

package/dist/serve-static.d.ts

@@ -7,5 +7,6 @@ export declare type ServeStaticOptions = {
     root?: string;
     path?: string;
     index?: string;
+    rewriteRequestPath?: (path: string) => string;
 };
 export declare const serveStatic: (options?: ServeStaticOptions) => (c: Context, next: Next) => Promise<Response | undefined>;

package/dist/serve-static.js

@@ -11,8 +11,9 @@ const serveStatic = (options = { root: '' }) => {
             await next();
         }
         const url = new URL(c.req.url);
+        const filename = options.path ?? url.pathname;
         let path = (0, filepath_1.getFilePath)({
-            filename: options.path ?? url.pathname,
+            filename: options.rewriteRequestPath ? options.rewriteRequestPath(filename) : filename,
             root: options.root,
             defaultDocument: options.index ?? 'index.html',
         });

package/dist/stream.d.ts

@@ -1,7 +1,3 @@
 /// <reference types="node" />
 import type { Writable } from 'node:stream';
 export declare function writeReadableStreamToWritable(stream: ReadableStream, writable: Writable): Promise<void>;
-/**
- * Credits:
- *   - https://github.com/remix-run/remix/blob/e77e2eb/packages/remix-node/stream.ts
- */

package/dist/stream.js

@@ -2,26 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeReadableStreamToWritable = void 0;
 async function writeReadableStreamToWritable(stream, writable) {
-    let reader = stream.getReader();
-    async function read() {
-        let { done, value } = await reader.read();
-        if (done) {
-            writable.end();
-            return;
-        }
-        writable.write(value);
-        await read();
+    const reader = stream.getReader();
+    function onClose() {
+        reader.cancel(new Error('Response writer closed'));
     }
+    writable.once('close', onClose);
     try {
-        await read();
+        while (true) {
+            const { done, value } = await reader.read();
+            if (done) {
+                writable.end();
+                return;
+            }
+            writable.write(value);
+        }
     }
-    catch (error) {
-        writable.destroy(error);
-        throw error;
+    finally {
+        writable.off('close', onClose);
+        reader.releaseLock();
     }
 }
 exports.writeReadableStreamToWritable = writeReadableStreamToWritable;
-/**
- * Credits:
- *   - https://github.com/remix-run/remix/blob/e77e2eb/packages/remix-node/stream.ts
- */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/node-server",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "HTTP Server for Hono on Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,7 +48,7 @@
     "@types/jest": "^29.0.1",
     "@types/node": "^18.7.16",
     "@types/supertest": "^2.0.12",
-    "hono": "^2.7.1",
+    "hono": "^3.1.5",
     "jest": "^29.0.3",
     "next": "13.1.6",
     "np": "^7.6.2",