owebjs 1.5.8-dev → 1.5.9-dev

package/README.md

@@ -99,6 +99,7 @@ import Oweb from 'owebjs';
 const app = await new Oweb({
     uWebSocketsEnabled: true,
     poweredByHeader: false,
+    autoPreflight: true,
     staticResponseHeaders: {
         // CORS (set your real origin in production)
         'access-control-allow-origin': 'https://yourdomain.com',
@@ -126,6 +127,28 @@ await app.loadRoutes({
 await app.start({ port: 3000, host: '0.0.0.0' });
 ```
 
+## CORS Configuration
+
+Use `autoPreflight` to return `204` for preflight requests and set CORS headers through `staticResponseHeaders`.
+
+```js
+import Oweb from 'owebjs';
+
+const app = await new Oweb({
+    uWebSocketsEnabled: true,
+    autoPreflight: true,
+    poweredByHeader: false,
+    staticResponseHeaders: {
+        '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',
+    },
+}).setup();
+```
+
+If you need credentials, do not use `*` for `access-control-allow-origin`; set an explicit origin.
+
 ## First App (2 Minutes)
 
 Start with a minimal app, then we will add route conventions step by step.
@@ -167,7 +190,7 @@ routes/
     [id].js
   auth/
     login.post.js
-  matcher/
+  posts/
     [id=integer].js
   events/
     sse.js
@@ -236,7 +259,7 @@ export default class LoginPostRoute extends Route {
 
 Matcher params add filename-level validation.
 
-`routes/matcher/[id=integer].js` + `matchers/integer.js`
+`routes/posts/[id=integer].js` + `matchers/integer.js`
 
 ```js
 // matchers/integer.js

package/dist/index.d.ts

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

package/dist/structures/Oweb.js

@@ -29,6 +29,7 @@ class Oweb extends _FastifyInstance {
     this._options = options ?? {};
     this._options.uWebSocketsEnabled ??= false;
     this._options.poweredByHeader ??= true;
+    this._options.autoPreflight ??= false;
     this._options.OWEB_INTERNAL_ERROR_HANDLER ??= (_, res, err) => {
       return res.status(500).send({
         error: err.message
@@ -62,7 +63,9 @@ class Oweb extends _FastifyInstance {
     if (this._options.uWebSocketsEnabled) {
       const serverimp = (await import("../uwebsocket/server.js")).default;
       const server = await serverimp({
-        staticResponseHeaders: this._options.staticResponseHeaders
+        staticResponseHeaders: this._options.staticResponseHeaders,
+        autoPreflight: this._options.autoPreflight,
+        poweredByHeader: this._options.poweredByHeader
       });
       this.uServer = server;
       this._options.serverFactory = (handler) => {
@@ -94,6 +97,11 @@ class Oweb extends _FastifyInstance {
         done();
       });
     }
+    if (this._options.autoPreflight && !this._options.uWebSocketsEnabled) {
+      fastify.options("/*", (_req, res) => {
+        return res.status(204).send();
+      });
+    }
     const internalKV = this._internalKV;
     fastify.addHook("onClose", async () => {
       const watchers = internalKV.get(HMR_WATCHERS_KEY);

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, staticResponseHeaders }) {
+async function server_default({ cert_file_name, key_file_name, staticResponseHeaders, autoPreflight, poweredByHeader }) {
   let uWS;
   uWS = (await import("uWebSockets.js")).default;
   let appType = "App";
@@ -37,6 +37,27 @@ async function server_default({ cert_file_name, key_file_name, staticResponseHea
     const query = req.getQuery();
     const url = req.getUrl();
     const requiresBody = method !== "HEAD" && method !== "GET";
+    if (autoPreflight && method === "OPTIONS") {
+      res.writeStatus("204 No Content");
+      let hasPoweredByHeader = false;
+      if (normalizedStaticHeaders?.length) {
+        for (let i = 0; i < normalizedStaticHeaders.length; i++) {
+          const [key, value] = normalizedStaticHeaders[i];
+          if (key === "content-length" || key === "transfer-encoding") {
+            continue;
+          }
+          if (key === "x-powered-by") {
+            hasPoweredByHeader = true;
+          }
+          res.writeHeader(key, value);
+        }
+      }
+      if (poweredByHeader && !hasPoweredByHeader) {
+        res.writeHeader("x-powered-by", "Oweb");
+      }
+      res.end();
+      return;
+    }
     res.finished = false;
     res.aborted = false;
     if (requiresBody) {

package/package.json

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

package/0http.js

@@ -1,8 +0,0 @@
-import cero from '0http';
-const { router, server } = cero();
-
-router.get('/', (req, res) => {
-    res.end('Hello, World!');
-});
-
-server.listen(3000);

package/benchmark.txt

@@ -1,191 +0,0 @@
-OWEB UWS:
-
-╰─ autocannon -c 100 -d 40 -p 10 localhost:3000
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-running [=================== ] 95%
-┌─────────┬──────┬───────┬───────┬───────┬──────────┬──────────┬────────┐
-│ Stat    │ 2.5% │ 50%   │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max    │
-├─────────┼──────┼───────┼───────┼───────┼──────────┼──────────┼────────┤
-│ Latency │ 5 ms │ 12 ms │ 73 ms │ 98 ms │ 15.81 ms │ 15.73 ms │ 158 ms │
-└─────────┴──────┴───────┴───────┴───────┴──────────┴──────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬─────────┬───────────┬──────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg       │ Stdev    │ Min     │
-├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼─────────┤
-│ Req/Sec   │ 57.087  │ 57.087  │ 64.991  │ 72.191  │ 64.785,27 │ 3.607,71 │ 57.060  │
-├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼─────────┤
-│ Bytes/Sec │ 9.42 MB │ 9.42 MB │ 10.7 MB │ 11.9 MB │ 10.7 MB   │ 596 kB   │ 9.41 MB │
-└───────────┴─────────┴─────────┴─────────┴─────────┴───────────┴──────────┴─────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 38
-
-2463k requests in 40.19s, 406 MB read
-╭─ pwsh      40s 459ms⠀                                                                          6,13:14 
-╰─ autocannon -c 100 -d 40 -p 10 localhost:3000
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-
-┌─────────┬──────┬───────┬───────┬───────┬─────────┬──────────┬────────┐
-│ Stat    │ 2.5% │ 50%   │ 97.5% │ 99%   │ Avg     │ Stdev    │ Max    │
-├─────────┼──────┼───────┼───────┼───────┼─────────┼──────────┼────────┤
-│ Latency │ 5 ms │ 13 ms │ 72 ms │ 98 ms │ 15.9 ms │ 15.27 ms │ 262 ms │
-└─────────┴──────┴───────┴───────┴───────┴─────────┴──────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬─────────┬───────────┬──────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg       │ Stdev    │ Min     │
-├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼─────────┤
-│ Req/Sec   │ 48.959  │ 48.959  │ 64.447  │ 70.783  │ 63.949,54 │ 4.776,67 │ 48.930  │
-├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼─────────┤
-│ Bytes/Sec │ 8.08 MB │ 8.08 MB │ 10.6 MB │ 11.7 MB │ 10.6 MB   │ 789 kB   │ 8.07 MB │
-└───────────┴─────────┴─────────┴─────────┴─────────┴───────────┴──────────┴─────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 39
-
-2495k requests in 40.96s, 412 MB read
-
-
-OWEB FASTIFY:
-
-╰─ autocannon -c 100 -d 40 -p 10 localhost:3000
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-
-┌─────────┬──────┬───────┬───────┬────────┬──────────┬──────────┬────────┐
-│ Stat    │ 2.5% │ 50%   │ 97.5% │ 99%    │ Avg      │ Stdev    │ Max    │
-├─────────┼──────┼───────┼───────┼────────┼──────────┼──────────┼────────┤
-│ Latency │ 3 ms │ 21 ms │ 84 ms │ 110 ms │ 26.12 ms │ 20.65 ms │ 200 ms │
-└─────────┴──────┴───────┴───────┴────────┴──────────┴──────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬────────┬──────────┬──────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%  │ Avg      │ Stdev    │ Min     │
-├───────────┼─────────┼─────────┼─────────┼────────┼──────────┼──────────┼─────────┤
-│ Req/Sec   │ 26.751  │ 26.751  │ 36.287  │ 45.503 │ 37.570,6 │ 4.606,09 │ 26.741  │
-├───────────┼─────────┼─────────┼─────────┼────────┼──────────┼──────────┼─────────┤
-│ Bytes/Sec │ 4.76 MB │ 4.76 MB │ 6.46 MB │ 8.1 MB │ 6.69 MB  │ 820 kB   │ 4.76 MB │
-└───────────┴─────────┴─────────┴─────────┴────────┴──────────┴──────────┴─────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 40
-
-1504k requests in 40.05s, 268 MB read
-╭─ pwsh      40s 334ms⠀                                                                          6,13:16 
-╰─ autocannon -c 100 -d 40 -p 10 localhost:3000
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-
-┌─────────┬──────┬───────┬───────┬────────┬──────────┬──────────┬────────┐
-│ Stat    │ 2.5% │ 50%   │ 97.5% │ 99%    │ Avg      │ Stdev    │ Max    │
-├─────────┼──────┼───────┼───────┼────────┼──────────┼──────────┼────────┤
-│ Latency │ 4 ms │ 20 ms │ 93 ms │ 122 ms │ 24.03 ms │ 21.64 ms │ 209 ms │
-└─────────┴──────┴───────┴───────┴────────┴──────────┴──────────┴────────┘
-┌───────────┬────────┬────────┬─────────┬─────────┬───────────┬──────────┬────────┐
-│ Stat      │ 1%     │ 2.5%   │ 50%     │ 97.5%   │ Avg       │ Stdev    │ Min    │
-├───────────┼────────┼────────┼─────────┼─────────┼───────────┼──────────┼────────┤
-│ Req/Sec   │ 29.759 │ 29.759 │ 41.343  │ 44.895  │ 40.765,81 │ 3.004,68 │ 29.750 │
-├───────────┼────────┼────────┼─────────┼─────────┼───────────┼──────────┼────────┤
-│ Bytes/Sec │ 5.3 MB │ 5.3 MB │ 7.36 MB │ 7.99 MB │ 7.26 MB   │ 535 kB   │ 5.3 MB │
-└───────────┴────────┴────────┴─────────┴─────────┴───────────┴──────────┴────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 40
-
-1632k requests in 40.05s, 290 MB read
-
-DÜZ FASTIFY:
-
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-
-┌─────────┬──────┬───────┬───────┬───────┬──────────┬──────────┬────────┐
-│ Stat    │ 2.5% │ 50%   │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max    │
-├─────────┼──────┼───────┼───────┼───────┼──────────┼──────────┼────────┤
-│ Latency │ 3 ms │ 18 ms │ 76 ms │ 97 ms │ 21.09 ms │ 17.82 ms │ 257 ms │
-└─────────┴──────┴───────┴───────┴───────┴──────────┴──────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬─────────┬──────────┬──────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg      │ Stdev    │ Min     │
-├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────┼─────────┤
-│ Req/Sec   │ 32.543  │ 32.543  │ 46.783  │ 49.695  │ 46.349,8 │ 2.964,89 │ 32.530  │
-├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────┼─────────┤
-│ Bytes/Sec │ 5.79 MB │ 5.79 MB │ 8.33 MB │ 8.85 MB │ 8.25 MB  │ 528 kB   │ 5.79 MB │
-└───────────┴─────────┴─────────┴─────────┴─────────┴──────────┴──────────┴─────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 40
-
-1855k requests in 40.06s, 330 MB read
-╭─ pwsh      40s 362ms⠀                                                                          6,13:18 
-╰─ autocannon -c 100 -d 40 -p 10 localhost:3000
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-
-┌─────────┬──────┬───────┬───────┬────────┬──────────┬─────────┬────────┐
-│ Stat    │ 2.5% │ 50%   │ 97.5% │ 99%    │ Avg      │ Stdev   │ Max    │
-├─────────┼──────┼───────┼───────┼────────┼──────────┼─────────┼────────┤
-│ Latency │ 3 ms │ 18 ms │ 80 ms │ 102 ms │ 21.48 ms │ 18.3 ms │ 188 ms │
-└─────────┴──────┴───────┴───────┴────────┴──────────┴─────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬────────┬──────────┬──────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%  │ Avg      │ Stdev    │ Min     │
-├───────────┼─────────┼─────────┼─────────┼────────┼──────────┼──────────┼─────────┤
-│ Req/Sec   │ 37.567  │ 37.567  │ 45.535  │ 48.863 │ 45.501,6 │ 2.214,24 │ 37.550  │
-├───────────┼─────────┼─────────┼─────────┼────────┼──────────┼──────────┼─────────┤
-│ Bytes/Sec │ 6.68 MB │ 6.68 MB │ 8.11 MB │ 8.7 MB │ 8.1 MB   │ 394 kB   │ 6.68 MB │
-└───────────┴─────────┴─────────┴─────────┴────────┴──────────┴──────────┴─────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 40
-
-1821k requests in 40.05s, 324 MB read
-
-DÜZ UWS:
-
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-running [=================== ] 95%
-┌─────────┬───────┬───────┬───────┬───────┬──────────┬─────────┬────────┐
-│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%   │ Avg      │ Stdev   │ Max    │
-├─────────┼───────┼───────┼───────┼───────┼──────────┼─────────┼────────┤
-│ Latency │ 11 ms │ 12 ms │ 19 ms │ 22 ms │ 12.93 ms │ 3.39 ms │ 167 ms │
-└─────────┴───────┴───────┴───────┴───────┴──────────┴─────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬─────────┬───────────┬─────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg       │ Stdev   │ Min     │
-├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼─────────┼─────────┤
-│ Req/Sec   │ 71.743  │ 71.743  │ 80.831  │ 80.959  │ 79.149,48 │ 3.427,1 │ 71.730  │
-├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼─────────┼─────────┤
-│ Bytes/Sec │ 10.6 MB │ 10.6 MB │ 11.9 MB │ 11.9 MB │ 11.6 MB   │ 503 kB  │ 10.5 MB │
-└───────────┴─────────┴─────────┴─────────┴─────────┴───────────┴─────────┴─────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 38
-
-3009k requests in 40.43s, 442 MB read
-╭─ pwsh      40s 739ms⠀                                                                          6,13:20 
-╰─ autocannon -c 100 -d 40 -p 10 localhost:3000
-Running 40s test @ http://localhost:3000
-100 connections with 10 pipelining factor
-
-
-┌─────────┬───────┬───────┬───────┬───────┬──────────┬─────────┬────────┐
-│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%   │ Avg      │ Stdev   │ Max    │
-├─────────┼───────┼───────┼───────┼───────┼──────────┼─────────┼────────┤
-│ Latency │ 10 ms │ 12 ms │ 20 ms │ 22 ms │ 12.44 ms │ 3.35 ms │ 181 ms │
-└─────────┴───────┴───────┴───────┴───────┴──────────┴─────────┴────────┘
-┌───────────┬────────┬────────┬─────────┬─────────┬───────────┬──────────┬────────┐
-│ Stat      │ 1%     │ 2.5%   │ 50%     │ 97.5%   │ Avg       │ Stdev    │ Min    │
-├───────────┼────────┼────────┼─────────┼─────────┼───────────┼──────────┼────────┤
-│ Req/Sec   │ 68.287 │ 68.287 │ 80.831  │ 89.855  │ 81.377,65 │ 4.922,97 │ 68.284 │
-├───────────┼────────┼────────┼─────────┼─────────┼───────────┼──────────┼────────┤
-│ Bytes/Sec │ 10 MB  │ 10 MB  │ 11.9 MB │ 13.2 MB │ 12 MB     │ 724 kB   │ 10 MB  │
-└───────────┴────────┴────────┴─────────┴─────────┴───────────┴──────────┴────────┘
-
-Req/Bytes counts sampled once per second.
-# of samples: 39
-
-3175k requests in 41.09s, 467 MB read
-

package/express.js

@@ -1,14 +0,0 @@
-import express from 'express';
-
-const app = express();
-const port = 3000;
-
-// Define a route for the root URL
-app.get('/', (req, res) => {
-    res.send('Hello World from Express!');
-});
-
-// Start the server
-app.listen(port, () => {
-    console.log(`Express app listening at http://localhost:${port}`);
-});

package/fasti.js

@@ -1,14 +0,0 @@
-import fastify from 'fastify';
-
-const app = fastify();
-
-app.get('/', async (request, reply) => {
-    return 'Hello, World!';
-});
-
-app.listen({ port: 3000, host: '0.0.0.0' }, (err) => {
-    if (err) {
-        console.error(err);
-        process.exit(1);
-    }
-});

package/purehttp.js

@@ -1,19 +0,0 @@
-import http from 'node:http';
-
-const hostname = '127.0.0.1';
-const port = 3000;
-
-// Create the server instance
-const server = http.createServer((req, res) => {
-    // Set the response header with HTTP status and Content-Type
-    res.statusCode = 200;
-    res.setHeader('Content-Type', 'text/plain');
-
-    // Send the response body
-    res.end('Hello, World!\n');
-});
-
-// Start listening for requests
-server.listen(port, hostname, () => {
-    console.log(`Server running at http://${hostname}:${port}/`);
-});

package/uws.js

@@ -1,16 +0,0 @@
-import uWS from 'uwebsockets.js';
-
-uWS.App()
-    .get('/', (res, req) => {
-        res.writeStatus('200 OK')
-            .writeHeader('Content-Type', 'text/plain; charset=utf-8')
-            .end('Hello, World!');
-    })
-    .listen('0.0.0.0', 3000, (listenSocket) => {
-        if (listenSocket) {
-            console.log('uWebSockets.js listening on http://localhost:3000');
-        } else {
-            console.error('Failed to listen on port 3000');
-            process.exit(1);
-        }
-    });