sumor 1.3.0 → 2.0.0

package/modules/i18n/convertI18nValue/index.js

@@ -0,0 +1,14 @@
+import getI18nValue from './getI18nTemplate.js'
+import stringVariableReplace from './stringVariableReplace.js'
+
+export default function (config, target, code, data) {
+  const i18nTemplate = getI18nValue(config, target, code)
+  if (i18nTemplate === undefined) {
+    return code
+  }
+  if (typeof i18nTemplate === 'string') {
+    return stringVariableReplace(i18nTemplate, data)
+  } else {
+    return i18nTemplate
+  }
+}

package/modules/i18n/convertI18nValue/index.test.js

@@ -0,0 +1,55 @@
+import { describe, it, expect } from '@jest/globals'
+import convertI18n from './index.js'
+
+describe('convertI18n', () => {
+  const config = {
+    en: { greeting: 'Hello, {name}!' },
+    'zh-CN': { greeting: '你好, {name}!' },
+    origin: { greeting: 'Hi, {name}!' }
+  }
+  const config2 = {
+    'zh-CN': { greeting: '你好, {name}!' },
+    origin: { greeting: 'Hi, {name}!' }
+  }
+  const config3 = {
+    'zh-CN': { allowRegister: true },
+    origin: { allowRegister: false }
+  }
+
+  it('应该替换模板中的变量', () => {
+    const data = { name: 'John' }
+    const result = convertI18n(config, 'en', 'greeting', data)
+    expect(result).toBe('Hello, John!')
+  })
+
+  it('应该返回指定区域的模板', () => {
+    const data = { name: '李雷' }
+    const result = convertI18n(config, 'zh-CN', 'greeting', data)
+    expect(result).toBe('你好, 李雷!')
+  })
+
+  it('如果找不到区域，应该返回原始模板', () => {
+    const data = { name: 'Jane' }
+    const result = convertI18n(config, 'fr', 'greeting', data)
+    expect(result).toBe('Hello, Jane!')
+  })
+
+  it('如果找不到区域且找不到en，应该返回原始模板', () => {
+    const data = { name: 'Jane' }
+    const result = convertI18n(config2, 'fr', 'greeting', data)
+    expect(result).toBe('Hi, Jane!')
+  })
+
+  it('如果类型不是字符串，应该返回原始模板', () => {
+    const result1 = convertI18n(config3, 'fr', 'allowRegister', {})
+    expect(result1).toBe(false)
+    const result2 = convertI18n(config3, 'zh-CN', 'allowRegister', {})
+    expect(result2).toBe(true)
+  })
+
+  it('如果找不到i18n模板，应该返回代码', () => {
+    const data = { name: 'John' }
+    const result = convertI18n(config, 'en', 'nonexistent', data)
+    expect(result).toBe('nonexistent')
+  })
+})

package/modules/i18n/convertI18nValue/stringVariableReplace.js

@@ -0,0 +1,13 @@
+export default function (template, data) {
+  data = data || {}
+  return template.replace(/{(\w+)}/g, (_, key) => {
+    const value = data[key]
+    if (value === undefined || value === null) {
+      return '?'
+    }
+    if (typeof value === 'object') {
+      return JSON.stringify(value)
+    }
+    return String(value)
+  })
+}

package/modules/i18n/convertI18nValue/stringVariableReplace.test.js

