wok-server 0.4.7 → 0.4.8

package/dist/http-client/index.js

@@ -16,14 +16,18 @@ function doRequest(opts) {
         if (opts.query) {
             Object.entries(opts.query).forEach(entry => {
                 const [key, val] = entry;
-                if (typeof val === 'string') {
+                // 忽略空值
+                if (val === undefined || val === null) {
+                    return;
+                }
+                else if (typeof val === 'string') {
                     url.searchParams.append(key, val);
                 }
                 else if (Array.isArray(val)) {
                     val.forEach(v => url.searchParams.append(key, v));
                 }
                 else {
-                    throw new Error(`The value is neither of string nor string[] type：${val}`);
+                    throw new Error(`The request parameter value is neither of string nor string[] type：${val} ,name: ${key}`);
                 }
             });
         }

package/dist/mysql/config.js

@@ -23,7 +23,8 @@ exports.defaultConfig = {
     slowSqlWarn: true,
     slowSqlMs: 200,
     transactionTimeout: 5000,
-    transactionStrict: true
+    transactionStrict: true,
+    maxOpsInStrictTx: 10
 };
 /**
  * 配置校验规则.
@@ -45,5 +46,6 @@ exports.configValidation = {
     slowSqlWarn: [(0, validation_1.notNull)()],
     slowSqlMs: [(0, validation_1.notNull)(), (0, validation_1.min)(1), (0, validation_1.max)(3600000)],
     transactionTimeout: [(0, validation_1.notNull)(), (0, validation_1.min)(0), (0, validation_1.max)(60000)],
-    transactionStrict: [(0, validation_1.notNull)()]
+    transactionStrict: [(0, validation_1.notNull)()],
+    maxOpsInStrictTx: [(0, validation_1.notNull)(), (0, validation_1.min)(1)]
 };

package/dist/mysql/manager/tx-strict.js

@@ -7,15 +7,17 @@ const exception_1 = require("../exception");
  * 严格 mysql 事务会话，会禁用一些操作.
  */
 class MysqlStrictTxSession extends tx_1.MysqlTxSession {
+    config;
     #opsCount = 0;
     constructor(config, conn) {
         super(config, conn);
+        this.config = config;
     }
     /**
      * 为操作计数，检查是否操作次数过多.
      */
     #checkAndAddOpsCount() {
-        if (this.#opsCount >= 10) {
+        if (this.#opsCount >= this.config.maxOpsInStrictTx) {
             throw new exception_1.MysqlException('Too many operations in a strict transaction.');
         }
         this.#opsCount++;

package/documentation/zh-cn/mvc.md

@@ -629,3 +629,39 @@ await startWebServer({
   }
 })
 ```
+
+### Server-Sent Events
+
+组件本身没有直接提供对 SSE（Server-Sent Events） 的支持，可以在路由的处理函数中适当的进行处理来实现。
+
+```ts
+// 启动服务
+await startWebServer({
+  // 路由配置
+  routers: {
+    '/sse': async exchange => {
+      const { response } = exchange
+      // 设置消息头
+      response.setHeader('Content-Type', 'text/event-stream')
+      response.setHeader('Cache-Control', 'no-cache')
+      response.setHeader('Connection', 'keep-alive')
+      // 模拟异步操作更新多条消息
+      let counter = 0
+      for (let i = 0; i < 10; i++) {
+        // 沉睡一秒，模拟异步业务处理
+        await new Promise<void>((resolve, reject) => {
+          setTimeout(resolve, 1000)
+        })
+        counter++
+        // 写数据到响应信息中，前端在 EventSource 的 message 事件中处理
+        response.write(`data: ${JSON.stringify({ message: '实时更新', count: counter })}\n\n`)
+        if (counter >= 10) {
+          break
+        }
+      }
+      // 最后结束响应
+      response.end()
+    }
+  }
+})
+```

package/documentation/zh-cn/mysql.md

@@ -29,6 +29,7 @@ mysql 组件基于 [mysql2](https://www.npmjs.com/package/mysql2) 封装，提
 | MYSQL_SLOW_SQL_MS             | 慢 sql 毫秒数，默认 200                               |
 | MYSQL_TRANSACTION_TIMEOUT     | 事务超时时间，单位毫秒，默认 5000                     |
 | MYSQL_TRANSACTION_STRICT      | 事务严格模式，默认 true，设置为 false 可关闭严格模式  |
+| MYSQL_MAX_OPS_IN_STRICT_TX    | 严格事务中可以执行的操作次数，默认 10  |
 
 ## 初始化
 
@@ -548,7 +549,7 @@ mysqlManager.tx(
 
 ### 严格模式
 
-因此事务默认是打开严格模式的，在严格模式下，事务中的很多操作都被禁止，
+事务默认是打开严格模式的，在严格模式下，事务中的很多操作都被禁止，
 通过将环境变量 MYSQL_TRANSACTION_STRICT （默认变量名称，多实例的情况下使用对应名称）
 设置为 false 可以关闭。
 
@@ -560,6 +561,6 @@ mysqlManager.tx(
 4. 批量查询和计数 find、count、paginate
 5. findByIdIn 参数超过 100 个
 6. 使用 query 和 modify 执行自定义 sql
-7. 调用 session 进行的任何操作累计超过 10 次
+7. 调用 session 进行的任何操作累计超过 10 次，通过 MYSQL_MAX_OPS_IN_STRICT_TX 变量可以修改允许的次数
 
 长事务有很大的风险，在生产环境下推荐使用严格事务，并且将事务的超时时间设置的尽可能短一些。

package/package.json

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

package/types/mysql/config.d.ts

@@ -75,6 +75,10 @@ export interface MysqlConfig {
      * 事务严格模式
      */
     transactionStrict: boolean;
+    /**
+     * 在严格事务中可进行的最大操作次数
+     */
+    maxOpsInStrictTx: number;
 }
 /**
  * 默认配置.

package/types/mysql/manager/tx-strict.d.ts

@@ -8,6 +8,7 @@ import { DeleteManyOpts, FindOpts, MixCriteria, MysqlPage, MysqlPaginateOpts, Up
  */
 export declare class MysqlStrictTxSession extends MysqlTxSession {
     #private;
+    private config;
     constructor(config: MysqlConfig, conn: PoolConnection);
     findById<T>(table: Table<T>, id: string | number): Promise<T | null>;
     findByIdIn<T>(table: Table<T>, ids: (string | number)[]): Promise<T[]>;