wok-server 0.1.0

package/dist/mysql/manager/utils.js

@@ -0,0 +1,56 @@
+"use strict";
+// 工具集，将一些驱动的方法进行 promise 封装，方便操作
+// 程序中没有使用 mysql2/promise ，主要是在测试中发现 mysql2/promise 不是很可靠
+// mysql2/promise 在查询方便处理的不是很好
+// query 查询在没有记录的情况下仍然会返回列表，里面会包含列定义信息，不符合预期
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promiseGetConnection = exports.promiseQuery = void 0;
+const mysql2_1 = require("mysql2");
+const log_1 = require("../../log");
+/**
+ * 查询，适用于各种 sql 的执行
+ * @param config
+ * @param conn
+ * @param sql
+ * @param values
+ * @returns
+ */
+function promiseQuery(config, conn, sql, values = []) {
+    return new Promise((res, rej) => {
+        const start = new Date().getTime();
+        conn.query(sql, values, (err, result) => {
+            if (config.slowSqlWarn) {
+                const cost = new Date().getTime() - start;
+                // 慢 sql 警告
+                if (cost > config.slowSqlMs) {
+                    (0, log_1.getLogger)().warn(`[mysql slow sql] ${cost}ms ${(0, mysql2_1.format)(sql, values)}`);
+                }
+            }
+            if (err) {
+                rej(err);
+            }
+            else {
+                res(result);
+            }
+        });
+    });
+}
+exports.promiseQuery = promiseQuery;
+/**
+ * 获取连接
+ * @param pool
+ * @returns
+ */
+function promiseGetConnection(pool) {
+    return new Promise((res, rej) => {
+        pool.getConnection((err, conn) => {
+            if (err) {
+                rej(err);
+            }
+            else {
+                res(conn);
+            }
+        });
+    });
+}
+exports.promiseGetConnection = promiseGetConnection;

