@linebridge/engine-neo 1.0.7 → 1.2.2

package/README.md

@@ -5,7 +5,7 @@ The official, high-performance HTTP and WebSocket engine for [Linebridge](https:
 ## Installation
 
 ```bash
-npm install @linebridge/engine-neo
+pnpm add @linebridge/engine-neo
 ```
 
 ## Usage
@@ -22,5 +22,4 @@ import "@linebridge/engine-neo"
 
 This project is licensed under the **MIT License**.
 
-It includes software developed by uNetworking AB and uWebSockets.js contributors, which is licensed under the **Apache License 2.0**.
-See the [LICENSE](./LICENSE) file for more details.
+It includes software developed by uNetworking AB and uWebSockets.js contributors, which is licensed under the **Apache License 2.0**. See the [LICENSE](./LICENSE) file for more details.

package/lib/cookie.d.ts

@@ -0,0 +1,2 @@
+export declare function sign(value: string, secret: string): string;
+export declare function unsign(signed_value: string, secret: string): string | undefined;

package/lib/cookie.js

@@ -0,0 +1,23 @@
+import * as crypto from "node:crypto";
+export function sign(value, secret) {
+    const mac = crypto
+        .createHmac("sha256", secret)
+        .update(value)
+        .digest("base64")
+        .replace(/=+$/, "");
+    return `${value}.${mac}`;
+}
+export function unsign(signed_value, secret) {
+    const lastDot = signed_value.lastIndexOf(".");
+    if (lastDot === -1)
+        return undefined;
+    const value = signed_value.slice(0, lastDot);
+    const expectedSignature = sign(value, secret);
+    const expectedBuffer = Buffer.from(expectedSignature);
+    const providedBuffer = Buffer.from(signed_value);
+    if (expectedBuffer.length === providedBuffer.length &&
+        crypto.timingSafeEqual(expectedBuffer, providedBuffer)) {
+        return value;
+    }
+    return undefined;
+}

package/lib/engine.d.ts

@@ -15,6 +15,8 @@ import uws_wrapper, { type uWebsockets } from "./uws.js";
 import RTEngine from "linebridge/classes/RtEngine/index";
 import { EngineAdaptor } from "linebridge/classes/EngineAdaptor/index";
 import { Route } from "linebridge/classes/Route/index";
+import route_register from "./route_register.js";
+import middleware_register from "./register_middleware.js";
 /**
  * Options that control the engine's behaviour.
  */
@@ -76,9 +78,9 @@ export declare class NeoEngine extends EngineAdaptor {
     /** Gracefully shuts down the server. Bound to the engine instance. */
     close: () => Promise<boolean>;
     /** Registers a route (HTTP method + path + handler). */
-    register: (route: import("linebridge/classes/Route/index").RouteAlike) => void;
+    register: OmitThisParameter<typeof route_register>;
     /** Registers a global middleware that runs before every route handler. */
-    register_middleware: (middleware: any) => void;
+    register_middleware: OmitThisParameter<typeof middleware_register>;
     /**
      * Publish a message to a topic in MQTT syntax to all WebSocket connections on this Server instance.
      * You cannot publish using wildcards, only fully specified topics.
@@ -91,7 +93,7 @@ export declare class NeoEngine extends EngineAdaptor {
     /** Incoming HTTP request handler. Bound to the engine instance. */
     on_request: (native_req: uWebsockets.HttpRequest, native_res: uWebsockets.HttpResponse, route: Route<any, "server"[]>, socket?: uWebsockets.us_socket_context_t | null | undefined) => any;
     /** Middleware/route iteration loop. Bound to the engine instance. */
-    request_iterator: (request: Request<any>, response: Response<any>, route: Route<Server<"neo">, "server"[]>, allMiddlewares: Handler<HandlerKind>[], cursor?: number | undefined) => Promise<void>;
+    request_iterator: (request: Request<any>, response: Response<any>, route: Route<Server<"neo">, "server"[]>, allMiddlewares: Handler<HandlerKind.middleware>[], cursor?: number | undefined) => Promise<void>;
     /**
      * Decrements the pending request counter and fires the zero-handler
      * when no requests remain in flight.

package/lib/engine.js

@@ -14,7 +14,7 @@ import toBoolean from "linebridge/utils/toBoolean";
 import RTEngine from "linebridge/classes/RtEngine/index";
 import { EngineAdaptor } from "linebridge/classes/EngineAdaptor/index";
 import { Route } from "linebridge/classes/Route/index";
-import WebsocketPolyfill from "./ws/Websocket.js";
+import Websocket from "./ws/Websocket.js";
 import route_register from "./route_register.js";
 import middleware_register from "./register_middleware.js";
 import listen from "./listen.js";
@@ -128,7 +128,7 @@ export class NeoEngine extends EngineAdaptor {
                 upgrade: (res, req, _context) => this.ws.handleUpgrade(req, res),
                 // wrap raw uWS websocket with the polyfill so RTEngine gets EventEmitter + helpers
                 open: (ws) => {
-                    const poly = new WebsocketPolyfill(ws);
+                    const poly = new Websocket(ws);
                     ws.poly = poly;
                     //@ts-ignore polyfill context is Object vs RtEngineSocket's typed shape, but runtime is correct
                     this.ws.handleConnection(poly);
@@ -151,12 +151,15 @@ export class NeoEngine extends EngineAdaptor {
             // @ts-ignore
             global.websockets = this.ws;
         }
-        // create the default route
-        const defaultRoute = new Route();
-        defaultRoute.method = "any";
-        defaultRoute.path = "/*";
-        defaultRoute.fn = this._defaultResponse;
-        this.register(defaultRoute);
+        if (!toBoolean(process.env.LB_SOCKET_MODE)) {
+            // create the default route
+            const defaultRoute = new Route();
+            defaultRoute.method = "any";
+            defaultRoute.path = "/*";
+            defaultRoute.fn = this._defaultResponse;
+            defaultRoute._initialize(this.server);
+            this.register(defaultRoute);
+        }
     };
     /** Starts the server. Bound to the engine instance. */
     listen = listen.bind(this);
@@ -200,7 +203,9 @@ export class NeoEngine extends EngineAdaptor {
      * Default handler for unmatched routes. Responds with a 404 JSON body.
      */
     _defaultResponse(req, res) {
-        res.status(404).json({ error: "Not found" });
+        res.status(404)
+            .setHeader("content-type", "application/json")
+            ._sendFast(`{"error":"Not found"}`);
     }
 }
 export { uws_wrapper as uWebsockets };

package/lib/listen.js

@@ -25,7 +25,9 @@ export default async function () {
                 this.listen_socket = listen_socket;
                 // optionally register process-exit listeners for graceful shutdown
                 if (this.options.auto_close) {
-                    EXIT_EVENTS.forEach((type) => process.once(type, () => this.close()));
+                    EXIT_EVENTS.forEach((type) => process.once(type, () => {
+                        void this.server._fireClose();
+                    }));
                 }
                 resolve();
             }

package/lib/request.d.ts

@@ -5,9 +5,8 @@
  * body parsing (JSON, text, urlencoded, buffer), cookies, IP resolution,
  * and path/query parameters.
  */
+import { sign, unsign } from "./cookie.js";
 import type { uWebsockets } from "./uws.js";
-type HttpRequest = uWebsockets.HttpRequest;
-type HttpResponse = uWebsockets.HttpResponse;
 import type { Request as BaseHttpRequest } from "linebridge/classes/Handler/http";
 import type { EngineAdaptor } from "linebridge/classes/EngineAdaptor/index";
 import type { Route } from "linebridge/classes/Route/index";
@@ -46,9 +45,9 @@ export default class Request<TServer = Server<any>> implements BaseHttpRequest {
     /** Parsed query string parameters (lazy). */
     _query_parameters: any;
     /** The raw uWS HttpRequest object. */
-    _raw_request: HttpRequest;
+    _raw_request: uWebsockets.HttpRequest;
     /** The raw uWS HttpResponse object (needed for `onData` and `getRemoteAddress`). */
-    _raw_response: HttpResponse;
+    _raw_response: uWebsockets.HttpResponse;
     /** Request headers extracted synchronously. */
     _headers: Record<string, string>;
     /** Whether all body chunks have been received. */
@@ -74,7 +73,7 @@ export default class Request<TServer = Server<any>> implements BaseHttpRequest {
     /**
      * Creates a Request instance from raw uWS objects.
      */
-    static create<TServer extends Server<any>>(route: Route<TServer>, raw_request: HttpRequest, raw_response: HttpResponse): Request<TServer>;
+    static create<TServer extends Server<any>>(route: Route<TServer>, raw_request: uWebsockets.HttpRequest, raw_response: uWebsockets.HttpResponse): Request<TServer>;
     /**
      * The engine that owns this request.
      */
@@ -82,7 +81,7 @@ export default class Request<TServer = Server<any>> implements BaseHttpRequest {
     /**
      * The raw uWS HttpRequest.
      */
-    get raw(): HttpRequest;
+    get raw(): uWebsockets.HttpRequest;
     /**
      * Lazily-parsed headers as a plain object.
      * Header names are lowercased by uWS.
@@ -98,13 +97,13 @@ export default class Request<TServer = Server<any>> implements BaseHttpRequest {
      */
     resume(): this;
     /**
-     * Signs a string with a secret using the same algorithm as `cookie-signature`.
+     * Signs a string with a secret
      */
-    sign(string: string, secret: string): any;
+    sign: typeof sign;
     /**
      * Unsigns a signed value. Returns the original string or `undefined` on failure.
      */
-    unsign(signed_value: string, secret: string): any;
+    unsign: typeof unsign;
     /**
      * Starts the body parser by registering a uWS `onData` callback.
      *
@@ -168,4 +167,3 @@ export default class Request<TServer = Server<any>> implements BaseHttpRequest {
      */
     get proxy_ip(): string;
 }
-export {};

package/lib/request.js

@@ -6,8 +6,8 @@
  * and path/query parameters.
  */
 import * as cookie from "cookie";
+import { sign, unsign } from "./cookie.js";
 import querystring from "fast-querystring";
-import signature from "cookie-signature";
 /**
  * HTTP Request class wrapping a uWS HttpRequest.
  *
@@ -138,18 +138,13 @@ export default class Request {
         return this;
     }
     /**
-     * Signs a string with a secret using the same algorithm as `cookie-signature`.
+     * Signs a string with a secret
      */
-    sign(string, secret) {
-        return signature.sign(string, secret);
-    }
+    sign = sign;
     /**
      * Unsigns a signed value. Returns the original string or `undefined` on failure.
      */
-    unsign(signed_value, secret) {
-        const unsigned_value = signature.unsign(signed_value, secret);
-        return unsigned_value !== false ? unsigned_value : undefined;
-    }
+    unsign = unsign;
     /**
      * Starts the body parser by registering a uWS `onData` callback.
      *

package/lib/request_iterator.d.ts

@@ -9,7 +9,7 @@ import type Engine from "./engine.js";
 import type Request from "./request.js";
 import type Response from "./response.js";
 import type { Route } from "linebridge/classes/Route/index";
-import type { Handler } from "linebridge/classes/Handler/index";
+import type { Handler, HandlerKind } from "linebridge/classes/Handler/index";
 /**
  * Recursively iterates the middleware chain, then calls the route handler.
  *
@@ -19,4 +19,4 @@ import type { Handler } from "linebridge/classes/Handler/index";
  *
  * @param cursor - Zero-based index into the middleware array. Increments on each recursion.
  */
-export default function (this: Engine, request: Request<any>, response: Response<any>, route: Route<typeof this.server>, allMiddlewares: Handler[], cursor?: number): Promise<void>;
+export default function (this: Engine, request: Request<any>, response: Response<any>, route: Route<typeof this.server>, allMiddlewares: Handler<HandlerKind.middleware>[], cursor?: number): Promise<void>;

package/lib/response.d.ts

@@ -7,7 +7,6 @@
  */
 import SSEventStream from "./SSEventStream.js";
 import type { uWebsockets } from "./uws.js";
-type HttpResponse = uWebsockets.HttpResponse;
 import type { EngineAdaptor } from "linebridge/classes/EngineAdaptor/index";
 import type { Route } from "linebridge/classes/Route/index";
 import type { Server } from "linebridge/server";
@@ -39,7 +38,7 @@ export default class Response<TServer = Server<any>> implements BaseHttpResponse
     /** The uWS upgrade socket (WebSocket upgrade requests only). */
     _upgrade_socket: any;
     /** The raw uWS HttpResponse object. */
-    _raw_response: HttpResponse | null;
+    _raw_response: uWebsockets.HttpResponse | null;
     /** HTTP status code (defaults to 200). */
     _status_code: number;
     /** Custom status message (overrides the default from STATUS_CODES). */
@@ -71,7 +70,7 @@ export default class Response<TServer = Server<any>> implements BaseHttpResponse
      * pending request counter, stops body parsing on the paired request, and
      * fires abort/close event listeners.
      */
-    static create<TServer extends Server<any>>(raw_response: HttpResponse, route: Route<TServer>, request: any, socket: any): Response<TServer>;
+    static create<TServer extends Server<any>>(raw_response: uWebsockets.HttpResponse, route: Route<TServer>, request: any, socket: any): Response<TServer>;
     /**
      * Registers an event listener on the response.
      * Supported events: `"abort"`, `"close"`, `"finish"`.
@@ -198,7 +197,7 @@ export default class Response<TServer = Server<any>> implements BaseHttpResponse
     /**
      * The raw uWS HttpResponse.
      */
-    get raw(): HttpResponse | null;
+    get raw(): uWebsockets.HttpResponse | null;
     /**
      * Whether the response has been aborted by the client.
      */

package/lib/response.js

@@ -5,9 +5,9 @@
  * headers, cookies (with signed cookie support), streaming, file serving,
  * Server-Sent Events, redirects, and JSON/HTML shortcuts.
  */
-import * as cookie from "cookie";
-import signature from "cookie-signature";
 import { STATUS_CODES } from "http";
+import * as cookie from "cookie";
+import { sign } from "./cookie.js";
 import mime_types from "mime-types";
 import SSEventStream from "./SSEventStream.js";
 const stringify = JSON.stringify;
@@ -237,7 +237,7 @@ export default class Response {
         }
         if (sign_cookie && typeof options.secret === "string") {
             options.encode = false;
-            value = signature.sign(value, options.secret);
+            value = sign(value, options.secret);
         }
         if (this._cookies === null) {
             this._cookies = Object.create(null);

package/lib/route_register.d.ts

@@ -1,5 +1,5 @@
-import type Engine from "./engine.js";
-import { RouteAlike } from "linebridge/classes/Route/index";
+import type { Route } from "linebridge/classes/Route/index";
+import type { NeoEngine } from "./engine.js";
 /**
  * Registers a route with the engine's uWS app.
  *
@@ -7,4 +7,4 @@ import { RouteAlike } from "linebridge/classes/Route/index";
  *
  * @throws {Error} If the engine is not initialized or the route is invalid.
  */
-export default function (this: Engine, route: RouteAlike): void;
+export default function (this: NeoEngine, route: Route): void;

package/lib/route_register.js

@@ -1,5 +1,3 @@
-import { Route, } from "linebridge/classes/Route/index";
-import { HandlerKind } from "linebridge/classes/Handler/index";
 /**
  * Registers a route with the engine's uWS app.
  *
@@ -11,57 +9,25 @@ export default function (route) {
     if (!this.uws) {
         throw new Error("Engine is not initialized");
     }
-    let routeInstance;
-    // support passing a class constructor or an already-constructed instance
-    if (typeof route === "function") {
-        try {
-            routeInstance = new route();
-        }
-        catch (err) {
-            console.error(`Failed to construct route class:\n`, err);
-            return;
-        }
-    }
-    else if (route instanceof Route) {
-        routeInstance = route;
-    }
-    else if (typeof route.fn === "function") {
-        routeInstance = new Route();
-        routeInstance.kind = HandlerKind.http;
-        routeInstance.path = route.path ?? "/";
-        routeInstance.method = route.method ?? "get";
-        routeInstance.useContexts = route.useContexts ?? [];
-        routeInstance.useMiddlewares = route.useMiddlewares ?? [];
-        routeInstance.fn = route.fn;
-    }
-    else {
-        throw new Error("Invalid route provided");
-    }
-    // try to initialize the route
-    try {
-        routeInstance._initialize(this.server);
-    }
-    catch (err) {
-        console.error(`Failed to initialize route:\n`, err);
-        return;
-    }
     // normalize DELETE method for uWS compatibility (uWS uses "del" internally)
-    if (routeInstance.method === "delete") {
-        routeInstance.method = "del";
+    if (route.method === "delete") {
+        route.method = "del";
     }
     // verify the method is a valid uWS route method before registering
-    if (typeof this.uws[routeInstance.method] !== "function") {
-        console.warn(`Invalid method (${routeInstance.method}) for route handler [${routeInstance.path}]\nSkipping route..`);
+    if (typeof this.uws[route.method] !== "function") {
+        console.warn(`Invalid method (${route.method}) for route handler [${route.path}]\nSkipping route..`);
         return;
     }
     this.registers.add({
-        kind: routeInstance.kind,
-        method: routeInstance.method,
-        path: routeInstance.path,
-        useContexts: routeInstance.useContexts,
-        useMiddlewares: routeInstance.useMiddlewares,
-        _source_file: routeInstance._source_file,
-        handler: routeInstance.handler,
+        kind: route.kind,
+        method: route.method,
+        path: route.path,
+        useContexts: route.useContexts,
+        useMiddlewares: route.useMiddlewares,
+        _source_file: route._source_file,
+        handler: route.handler,
     });
-    this.uws[routeInstance.method](routeInstance.path, (res, req) => this.on_request(req, res, routeInstance));
+    if (route.kind === "http") {
+        this.uws[route.method](route.path, (res, req) => this.on_request(req, res, route));
+    }
 }

package/lib/utils.d.ts

@@ -10,5 +10,5 @@ declare function wrap_object(original: any, target: any): void;
  * @param {BufferEncoding} encoding
  * @returns {String} String
  */
-declare function array_buffer_to_string(array_buffer: ArrayBuffer, encoding?: BufferEncoding): any;
+declare function array_buffer_to_string(array_buffer: ArrayBuffer, encoding?: BufferEncoding): string;
 export { array_buffer_to_string, wrap_object };

package/lib/uws.js

@@ -11,17 +11,23 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createRequire } from "node:module";
+import os from "node:os";
 let uws_wrapper;
-try {
-    uws_wrapper = createRequire(import.meta.url)("../uws-wrapper.node");
+if (process.env.IS_BUNDLED) {
+    // @ts-ignore
+    const mod = await import("../uws-wrapper.node");
+    uws_wrapper = mod.default ?? mod;
 }
-catch (e) {
+else {
     try {
-        uws_wrapper = createRequire(import.meta.url)("../build/Release/uws-wrapper.node");
+        uws_wrapper = await import(import.meta.resolve("../uws-wrapper.node"));
     }
-    catch (e2) {
-        uws_wrapper = createRequire(import.meta.url)("../build/out/uws-wrapper.node");
+    catch (e) {
+        uws_wrapper = await import(import.meta.resolve(`../build/Release/uws-wrapper-${os.arch()}.node`));
+    }
+    if (uws_wrapper) {
+        // @ts-ignore
+        uws_wrapper = uws_wrapper.default ?? uws_wrapper;
     }
 }
 export default uws_wrapper;