wok-server 0.2.1 → 0.3.0

package/dist/config/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerConfig = exports.getConfig = void 0;
+exports.generateConfig = exports.registerConfig = exports.getConfig = void 0;
 const tslib_1 = require("tslib");
 const dotenv_1 = require("dotenv");
 const validation_1 = require("../validation");
@@ -31,6 +31,21 @@ function registerConfig(defaultConfig, envPrefix, validation) {
     if (configEnvMap.has(envPrefix)) {
         throw new exception_1.ConfigException(`The prefix "${envPrefix}" has already been registered`);
     }
+    const config = generateConfig(defaultConfig, envPrefix, validation);
+    configEnvMap.set(envPrefix, config);
+    return config;
+}
+exports.registerConfig = registerConfig;
+/**
+ * 根据环境变量来生成配置对象，与 registerConfig 的参数是一致的，和 registerConfig 不同的是
+ * generateConfig 可以多次重复使用，方便在运行时更改环境变量后再生成配置，而调用 registerConfig
+ * 一旦注册后不能再被更改。之所以这样设计是为了方便程序的测试，模拟不同的环境来运行程序，和其它的
+ * 一些特殊需求。
+ * @param defaultConfig
+ * @param envPrefix
+ * @param validation
+ */
+function generateConfig(defaultConfig, envPrefix, validation) {
     // 环境变量匹配
     for (const propName in defaultConfig) {
         const defaultVal = defaultConfig[propName];
@@ -53,10 +68,9 @@ function registerConfig(defaultConfig, envPrefix, validation) {
             throw new exception_1.ConfigException(`Error in verifying configuration information, configuration prefix：${envPrefix}`);
         }
     }
-    configEnvMap.set(envPrefix, defaultConfig);
     return defaultConfig;
 }
