wok-server 0.4.13 → 0.6.0

package/src/mysql/manager/ops/update.ts

@@ -0,0 +1,294 @@
+import { PoolConnection, ResultSetHeader } from 'mysql2'
+import { MysqlException } from '../../exception'
+import { Table } from '../../table-info'
+import { MixCriteria, buildQuery } from './criteria'
+import { promiseQuery } from '../utils'
+import { MysqlConfig } from '../../config'
+import { processColumnValue } from './utils'
+
+/**
+ * 更新
+ * @param config
+ * @param connection
+ * @param mapping
+ * @param data
+ * @returns
+ */
+export async function update<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  data: T
+): Promise<T> {
+  // 列信息
+  let columns: Array<keyof T> = [...table.columns]
+  // 创建时间不更新
+  if (table.createdDate) {
+    const { column } = table.createdDate
+    columns = columns.filter(col => col !== column)
+  }
+  if (table.updatedDate) {
+    const updatedDate = table.updatedDate.type === 'date' ? new Date() : new Date().getTime()
+    data[table.updatedDate.column] = updatedDate as any
+    columns.push(table.updatedDate.column)
+  }
+  // 构建 sql
+  const sql = `update ?? set ${columns.map(() => ' ?? = ? ').join(',')} where ?? = ?`
+  // 值
+  const values: any[] = [
+    table.tableName,
+    ...columns.flatMap(col => [col, processColumnValue(data[col])]),
+    table.id,
+    data[table.id]
+  ]
+  const res = await promiseQuery(config, connection, sql, values)
+  const packet = res as ResultSetHeader
+  if (packet.affectedRows !== 1) {
+    throw new MysqlException(
+      `Failed to update record, possibly due to non-existent record，table：${
+        table.tableName
+      }，primary key: ${data[table.id]}`
+    )
+  }
+  return data
+}
+/**
+ * 更新器
+ */
+export type Updater<T> = Partial<{
+  // 普通的更新赋值
+  [key in keyof T]:
+    | T[key]
+    // undefined 表示不参与更新，作用是方便编写一些特殊的逻辑，比如特定情况下不更新
+    | undefined
+    // 将字段置空，置空是不能使用 null 类型的，必须使用元组 ['setNull']
+    | ['setNull']
+    // 将字段自增
+    | ['inc', number]
+    /**
+     * 设置一个字段的值，和直接赋值是一样的，作用是解决一些特殊的情况的冲突
+     * 比如将 json 字段的值设置为 ['setNull'] ,这就会被认为是要置空，
+     * 使用 ['set',['setNull']] 就可以解决这个问题
+     */
+    | ['set', T[key]]
+}>
+/**
+ * 转换更新器
+ * @param table
+ * @param updater
+ * @returns
+ */
+function updatorToSql<T>(table: Table<T>, updater: Updater<T>): { sql: string; values: any[] } {
+  const values: any[] = []
+  // 更新操作
+  const updateFragList: string[] = []
+  // 更新时间
+  if (table.updatedDate) {
+    const updatedDate = table.updatedDate.type === 'date' ? new Date() : new Date().getTime()
+    updateFragList.push(' ?? = ?')
+    values.push(table.updatedDate.column, updatedDate)
+  }
+  for (const column in updater) {
+    // 过滤掉id
+    if (column === table.id) {
+      continue
+    }
+    const val = updater[column]
+    // undefined 表示不参与更新，作用是方便编写一些特殊的逻辑，比如特定情况下不更新
+    if (val === undefined) {
+      continue
+    }
+    // 兼容将值设置成 null 的情况，和 ['setNull’] 等同
+    if (val === null) {
+      updateFragList.push(' ?? = NULL ')
+      values.push(column)
+      continue
+    }
+    if (Array.isArray(val)) {
+      // set null
+      if (val[0] === 'setNull') {
+        updateFragList.push(' ?? = NULL ')
+        values.push(column)
+        continue
+      }
+      if (val[0] === 'inc') {
+        updateFragList.push(' ?? = ?? + ? ')
+        values.push(column, column, val[1])
+        continue
+      }
+      if (val[0] === 'set') {
+        updateFragList.push(' ?? = ? ')
+        values.push(column, processColumnValue(val[1]))
+        continue
+      }
+    }
+    updateFragList.push(' ?? = ? ')
+    values.push(column, processColumnValue(val))
+  }
+  return { sql: updateFragList.join(','), values }
+}
+
+/**
+ * 部分更新
+ * @param connection
+ * @param mapping
+ * @param type
+ * @param data
+ */
+export async function partialUpdate<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  data: Updater<T>
+): Promise<boolean> {
+  if (!data[table.id]) {
+    throw new MysqlException(
+      `Can't do a partial update, the data to be updated does not contain a primary key，table: ${
+        table.tableName
+      }，column：${JSON.stringify(data)}`
+    )
+  }
+  const id = data[table.id]
+  if (typeof id !== 'string' && typeof id !== 'number') {
+    throw new MysqlException('Primary key can only be of string or number type')
+  }
+  if (Object.keys(data).length < 2) {
+    throw new MysqlException(
+      `Can't do a partial update, data must contain at least one column outside of the primary key，table: ${
+        table.tableName
+      }，column：${JSON.stringify(data)}`
+    )
+  }
+  const fieldNames = Object.keys(data)
+  for (const name of fieldNames) {
+    if (name !== table.id && !table.columns.some(col => col === name)) {
+      throw new MysqlException(
+        `Can't do a partial update，there are unconfigured columns in the data，table： ${table.tableName}，unconfigured column：${name}`
+      )
+    }
+  }
+  let sql = ` update ?? `
+  const values: any[] = [table.tableName]
+  // 更新操作
+  const convertRes = updatorToSql(table, data)
+  if (!convertRes.sql) {
+    throw new MysqlException('No fields were specified to be updated!')
+  }
+  values.push(...convertRes.values)
+  sql += ` set ${convertRes.sql} where ?? = ?`
+  values.push(table.id, id)
+
+  const res = await promiseQuery(config, connection, sql, values)
+  const packet = res as ResultSetHeader
+  return packet.affectedRows === 1
+}
+/**
+ * 更新指定的一条记录
+ * @param config
+ * @param connection
+ * @param table
+ * @param query
+ * @param data
+ */
+export async function updateOne<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  query: MixCriteria<T>,
+  updater: Updater<T>
+): Promise<boolean> {
+  const values: any[] = []
+  const mysqlQuery = buildQuery(query)
+  if (!mysqlQuery) {
+    throw new MysqlException('No valid criteria specified.')
+  }
+  let sql = ` update ?? `
+  values.push(table.tableName)
+  // 更新操作
+  const convertRes = updatorToSql(table, updater)
+  if (!convertRes.sql) {
+    throw new MysqlException('No fields were specified to be updated!')
+  }
+  sql += ` set ${convertRes.sql} `
+  values.push(...convertRes.values)
+  sql += ` where ${mysqlQuery.sql} limit 1`
+  values.push(...mysqlQuery.values)
+  const res = await promiseQuery(config, connection, sql, values)
+  const packet = res as ResultSetHeader
+  return packet.affectedRows === 1
+}
+/**
+ * 更新选项
+ */
+export interface UpdateOpts<T> {
+  /**
+   * 表
+   */
+  table: Table<T>
+  /**
+   * 查询条件
+   */
+  query: MixCriteria<T>
+  /**
+   * 限制数量
+   */
+  limit?: number
+  /**
+   * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+   */
+  orderBy?: Array<[keyof T, 'asc' | 'desc']>
+  /**
+   * 更新设置
+   */
+  updater: Updater<T>
+}
+
+/**
+ * 更新所有匹配条件的记录
+ * @param config
+ * @param connection 连接
+ * @param table 表
+ * @param query 查询条件
+ * @param updater 更新操作，支持置空和递增（需要使用元组）
+ */
+export async function updateMany<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  opts: UpdateOpts<T>
+): Promise<number> {
+  const values: any[] = []
+  const mysqlQuery = buildQuery(opts.query)
+  if (!mysqlQuery) {
+    throw new MysqlException('No valid criteria specified.')
+  }
+  let sql = ` update ?? `
+  values.push(opts.table.tableName)
+  // 更新操作
+  const convertRes = updatorToSql(opts.table, opts.updater)
+  if (!convertRes.sql) {
+    throw new MysqlException('No fields were specified to be updated!')
+  }
+  sql += ` set ${convertRes.sql} `
+  values.push(...convertRes.values)
+  sql += ` where ${mysqlQuery.sql} `
+  values.push(...mysqlQuery.values)
+  // 排序
+  if (opts.orderBy && opts.orderBy.length) {
+    opts.orderBy.forEach((orderBy, idx) => {
+      const [field, sort] = orderBy
+      if (idx == 0) {
+        sql += ` order by ?? ${sort} `
+      } else {
+        sql += ` , ?? ${sort} `
+      }
+      values.push(field)
+    })
+  }
+  // 数量限制
+  if (opts.limit) {
+    sql += ` limit ${opts.limit} `
+  }
+  const res = await promiseQuery(config, connection, sql, values)
+  const packet = res as ResultSetHeader
+  return packet.affectedRows
+}