@@ -0,0 +1,39 @@
+import { describe, test, expect } from '@jest/globals'
+import stringVariableReplace from './stringVariableReplace.js'
+
+describe('字符串变量替换工具', () => {
+  test('替换占位符为值', () => {
+    const template = 'User not found: {name}'
+    const data = { name: 'Tester' }
+    const result = stringVariableReplace(template, data)
+    expect(result).toBe('User not found: Tester')
+  })
+
+  test('如果未提供值，则返回占位符', () => {
+    const template = 'User not found: {name}'
+    const data = {}
+    const result = stringVariableReplace(template, data)
+    expect(result).toBe('User not found: ?')
+  })
+
+  test('如果值是对象，则将占位符替换为JSON字符串', () => {
+    const template = 'User details: {user}'
+    const data = { user: { id: 1, name: 'Tester' } }
+    const result = stringVariableReplace(template, data)
+    expect(result).toBe('User details: {"id":1,"name":"Tester"}')
+  })
+
+  test('如果值为null，则返回问号', () => {
+    const template = 'User not found: {name}'
+    const data = { name: null }
+    const result = stringVariableReplace(template, data)
+    expect(result).toBe('User not found: ?')
+  })
+
+  test('将数字值转换为字符串', () => {
+    const template = 'User age: {age}'
+    const data = { age: 30 }
+    const result = stringVariableReplace(template, data)
+    expect(result).toBe('User age: 30')
+  })
+})

package/modules/i18n/index.js

@@ -0,0 +1,26 @@
+import convertI18nValue from './convertI18nValue/index.js'
+import { cache, register, registerAll } from './registry.js'
+import path from 'path'
+
+export { cache as data }
+
+export { register, registerAll }
+
+// 预定义的 i18n 文件夹路径
+const moduleRoot = new URL('.', import.meta.url).pathname
+const predefinedI18nPath = path.join(moduleRoot, '../../i18n')
+await registerAll(predefinedI18nPath)
+const predefinedI18nExtPath = path.join(moduleRoot, '../../i18nExt')
+await registerAll(predefinedI18nExtPath)
+
+const convert = function (namespace, target, code, data = {}) {
+  if (!cache[namespace.toLowerCase()]) {
+    return
+  }
+
+  const i18nConfig = cache[namespace.toLowerCase()]
+
+  return convertI18nValue(i18nConfig, target, code, data)
+}
+
+export { convert }

package/modules/i18n/index.test.js

@@ -0,0 +1,13 @@
+import { describe, it, expect } from '@jest/globals'
+import { convert } from './index.js'
+
+describe('i18n 转换函数', () => {
+  it('如果命名空间未注册，返回undefined', () => {
+    const result = convert('unregisteredNamespace', 'target', 'code')
+    expect(result).toBeUndefined()
+  })
+  it('检查预定义的 i18n 文件夹路径', () => {
+    expect(convert('sumor_internal', 'en', 'TEST', { value: 'value' })).toBe('Test value')
+    expect(convert('SUMOR_INTERNAL', 'zh-CN', 'TEST', { value: 'value' })).toBe('测试 value')
+  })
+})

package/modules/i18n/load/README.md

@@ -0,0 +1,28 @@
+## 加载配置
+
+load 目录为加载 i18n 配置的目录。将会根据指定目录，加载所有的配置文件。
+
+### 示例
+
+配置目录为 /config/i18n，基础配置文件名为 demo.yml。
+则调用 load 模块时，传入的参数为`/config/i18n/demo`。
+会加载如下文件：
+
+- /config/i18n/demo.yml
+- /config/i18n/demo.zh-CN.yml
+- /config/i18n/demo.zh.yml
+- /config/i18n/demo.en.yml
+- ... 等地区语言后缀的文件
+
+#### 返回值
+
+demo.yml 会作为 origin 的值，其他文件会根据语言后缀，作为对应的语言配置。
+
+```json
+{
+  "origin": { "key": "ORIGIN" },
+  "zh-CN": { "key": "CHINA" },
+  "zh": { "key": "CHINESE" },
+  "en": { "key": "ENGLISH" }
+}
+```

package/modules/i18n/load/load.js

@@ -0,0 +1,31 @@
+import loadConfig from '../../utils/loadConfig.js'
+import path from 'path'
+
+async function loadI18nConfig(i18nPath) {
+  const result = {
+    origin: {}
+  }
+
+  // 去除i18nPath后缀
+  i18nPath = i18nPath.split('.')[0]
+
+  const root = path.dirname(i18nPath)
+  const name = path.basename(i18nPath)
+  const files = await loadConfig(name + '*', root)
+
+  for (const key in files) {
+    // key为name.*才是国际化文件
+    const prefix = `${name}.`
+
+    if (key === name) {
+      result.origin = files[key]
+    } else if (key.startsWith(prefix)) {
+      const lang = key.replace(prefix, '')
+      result[lang] = files[key]
+    }
+  }
+
+  return result
+}
+
+export default loadI18nConfig

