wok-server 0.1.2 → 0.1.5

package/README.md

@@ -1,4 +1,4 @@
-# node 后端框架
+# Wok Server
 
 一个简洁易用的 Nodejs 后端框架，使用 Typescript 开发，有完整的类型约束和定义，注释详细，文档齐全，支持国际化。
 

package/dist/mvc/handler/json.js

@@ -20,7 +20,12 @@ function createJsonHandler(opts) {
         if (opts.validation) {
             // 切换语言
             (0, i18n_1.getI18n)().switchByRequest(exchange.request.headers);
-            (0, validation_1.validate)(body, opts.validation);
+            if (typeof opts.validation === 'function') {
+                (0, validation_1.validate)(body, opts.validation());
+            }
+            else {
+                (0, validation_1.validate)(body, opts.validation);
+            }
         }
         const res = await opts.handle(body, exchange);
         if (!res) {

package/dist/mvc/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.stopWebServer = exports.startWebServer = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
 const http_1 = require("http");
 const os_1 = require("os");
 const path_1 = require("path");
@@ -73,7 +74,7 @@ async function handleRouter(exchange, routers, staticSettings) {
     const router = routers[path];
     if (!router) {
         // 路由找不不到，尝试静态文件
-        if (staticSettings.length) {
+        if ((exchange.request.method || '').toLowerCase() === 'get' && staticSettings.length) {
             await handleStatic(exchange, routers, path, staticSettings);
         }
         else {
@@ -123,15 +124,15 @@ async function handleStatic(exchange, routers, path, staticSettings) {
         respond404(exchange, routers, path);
         return;
     }
-    const stat = (0, fs_1.statSync)(fullPath);
+    const statRes = await (0, promises_1.stat)(fullPath);
     // 目录，寻找 index.html
-    if (stat.isDirectory()) {
+    if (statRes.isDirectory()) {
         const indexPath = (0, path_1.resolve)(fullPath, 'index.html');
         if (!(0, fs_1.existsSync)(indexPath)) {
             respond404(exchange, routers, path);
             return;
         }
-        const indexStat = (0, fs_1.statSync)(indexPath);
+        const indexStat = await (0, promises_1.stat)(indexPath);
         if (!indexStat.isFile()) {
             respond404(exchange, routers, path);
             return;
@@ -144,7 +145,7 @@ async function handleStatic(exchange, routers, path, staticSettings) {
         return;
     }
     // 文件直接渲染
-    if (stat.isFile()) {
+    if (statRes.isFile()) {
         // Cache-Control
         if (matchedSetting.cacheAge >= 0) {
             exchange.response.setHeader('Cache-Control', matchedSetting.cacheAge === 0 ? 'no-store' : `max-age=${matchedSetting.cacheAge}`);
@@ -210,8 +211,8 @@ async function startWebServer(opts) {
             if (!(0, fs_1.existsSync)(dir)) {
                 throw new Error(`Static file configuration error，path ${dir} does not exist，config dir：${setting.dir}`);
             }
-            const stat = (0, fs_1.statSync)(dir);
-            if (!stat.isDirectory()) {
+            const statRes = await (0, promises_1.stat)(dir);
+            if (!statRes.isDirectory()) {
                 throw new Error(`Static file configuration error，path ${dir} is not a directory，config dir：${setting.dir}`);
             }
             let finalPath = path.startsWith('/') ? path : '/' + path;
@@ -243,6 +244,7 @@ async function startWebServer(opts) {
         interceptors.push(...opts.interceptors);
     }
     SERVER = (0, http_1.createServer)((req, res) => {
+        res.setHeader('Server', 'Wok Server');
         res.on('error', error => {
             // 如果响应流发生错误，只能把信息记录下来
             (0, log_1.getLogger)().error(`Response Error：${req.url}`, error);
@@ -266,7 +268,7 @@ async function startWebServer(opts) {
     await new Promise((resolve, reject) => {
         server.on('error', e => {
             if (e.code === 'EADDRINUSE') {
-                reject(`端口号 ${config_1.config.port} 已经被占用`);
+                reject(`Port ${config_1.config.port} is already in use.`);
             }
             else {
                 reject(e);

package/dist/mvc/render/file.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderFile = void 0;
 const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
 const json_1 = require("./json");
 const path_1 = require("path");
+const zlib_1 = require("zlib");
 /**
  * 常用的 content-type 对照表
  */
@@ -96,7 +98,7 @@ function decideContentType(fileName) {
  */
 async function renderFile(request, response, filePath, download = false) {
     if (!(0, fs_1.existsSync)(filePath)) {
-        (0, json_1.renderError)(response, '文件不存在', 404);
+        (0, json_1.renderError)(response, 'Cannot find file.', 404);
         return;
     }
     const fileName = (0, path_1.basename)(filePath);
@@ -118,11 +120,31 @@ async function renderFile(request, response, filePath, download = false) {
     else if (contentType) {
         response.setHeader('Content-Type', contentType);
     }
+    const statRes = await (0, promises_1.stat)(filePath);
+    // 支持 If-Modified-Since
+    // 由于只是简单的文件映射，没有 etag，不能支持 If-None-Match
+    // 缓存校验只能支持时间的比对，修改时间是文件系统本来就有的
+    if (request.headers['if-modified-since']) {
+        const modifiedSince = new Date(request.headers['if-modified-since']);
+        // 判定日期是否有效
+        if (modifiedSince instanceof Date && !isNaN(modifiedSince.getTime())) {
+            // 比较更改日期，只精确到秒, UTC 格式只精确到秒，但是 mtime 是包含毫秒的
+            const { mtime } = statRes;
+            mtime.setMilliseconds(0);
+            if (modifiedSince >= mtime) {
+                response.statusCode = 304;
+                response.setHeader('Last-Modified', statRes.mtime.toUTCString());
+                response.end();
+                return;
+            }
+        }
+    }
     // 支持 Range
     // https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Range
     const rangeHeader = request.headers['range'];
     if (!rangeHeader) {
-        return streamFile(filePath, response);
+        response.setHeader('Last-Modified', statRes.mtime.toUTCString());
+        return streamFile(filePath, request, response);
     }
     // 解析，range 示例：bytes=200-1000, 2000-6576, 19000-
     // 多段的情况，暂时不做支持，非常麻烦，段数多还可能会有效率问题
@@ -130,38 +152,37 @@ async function renderFile(request, response, filePath, download = false) {
     const ranges = rangeHeader.split(',');
     let range = ranges.length ? ranges[0] : undefined;
     if (!range) {
-        return streamFile(filePath, response);
+        return streamFile(filePath, request, response);
     }
     range = range.trim();
     if (!range.startsWith('bytes=')) {
-        return streamFile(filePath, response);
+        return streamFile(filePath, request, response);
     }
     range = range.substring(6);
     const strs = range.split('-');
     let start = strs[0] ? parseInt(strs[0], 10) : NaN;
     let end = strs[1] ? parseInt(strs[1], 10) : NaN;
     // 解析文件
-    const stat = (0, fs_1.statSync)(filePath);
     if (isNaN(start) || start < 0) {
         // 范围不合法，返回 416
         (0, json_1.renderError)(response, `Range not satisfiable，start is ${start}`, 416);
         return;
     }
     if (isNaN(end)) {
-        end = stat.size - 1;
+        end = statRes.size - 1;
     }
-    else if (end > stat.size - 1) {
+    else if (end > statRes.size - 1) {
         // 范围不合法，返回 416
-        (0, json_1.renderError)(response, `Range not satisfiable，end must not be greater than ${stat.size - 1}`, 416);
+        (0, json_1.renderError)(response, `Range not satisfiable，end must not be greater than ${statRes.size - 1}`, 416);
         return;
     }
     // 注：Range 和 Content-Range 还有 createReadStream 中的字节范围，都是前后全包含的
     // Content-Range: bytes 42-1233/1234
-    response.setHeader('Content-Range', `bytes ${start}-${end}/${stat.size}`);
-    return streamFile(filePath, response, { start, end });
+    response.setHeader('Content-Range', `bytes ${start}-${end}/${statRes.size}`);
+    return streamFile(filePath, request, response, { start, end });
 }
 exports.renderFile = renderFile;
-function streamFile(filePath, response, opts) {
+function streamFile(filePath, request, response, opts) {
     return new Promise((res, rej) => {
         if (opts && typeof opts.start === 'number') {
             // 部分返回 206
@@ -171,6 +192,22 @@ function streamFile(filePath, response, opts) {
             // 全部返回 200
             response.statusCode = 200;
         }
+        // 支持 gzip
+        const acceptEncoding = request.headers['accept-encoding'];
+        if (acceptEncoding) {
+            // Accept-Encoding: br;q=1.0, gzip;q=0.8, *;q=0.1
+            const acceptEncodings = acceptEncoding
+                .trim()
+                .split(',')
+                .map(item => item.trim())
+                .map(item => item.split(';')[0]);
+            if (acceptEncodings.includes('gzip') || acceptEncodings.includes('*')) {
+                response.setHeader('Content-Encoding', 'gzip');
+                (0, fs_1.createReadStream)(filePath, opts).pipe((0, zlib_1.createGzip)()).pipe(response);
+                response.once('finish', res).once('error', rej);
+                return;
+            }
+        }
         (0, fs_1.createReadStream)(filePath, opts).pipe(response);
         response.once('finish', res).once('error', rej);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wok-server",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "packageManager": "pnpm@8.9.0",
   "description": "一个基于 NodeJs 和 TypeScript 的后端框架，轻量级、克制、简洁。A lightweight, restrained, and concise backend framework based on Node.js and TypeScript.",
   "scripts": {

package/types/mvc/handler/json.d.ts

@@ -12,7 +12,7 @@ export declare function createJsonHandler<REQ, RES = void>(opts: {
     /**
      * 校验信息，可选，用于检查请求信息.对于一些特殊情况，无法使用校验器的，可以在 handle 中继续处理.
      */
-    validation?: ValidationOpts<REQ>;
+    validation?: ValidationOpts<REQ> | (() => ValidationOpts<REQ>);
     /**
      * 处理请求.
      * @param body 正文内容