package/src/mysql/manager/ops/utils.ts

@@ -0,0 +1,20 @@
+/**
+ * 处理列的值，对特殊类型 json 进行加工处理后返回
+ * @param value
+ */
+export function processColumnValue(value: any) {
+  // date 类型 typeof 也是 object ，先排除
+  if (value instanceof Date) {
+    return value
+  }
+  // buffer 也是
+  if (value instanceof Buffer) {
+    return value
+  }
+  // json
+  if (typeof value === 'object') {
+    return JSON.stringify(value)
+  }
+  // 其它的情况直接返回
+  return value
+}

package/src/mysql/manager/tx-strict.ts

@@ -0,0 +1,138 @@
+import { PoolConnection } from 'mysql2'
+import { MysqlConfig } from '../config'
+import { MysqlTxSession } from './tx'
+import { Table } from '../table-info'
+import { MysqlException } from '../exception'
+import {
+  DeleteManyOpts,
+  FindOpts,
+  FindSelectOpts,
+  MixCriteria,
+  MysqlPage,
+  MysqlPaginateOpts,
+  UpdateOpts,
+  Updater
+} from './ops'
+
+/**
+ * 严格 mysql 事务会话，会禁用一些操作.
+ */
+export class MysqlStrictTxSession extends MysqlTxSession {
+  #opsCount = 0
+  constructor(private config: MysqlConfig, conn: PoolConnection) {
+    super(config, conn)
+  }
+  /**
+   * 为操作计数，检查是否操作次数过多.
+   */
+  #checkAndAddOpsCount() {
+    if (this.#opsCount >= this.config.maxOpsInStrictTx) {
+      throw new MysqlException('Too many operations in a strict transaction.')
+    }
+    this.#opsCount++
+  }
+
+  findById<T>(table: Table<T>, id: string | number): Promise<T | null> {
+    this.#checkAndAddOpsCount()
+    return super.findById(table, id)
+  }
+
+  findByIdIn<T>(table: Table<T>, ids: (string | number)[]): Promise<T[]> {
+    if (ids.length > 100) {
+      throw new MysqlException(
+        `The augument ids length(${ids.length}) passed to findByIdIn in a strict transaction is too large .`
+      )
+    }
+    this.#checkAndAddOpsCount()
+    return super.findByIdIn(table, ids)
+  }
+
+  existsBy<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<boolean> {
+    this.#checkAndAddOpsCount()
+    return super.existsBy(table, criteria)
+  }
+
+  existsById<T>(table: Table<T>, id: string | number): Promise<boolean> {
+    this.#checkAndAddOpsCount()
+    return super.existsById(table, id)
+  }
+
+  deleteById<T>(table: Table<T>, id: string | number): Promise<boolean> {
+    this.#checkAndAddOpsCount()
+    return super.deleteById(table, id)
+  }
+
+  deleteOne<T>(table: Table<T>, criteria: Partial<T>): Promise<boolean> {
+    this.#checkAndAddOpsCount()
+    return super.deleteOne(table, criteria)
+  }
+
+  deleteMany<T>(opts: DeleteManyOpts<T>): Promise<number> {
+    throw new MysqlException('Prohibited to use deleteBy in a strict transaction.')
+  }
+
+  findAll<T>(table: Table<T>): Promise<T[]> {
+    throw new MysqlException('Prohibited to use findAll in a strict transaction.')
+  }
+
+  findFirst<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<T | null> {
+    this.#checkAndAddOpsCount()
+    return super.findFirst(table, criteria)
+  }
+
+  insert<T>(table: Table<T>, data: T): Promise<T> {
+    this.#checkAndAddOpsCount()
+    return super.insert(table, data)
+  }
+
+  insertMany<T>(table: Table<T>, list: T[]): Promise<void> {
+    throw new MysqlException('Prohibited to use insertMany in a strict transaction.')
+  }
+
+  update<T>(table: Table<T>, data: T): Promise<T> {
+    this.#checkAndAddOpsCount()
+    return super.update(table, data)
+  }
+
+  updateMany<T>(opts: UpdateOpts<T>): Promise<number> {
+    throw new MysqlException('Prohibited to use updateMany in a strict transaction.')
+  }
+
+  updateOne<T>(
+    table: Table<T>,
+    query: Partial<T>,
+    updater: Partial<{ [key in keyof T]: ['setNull'] | ['inc', number] | T[key] | undefined }>
+  ): Promise<boolean> {
+    this.#checkAndAddOpsCount()
+    return super.updateOne(table, query, updater)
+  }
+
+  partialUpdate<T>(table: Table<T>, data: Updater<T>): Promise<boolean> {
+    this.#checkAndAddOpsCount()
+    return super.partialUpdate(table, data)
+  }
+
+  find<T>(opts: FindOpts<T>): Promise<T[]> {
+    throw new MysqlException('Prohibited to use find in a strict transaction.')
+  }
+
+  findSelect<T, K extends keyof T>(opts: FindSelectOpts<T, K>): Promise<Pick<T, K>[]> {
+    throw new MysqlException('Prohibited to use findSelect in a strict transaction.')
+  }
+
+  count<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<number> {
+    throw new MysqlException('Prohibited to use count in a strict transaction.')
+  }
+
+  paginate<T>(opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>> {
+    throw new MysqlException('Prohibited to use paginate in a strict transaction.')
+  }
+
+  query<T>(sql: string, values?: any[] | undefined): Promise<T[]> {
+    throw new MysqlException('Prohibited to use query in a strict transaction.')
+  }
+
+  modify(sql: string, values?: any[] | undefined): Promise<number> {
+    throw new MysqlException('Prohibited to use modify in a strict transaction.')
+  }
+}