package/modules/i18n/load/load.test.js

@@ -0,0 +1,30 @@
+import { describe, it, expect, beforeAll, afterAll } from '@jest/globals'
+import fs from 'fs-extra'
+import path from 'path'
+import loadI18nConfig from './load.js'
+import tmp from '../../../test-utils/tmp.js'
+
+const tmpDir = await tmp('i18nLoad')
+
+describe('加载国际化数据目录', () => {
+  beforeAll(() => {
+    fs.ensureDirSync(tmpDir)
+    fs.writeFileSync(path.join(tmpDir, 'demo.yml'), 'key: origin')
+    fs.writeFileSync(path.join(tmpDir, 'demo.zh-CN.yml'), 'key: zh-CN')
+    fs.writeFileSync(path.join(tmpDir, 'demo.en.json'), JSON.stringify({ key: 'en' }, null, 2))
+    fs.writeFileSync(path.join(tmpDir, 'demodemo.yml'), 'key: Unknown')
+  })
+
+  afterAll(() => {
+    fs.removeSync(tmpDir)
+  })
+
+  it('应该加载基础的 i18n 配置和所有特定语言的配置', async () => {
+    const config = await loadI18nConfig(`${tmpDir}/demo`)
+    expect(config).toEqual({
+      origin: { key: 'origin' },
+      'zh-CN': { key: 'zh-CN' },
+      en: { key: 'en' }
+    })
+  })
+})

package/modules/i18n/registry.js

@@ -0,0 +1,48 @@
+import load from './load/load.js'
+import { glob } from 'glob'
+import path from 'path'
+
+// Extracted utility functions
+import { filterOneDot, filterDoubleDot, getRelativePath, joinPath } from '../utils/pathUtils.js'
+
+export const cache = {}
+
+export async function register(namespace, data) {
+  namespace = namespace.toLowerCase()
+  // namespace = namespace.toUpperCase()
+  cache[namespace] = cache[namespace] || {}
+
+  // 传入路径，则根据路径读取数据
+  if (typeof data === 'string') {
+    data = await load(data)
+  }
+
+  for (const key in data) {
+    cache[namespace][key] = cache[namespace][key] || {}
+    cache[namespace][key] = {
+      ...cache[namespace][key],
+      ...data[key]
+    }
+  }
+}
+
+export async function registerAll(directory) {
+  const absDirectory = path.resolve(directory)
+
+  const files = glob.sync(`${absDirectory}/**/*.*`)
+  const originFiles = filterOneDot(files)
+  const extFiles = filterDoubleDot(files)
+
+  // 处理扩展文件列表，去除扩展属性
+  const extFilesOrigin = extFiles.map(file => {
+    const paths = file.split('.')
+    return paths[0] + '.' + paths[2]
+  })
+
+  const allOriginFiles = originFiles.concat(extFilesOrigin)
+
+  for (const file of allOriginFiles) {
+    const ns = getRelativePath(absDirectory, file)
+    await register(ns, joinPath(process.cwd(), file))
+  }
+}

package/modules/i18n/registry.test.js

