wok-server 0.4.13 → 0.6.0

package/src/log/index.ts

@@ -0,0 +1,136 @@
+import { config } from './config'
+import { fileStore } from './file'
+import { LogLevel } from './level'
+import { formatLogJson, formatLogText, Log } from './log'
+import { getLogStore, setLogStore } from './store'
+
+/**
+ * 文件存储
+ */
+if (config.file) {
+  setLogStore(fileStore)
+}
+
+class Logger {
+  constructor(private prefix?: string) {}
+
+  /**
+   * 输出日志
+   * @param level
+   * @param message
+   * @param error
+   */
+  private log(level: LogLevel, message: string, error?: any) {
+    if (level < config.level) {
+      return
+    }
+    const log: Log = {
+      level,
+      content: message,
+      time: new Date(),
+      prefix: this.prefix,
+      error
+    }
+    // 控制台输出日志
+    if (config.console) {
+      // const msg = config.format === 'text' ? formatLogText(log, true) : formatLogJson(log, true)
+      // 控制台强制使用 text 格式，json 格式只在文件中输出
+      const msg = formatLogText(log, true)
+      switch (level) {
+        case LogLevel.DEBUG:
+          console.debug(msg)
+          break
+        case LogLevel.INFO:
+          console.info(msg)
+          break
+        case LogLevel.WARN:
+          console.warn(msg)
+          break
+        case LogLevel.ERROR:
+          console.error(msg)
+          break
+      }
+      if (error) {
+        console.error(error)
+      }
+    }
+    // 自定义存储中输出日志
+    const store = getLogStore()
+    if (store) {
+      store(log, config)
+    }
+  }
+  /**
+   * debug 日志
+   */
+  debug(message: string) {
+    this.log(LogLevel.DEBUG, message)
+  }
+
+  isDebugEnabled() {
+    return LogLevel.DEBUG >= config.level
+  }
+  /**
+   * info 日志
+   * @param message
+   */
+  info(message: string) {
+    this.log(LogLevel.INFO, message)
+  }
+
+  isInfoEnabled() {
+    return LogLevel.INFO >= config.level
+  }
+  /**
+   * 警告日志
+   * @param message
+   * @param error
+   */
+  warn(message: string, error?: any) {
+    this.log(LogLevel.WARN, message, error)
+  }
+  /**
+   * 等同于 warn
+   * @param message
+   * @param error
+   */
+  warning(message: string, error?: any) {
+    this.log(LogLevel.WARN, message, error)
+  }
+
+  isWarnEnabled() {
+    return LogLevel.WARN >= config.level
+  }
+  /**
+   * 错误日志
+   * @param message
+   * @param error
+   */
+  error(message: string, error?: any) {
+    this.log(LogLevel.ERROR, message, error)
+  }
+
+  isErrorEnabled() {
+    return LogLevel.ERROR >= config.level
+  }
+}
+
+const defaultLogger = new Logger()
+
+/**
+ * 获取日志对象.
+ *
+ * @param prefix 日志前缀，如果有值，每条日志前都会加上前缀信息
+ * @returns
+ */
+export function getLogger(prefix?: string) {
+  if (prefix) {
+    return new Logger(prefix)
+  }
+  return defaultLogger
+}
+
+export * from './config'
+export * from './level'
+export * from './log'
+export { setLogStore } from './store'

package/src/log/level.ts

@@ -0,0 +1,29 @@
+/**
+ * 日志级别.
+ */
+export enum LogLevel {
+  DEBUG = 1,
+  INFO = 2,
+  WARN = 3,
+  ERROR = 4
+}
+
+/**
+ * 解析日志级别
+ * @param level
+ */
+export function parseLogLevel(level: string): LogLevel {
+  const iLevel = level.toUpperCase()
+  switch (iLevel) {
+    case 'DEBUG':
+      return LogLevel.DEBUG
+    case 'INFO':
+      return LogLevel.INFO
+    case 'WARN':
+      return LogLevel.WARN
+    case 'ERROR':
+      return LogLevel.ERROR
+    default:
+      throw new Error(`Unknown log level ：${level}`)
+  }
+}

package/src/log/log.ts