package/src/mysql/manager/tx.ts

@@ -0,0 +1,31 @@
+import { PoolConnection } from 'mysql2'
+import { BaseMysqlManager } from './base'
+import { MysqlConfig } from '../config'
+import { MysqlException } from '../exception'
+
+/**
+ * mysql 事务会话.
+ */
+export class MysqlTxSession extends BaseMysqlManager {
+  /**
+   * 中止标识
+   */
+  #aborted = false
+
+  constructor(config: MysqlConfig, conn: PoolConnection) {
+    super({ config, connection: conn })
+  }
+
+  protected queryWithConnection<T>(queryFn: (conn: PoolConnection) => Promise<T>): Promise<T> {
+    if (this.#aborted) {
+      throw new MysqlException('Session has been aborted!')
+    }
+    return super.queryWithConnection(queryFn)
+  }
+  /**
+   * 中止，被中止后的会话不能再进行任何操作
+   */
+  abort() {
+    this.#aborted = true
+  }
+}

package/src/mysql/manager/utils.ts

@@ -0,0 +1,75 @@
+// 工具集，将一些驱动的方法进行 promise 封装，方便操作
+// 程序中没有使用 mysql2/promise ，主要是在测试中发现 mysql2/promise 不是很可靠
+// mysql2/promise 在查询方便处理的不是很好
+// query 查询在没有记录的情况下仍然会返回列表，里面会包含列定义信息，不符合预期
+
+import {
+  Connection,
+  OkPacket,
+  Pool,
+  PoolConnection,
+  ProcedureCallPacket,
+  ResultSetHeader,
+  RowDataPacket,
+  format
+} from 'mysql2'
+import { MysqlConfig } from '../config'
+import { getLogger } from '../../log'
+
+/**
+ * 查询，适用于各种 sql 的执行
+ * @param config
+ * @param conn
+ * @param sql
+ * @param values
+ * @returns
+ */
+export function promiseQuery(
+  config: MysqlConfig,
+  conn: Connection,
+  sql: string,
+  values: any[] = []
+) {
+  return new Promise<
+    | OkPacket
+    | ResultSetHeader
+    | ResultSetHeader[]
+    | RowDataPacket[]
+    | RowDataPacket[][]
+    | OkPacket[]
+    | ProcedureCallPacket
+  >((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) {
+          getLogger().warn(`[mysql slow sql] ${cost}ms ${format(sql, values)}`)
+        }
+      }
+      if (err) {
+        rej(err)
+      } else {
+        res(result)
+      }
+    })
+  })
+}
+
+/**
+ * 获取连接
+ * @param pool
+ * @returns
+ */
+export function promiseGetConnection(pool: Pool) {
+  return new Promise<PoolConnection>((res, rej) => {
+    pool.getConnection((err, conn) => {
+      if (err) {
+        rej(err)
+      } else {
+        res(conn)
+      }
+    })
+  })
+}

