owebjs 1.5.7-dev → 1.5.8-dev

package/README.md

@@ -72,10 +72,10 @@ second average
 | Runtime                   | Version   | Requests/sec |
 | ------------------------- | --------- | -----------: |
 | uWebSockets.js            | 20.52.0   |       79,149 |
-| **Oweb (uWS)**            | 1.5.7-dev |       70,535 |
+| **Oweb (uWS)**            | 1.5.8-dev |       76,853 |
 | 0http                     | 4.4.0     |       46,605 |
 | Fastify                   | 4.23.2    |       46,238 |
-| **Oweb (Fastify)**        | 1.5.7-dev |       42,570 |
+| **Oweb (Fastify)**        | 1.5.8-dev |       42,570 |
 | Node.js http.createServer | 24.5.0    |       42,544 |
 | Express                   | 5.2.1     |       24,913 |
 
@@ -83,6 +83,49 @@ This is a synthetic "Hello, Word!" benchmark that aims to evaluate the framework
 The overhead that each framework has on your application depends on your application.
 You should always benchmark if performance matters to you.
 
+## Best Performance
+
+For the highest throughput, use these defaults:
+
+- Enable uWebSockets runtime: `uWebSocketsEnabled: true`
+- Disable powered-by header: `poweredByHeader: false`
+- For headers that should be sent on every request (for example CORS-related headers), use `staticResponseHeaders` instead of per-request hooks
+
+Example (production-oriented):
+
+```js
+import Oweb from 'owebjs';
+
+const app = await new Oweb({
+    uWebSocketsEnabled: true,
+    poweredByHeader: false,
+    staticResponseHeaders: {
+        // CORS (set your real origin in production)
+        'access-control-allow-origin': 'https://yourdomain.com',
+        'access-control-allow-methods': 'GET,POST,PUT,PATCH,DELETE,OPTIONS',
+        'access-control-allow-headers': 'Content-Type, Authorization',
+        vary: 'Origin',
+
+        // Security headers
+        'x-content-type-options': 'nosniff',
+        'x-frame-options': 'DENY',
+        'referrer-policy': 'strict-origin-when-cross-origin',
+        'permissions-policy': 'geolocation=(), microphone=(), camera=()',
+        'cross-origin-opener-policy': 'same-origin',
+        'cross-origin-resource-policy': 'same-site',
+    },
+}).setup();
+
+await app.loadRoutes({
+    directory: 'routes',
+    hmr: {
+        enabled: false,
+    },
+});
+
+await app.start({ port: 3000, host: '0.0.0.0' });
+```
+
 ## First App (2 Minutes)
 
 Start with a minimal app, then we will add route conventions step by step.

package/dist/index.d.ts

@@ -21,6 +21,7 @@ export { HTTPMethods } from 'fastify/types/utils';
 interface OwebOptions extends FastifyServerOptions {
     uWebSocketsEnabled?: boolean;
     poweredByHeader?: boolean;
+    staticResponseHeaders?: Record<string, string>;
     OWEB_INTERNAL_ERROR_HANDLER?: Function;
 }
 interface LoadRoutesOptions {

package/dist/structures/Oweb.js

@@ -61,7 +61,9 @@ class Oweb extends _FastifyInstance {
   async setup() {
     if (this._options.uWebSocketsEnabled) {
       const serverimp = (await import("../uwebsocket/server.js")).default;
-      const server = await serverimp({});
+      const server = await serverimp({
+        staticResponseHeaders: this._options.staticResponseHeaders
+      });
       this.uServer = server;
       this._options.serverFactory = (handler) => {
         server.on("request", handler);
@@ -74,7 +76,19 @@ class Oweb extends _FastifyInstance {
     if (!this._options.uWebSocketsEnabled) {
       await fastify.register(websocketPlugin);
     }
-    if (this._options.poweredByHeader) {
+    const staticHeaderEntries = this._options.staticResponseHeaders ? Object.entries(this._options.staticResponseHeaders) : [];
+    if (!this._options.uWebSocketsEnabled && (this._options.poweredByHeader || staticHeaderEntries.length)) {
+      fastify.addHook("onRequest", (_, res, done) => {
+        if (this._options.poweredByHeader) {
+          res.header("X-Powered-By", "Oweb");
+        }
+        for (let i = 0; i < staticHeaderEntries.length; i++) {
+          const [key, value] = staticHeaderEntries[i];
+          res.header(key, value);
+        }
+        done();
+      });
+    } else if (this._options.poweredByHeader) {
       fastify.addHook("onRequest", (_, res, done) => {
         res.header("X-Powered-By", "Oweb");
         done();

package/dist/uwebsocket/response.js

@@ -17,8 +17,9 @@ class HttpResponse extends Writable {
   __headers;
   headersSent;
   finished;
+  staticHeaders;
   _socket = null;
-  constructor(uResponse, uServer) {
+  constructor(uResponse, uServer, staticHeaders) {
     super();
     this.res = uResponse;
     this.server = uServer;
@@ -27,6 +28,7 @@ class HttpResponse extends Writable {
     this.__headers = {};
     this.headersSent = false;
     this.finished = false;
+    this.staticHeaders = staticHeaders;
   }
   get socket() {
     if (!this._socket) {
@@ -62,6 +64,18 @@ class HttpResponse extends Writable {
     if (this.headersSent || this.isClosed()) return;
     const message = this.statusMessage || http.STATUS_CODES[this.statusCode] || "Unknown";
     this.res.writeStatus(`${this.statusCode} ${message}`);
+    if (this.staticHeaders?.length) {
+      for (let i = 0; i < this.staticHeaders.length; i++) {
+        const [key, value] = this.staticHeaders[i];
+        if (key === "content-length" || key === "transfer-encoding") {
+          continue;
+        }
+        if (this.__headers[key] !== void 0) {
+          continue;
+        }
+        this.res.writeHeader(key, value);
+      }
+    }
     const keys = Object.keys(this.__headers);
     for (let i = 0; i < keys.length; i++) {
       const key = keys[i];

package/dist/uwebsocket/server.js

@@ -6,7 +6,7 @@ const REQUEST_EVENT = "request";
 import HttpRequest from './request.js';
 import HttpResponse from './response.js';
 import http from "node:http";
-async function server_default({ cert_file_name, key_file_name }) {
+async function server_default({ cert_file_name, key_file_name, staticResponseHeaders }) {
   let uWS;
   uWS = (await import("uWebSockets.js")).default;
   let appType = "App";
@@ -22,6 +22,10 @@ async function server_default({ cert_file_name, key_file_name }) {
     cert_file_name,
     key_file_name
   };
+  const normalizedStaticHeaders = staticResponseHeaders ? Object.entries(staticResponseHeaders).map(([k, v]) => [
+    k.toLowerCase(),
+    String(v)
+  ]) : void 0;
   const copyArrayBufferToBuffer = /* @__PURE__ */ __name((bytes) => {
     const src = new Uint8Array(bytes);
     const out = Buffer.allocUnsafe(src.byteLength);
@@ -47,7 +51,7 @@ async function server_default({ cert_file_name, key_file_name }) {
       query,
       url
     });
-    const resWrapper = new HttpResponse(res, uServer);
+    const resWrapper = new HttpResponse(res, uServer, normalizedStaticHeaders);
     reqWrapper.res = resWrapper;
     resWrapper.req = reqWrapper;
     reqWrapper.bindSocketFactory(() => resWrapper.socket);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "owebjs",
-    "version": "1.5.7-dev",
+    "version": "1.5.8-dev",
     "description": "A flexible and modern web framework built on top of Fastify",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",