@server/next 0.15.0 → 0.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@server/next",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "An experimental reimplementation of server.js focused on the DX",
   "homepage": "https://node-server.com/",
   "repository": "https://github.com/franciscop/server-next.git",

package/readme.md

@@ -7,7 +7,7 @@
 A fully-fledged web server for Node.js, with all the basics covered for you:
 
 ```js
-import server, { get, post, put, use, error } from 'server';
+import server, { get, post, put, use } from 'server';
 
 // Create a running instance of the server
 const app = server(config, [pluginA, pluginB]);
@@ -17,12 +17,11 @@ app([
   get('/users', getUsers),
   post('/users', createUser),
   put('/users/:id', editUser),
-  use('/admin/*', dashboard),
-  error(ctx => console.log(ctx.error))
+  use('/admin/*', dashboard)
 ]);
 ```
 
-It includes all the things you would expect from a modern Server framework, like routing, static file serving, body+file parsing, gzip+brotli\*, streaming, etc.
+It includes all the things you would expect from a modern Server framework, like routing, static file serving, body+file parsing, gzip+brotli, streaming, server-timing, plugins\*, etc.
 
 > \* not yet available
 
@@ -41,7 +40,9 @@ Why? The ecosystem is moving out of server-rendered websites so we are as well.
 
 ## Progress
 
-- Router has `get` and `post`, as well as URL pattern matches
+- Router has all verbs, as well as URL pattern matches
+- Full URL parsing, including `query` and `params` in ctx.url.
+- Body and Files parsing is working (TODO: try with binary files and add tests)
 - The middleware can return:
   - A number and it'll be set as the status code
   - A string and it'll be sent as plain text or html (if it starts with "<")

package/src/RequestLogger.js

@@ -17,13 +17,6 @@ const format = (n, [below, above], limit = Infinity) => {
   }
 };
 