package/src/mysql/migration.ts

@@ -0,0 +1,149 @@
+import { existsSync, readdirSync, readFileSync, statSync } from 'fs'
+import { Connection, RowDataPacket } from 'mysql2'
+import { isAbsolute, resolve } from 'path'
+import { getLogger } from '../log'
+import { MysqlConfig } from './config'
+import { MysqlException } from './exception'
+import { promiseQuery } from './manager/utils'
+
+/**
+ * 版本信息.
+ */
+interface MysqlVersion {
+  version: number
+  filePath: string
+}
+
+/**
+ * 迁移.
+ * @param config
+ * @param conn
+ */
+export async function migrate(config: MysqlConfig, conn: Connection) {
+  const versionDir = config.versionControlDir
+  // 查找文件
+  const dir = isAbsolute(versionDir) ? versionDir : resolve(process.cwd(), versionDir)
+  if (!existsSync(dir)) {
+    throw new Error(`Directory ${versionDir} does not exist`)
+  }
+  const versions: MysqlVersion[] = []
+  // 忽略隐藏文件
+  const files = readdirSync(dir).filter(file => !file.startsWith('.'))
+  for (const file of files) {
+    const filePath = resolve(dir, file)
+    const stat = 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 promiseQuery(config, conn, `SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED`)
+  await new Promise<void>((resolve, reject) => {
+    conn.beginTransaction(err => {
+      if (err) {
+        reject(err)
+      } else {
+        resolve()
+      }
+    })
+  })
+  try {
+    // 执行 sql, 判定当前版本
+    let currentVersion = await getCurrentVersion(config, conn)
+    if (typeof currentVersion !== 'number') {
+      // 插入初始版本号
+      await promiseQuery(config, conn, 'insert `db_version`(`version`) values (0)')
+    }
+    const filnalCurrentVersion = currentVersion || 0
+    const pendingVersions = versions.filter(ver => ver.version > filnalCurrentVersion)
+    if (!pendingVersions.length) {
+      getLogger().info('The SQL version is already the latest.')
+      return
+    }
+    const nextVersion = filnalCurrentVersion + 1
+    if (pendingVersions[0].version !== nextVersion) {
+      throw new MysqlException(
+        `MySQL migration error, the next version should be ${nextVersion}，but current is ${pendingVersions[0].version}`
+      )
+    }
+
+    for (const verion of pendingVersions) {
+      getLogger().info(`Mysql migrating, version: ${verion.version}`)
+      let sql = readFileSync(verion.filePath, { encoding: 'utf-8' })
+      await promiseQuery(config, conn, sql)
+      // 版本号
+      await promiseQuery(config, conn, `UPDATE db_version SET version=${verion.version};`)
+    }
+    // 提交
+    await new Promise<void>((resolve, reject) => {
+      conn.commit(err => {
+        if (err) {
+          reject(err)
+        } else {
+          resolve()
+        }
+      })
+    })
+    getLogger().info('Mysql migration finished.')
+  } catch (e) {
+    // 异常回退，仅能回退 dml 操作，对 ddl 无效
+    await new Promise<void>((resolve, reject) => {
+      conn.rollback(err => {
+        if (err) {
+          reject(err)
+        } else {
+          resolve()
+        }
+      })
+    })
+    throw e
+  }
+}
+
+async function createVersionTableIfNotExist(config: MysqlConfig, conn: Connection): Promise<void> {
+  await 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: MysqlConfig, conn: Connection): Promise<number | null> {
+  const res = await promiseQuery(config, conn, 'select version from `db_version` for update')
+  const rows = res as RowDataPacket[]
+  if (rows.length >= 1) {
+    return rows[0].version
+  } else {
+    return null
+  }
+}