-exports.registerConfig = registerConfig;
+exports.generateConfig = generateConfig;
 function buildEnvName(envPrefix, propName) {
     let part2 = propName.replace(/[A-Z]+/g, subStr => `_${subStr}`);
     if (part2.startsWith('_')) {

package/dist/log/file.js

@@ -14,14 +14,7 @@ let QUEUE = [];
  */
 function fileStore(log) {
     QUEUE.push(log);
-    setTimeout(() => {
-        try {
-            write();
-        }
-        catch (e) {
-            console.error('Writing log file failed', e);
-        }
-    }, 0);
+    setTimeout(() => write().catch(e => console.error('Writing log file failed', e)), 0);
 }
 exports.fileStore = fileStore;
 function buildFilePath() {
@@ -35,18 +28,18 @@ function buildFilePath() {
     fileName += '.log';
     return (0, path_1.resolve)(config_1.config.fileDir, fileName);
 }
-function write() {
+async function write() {
     if (!QUEUE.length) {
         return;
     }
     const path = buildFilePath();
     const dir = (0, path_1.dirname)(path);
     if (!(0, fs_1.existsSync)(dir)) {
-        (0, fs_1.mkdirSync)(dir);
+        await (0, promises_1.mkdir)(dir, { recursive: true });
     }
     const lines = QUEUE.join(os_1.EOL);
-    (0, fs_1.appendFileSync)(path, lines);
     QUEUE = [];
+    await (0, promises_1.appendFile)(path, lines);
 }
 if (config_1.config.file) {
     /**

package/dist/mvc/config.js

@@ -1,20 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = void 0;
+exports.getConfig = void 0;
 const config_1 = require("../config");
 const validation_1 = require("../validation");
-exports.config = (0, config_1.registerConfig)({
-    port: 8080,
-    timeout: 30000,
-    accessLog: false,
-    corsAllowHeaders: '*',
-    corsAllowMethods: '*',
-    corsAllowOrigin: '*'
-}, 'SERVER', {
-    port: [(0, validation_1.notNull)(), (0, validation_1.min)(80), (0, validation_1.max)(65535)],
-    timeout: [(0, validation_1.notNull)(), (0, validation_1.min)(1000), (0, validation_1.max)(60000)],
-    accessLog: [(0, validation_1.notNull)()],
-    corsAllowOrigin: [(0, validation_1.notBlank)()],
-    corsAllowHeaders: [(0, validation_1.notBlank)()],
-    corsAllowMethods: [(0, validation_1.notBlank)()]
-});
+function getConfig() {
+    return (0, config_1.generateConfig)({
+        port: 8080,
+        timeout: 30000,
+        accessLog: false,
+        corsAllowHeaders: '*',
+        corsAllowMethods: '*',
+        corsAllowOrigin: '*',
+        tlsEnable: false,
+        tlsKey: '',
+        tlsCert: ''
+    }, 'SERVER', {
+        port: [(0, validation_1.notNull)(), (0, validation_1.min)(80), (0, validation_1.max)(65535)],
+        timeout: [(0, validation_1.notNull)(), (0, validation_1.min)(1000), (0, validation_1.max)(60000)],
+        accessLog: [(0, validation_1.notNull)()],
+        corsAllowOrigin: [(0, validation_1.notBlank)()],
+        corsAllowHeaders: [(0, validation_1.notBlank)()],
+        corsAllowMethods: [(0, validation_1.notBlank)()],
+        tlsEnable: [(0, validation_1.notNull)()]
+    });
+}
+exports.getConfig = getConfig;

package/dist/mvc/handler/json.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonHandler = void 0;
+const cache_1 = require("../../cache");
 const i18n_1 = require("../../i18n");
 const validation_1 = require("../../validation");
 /**
@@ -27,6 +28,26 @@ function createJsonHandler(opts) {
                 (0, validation_1.validate)(body, opts.validation);
             }
         }
+        // 缓存处理
+        if (opts.cache) {
+            const cacheInfo = await opts.cache(body, exchange);
+            const buffer = (0, cache_1.getCache)().get(cacheInfo.key);
+            if (buffer && buffer instanceof Buffer) {
+                renderJsonBuffer(exchange, buffer);
+            }
+            else {
+                const res = await opts.handle(body, { request: exchange.request });
+                if (!res) {
+                    // 无结果不缓存
+                    exchange.respond({ statusCode: 200 });
+                    return;
+                }
+                const buffer = Buffer.from(JSON.stringify(res), 'utf-8');
+                (0, cache_1.getCache)().put(cacheInfo.key, buffer, cacheInfo.expiresInSeconds);
+                renderJsonBuffer(exchange, buffer);
+            }
+            return;
+        }
         const res = await opts.handle(body, { request: exchange.request });
         if (!res) {
             exchange.respond({ statusCode: 200 });
@@ -36,3 +57,9 @@ function createJsonHandler(opts) {
     };
 }
 exports.createJsonHandler = createJsonHandler;
+function renderJsonBuffer(exchange, buffer) {
+    const { response } = exchange;
+    response.setHeader('content-type', 'application/json; charset=UTF-8');
+    response.statusCode = 200;
+    response.end(buffer);
+}

package/dist/mvc/index.js

@@ -2,193 +2,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 https_1 = require("https");
-const os_1 = require("os");
-const path_1 = require("path");
-const log_1 = require("../log");
-const access_log_1 = require("./access-log");
-const config_1 = require("./config");
-const exchange_1 = require("./exchange");
-const render_1 = require("./render");
-/**
- * 处理请求，完成拦截器和路由的流程.
- *
- * @param interceptors 拦截器
- * @param routers 路由
- * @param req
- * @param res
- * @param staticSettings
- */
-async function handleRequest(interceptors, routers, req, res, staticSettings) {
-    req.socket.remoteAddress;
-    const { method } = req;
-    // cros 支持
-    res.setHeader('Access-Control-Allow-Origin', config_1.config.corsAllowOrigin);
-    res.setHeader('Access-Control-Allow-Headers', config_1.config.corsAllowHeaders);
-    res.setHeader('Access-Control-Allow-Methods', config_1.config.corsAllowMethods);
-    if (method === 'OPTIONS') {
-        res.statusCode = 200;
-        res.end();
-        return;
-    }
-    const exchange = new exchange_1.ServerExchange(req, res);
-    // 顺序执行拦截器
-    await handleInterceptor(interceptors, 0, exchange, req, res, routers, staticSettings);
-}
-/**
- * 处理拦截器.
- * @param interceptors 拦截器
- * @param idx 当前要执行的拦截器下标
- * @param exchange 传输对象
- * @param req
- * @param res
- * @param routers 路由
- * @param staticSettings
- */
-async function handleInterceptor(interceptors, idx, exchange, req, res, routers, staticSettings) {
-    const interceptor = interceptors[idx];
-    // 到最后一个了，那么执行路由处理
-    if (!interceptor) {
-        await handleRouter(exchange, routers, staticSettings);
-        return;
-    }
-    await interceptor(exchange, () => handleInterceptor(interceptors, idx + 1, exchange, req, res, routers, staticSettings));
-}
-/**
- * 处理路由.
- * @param exchange
- * @param routers
- * @param staticSettings
- * @returns
- */
-async function handleRouter(exchange, routers, staticSettings) {
-    const url = exchange.request.url;
-    if (url === undefined) {
-        return;
-    }
-    // 判定路由
-    const idx = url.indexOf('?');
-    let path = idx === -1 ? url : url.substring(0, idx);
-    const router = routers[path];
-    if (!router) {
-        // 路由找不不到，尝试静态文件
-        if ((exchange.request.method || '').toLowerCase() === 'get' && staticSettings.length) {
-            await handleStatic(exchange, routers, path, staticSettings);
-        }
-        else {
-            respond404(exchange, routers, path);
-        }
-        return;
-    }
-    // 执行路由
-    await router(exchange);
-    // 在路由顺利处理的情况下，如果 res 没有 end ，就表示响应没有完成
-    // 也就是说路由没有做响应处理，或处理没有完成就结束了，给予错误提示
-    if (!exchange.response.writableEnded) {
-        throw new Error(`RouterHandler unresponsive, url: ${url}`);
-    }
-}
-/**
- * 处理静态文件
- * @param exchange
- * @param routers
- * @param path
- * @param staticDir
- * @returns
- */
-async function handleStatic(exchange, routers, path, staticSettings) {
-    // 匹配
-    let matchedSetting;
-    for (const setting of staticSettings) {
-        if (setting.path === '/') {
-            matchedSetting = setting;
-            break;
-        }
-        if (path.startsWith(setting.path)) {
-            matchedSetting = setting;
-            break;
-        }
-    }
-    if (!matchedSetting) {
-        respond404(exchange, routers, path);
-        return;
-    }
-    let finalPath = matchedSetting.path === '/' ? path : path.substring(matchedSetting.path.length);
-    if (finalPath.startsWith('/')) {
-        finalPath = finalPath.substring(1);
-    }
-    const fullPath = (0, path_1.resolve)(matchedSetting.dir, finalPath);
-    if (!(0, fs_1.existsSync)(fullPath)) {
-        respond404(exchange, routers, path);
-        return;
-    }
-    const statRes = await (0, promises_1.stat)(fullPath);
-    // 目录，寻找 index.html
-    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 = await (0, promises_1.stat)(indexPath);
-        if (!indexStat.isFile()) {
-            respond404(exchange, routers, path);
-            return;
-        }
-        // Cache-Control
-        if (matchedSetting.cacheAge >= 0) {
-            exchange.response.setHeader('Cache-Control', matchedSetting.cacheAge === 0 ? 'no-store' : `max-age=${matchedSetting.cacheAge}`);
-        }
-        await exchange.respondFile(indexPath, false);
-        return;
-    }
-    // 文件直接渲染
-    if (statRes.isFile()) {
-        // Cache-Control
-        if (matchedSetting.cacheAge >= 0) {
-            exchange.response.setHeader('Cache-Control', matchedSetting.cacheAge === 0 ? 'no-store' : `max-age=${matchedSetting.cacheAge}`);
-        }
-        await exchange.respondFile(fullPath, false);
-        return;
-    }
-    // 其它类型，404
-    respond404(exchange, routers, path);
-}
-/**
- * 404响应
- *
- * @param exchange
- * @param routers
- * @param path
- */
-async function respond404(exchange, routers, path) {
-    const handler = routers['*'];
-    if (handler) {
-        await handler(exchange);
-    }
-    else {
-        exchange.respondErrMsg(`${path} not found`, 404);
-    }
-}
-/**
- * 获取 ipv4 地址列表
- * @returns
- */
-function getIpv4List() {
-    const ifs = (0, os_1.networkInterfaces)();
-    const res = [];
-    for (const name in ifs) {
-        const list = ifs[name];
-        if (!list) {
-            continue;
-        }
-        res.push(...list.filter(info => info.family === 'IPv4').map(info => info.address));
-    }
-    return res;
-}
+const server_1 = require("./server");
 /**
  * 服务实例.
  */
@@ -198,103 +12,11 @@ let SERVER;
  * @param opts
  */
 async function startWebServer(opts) {
-    (0, https_1.createServer)({
-        cert: '', key: ''
-    }, () => {
-    });
     if (SERVER) {
         throw new Error('The server has already been started!');
     }
-    // 检查静态文件配置，做一些预处理的操作，在处理静态资源的请求时不必再做这些处理
-    const staticSettings = [];
-    if (opts.static) {
-        // 重复记录表 ，作用是为了路径去重判定，可以提示哪些路径是重复的
-        const duplicateMap = new Map();
-        for (const entry of Object.entries(opts.static)) {
-            const [path, setting] = entry;
-            const dir = (0, path_1.isAbsolute)(setting.dir) ? setting.dir : (0, path_1.resolve)(process.cwd(), setting.dir);
-            if (!(0, fs_1.existsSync)(dir)) {
-                throw new Error(`Static file configuration error，path ${dir} does not exist，config dir：${setting.dir}`);
-            }
-            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;
-            // 保持以 / 结尾，为了匹配方便
-            if (!finalPath.endsWith('/')) {
-                finalPath += '/';
-            }
-            if (duplicateMap.has(finalPath)) {
-                throw new Error(`Static path duplicated: ${duplicateMap.get(finalPath)} and ${path}`);
-            }
-            duplicateMap.set(finalPath, path);
-            staticSettings.push({ path: finalPath, dir, cacheAge: setting.cacheAge || 0 });
-        }
-        // 优先级排序
-        staticSettings.sort((o1, o2) => {
-            let priority1 = o1.path === '/' ? -1 : o1.path.split('/').length;
-            let priority2 = o2.path === '/' ? -1 : o2.path.split('/').length;
-            // 如果 o1 优先级高，就应该排前面，返回小于0的值，反之亦然\
-            // 前面的优先级值是值越大优先级越高，反过来减
-            return priority2 - priority1;
-        });
-    }
-    // 如果启用请求日志，增加拦截器
-    let interceptors = [];
-    if (config_1.config.accessLog) {
-        interceptors.push(access_log_1.accessLogInterceptor);
-    }
-    if (opts.interceptors) {
-        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);
-        });
-        handleRequest(interceptors, opts.routers, req, res, staticSettings).catch(error => {
-            (0, log_1.getLogger)().error(`Handle request failed：${req.url}`, error);
-            if (!res.writableEnded) {
-                // 响应 500
-                (0, render_1.renderError)(res, error.message ? error.message : 'Internal Server Error', 500);
-            }
-        });
-    });
-    SERVER.setTimeout(config_1.config.timeout);
-    SERVER.on('timeout', (socket) => {
-        socket.end('HTTP/1.1 408 Timeout\ncontent-type: application/json; charset=utf-8\n\n{"message":"Request timeout"}');
-    });
-    if (opts.preHandler) {
-        await opts.preHandler(SERVER);
-    }
-    const server = SERVER;
-    await new Promise((resolve, reject) => {
-        server.on('error', e => {
-            if (e.code === 'EADDRINUSE') {
-                reject(`Port ${config_1.config.port} is already in use.`);
-            }
-            else {
-                reject(e);
-            }
-        });
-        server.listen(config_1.config.port, resolve);
-    });
-    console.log('App running at: ');
-    getIpv4List().forEach(ip => {
-        if (config_1.config.port === 80) {
-            console.log(`http://${ip}`);
-        }
-        else {
-            console.log(`http://${ip}:${config_1.config.port}`);
-        }
-    });
-    process.on('beforeExit', () => {
-        if (server.listening) {
-            server.close();
-        }
-    });
+    SERVER = new server_1.WokServer(opts);
+    await SERVER.start();
 }
 exports.startWebServer = startWebServer;
 /**
@@ -305,24 +27,13 @@ async function stopWebServer() {
     if (!SERVER) {
         return;
     }
-    if (SERVER.listening) {
-        const server = SERVER;
-        await new Promise((res, rej) => {
-            server.close(err => {
-                if (err) {
-                    rej(err);
-                }
-                else {
-                    res();
-                }
-            });
-        });
-    }
+    SERVER.stop();
     SERVER = undefined;
 }
 exports.stopWebServer = stopWebServer;
+process.on('beforeExit', stopWebServer);
 tslib_1.__exportStar(require("./exchange"), exports);
 tslib_1.__exportStar(require("./handler"), exports);
+tslib_1.__exportStar(require("./interceptor"), exports);
 tslib_1.__exportStar(require("./render"), exports);
 tslib_1.__exportStar(require("./router"), exports);
-tslib_1.__exportStar(require("./interceptor"), exports);

package/dist/mvc/render/file.js

@@ -3,92 +3,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 对照表
- */
-const frequentlyUsedContentTypeTable = {
-    aac: 'audio/aac',
-    abw: 'application/x-abiword',
-    arc: 'application/x-freearc',
-    avi: 'video/x-msvideo',
-    azw: 'application/vnd.amazon.ebook',
-    bin: 'application/octet-stream',
-    bmp: 'image/bmp',
-    bz: 'application/x-bzip',
-    bz2: 'application/x-bzip2',
-    csh: 'application/x-csh',
-    css: 'text/css',
-    csv: 'text/csv',
-    doc: 'application/msword',
-    docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
-    eot: 'application/vnd.ms-fontobject',
-    epub: 'application/epub+zip',
-    gif: 'image/gif',
-    htm: 'text/html',
-    html: 'text/html',
-    ico: 'image/vnd.microsoft.icon',
-    ics: 'text/calendar',
-    jar: 'application/java-archive',
-    jpeg: 'image/jpeg',
-    jpg: 'image/jpeg',
-    js: 'text/javascript',
-    json: 'application/json',
-    jsonld: 'application/ld+json',
-    mid: 'audio/midi',
-    midi: 'audio/midi',
-    mjs: 'text/javascript',
-    mp3: 'audio/mpeg',
-    mpeg: 'video/mpeg',
-    mpkg: 'application/vnd.apple.installer+xml',
-    odp: 'application/vnd.oasis.opendocument.presentation',
-    ods: 'application/vnd.oasis.opendocument.spreadsheet',
-    odt: 'application/vnd.oasis.opendocument.text',
-    oga: 'audio/ogg',
-    ogv: 'video/ogg',
-    ogx: 'application/ogg',
-    otf: 'font/otf',
-    png: 'image/png',
-    pdf: 'application/pdf',
-    ppt: 'application/vnd.ms-powerpoint',
-    pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
-    rar: 'application/x-rar-compressed',
-    rtf: 'application/rtf',
-    sh: 'application/x-sh',
-    svg: 'image/svg+xml',
-    swf: 'application/x-shockwave-flash',
-    tar: 'application/x-tar',
-    tif: 'image/tiff',
-    tiff: 'image/tiff',
-    ttf: 'font/ttf',
-    txt: 'text/plain',
-    vsd: 'application/vnd.visio',
-    wav: 'audio/wav',
-    weba: 'audio/webm',
-    webm: 'video/webm',
-    webp: 'image/webp',
-    woff: 'font/woff',
-    woff2: 'font/woff2',
-    xhtml: 'application/xhtml+xml',
-    xls: 'application/vnd.ms-excel',
-    xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-    xml: 'application/xml',
-    xul: 'application/vnd.mozilla.xul+xml',
-    zip: 'application/zip',
-    '3gp': 'video/3gpp',
-    '3g2': 'video/3gpp2',
-    '7z': 'application/x-7z-compressed'
-};
-function decideContentType(fileName) {
-    const idx = fileName.lastIndexOf('.');
-    if (idx === -1) {
-        return undefined;
-    }
-    const suffix = fileName.substring(idx + 1);
-    return frequentlyUsedContentTypeTable[suffix];
-}
+const static_1 = require("../static");
+const json_1 = require("./json");
 /**
  * 响应一个文件.
  * @param request  请求信息
@@ -108,7 +26,7 @@ async function renderFile(request, response, filePath, download = false) {
         isDownload = true;
     }
     else {
-        contentType = decideContentType(fileName);
+        contentType = (0, static_1.decideContentType)(fileName);
         if (!contentType) {
             isDownload = true;
         }