@@ -0,0 +1,84 @@
+import { describe, it, expect, beforeAll, afterAll } from '@jest/globals'
+import fs from 'fs-extra'
+import path from 'path'
+import { registerAll, cache, register } from './registry.js'
+import tmp from '../../test-utils/tmp.js'
+
+const tmp1Dir = await tmp('i18nRegistry1')
+const tmp2Dir = await tmp('i18nRegistry2')
+const tmp3Dir = await tmp('i18nRegistry3')
+
+describe('注册I18n', () => {
+  beforeAll(() => {
+    fs.ensureDirSync(tmp1Dir)
+    fs.writeFileSync(path.join(tmp1Dir, 'demo.yml'), 'key: origin')
+    fs.writeFileSync(path.join(tmp1Dir, 'demo.en.yml'), 'key: en')
+    fs.writeFileSync(path.join(tmp1Dir, 'demo.zh-CN.yml'), 'key: zh-CN')
+    fs.writeFileSync(path.join(tmp1Dir, 'demo2.json'), '{"key": "origin"}')
+    fs.writeFileSync(path.join(tmp1Dir, 'demo2.en.json'), '{"key": "en"}')
+    fs.writeFileSync(path.join(tmp1Dir, 'demo2.zh-CN.json'), '{"key": "zh-CN"}')
+
+    fs.ensureDirSync(tmp2Dir)
+    fs.writeFileSync(path.join(tmp2Dir, 'demo3.yml'), 'key: origin')
+    fs.ensureDirSync(tmp3Dir)
+    fs.writeFileSync(path.join(tmp3Dir, 'demo3.zh-CN.yml'), 'key: zh-CN')
+  })
+
+  afterAll(() => {
+    fs.removeSync(tmp1Dir)
+    fs.removeSync(tmp2Dir)
+  })
+
+  it('通过路径，注册所有指定路径下的i18n配置文件', async () => {
+    await registerAll(tmp1Dir)
+    expect(cache.demo).toBeDefined()
+    expect(cache.demo.origin).toBeDefined()
+    expect(cache.demo.en).toBeDefined()
+    expect(cache.demo['zh-CN']).toBeDefined()
+    expect(cache.demo.origin.key).toBe('origin')
+    expect(cache.demo.en.key).toBe('en')
+    expect(cache.demo['zh-CN'].key).toBe('zh-CN')
+
+    expect(cache.demo2).toBeDefined()
+    expect(cache.demo2.origin).toBeDefined()
+    expect(cache.demo2.en).toBeDefined()
+    expect(cache.demo2['zh-CN']).toBeDefined()
+    expect(cache.demo2.origin.key).toBe('origin')
+    expect(cache.demo2.en.key).toBe('en')
+    expect(cache.demo2['zh-CN'].key).toBe('zh-CN')
+  })
+
+  it('通过路径，注册单个文件', async () => {
+    await register('demo3', path.join(tmp2Dir, 'demo3.yml'))
+    expect(cache.demo3).toBeDefined()
+    expect(cache.demo3.origin).toBeDefined()
+    expect(cache.demo3.origin.key).toBe('origin')
+  })
+
+  it('通过路径，注册单个文件，命名空间已存在', async () => {
+    await register('demo3', path.join(tmp2Dir, 'demo3.yml'))
+    expect(cache.demo3).toBeDefined()
+    expect(cache.demo3.origin).toBeDefined()
+    expect(cache.demo3.origin.key).toBe('origin')
+    expect(cache.demo3['zh-CN']).toBeUndefined()
+    await register('demo3', path.join(tmp3Dir, 'demo3.yml'))
+    expect(cache.demo3['zh-CN']).toBeDefined()
+    expect(cache.demo3['zh-CN'].key).toBe('zh-CN')
+  })
+
+  it('通过数据，注册单个命名空间', async () => {
+    await register('demo4', {
+      origin: {
+        key: 'origin'
+      },
+      'zh-CN': {
+        key: 'zh-CN'
+      }
+    })
+    expect(cache.demo4).toBeDefined()
+    expect(cache.demo4.origin).toBeDefined()
+    expect(cache.demo4.origin.key).toBe('origin')
+    expect(cache.demo4['zh-CN']).toBeDefined()
+    expect(cache.demo4['zh-CN'].key).toBe('zh-CN')
+  })
+})

package/modules/logger/convert/parseFile.js

@@ -0,0 +1,14 @@
+const parseFile = fileString => {
+  const logs = fileString.split('\n')
+  return logs
+    .filter(o => o.trim() !== '')
+    .map(o => {
+      const log = JSON.parse(o)
+      log.message = decodeURIComponent(log.message)
+      const dataString = decodeURIComponent(log.data)
+      log.data = JSON.parse(dataString)
+      return log
+    })
+}
+
+export default parseFile

