@hono/node-server 0.2.4 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # Hono on Node.js
 
-**`@honojs/node-server` is renamed to `@hono/node-serer` !!**
+**`@honojs/node-server` is renamed to `@hono/node-server` !!**
 
 ---
 
@@ -89,6 +89,8 @@ 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.
+
 ## Related projects
 
 - Hono - <https://honojs.dev>

package/dist/listener.d.ts

@@ -0,0 +1,3 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { FetchCallback } from './types';
+export declare const getRequestListener: (fetchCallback: FetchCallback) => (incoming: IncomingMessage, outgoing: ServerResponse) => Promise<void>;

package/dist/listener.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequestListener = void 0;
+const fetch_1 = require("./fetch");
+const stream_1 = require("./stream");
+const getRequestListener = (fetchCallback) => {
+    return async (incoming, outgoing) => {
+        const method = incoming.method || 'GET';
+        const url = `http://${incoming.headers.host}${incoming.url}`;
+        const headerRecord = {};
+        const len = incoming.rawHeaders.length;
+        for (let i = 0; i < len; i++) {
+            if (i % 2 === 0) {
+                const key = incoming.rawHeaders[i];
+                headerRecord[key] = incoming.rawHeaders[i + 1];
+            }
+        }
+        const init = {
+            method: method,
+            headers: headerRecord,
+        };
+        if (!(method === 'GET' || method === 'HEAD')) {
+            // lazy-consume request body
+            init.body = new ReadableStream({
+                start: async (controller) => {
+                    for await (const chunk of incoming) {
+                        controller.enqueue(chunk);
+                    }
+                    controller.close();
+                }
+            });
+        }
+        let res;
+        try {
+            res = (await fetchCallback(new Request(url.toString(), init)));
+        }
+        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));
+            }
+            else {
+                outgoing.setHeader(k, v);
+            }
+        }
+        outgoing.statusCode = res.status;
+        if (res.body) {
+            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);
+                }
+            }
+            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 {
+            outgoing.end();
+        }
+    };
+};
+exports.getRequestListener = getRequestListener;

package/dist/nextjs.d.ts

@@ -0,0 +1,2 @@
+import { HandleInterface } from './types';
+export declare const handle: HandleInterface;

package/dist/nextjs.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handle = void 0;
+const hono_1 = require("hono");
+const listener_1 = require("./listener");
+// <E extends Hono<any, any>
+const handle = (subApp, path = '/') => {
+    return (0, listener_1.getRequestListener)(new hono_1.Hono().route(path, subApp).fetch);
+};
+exports.handle = handle;

package/dist/serve-static.d.ts

@@ -1,6 +1,9 @@
 import type { Next } from 'hono';
 import { Context } from 'hono';
 export declare type ServeStaticOptions = {
+    /**
+     * Root path, relative to current working directory. (absolute paths are not supported)
+     */
     root?: string;
     path?: string;
     index?: string;

package/dist/server.d.ts

@@ -1,10 +1,4 @@
 import { Server } from 'node:http';
-declare type FetchCallback = (request: Request) => Promise<unknown> | unknown;
-declare type Options = {
-    fetch: FetchCallback;
-    port?: number;
-    serverOptions?: Object;
-};
+import { Options } from './types';
 export declare const createAdaptorServer: (options: Options) => Server;
 export declare const serve: (options: Options) => Server;
-export {};

package/dist/server.js

@@ -2,78 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serve = exports.createAdaptorServer = void 0;
 const node_http_1 = require("node:http");
-const fetch_1 = require("./fetch");
-const stream_1 = require("./stream");
 const globals_1 = require("./globals");
+const listener_1 = require("./listener");
 (0, globals_1.installGlobals)();
 const createAdaptorServer = (options) => {
     const fetchCallback = options.fetch;
-    const requestListener = getRequestListener(fetchCallback);
+    const requestListener = (0, listener_1.getRequestListener)(fetchCallback);
     const server = (0, node_http_1.createServer)(options.serverOptions || {}, requestListener);
     return server;
 };
 exports.createAdaptorServer = createAdaptorServer;
 const serve = (options) => {
     const server = (0, exports.createAdaptorServer)(options);
-    server.listen(options.port || 3000);
+    server.listen(options.port || 3000, options.hostname || '0.0.0.0');
     return server;
 };
 exports.serve = serve;
-const getRequestListener = (fetchCallback) => {
-    return async (incoming, outgoing) => {
-        const method = incoming.method || 'GET';
-        const url = `http://${incoming.headers.host}${incoming.url}`;
-        const headerRecord = {};
-        const len = incoming.rawHeaders.length;
-        for (let i = 0; i < len; i++) {
-            if (i % 2 === 0) {
-                const key = incoming.rawHeaders[i];
-                headerRecord[key] = incoming.rawHeaders[i + 1];
-            }
-        }
-        const init = {
-            method: method,
-            headers: headerRecord,
-        };
-        if (!(method === 'GET' || method === 'HEAD')) {
-            const buffers = [];
-            for await (const chunk of incoming) {
-                buffers.push(chunk);
-            }
-            const buffer = Buffer.concat(buffers);
-            init['body'] = buffer;
-        }
-        let res;
-        try {
-            res = (await fetchCallback(new Request(url.toString(), init)));
-        }
-        catch {
-            res = new fetch_1.Response(null, { status: 500 });
-        }
-        const contentType = res.headers.get('content-type') || '';
-        const contentEncoding = res.headers.get('content-encoding');
-        for (const [k, v] of res.headers) {
-            if (k === 'set-cookie') {
-                outgoing.setHeader(k, res.headers.getAll(k));
-            }
-            else {
-                outgoing.setHeader(k, v);
-            }
-        }
-        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());
-            }
-            else {
-                await (0, stream_1.writeReadableStreamToWritable)(res.body, outgoing);
-            }
-        }
-        else {
-            outgoing.end();
-        }
-    };
-};

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/dist/types.d.ts

@@ -0,0 +1,15 @@
+import type { Hono } from 'hono';
+import type { NextApiHandler } from 'next/types';
+export declare type FetchCallback = (request: Request) => Promise<unknown> | unknown;
+export declare type NextHandlerOption = {
+    fetch: FetchCallback;
+};
+export declare type Options = {
+    fetch: FetchCallback;
+    port?: number;
+    hostname?: string;
+    serverOptions?: Object;
+};
+export interface HandleInterface {
+    <E extends Hono<any, any>>(subApp: E, path?: string): NextApiHandler;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/node-server",
-  "version": "0.2.4",
+  "version": "0.4.0",
   "description": "HTTP Server for Hono on Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,12 +9,16 @@
   ],
   "exports": {
     ".": "./dist/index.js",
-    "./serve-static": "./dist/serve-static.js"
+    "./serve-static": "./dist/serve-static.js",
+    "./nextjs": "./dist/nextjs.js"
   },
   "typesVersions": {
     "*": {
       "serve-static": [
         "./dist/serve-static.d.ts"
+      ],
+      "nextjs": [
+        "./dist/nextjs.d.ts"
       ]
     }
   },
@@ -46,6 +50,7 @@
     "@types/supertest": "^2.0.12",
     "hono": "^2.7.1",
     "jest": "^29.0.3",
+    "next": "13.1.6",
     "np": "^7.6.2",
     "rimraf": "^3.0.2",
     "supertest": "^6.2.4",