-const findSize = ({ headers, body, size }, res) => {
-  if (size) return size;
-  if (body) return body.length;
-  if (headers["content-length"]) return +headers["content-length"];
-  return 0;
-};
-
 function simpleType(type) {
   const simpler = {
     "text/html": "html",
@@ -59,7 +52,7 @@ export default function RequestLogger(ctx) {
       const statColor =
         status < 300 ? "green" : status < 500 ? "yellow" : "red";
       const statusBlock = `{${statColor}}[${ctx.res.status}]{/}`;
-      const resSize = format(findSize(ctx.res), ["b", "kb"], 100000);
+      const resSize = format(ctx.res.size || 0, ["b", "kb"], 100000);
       const t = Math.round(ctx.time._total - ctx.time._init);
       const resTime = format(t, ["ms", "s"], 1000);
 

package/src/ServerUrl.js

@@ -1,21 +1,57 @@
-export default class ServerUrl {
+import { inspect } from "util";
+
+const colors = {
+  string: process.env.NO_COLOR ? "" : "\x1b[32m",
+  number: process.env.NO_COLOR ? "" : "\x1b[33m",
+};
+
+const properties = [
+  "hash",
+  "host",
+  "hostname",
+  "href",
+  "origin",
+  "params",
+  "password",
+  "path",
+  "pathname",
+  "port",
+  "protocol",
+  "query",
+  "search",
+  "searchParams",
+  "username",
+];
+
+export default class ServerUrl extends URL {
   constructor(urlString) {
-    const url = new URL(urlString);
-    this.href = url.href;
-    this.origin = url.origin;
-    this.protocol = url.protocol;
-    this.username = url.username;
-    this.password = url.password;
-    this.host = url.host;
-    this.hostname = url.hostname;
-    this.port = url.port ? +url.port : null; // make it an intege
-    this.pathname = url.pathname;
-    this.path = url.pathname; // nicknam
-    this.params = {}; // The URL parameter
-    this.search = url.search;
-    this.searchParams = url.searchParams;
-    this.query = this.getQuery(url.searchParams.entries()); // As a plain object
-    this.hash = url.hash;
+    super(urlString);
+
+    const custom = {
+      port: +this.port || null,
+      path: this.pathname,
+      params: {},
+      query: this.getQuery(this.searchParams.entries()),
+    };
+
+    for (let key of properties) {
+      const value = key in custom ? custom[key] : this[key];
+      Object.defineProperty(this, key, {
+        value,
+        enumerable: true,
+        writable: true,
+      });
+    }
+  }
+
+  [inspect.custom]() {
+    const props = Object.keys(this)
+      .map((key) => {
+        const color = colors[typeof this[key]] || "";
+        return `  ${key}: ${color}${inspect(this[key])}\x1b[0m`;
+      })
+      .join("\n");
+    return `ServerUrl {\n${props}\n}`;
   }
 
   getQuery(entries) {

package/src/ServerUrl.test.js

@@ -17,6 +17,24 @@ describe("getUrl()", () => {
     expect(url.host).toBe("example.com");
     expect(url.hostname).toBe("example.com");
     expect(url.port).toBe(null);
+
+    expect(Object.keys(url)).toEqual([
+      "hash",
+      "host",
+      "hostname",
+      "href",
+      "origin",
+      "params",
+      "password",
+      "path",
+      "pathname",
+      "port",
+      "protocol",
+      "query",
+      "search",
+      "searchParams",
+      "username",
+    ]);
   });
 
   it("can parse localhost", () => {

package/src/index.js

@@ -2,7 +2,9 @@ import http from "node:http";
 import fs from "node:fs";
 import fsp from "node:fs/promises";
 import path from "node:path";
+import zlib from "node:zlib";
 import { pipeline } from "node:stream/promises";
+import { Readable, PassThrough } from "node:stream";
 
 import "dotenv/config";
 
@@ -29,6 +31,35 @@ const exists = (file) => {
   );
 };
 
+const measure = (ctx) => {
+  const sizeUp = new PassThrough();
+  ctx.res.size = 0;
+  sizeUp.on("data", (chunk) => {
+    ctx.res.size += chunk.length;
+  });
+  return sizeUp;
+};
+
+const findEncoding = (acceptEncoding) => {
+  let encoding;
+  if (/\bbr\b/.test(acceptEncoding)) {
+    encoding = "br";
+  } else if (/\bgzip\b/.test(acceptEncoding)) {
+    encoding = "gzip";
+  } else if (/\bdeflate\b/.test(acceptEncoding)) {
+    encoding = "deflate";
+  }
+
+  const methods = {
+    deflate: () => zlib.createDeflate(),
+    gzip: () => zlib.createGzip(),
+    br: () => zlib.createBrotliCompress(),
+  };
+
+  const compress = methods[encoding];
+  return [encoding, compress];
+};
+
 const api = {
   get: [],
   post: [],
@@ -119,7 +150,6 @@ export default function (options = {}, plugins) {
           ctx.res.body = out;
           const isHtml = out.trim().startsWith("<");
           ctx.res.headers["content-type"] = isHtml ? "text/html" : "text/plain";
-          ctx.res.headers["content-length"] = Buffer.byteLength(out);
         } else {
           if (out.pipe) {
             ctx.res.body = out;
@@ -127,7 +157,6 @@ export default function (options = {}, plugins) {
           } else {
             // Plain object
             if (out.type) ctx.res.headers["content-type"] = out.type;
-            if (out.length) ctx.res.headers["content-length"] = out.length;
             ctx.res.headers = { ...ctx.res.headers, ...(out.headers || {}) };
             ctx.res.body = out.body || "";
             ctx.res.status = out.status || 200;
@@ -147,21 +176,30 @@ export default function (options = {}, plugins) {
         ctx.res.headers["server-timing"] += ", ";
       }
     });
+
+    const [encoding, compress] = findEncoding(ctx.headers["accept-encoding"]);
+    if (encoding) {
+      ctx.res.headers["content-encoding"] = encoding;
+    }
+
     res.writeHead(ctx.res.status, ctx.res.headers);
-    if (ctx.res.body.pipe) {
-      if (ctx.res.body.path) {
-        ctx.res.type = ctx.res.body.path.split(".").pop();
-        ctx.res.size = await fsp.stat(ctx.res.body.path).then((s) => s.size);
-      } else {
-        ctx.res.size = 0;
-        ctx.res.body.on("data", function (chunk) {
-          ctx.res.size += chunk.length;
-        });
-      }
-      await pipeline(ctx.res.body, res);
+
+    // If it's not a pipe, e.g. a String, make it a pipe
+    if (!ctx.res.body.pipe) {
+      ctx.res.body = Readable.from([ctx.res.body]);
+    }
+
+    if (ctx.res.body.path) {
+      ctx.res.type = ctx.res.body.path.split(".").pop();
+    }
+
+    if (compress) {
+      await pipeline(ctx.res.body, compress(), measure(ctx), res);
     } else {
-      res.end(ctx.res.body);
+      await pipeline(ctx.res.body, measure(ctx), res);
     }
+    res.end();
+
     // The actual sent headers, as seen by the response
     ctx.res.headers = Object.fromEntries(
       res._header
@@ -278,3 +316,12 @@ export const head = (pattern, callback) => {
     return callback(ctx);
   };
 };
+
+export const use = (pattern, callback) => {
+  return (ctx) => {
+    const match = pathPattern(pattern, ctx.url.path);
+    if (!match) return null;
+    ctx.url.params = match;
+    return callback(ctx);
+  };
+};