owebjs 1.5.5-dev → 1.5.8-dev

package/benchmark.txt

@@ -0,0 +1,191 @@
+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/dist/index.d.ts

@@ -20,6 +20,8 @@ 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 {
@@ -48,6 +50,8 @@ declare class Oweb extends _FastifyInstance {
     uServer: any;
     routes: Map<string, any>;
     constructor(options?: OwebOptions);
+    private getHmrWatchers;
+    private closeHMRWatchers;
     /**
      *
      * Returns a fastify instance with the Oweb prototype methods

package/dist/structures/Oweb.js

@@ -6,6 +6,7 @@ import { applyMatcherHMR, applyRouteHMR, assignRoutes } from '../utils/assignRou
 import { watchDirectory } from '../utils/watcher.js';
 import { info, success, warn } from '../utils/logger.js';
 import websocketPlugin from "@fastify/websocket";
+const HMR_WATCHERS_KEY = "hmr:watchers";
 let _FastifyInstance = class _FastifyInstance2 {
   static {
     __name(this, "_FastifyInstance");
@@ -27,12 +28,32 @@ class Oweb extends _FastifyInstance {
     super();
     this._options = options ?? {};
     this._options.uWebSocketsEnabled ??= false;
+    this._options.poweredByHeader ??= true;
     this._options.OWEB_INTERNAL_ERROR_HANDLER ??= (_, res, err) => {
       return res.status(500).send({
         error: err.message
       });
     };
   }
+  getHmrWatchers() {
+    let watchers = this._internalKV.get(HMR_WATCHERS_KEY);
+    if (!watchers) {
+      watchers = [];
+      this._internalKV.set(HMR_WATCHERS_KEY, watchers);
+    }
+    return watchers;
+  }
+  async closeHMRWatchers() {
+    const watchers = this.getHmrWatchers();
+    if (!watchers.length) return;
+    const activeWatchers = watchers.splice(0, watchers.length);
+    await Promise.all(activeWatchers.map(async (watcher) => {
+      try {
+        await watcher.close();
+      } catch {
+      }
+    }));
+  }
   /**
    *
    * Returns a fastify instance with the Oweb prototype methods
@@ -40,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);
@@ -53,9 +76,35 @@ class Oweb extends _FastifyInstance {
     if (!this._options.uWebSocketsEnabled) {
       await fastify.register(websocketPlugin);
     }
-    fastify.addHook("onRequest", (_, res, done) => {
-      res.header("X-Powered-By", "Oweb");
-      done();
+    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();
+      });
+    }
+    const internalKV = this._internalKV;
+    fastify.addHook("onClose", async () => {
+      const watchers = internalKV.get(HMR_WATCHERS_KEY);
+      if (!watchers?.length) return;
+      const activeWatchers = watchers.splice(0, watchers.length);
+      await Promise.all(activeWatchers.map(async (watcher) => {
+        try {
+          await watcher.close();
+        } catch {
+        }
+      }));
     });
     for (const key in Object.getOwnPropertyDescriptors(Oweb.prototype)) {
       if (key === "constructor") continue;
@@ -107,6 +156,8 @@ class Oweb extends _FastifyInstance {
       this._internalKV.set("hmr", true);
       success(`Hot Module Replacement enabled. Watching changes in ${hmr.directory}`, "HMR");
     } else {
+      this._internalKV.set("hmr", false);
+      void this.closeHMRWatchers();
       warn('Hot Module Replacement is disabled. Use "await app.loadRoutes({ hmr: { enabled: true, directory: path } })" to enable it.', "HMR");
     }
     return assignRoutes(this, directory, matchersDirectory);
@@ -115,14 +166,18 @@ class Oweb extends _FastifyInstance {
    *
    * Watches for changes in the routes directory
    */
-  watch() {
-    watchDirectory(this.hmrDirectory, true, (op, path, content) => {
+  async watch() {
+    await this.closeHMRWatchers();
+    const watchers = this.getHmrWatchers();
+    const routeWatcher = watchDirectory(this.hmrDirectory, true, (op, path, content) => {
       applyRouteHMR(this, op, this.hmrDirectory, this.directory, path, content);
     });
+    watchers.push(routeWatcher);
     if (this.hmrMatchersDirectory) {
-      watchDirectory(this.hmrMatchersDirectory, true, (op, path, content) => {
+      const matcherWatcher = watchDirectory(this.hmrMatchersDirectory, true, (op, path, content) => {
         applyMatcherHMR(this, op, this.hmrMatchersDirectory, this.matchersDirectory, path, content);
       });
+      watchers.push(matcherWatcher);
     }
   }
   /**
@@ -139,7 +194,11 @@ class Oweb extends _FastifyInstance {
         host
       }, (err, address) => {
         if (process.env.NODE_ENV !== "production") {
-          if (this.hmrDirectory) this.watch();
+          if (this.hmrDirectory) {
+            this.watch().catch((watchError) => {
+              warn(`HMR watcher failed to initialize: ${watchError.message}`, "HMR");
+            });
+          }
         } else {
           info("Hot Module Replacement is disabled in production mode. NODE_ENV is set to production.", "HMR");
         }