package/modules/logger/convert/parseFile.test.js

@@ -0,0 +1,28 @@
+import { describe, it, expect } from '@jest/globals'
+import parseFile from './parseFile.js'
+
+describe('parseFile', () => {
+  it('应该正确解析日志文件字符串', () => {
+    const fileString = `{"message":"test%20message","data":"%7B%22key%22%3A%22value%22%7D"}\n{"message":"another%20message","data":"%7B%22anotherKey%22%3A%22anotherValue%22%7D"}`
+    const result = parseFile(fileString)
+    expect(result).toEqual([
+      { message: 'test message', data: { key: 'value' } },
+      { message: 'another message', data: { anotherKey: 'anotherValue' } }
+    ])
+  })
+
+  it('应该返回空数组对于空文件字符串', () => {
+    const fileString = ''
+    const result = parseFile(fileString)
+    expect(result).toEqual([])
+  })
+
+  it('应该忽略文件字符串中的空行', () => {
+    const fileString = `{"message":"test%20message","data":"%7B%22key%22%3A%22value%22%7D"}\n\n{"message":"another%20message","data":"%7B%22anotherKey%22%3A%22anotherValue%22%7D"}`
+    const result = parseFile(fileString)
+    expect(result).toEqual([
+      { message: 'test message', data: { key: 'value' } },
+      { message: 'another message', data: { anotherKey: 'anotherValue' } }
+    ])
+  })
+})

package/modules/logger/convert/stringifyCMD.js

@@ -0,0 +1,48 @@
+import chalk from 'chalk'
+
+const stringifyCMD = ({
+  level = 'info',
+  timestamp = Date.now(),
+  namespace = 'default',
+  id = ''
+}) => {
+  const date = new Date(timestamp)
+  const formattedTimestamp = date.toISOString().replace('T', ' ').replace('Z', '')
+
+  let colorFn
+  switch (level) {
+    case 'trace':
+      colorFn = chalk.gray
+      break
+    case 'debug':
+      colorFn = chalk.green
+      break
+    case 'info':
+      colorFn = chalk.blue
+      break
+    case 'warn':
+      colorFn = chalk.yellow
+      break
+    case 'error':
+      colorFn = chalk.red
+      break
+    default:
+      colorFn = chalk.white
+  }
+
+  const prefixes = []
+  prefixes.push(formattedTimestamp)
+  prefixes.push(level.toUpperCase())
+  prefixes.push(namespace.toUpperCase())
+  if (id) {
+    prefixes.push(id)
+  }
+  const prefixString = prefixes
+    .map(prefix => {
+      return `[${prefix}]`
+    })
+    .join(' ')
+  return colorFn(`${prefixString} -`)
+}
+
+export default stringifyCMD

package/modules/logger/convert/stringifyCMD.test.js

@@ -0,0 +1,37 @@
+import { describe, it, expect } from '@jest/globals'
+import stringify from './stringifyCMD.js'
+import chalk from 'chalk'
+
+const timestamp = 1609459200000 // 2021-01-01T00:00:00.000Z
+
+describe('日志对象转命令行输出字符串', () => {
+  it('应该使用默认值格式化日志消息', () => {
+    const result = stringify({}).replace(/\.\d{3}/, '')
+    const date = new Date().toISOString().replace('T', ' ').replace('Z', '')
+    expect(result).toBe(chalk.blue(`[${date}] [INFO] [DEFAULT] -`.replace(/\.\d{3}/, '')))
+  })
+
+  it('应该使用自定义值格式化日志消息', () => {
+    const result = stringify({
+      level: 'error',
+      timestamp,
+      namespace: 'custom',
+      id: '12345'
+    })
+    expect(result).toBe(chalk.red('[2021-01-01 00:00:00.000] [ERROR] [CUSTOM] [12345] -'))
+  })
+
+  it('应该为每个日志级别使用正确的颜色', () => {
+    const levels = ['trace', 'debug', 'info', 'warn', 'error', 'unknown']
+    const colors = [chalk.gray, chalk.green, chalk.blue, chalk.yellow, chalk.red, chalk.white]
+    levels.forEach((level, color) => {
+      const result = stringify({
+        level,
+        timestamp,
+        id: '12345'
+      })
+      const date = new Date(timestamp).toISOString().replace('T', ' ').replace('Z', '')
+      expect(result).toBe(colors[color](`[${date}] [${level.toUpperCase()}] [DEFAULT] [12345] -`))
+    })
+  })
+})

