MyClaw 开发日记 Day 2 - 核心包与配置系统完成

MyClaw 开发日记 Day 2 - 核心包与配置系统完成 ✅

工作时间： 2026-03-07 09:54 - 16:10 (约 6 小时)

阶段： Phase 1 Day 2 (基础架构)

✅ 今日完成任务

1. 核心包单元测试完善

为所有核心包编写了完整的测试套件：

@myclaw/core (27 个测试) ✅

  • Rule Schema 验证测试
  • Channel Config Schema 测试
  • Model Config Schema 测试
  • Permission Config Schema 测试
  • Gateway State Schema 测试
  • Result 类型测试
  • 边界情况和错误处理测试

@myclaw/logger (25 个测试) ✅

  • Logger 构造函数测试
  • 所有日志级别测试 (trace/debug/info/warn/error/fatal)
  • 子 logger 创建测试
  • 敏感数据掩码测试
  • 默认 logger 实例测试
  • 错误处理测试

@myclaw/gateway (17 个测试) ✅

  • GatewayLauncher 构造函数测试
  • 生命周期管理测试 (start/stop/restart)
  • 状态管理测试
  • 健康检查配置测试
  • 错误处理测试

@myclaw/storage (17 个测试) ✅

  • Storage 构造函数测试
  • Rules CRUD 操作测试
  • Channels CRUD 操作测试
  • Models CRUD 操作测试
  • Permissions CRUD 操作测试
  • 单例模式测试
  • 数据库关闭测试

总计：86 个核心包测试全部通过！ 🎉

2. 配置生成器 (@myclaw/config-generator)

创建配置文件生成器包，用于自动生成 OpenClaw Gateway 配置：

功能特性 (7 个测试) ✅

  • generateConfig() - 生成 OpenClaw 配置文件

    • 从 SQLite 数据库读取配置
    • 生成 openclaw.json 配置文件
    • 支持敏感信息掩码

  • generateEnvFile() - 生成环境变量文件

    • 自动提取 API 密钥
    • 生成 .env 文件
    • 支持多个 LLM 提供商

  • maskSensitiveConfig() - 敏感信息掩码

    • 自动掩码 token、apiKey、password、secret
    • 保护配置文件中的敏感数据

技术实现

1
2
3
4
5
6
7
8
9
10
11
12
13
// 示例用法
const generator = new ConfigGenerator({
  configDir: '~/.myclaw',
  dbPath: '~/.myclaw/myclaw.db'
});

// 生成配置文件
await generator.generateConfig();
// 输出: ~/.myclaw/openclaw.json

// 生成环境变量
await generator.generateEnvFile();
// 输出: ~/.myclaw/.env

3. 密钥注入系统 (@myclaw/keychain)

创建密钥管理系统，使用 macOS Keychain 安全存储敏感数据：

功能特性 (13 个测试) ✅

  • set(key, value) - 存储密钥到 Keychain
  • get(key) - 从 Keychain 读取密钥
  • delete(key) - 删除密钥
  • exists(key) - 检查密钥是否存在
  • list() - 列出所有密钥

技术实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { KeychainManager } from '@myclaw/keychain';

const keychain = new KeychainManager({ 
  service: 'com.myclaw.keys' 
});

// 存储密钥
await keychain.set('OPENAI_API_KEY', 'sk-xxx');

// 读取密钥
const apiKey = await keychain.get('OPENAI_API_KEY');

// 删除密钥
await keychain.delete('OPENAI_API_KEY');

安全特性

  • 使用 macOS 原生 Keychain 存储
  • 自动加密和解密
  • 系统级安全保护
  • 无需明文存储密钥

🔧 技术改进

1. 构建工具链优化

问题： tsdown 在构建时出现 “Maximum call stack size exceeded” 错误

解决方案：

  • 从 tsdown 迁移到 tsup
  • tsup 更稳定，社区支持更好

改进效果：

  • ✅ 构建速度提升
  • ✅ 类型声明文件生成正常
  • ✅ ESM 输出格式正确

2. Turbo 配置更新

问题： Turbo 2.0+ 不再支持 pipeline 字段

解决方案：

1
2
3
4
5
6
7
8
9
// turbo.json
{
  "tasks": {  // 从 "pipeline" 改为 "tasks"
    "build": {
      "dependsOn": ["^build"],
      "outputs": ["dist/**"]
    }
  }
}

3. TypeScript 配置修复

问题： paths 配置导致类型解析失败

解决方案：

1
2
3
4
5
6
7
8
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@myclaw/*": ["./packages/*/src"]
    }
  }
}

4. Package.json Exports 修复

问题： vitest 无法解析 workspace 包入口

解决方案：

1
2
3
4
5
6
7
8
9
10
{
  "main": "./dist/index.mjs",
  "types": "./dist/index.d.mts",
  "exports": {
    ".": {
      "import": "./dist/index.mjs",
      "types": "./dist/index.d.mts"
    }
  }
}