@@ -0,0 +1,77 @@
+import { EOL } from 'os'
+import { formatDateTime } from './date'
+import { LogLevel } from './level'
+
+/**
+ * 单条日志的信息
+ */
+export interface Log {
+  /**
+   * 日志的时间
+   */
+  time: Date
+  /**
+   * 日志的等级
+   */
+  level: LogLevel
+  /**
+   * 日志的内容
+   */
+  content: string
+  /**
+   * 异常信息
+   */
+  error?: any
+  /**
+   * 前缀信息
+   */
+  prefix?: string
+}
+
+/**
+ * 将日志格式化为简单的文本
+ * @param log
+ * @param ignoreError 忽略异常信息
+ * @returns
+ */
+export function formatLogText(log: Log, ignoreError = false) {
+  let str = `[${formatDateTime(log.time)}][${LogLevel[log.level]}]${
+    log.prefix ? `[${log.prefix}]` : ''
+  }${log.content}`
+  if (log.error && !ignoreError) {
+    if (log.error.stack) {
+      str += EOL + log.error.stack
+    } else if (log.error.message) {
+      str += EOL + log.error.message
+    } else {
+      str += EOL + log.error
+    }
+  }
+  return str
+}
+
+/**
+ * 将日志格式化为 json
+ * @param log
+ * @param ignoreError 忽略异常信息
+ * @returns
+ */
+export function formatLogJson(log: Log, ignoreError = false) {
+  let error: string | undefined
+  if (log.error && !ignoreError) {
+    error = ''
+    if (log.error.stack) {
+      error += log.error.stack
+    } else if (log.error.message) {
+      error += log.error.message
+    } else {
+      error += log.error
+    }
+  }
+  const json: any = { ...log }
+  delete json.error
+  if (error) {
+    json.error = error
+  }
+  return JSON.stringify(json)
+}

package/src/log/store.ts

@@ -0,0 +1,31 @@
+import { LogConfig } from './config'
+import { Log } from './log'
+
+/**
+ * 日志存储函数
+ */
+export interface LogStore {
+  /**
+   * 日志存储函数
+   * @param log 日志
+   * @param config 日志配置
+   */
+  (log: Log, config: LogConfig): void
+}
+
+/**
+ * 日志存储函数
+ */
+let STORE: LogStore | undefined
+
+/**
+ * 设置日志存储.
+ * @param store
+ */
+export function setLogStore(store: LogStore) {
+  STORE = store
+}
+
+export function getLogStore(): LogStore | undefined {
+  return STORE
+}

package/src/mongodb/collection.ts

@@ -0,0 +1,25 @@
+/**
+ * mogodb 集合信息
+ *
+ * <T> 数据类型，不能包含有 _id 字段，主键字段名称固定，不可以设置
+ */
+export interface MongoCollection<T> {
+  /**
+   * 集合名称.
+   */
+  collectionName: string
+  /**
+   * 创建时间字段信息,设置后在创建时会自动更新该字段
+   */
+  createdDate?: {
+    field: keyof T
+    type: 'number' | 'date'
+  }
+  /**
+   * 更新时间字段信息，设置后在更新记录时会自动维护该字段
+   */
+  updatedDate?: {
+    field: keyof T
+    type: 'number' | 'date'
+  }
+}

package/src/mongodb/config.ts

@@ -0,0 +1,69 @@
+import { ValidationOpts, max, min, notBlank, notNull } from '../validation'
+
+/**
+ * MongoDB 配置.
+ */
+export interface MongoDBConfig {
+  /**
+   * 连接地址.
+   * 示例：mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority
+   */
+  uri: string
+  /** The maximum number of connections in the connection pool. */
+  maxPoolSize: number
+  /** The minimum number of connections in the connection pool. */
+  minPoolSize: number
+  /** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
+  maxConnecting: number
+  /** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
+  maxIdleTimeMS: number
+  /** The maximum time in milliseconds that a thread can wait for a connection to become available. */
+  waitQueueTimeoutMS: number
+  /**
+   * 开启慢查询警告，默认开启
+   */
+  slowQueryWarn: boolean
+  /**
+   * 慢查询毫秒数，默认 200
+   */
+  slowQueryMs: number
+  /**
+   *事务超时时间，单位毫秒，默认 5000，设置为0的值表示不限制
+   */
+  transactionTimeout: number
+  /**
+   * 事务严格模式
+   */
+  transactionStrict: boolean
+}
+
+/**
+ * 默认配置.
+ */
+export const defaultConfig: MongoDBConfig = {
+  uri: 'mongodb://test:123456@localhost/test',
+  maxPoolSize: 10,
+  minPoolSize: 1,
+  maxConnecting: 10,
+  maxIdleTimeMS: 60000,
+  waitQueueTimeoutMS: 60000,
+  slowQueryWarn: true,
+  slowQueryMs: 200,
+  transactionTimeout: 5000,
+  transactionStrict: true
+}
+/**
+ * 配置校验
+ */
+export const configValidation: ValidationOpts<MongoDBConfig> = {
+  uri: [notBlank()],
+  maxPoolSize: [notNull(), min(1), max(1000)],
+  minPoolSize: [notNull(), min(1), max(1000)],
+  maxConnecting: [notNull(), min(1), max(1000)],
+  maxIdleTimeMS: [notNull(), min(1)],
+  waitQueueTimeoutMS: [notNull(), min(1)],
+  slowQueryWarn: [notNull()],
+  slowQueryMs: [notNull(), min(1), max(3600000)],
+  transactionTimeout: [notNull(), min(0), max(3600000)],
+  transactionStrict: [notNull()]
+}