package/dist/mysql/migration.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrate = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const log_1 = require("../log");
+const exception_1 = require("./exception");
+const utils_1 = require("./manager/utils");
+/**
+ * 迁移.
+ * @param config
+ * @param conn
+ */
+async function migrate(config, conn) {
+    const versionDir = config.versionControlDir;
+    // 查找文件
+    const dir = (0, path_1.isAbsolute)(versionDir) ? versionDir : (0, path_1.resolve)(process.cwd(), versionDir);
+    if (!(0, fs_1.existsSync)(dir)) {
+        throw new Error(`Directory ${versionDir} does not exist`);
+    }
+    const versions = [];
+    // 忽略隐藏文件
+    const files = (0, fs_1.readdirSync)(dir).filter(file => !file.startsWith('.'));
+    for (const file of files) {
+        const filePath = (0, path_1.resolve)(dir, file);
+        const stat = (0, fs_1.statSync)(filePath);
+        if (!stat.isFile()) {
+            continue;
+        }
+        if (!file.endsWith('.sql')) {
+            throw new Error(`版本文件名没有以 .sql 为后缀：${file}`);
+        }
+        const version = parseInt(file.substring(0, file.length - 4));
+        if (isNaN(version)) {
+            throw new Error(`Version file is not named with a number：${file}`);
+        }
+        versions.push({ version, filePath });
+    }
+    // 排序，判定顺序
+    versions.sort((o1, o2) => o1.version - o2.version);
+    for (let i = 0; i < versions.length; i++) {
+        const version = versions[i];
+        if (version.version !== i + 1) {
+            throw new Error(`The SQL version number must start from 1 and increment one by one，error version：${version.version}`);
+        }
+    }
+    await createVersionTableIfNotExist(config, conn);
+    // 在事务中执行版本管理，主要目的是为了通过锁来协调多个进程同时启动的情况
+    // 事务不能保存一个版本处理成功就完整回退，如有错误，仍然需要手动调整后再操作
+    await (0, utils_1.promiseQuery)(config, conn, `SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED`);
+    await new Promise((resolve, reject) => {
+        conn.beginTransaction(err => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                resolve();
+            }
+        });
+    });
+    try {
+        // 执行 sql, 判定当前版本
+        let currentVersion = await getCurrentVersion(config, conn);
+        if (typeof currentVersion !== 'number') {
+            // 插入初始版本号
+            await (0, utils_1.promiseQuery)(config, conn, 'insert `db_version`(`version`) values (0)');
+        }
+        const filnalCurrentVersion = currentVersion || 0;
+        const pendingVersions = versions.filter(ver => ver.version > filnalCurrentVersion);
+        if (!pendingVersions.length) {
+            (0, log_1.getLogger)().info('The SQL version is already the latest.');
+            return;
+        }
+        const nextVersion = filnalCurrentVersion + 1;
+        if (pendingVersions[0].version !== nextVersion) {
+            throw new exception_1.MysqlException(`MySQL migration error, the next version should be ${nextVersion}，but current is ${pendingVersions[0].version}`);
+        }
+        for (const verion of pendingVersions) {
+            (0, log_1.getLogger)().info(`Mysql migrating, version: ${verion.version}`);
+            let sql = (0, fs_1.readFileSync)(verion.filePath, { encoding: 'utf-8' });
+            await (0, utils_1.promiseQuery)(config, conn, sql);
+            // 版本号
+            await (0, utils_1.promiseQuery)(config, conn, `UPDATE db_version SET version=${verion.version};`);
+        }
+        // 提交
+        await new Promise((resolve, reject) => {
+            conn.commit(err => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+        (0, log_1.getLogger)().info('Mysql migration finished.');
+    }
+    catch (e) {
+        // 异常回退，仅能回退 dml 操作，对 ddl 无效
+        await new Promise((resolve, reject) => {
+            conn.rollback(err => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+        throw e;
+    }
+}
+exports.migrate = migrate;
+async function createVersionTableIfNotExist(config, conn) {
+    await (0, utils_1.promiseQuery)(config, conn, 'CREATE TABLE IF NOT EXISTS `db_version` (' +
+        '  `version` int NOT NULL,' +
+        '  PRIMARY KEY (`version`)' +
+        ') ENGINE = innodb DEFAULT CHARACTER SET = "utf8mb4" ' +
+        'COLLATE = "utf8mb4_unicode_ci";');
+}
+/**
+ * 获取当前版本，使用 for update 加锁，用于协调多进程并发场景
+ * @param config
+ * @param conn
+ * @returns
+ */
+async function getCurrentVersion(config, conn) {
+    const res = await (0, utils_1.promiseQuery)(config, conn, 'select version from `db_version` for update');
+    const rows = res;
+    if (rows.length >= 1) {
+        return rows[0].version;
+    }
+    else {
+        return null;
+    }
+}

package/dist/mysql/table-info.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableValidation = void 0;
+const validation_1 = require("../validation");
+exports.tableValidation = {
+    tableName: [(0, validation_1.notBlank)('表名不能为空')],
+    id: [(0, validation_1.notBlank)('id 不能为空')]
+};

package/dist/task/daily.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dailyTaskDelay = exports.scheduleDailyTask = void 0;
+const validation_1 = require("../validation");
+const task_1 = require("./task");
+/**
+ * 每日任务.
+ * @param hours 时
+ * @param minutes 分
+ * @param task 要执行的任务
+ * @returns
+ */
+function scheduleDailyTask(hours, minutes, task) {
+    // 校验
+    (0, validation_1.validate)({ hours, minutes }, {
+        hours: [(0, validation_1.notNull)(), (0, validation_1.min)(0), (0, validation_1.max)(23)],
+        minutes: [(0, validation_1.notNull)(), (0, validation_1.min)(0), (0, validation_1.max)(59)]
+    });
+    const taskController = new task_1.TaskController();
+    const delay = dailyTaskDelay(hours, minutes);
+    setTimeout(() => exec(hours, minutes, task, taskController), delay);
+    return taskController;
+}
+exports.scheduleDailyTask = scheduleDailyTask;
+/**
+ * 计算到下次指定时间点的延迟
+ * @param hours
+ * @param minutes
+ */
+function dailyTaskDelay(hours, minutes) {
+    const now = new Date();
+    let todayTime = new Date();
+    todayTime.setHours(hours);
+    todayTime.setMinutes(minutes);
+    todayTime.setSeconds(0);
+    todayTime.setMilliseconds(0);
+    // 如果今天还没有到指定的点，今天就执行，否则明天执行
+    if (todayTime > now) {
+        return todayTime.getTime() - now.getTime();
+    }
+    // 明天时间
+    const oneDayMilliseconds = 1000 * 3600 * 24;
+    const tomorrowTime = todayTime.getTime() + oneDayMilliseconds;
+    return tomorrowTime - now.getTime();
+}
+exports.dailyTaskDelay = dailyTaskDelay;
+function exec(hours, minutes, task, controller) {
+    Promise.resolve()
+        .then(async () => {
+        if (controller.isStopped()) {
+            return;
+        }
+        await (0, task_1.execTask)(task);
+        const delay = dailyTaskDelay(hours, minutes);
+        setTimeout(() => exec(hours, minutes, task, controller), delay);
+    })
+        .catch(console.error);
+}

package/dist/task/fixed-delay.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scheduleWithFixedDelay = void 0;
+const validation_1 = require("../validation");
+const task_1 = require("./task");
+/**
+ * 固定延迟执行任务
+ * @param initialDelay  第一次执行延迟的时间，单位秒
+ * @param delay 每次的延迟时间，单位秒
+ * @param task 任务
+ */
+function scheduleWithFixedDelay(initialDelay, delay, task) {
+    (0, validation_1.validate)({ initialDelay, delay }, {
+        initialDelay: [(0, validation_1.notNull)(), (0, validation_1.min)(0), (0, validation_1.max)(3600 * 24)],
+        delay: [(0, validation_1.notNull)(), (0, validation_1.min)(1), (0, validation_1.max)(3600 * 24)]
+    });
+    const controller = new task_1.TaskController();
+    setTimeout(() => exec(delay, task, controller), initialDelay * 1000);
+    return controller;
+}
+exports.scheduleWithFixedDelay = scheduleWithFixedDelay;
+function exec(delay, task, controller) {
+    Promise.resolve()
+        .then(async () => {
+        if (controller.isStopped()) {
+            return;
+        }
+        await (0, task_1.execTask)(task);
+        // 下次执行
+        setTimeout(() => exec(delay, task, controller), delay * 1000);
+    })
+        .catch(console.error);
+}

package/dist/task/fixed-rate.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scheduleWithFixedRate = void 0;
+const validation_1 = require("../validation");
+const task_1 = require("./task");
+/**
+ * 固定延迟执行任务
+ * @param initialDelay  第一次执行延迟的时间，单位秒
+ * @param period 每次的延迟时间，单位秒
+ * @param task 任务
+ */
+function scheduleWithFixedRate(initialDelay, period, task) {
+    (0, validation_1.validate)({ initialDelay, period }, {
+        initialDelay: [(0, validation_1.notNull)(), (0, validation_1.min)(0), (0, validation_1.max)(3600 * 24)],
+        period: [(0, validation_1.notNull)(), (0, validation_1.min)(1), (0, validation_1.max)(3600 * 24)]
+    });
+    const taskController = new task_1.TaskController();
+    setTimeout(() => exec(period, task, taskController), initialDelay * 1000);
+    return taskController;
+}
+exports.scheduleWithFixedRate = scheduleWithFixedRate;
+function exec(fixedDelay, task, controller) {
+    Promise.resolve()
+        .then(async () => {
+        if (controller.isStopped()) {
+            return;
+        }
+        const res = await (0, task_1.execTask)(task);
+        // 下次执行
+        let delay = res.start + fixedDelay * 1000 - new Date().getTime();
+        if (delay < 0) {
+            delay = 0;
+        }
+        setTimeout(() => exec(fixedDelay, task, controller), delay);
+    })
+        .catch(console.error);
+}

package/dist/task/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskController = void 0;
+const tslib_1 = require("tslib");
+var task_1 = require("./task");
+Object.defineProperty(exports, "TaskController", { enumerable: true, get: function () { return task_1.TaskController; } });
+tslib_1.__exportStar(require("./fixed-delay"), exports);
+tslib_1.__exportStar(require("./fixed-rate"), exports);
+tslib_1.__exportStar(require("./daily"), exports);

package/dist/task/task.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execTask = exports.TaskController = void 0;
+const log_1 = require("../log");
+/**
+ * 任务控制器
+ */
+class TaskController {
+    #stopped = false;
+    isStopped() {
+        return this.#stopped;
+    }
+    stop() {
+        this.#stopped = true;
+    }
+}
+exports.TaskController = TaskController;
+/**
+ * 任务执行，封装任务执行过程中的一些通用信息输出和异常控制.
+ * @param task
+ * @returns
+ */
+async function execTask(task) {
+    const start = new Date().getTime();
+    try {
+        (0, log_1.getLogger)().info(`START TASK：${task.name}`);
+        await task.run();
+    }
+    catch (e) {
+        (0, log_1.getLogger)().error(`TASK ERROR: ${task.name}`, e);
+    }
+    const end = new Date().getTime();
+    const cost = end - start;
+    if (cost > 1000 * 60 * 5) {
+        (0, log_1.getLogger)().warn(`Task "${task.name}" takes too long ，cost ${cost}ms`);
+    }
+    return { start, cost, end };
+}
+exports.execTask = execTask;

package/dist/validation/exception.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationException = void 0;
+/**
+ * 校验异常.
+ */
+class ValidationException {
+    errMsg;
+    validator;
+    propertyPath;
+    val;
+    constructor(
+    /**
+     * 异常信息，如 “不能为空” 之类的.
+     */
+    errMsg, 
+    /**
+     * 校验器名称，如 length 、notNull 之类的.
+     */
+    validator, 
+    /**
+     * 校验出错的路径.
+     */
+    propertyPath, 
+    /**
+     * 值
+     */
+    val) {
+        this.errMsg = errMsg;
+        this.validator = validator;
+        this.propertyPath = propertyPath;
+        this.val = val;
+    }
+    /**
+     * 对错误的完整描述信息，用于日志记录.
+     */
+    desc() {
+        return `Field "${this.propertyPath}" failed to validate by validator ${this.validator} ，value：${this.val}，info：${this.errMsg}`;
+    }
+    get message() {
+        return this.desc();
+    }
+}
+exports.ValidationException = ValidationException;

package/dist/validation/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = void 0;
+const tslib_1 = require("tslib");
+const exception_1 = require("./exception");
+/**
+ * 校验对象.
+ * @param obj
+ */
+function validate(obj, opts) {
+    for (const entry of Object.entries(opts)) {
+        const [prop, validators] = entry;
+        const val = obj[prop];
+        for (const validator of validators) {
+            const result = validator(val);
+            if (!result.ok) {
+                const propPath = [prop];
+                if (result.propPath) {
+                    propPath.push(...result.propPath);
+                }
+                throw new exception_1.ValidationException(result.message, result.validator, propPath.join('.'), val);
+            }
+        }
+    }
+}
+exports.validate = validate;
+// 导出
+tslib_1.__exportStar(require("./exception"), exports);
+tslib_1.__exportStar(require("./validator"), exports);

package/dist/validation/validator/array.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.array = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * 校验数组的条目.
+ */
+function array(opts) {
+    const validator = 'array';
+    return val => {
+        if (!val) {
+            return { ok: true };
+        }
+        if (!Array.isArray(val)) {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-array') };
+        }
+        // 条目处理
+        for (let i = 0; i < val.length; i++) {
+            const item = val[i];
+            for (const validation of Object.entries(opts)) {
+                const [prop, validators] = validation;
+                const val = item[prop];
+                for (const validate of validators) {
+                    const result = validate(val);
+                    if (!result.ok) {
+                        const propPath = [`[${i}]`, prop];
+                        if (result.propPath) {
+                            propPath.push(...result.propPath);
+                        }
+                        return { ok: false, validator, message: result.message, propPath };
+                    }
+                }
+            }
+        }
+        return { ok: true };
+    };
+}
+exports.array = array;

package/dist/validation/validator/enum.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enumerate = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * 枚举，校验值必须是指定列表中的一个.
+ * @param list 支持的值列表，仅支持数字和字符串类型
+ * @param msg
+ * @returns
+ */
+function enumerate(list, msg) {
+    const validator = 'enumerate';
+    return val => {
+        if (!val) {
+            return { ok: true };
+        }
+        if (!list.some(item => item === val)) {
+            return {
+                ok: false,
+                validator,
+                // must be one of [1,2,3]
+                message: msg || (0, i18n_1.getI18n)().buildMsg('validate-err-enum', `[${list.join(',')}]`)
+            };
+        }
+        return { ok: true };
+    };
+}
+exports.enumerate = enumerate;

package/dist/validation/validator/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./not-null"), exports);
+tslib_1.__exportStar(require("./not-blank"), exports);
+tslib_1.__exportStar(require("./max"), exports);
+tslib_1.__exportStar(require("./min"), exports);
+tslib_1.__exportStar(require("./regexp"), exports);
+tslib_1.__exportStar(require("./length"), exports);
+tslib_1.__exportStar(require("./enum"), exports);
+tslib_1.__exportStar(require("./array"), exports);
+tslib_1.__exportStar(require("./plain-obj"), exports);
+tslib_1.__exportStar(require("./max-length"), exports);
+tslib_1.__exportStar(require("./min-length"), exports);

package/dist/validation/validator/length.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.length = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * length 校验，可用于字符串或数组.
+ * @returns
+ */
+function length(opts) {
+    const validator = 'length';
+    return val => {
+        // 不校验空
+        if (!val) {
+            return { ok: true };
+        }
+        if (typeof val.length !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-no-length') };
+        }
+        const { length } = val;
+        if (typeof length !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-length-not-number') };
+        }
+        if (typeof opts.min === 'number' && length < opts.min) {
+            return {
+                ok: false,
+                validator,
+                message: opts.message || (0, i18n_1.getI18n)().buildMsg('validate-err-min-length', `${opts.min}`)
+            };
+        }
+        if (typeof opts.max === 'number' && length > opts.max) {
+            return {
+                ok: false,
+                validator,
+                message: opts.message || (0, i18n_1.getI18n)().buildMsg('validate-err-max-length', `${opts.max}`)
+            };
+        }
+        return { ok: true };
+    };
+}
+exports.length = length;

package/dist/validation/validator/max-length.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maxLength = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * 最大长度校验，可用于字符串或数组.
+ * @param maxLength
+ * @param message
+ * @returns
+ */
+function maxLength(maxLength, message) {
+    const validator = 'maxLength';
+    return val => {
+        // 不校验空
+        if (!val) {
+            return { ok: true };
+        }
+        if (typeof val.length !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-no-length') };
+        }
+        const { length } = val;
+        if (typeof length !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-length-not-number') };
+        }
+        if (length > maxLength) {
+            return {
+                ok: false,
+                validator,
+                message: message || (0, i18n_1.getI18n)().buildMsg('validate-err-max-length', `${maxLength}`)
+            };
+        }
+        return { ok: true };
+    };
+}
+exports.maxLength = maxLength;

package/dist/validation/validator/max.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.max = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * 最大值校验.
+ * @param max 最大值
+ * @param msg 错误消息
+ */
+function max(max, msg) {
+    const validator = 'max';
+    return val => {
+        if (val == undefined || val === null) {
+            return { ok: true };
+        }
+        if (typeof val !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-numer') };
+        }
+        if (val > max) {
+            return {
+                ok: false,
+                validator,
+                message: msg || (0, i18n_1.getI18n)().buildMsg('validate-err-max', `${max}`)
+            };
+        }
+        return { ok: true };
+    };
+}
+exports.max = max;

package/dist/validation/validator/min-length.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.minLength = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * 最小长度校验，可用于字符串或数组.
+ * @returns
+ */
+function minLength(minLength, message) {
+    const validator = 'minLength';
+    return val => {
+        // 不校验空
+        if (!val) {
+            return { ok: true };
+        }
+        if (typeof val.length !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-no-length') };
+        }
+        const { length } = val;
+        if (typeof length !== 'number') {
+            return { ok: false, validator, message: (0, i18n_1.getI18n)().buildMsg('validate-err-length-not-number') };
+        }
+        if (length < minLength) {
+            return {
+                ok: false,
+                validator,
+                message: message || (0, i18n_1.getI18n)().buildMsg('validate-err-min-length', `${minLength}`)
+            };
+        }
+        return { ok: true };
+    };
+}
+exports.minLength = minLength;