5. better-sqlite3 原生模块编译

问题： better-sqlite3 需要编译原生模块

解决方案：

1
2
cd node_modules/.pnpm/better-sqlite3@11.10.0/node_modules/better-sqlite3
npm run build-release

结果： ✅ Storage 包所有测试通过

📊 测试覆盖统计

包名 测试文件数 测试用例数 状态
@myclaw/core 1 27 ✅
@myclaw/logger 1 25 ✅
@myclaw/gateway 1 17 ✅
@myclaw/storage 1 17 ✅
@myclaw/config-generator 1 7 ✅
@myclaw/keychain 1 13 ✅
总计 6 106 ✅

🎯 测试亮点

1. Zod Schema 验证

所有数据模型都使用 Zod 进行运行时验证：

1
2
3
4
5
6
7
8
export const RuleSchema = z.object({
  id: z.string().uuid(),
  natural: z.string().min(1),
  compiled: z.object({
    trigger: z.enum(['cron', 'event', 'webhook', 'manual']),
    // ...
  }),
});

测试覆盖：

  • 有效数据验证
  • 无效数据拒绝
  • 边界情况处理
  • 默认值设置

2. 敏感信息掩码

Logger 自动掩码敏感字段：

1
2
3
new Logger({
  maskValuesOfKeys: ['apiKey', 'password', 'token', 'secret']
});

测试验证：

  • apiKey 被掩码
  • password 被掩码
  • token 被掩码
  • secret 被掩码

3. SQLite CRUD 操作

完整的数据库操作测试：

1
2
3
4
5
6
7
8
9
10
11
// 创建
storage.saveRule(rule);

// 读取
const retrieved = storage.getRule(rule.id);

// 更新
storage.saveRule(updatedRule);

// 删除
storage.deleteRule(rule.id);

测试覆盖：

  • 所有 CRUD 操作
  • 数据序列化/反序列化
  • 空值处理
  • 单例模式

4. macOS Keychain 集成

密钥管理测试：

1
2
3
4
5
6
7
8
9
// Mock child_process
vi.mock('child_process', () => ({
  exec: vi.fn(),
}));

// 测试 Keychain 操作
await keychain.set('test-key', 'test-value');
const value = await keychain.get('test-key');
expect(value).toBe('test-value');

测试覆盖：

  • 存储密钥
  • 读取密钥
  • 删除密钥
  • 错误处理

📝 学习笔记

Vitest 测试框架

优势：

  • 快速启动（基于 Vite）
  • 兼容 Jest API
  • 原生 TypeScript 支持
  • 内置覆盖率报告

最佳实践：

  • 使用 vi.fn() 进行 mock
  • 使用 beforeEach/afterEach 管理测试状态
  • 使用 describe/it 组织测试结构

Zod 验证库

核心优势：

  • 运行时类型检查
  • 自动类型推断
  • 详细的错误信息
  • 可组合性

测试策略：

  • 测试所有有效输入
  • 测试所有无效输入
  • 测试边界情况
  • 测试默认值

better-sqlite3

性能优势：

  • 同步 API
  • 高性能
  • 低内存占用

注意事项：

  • 需要编译原生模块
  • 使用 prepared statements
  • 正确关闭连接

macOS Keychain

安全优势：

  • 系统级加密
  • 自动访问控制
  • 用户授权机制
  • 跨应用隔离

最佳实践：

  • 使用服务名称隔离
  • 处理访问拒绝
  • 实现优雅降级

🚀 明日计划 (Day 3)

任务清单

1. 实现规则引擎核心

  • 自然语言规则解析
  • Cron 表达式生成
  • 规则验证和测试

2. 实现 CLI 工具

  • 命令行参数解析
  • 交互式配置向导
  • 规则管理命令

3. 编写集成测试

  • 多包协作测试
  • 端到端测试
  • 测试覆盖率报告

4. 完善文档

  • API 文档
  • 架构说明
  • 使用示例

交付物

  • 规则引擎核心实现
  • CLI 工具框架
  • 集成测试套件
  • 博客报告：核心包设计详解

📚 参考资料

  1. Vitest 文档
  2. Zod 验证库
  3. tsup 打包工具
  4. better-sqlite3 API
  5. Turbo 构建系统
  6. macOS Keychain Services

🎉 里程碑达成

Phase 1 Day 2 完成！

  • ✅ 核心包测试完成 (86 个测试)
  • ✅ 配置生成器完成 (7 个测试)
  • ✅ 密钥注入系统完成 (13 个测试)
  • ✅ 总计：106 个测试全部通过！

进度评价： 🟢 超前完成

心情指数： ⭐⭐⭐⭐⭐

代码统计：

  • 新增测试代码：~900 行
  • 新增源代码：~800 行
  • 修复配置文件：5 个
  • 测试用例：106 个

Phase 1 Day 2 完成！明天继续 Day 3，开始规则引擎开发！

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

程序员，关于技术我所知甚少，唯有探索，方得真知。