package/src/mongodb/doc.ts

@@ -0,0 +1,12 @@
+import { ObjectId } from 'mongodb'
+
+
+
+/**
+ * 文档 id
+ */
+export type MongoDocId = string | ObjectId
+/**
+ * 带 id 的文档。<T> 是自定义的集合类型，不包含主键字段。
+ */
+export type MongoDocWithId<T> = T & { _id: MongoDocId }

package/src/mongodb/exception.ts

@@ -0,0 +1,8 @@
+/**
+ * MongoDB 异常.
+ */
+export class MongoDBException extends Error {
+  constructor(readonly message: string) {
+    super(message)
+  }
+}

package/src/mongodb/index.ts

@@ -0,0 +1,71 @@
+import { MongoClient } from 'mongodb'
+import { registerConfig } from '../config'
+import { MongoDBConfig, configValidation, defaultConfig } from './config'
+import { MongoDBManager } from './manager'
+import { MongoMigrationVersion, migrate } from './migration'
+
+const managerMap = new Map<string, MongoDBManager>()
+
+const DEFAULT_NAME = 'MONGO'
+
+/**
+ * 启用 MongoDB
+ * @param opts 选项
+ */
+export async function enableMongoDB(opts?: {
+  /**
+   * 配置名称，同时也是环境变量配置的前缀，英文开头，由英文数字和下划线成.
+   */
+  name?: string
+  /**
+   * 迁移
+   */
+  migration?: { versionList: MongoMigrationVersion[] }
+}) {
+  const finalOpts = opts || {}
+  // 校验名称
+  if (finalOpts.name) {
+    if (!/^[a-zA-Z][a-zA-Z0-9_]{0,31}$/.test(finalOpts.name)) {
+      throw new Error(
+        `The mongodb configuration name must start with an english letter, digit or an underscore (_), and cannot exceed 32 characters：${finalOpts.name}`
+      )
+    }
+  }
+  const finalName = finalOpts.name || DEFAULT_NAME
+  // 配置信息
+  const mongoConfig = registerConfig<MongoDBConfig>(defaultConfig, finalName, configValidation)
+  const client = new MongoClient(mongoConfig.uri, {
+    maxPoolSize: mongoConfig.maxPoolSize,
+    minPoolSize: mongoConfig.minPoolSize,
+    maxConnecting: mongoConfig.maxConnecting,
+    maxIdleTimeMS: mongoConfig.maxIdleTimeMS,
+    waitQueueTimeoutMS: mongoConfig.waitQueueTimeoutMS
+  })
+  const db = client.db()
+  // 版本控制
+  if (finalOpts.migration) {
+    await migrate(db, finalOpts.migration.versionList)
+  }
+  process.addListener('beforeExit', () => client.close())
+  managerMap.set(finalName, new MongoDBManager(mongoConfig, db, client))
+}
+/**
+ * 获取管理器实例
+ * @param name
+ * @returns
+ */
+export function getMongoDBManager(name?: string) {
+  const manager = managerMap.get(name || DEFAULT_NAME)
+  if (!manager) {
+    throw new Error(
+      `找不到想要的 mongodb 配置 ${name ? ': ' + name : ''}，请先调用 enableMongoDB 启用`
+    )
+  }
+  return manager
+}
+
+export { MongoDBConfig } from './config'
+export * from './exception'
+export { MongoMigrationVersion } from './migration'
+export * from './collection'
+export * from './doc'