package/modules/logger/convert/stringifyFile.js

@@ -0,0 +1,24 @@
+const stringifyFile = ({
+  level = 'info',
+  timestamp = Date.now(),
+  namespace = 'DEFAULT',
+  id = '',
+  message = '',
+  code = '',
+  data = {}
+}) => {
+  // Encode message to Base64
+  const encodedMessage = encodeURIComponent(message)
+  const encodedData = encodeURIComponent(JSON.stringify(data))
+  return JSON.stringify({
+    level,
+    timestamp,
+    namespace,
+    id,
+    message: encodedMessage,
+    code,
+    data: encodedData
+  })
+}
+
+export default stringifyFile

package/modules/logger/convert/stringifyFile.test.js

@@ -0,0 +1,79 @@
+import { describe, it, expect } from '@jest/globals'
+import stringifyFile from './stringifyFile.js'
+import parseFile from './parseFile.js'
+
+describe('日志对象转文件输出字符串', () => {
+  it('应该使用默认值记录消息', () => {
+    let logString = ''
+
+    const message = '测试消息'
+    logString += stringifyFile({ message })
+
+    const log = parseFile(logString)[0]
+
+    expect(log.level).toBe('info')
+    expect(log.message).toBe(message)
+    expect(log.timestamp).toBeGreaterThan(0)
+    expect(log.namespace).toBe('DEFAULT')
+    expect(log.id).toBe('')
+    expect(log.code).toBe('')
+    expect(log.data).toEqual({})
+  })
+
+  it('应该记录多条消息', () => {
+    let logString = ''
+
+    const messages = ['测试消息 1', '测试消息 2', '测试消息 3']
+    messages.forEach(message => {
+      logString += stringifyFile({ message }) + '\n'
+    })
+
+    const logs = parseFile(logString)
+
+    logs.forEach((log, index) => {
+      expect(log.level).toBe('info')
+      expect(log.message).toBe(messages[index])
+      expect(log.timestamp).toBeGreaterThan(0)
+      expect(log.namespace).toBe('DEFAULT')
+      expect(log.id).toBe('')
+      expect(log.code).toBe('')
+      expect(log.data).toEqual({})
+    })
+  })
+
+  it('应该记录带有特殊字符的消息', () => {
+    let logString = ''
+
+    const message = '带有特殊字符的测试消息\n新行\t制表符'
+    logString += stringifyFile({ message })
+
+    const log = parseFile(logString)[0]
+
+    expect(log.level).toBe('info')
+    expect(log.message).toBe(message)
+    expect(log.timestamp).toBeGreaterThan(0)
+    expect(log.namespace).toBe('DEFAULT')
+    expect(log.id).toBe('')
+    expect(log.code).toBe('')
+    expect(log.data).toEqual({})
+  })
+
+  it('应该记录带有code和data的消息', () => {
+    let logString = ''
+
+    const message = '测试消息'
+    const code = 'testKey'
+    const data = { foo: 'bar' }
+    logString += stringifyFile({ message, code, data })
+
+    const log = parseFile(logString)[0]
+
+    expect(log.level).toBe('info')
+    expect(log.message).toBe(message)
+    expect(log.timestamp).toBeGreaterThan(0)
+    expect(log.namespace).toBe('DEFAULT')
+    expect(log.id).toBe('')
+    expect(log.code).toBe(code)
+    expect(log.data).toEqual(data)
+  })
+})