Files
go-trustlog/api/persistence/core_test.go
ryan 88f80ffa5e feat: 新增数据库持久化模块(Persistence),实现 Cursor + Retry 双层架构
## 核心功能

### 1. 数据库持久化支持
- 新增完整的 Persistence 模块 (api/persistence/)
- 支持三种持久化策略:
  * StrategyDBOnly - 仅落库,不存证
  * StrategyDBAndTrustlog - 既落库又存证(推荐)
  * StrategyTrustlogOnly - 仅存证,不落库
- 支持多数据库:PostgreSQL, MySQL, SQLite

### 2. Cursor + Retry 双层架构
- CursorWorker:第一道防线,快速发现新记录并尝试存证
  * 增量扫描 operation 表(基于时间戳游标)
  * 默认 10 秒扫描间隔,批量处理 100 条
  * 成功更新状态,失败转入重试队列
- RetryWorker:第二道防线,处理失败记录
  * 指数退避重试(1m → 2m → 4m → 8m → 16m)
  * 默认最多重试 5 次
  * 超限自动标记为死信

### 3. 数据库表设计
- operation 表:存储操作记录,支持可空 IP 字段
- trustlog_cursor 表:Key-Value 模式,支持多游标
- trustlog_retry 表:重试队列,支持指数退避

### 4. 异步最终一致性
- 应用调用立即返回(仅落库)
- CursorWorker 异步扫描并存证
- RetryWorker 保障失败重试
- 完整的监控和死信处理机制

## 修改文件

### 核心代码(11个文件)
- api/persistence/cursor_worker.go - Cursor 工作器(新增)
- api/persistence/repository.go - 数据仓储层(新增)
- api/persistence/schema.go - 数据库 Schema(新增)
- api/persistence/strategy.go - 策略管理器(新增)
- api/persistence/client.go - 客户端封装(新增)
- api/persistence/retry_worker.go - Retry 工作器(新增)
- api/persistence/config.go - 配置管理(新增)

### 修复内部包引用(5个文件)
- api/adapter/publisher.go - 修复 internal 包引用
- api/adapter/subscriber.go - 修复 internal 包引用
- api/model/envelope.go - 修复 internal 包引用
- api/model/operation.go - 修复 internal 包引用
- api/model/record.go - 修复 internal 包引用

### 单元测试(8个文件)
- api/persistence/*_test.go - 完整的单元测试
- 测试覆盖率:28.5%
- 测试通过率:49/49 (100%)

### SQL 脚本(4个文件)
- api/persistence/sql/postgresql.sql - PostgreSQL 建表脚本
- api/persistence/sql/mysql.sql - MySQL 建表脚本
- api/persistence/sql/sqlite.sql - SQLite 建表脚本
- api/persistence/sql/test_data.sql - 测试数据

### 文档(2个文件)
- README.md - 更新主文档,新增 Persistence 使用指南
- api/persistence/README.md - 完整的 Persistence 文档
- api/persistence/sql/README.md - SQL 脚本说明

## 技术亮点

1. **充分利用 Cursor 游标表**
   - 作为任务发现队列,非简单的位置记录
   - Key-Value 模式,支持多游标并发扫描
   - 时间戳天然有序,增量扫描高效

2. **双层保障机制**
   - Cursor:正常流程,快速处理
   - Retry:异常流程,可靠重试
   - 职责分离,监控清晰

3. **可空 IP 字段支持**
   - ClientIP 和 ServerIP 使用 *string 类型
   - 支持 NULL 值,符合数据库最佳实践
   - 使用 sql.NullString 正确处理

4. **完整的监控支持**
   - 未存证记录数监控
   - Cursor 延迟监控
   - 重试队列长度监控
   - 死信队列监控

## 测试结果

-  单元测试:49/49 通过 (100%)
-  代码覆盖率:28.5%
-  编译状态:无错误
-  支持数据库:PostgreSQL, MySQL, SQLite

## Breaking Changes

无破坏性变更。Persistence 模块作为可选功能,不影响现有代码。

## 版本信息

- 版本:v2.1.0
- Go 版本要求:1.21+
- 更新日期:2025-12-23
2025-12-23 18:59:43 +08:00

195 lines
5.5 KiB
Go

package persistence
import (
"strings"
"testing"
"time"
)
// TestCore 测试核心功能,不依赖外部模块
func TestTrustlogStatusString(t *testing.T) {
if StatusNotTrustlogged != "NOT_TRUSTLOGGED" {
t.Error("StatusNotTrustlogged value incorrect")
}
if StatusTrustlogged != "TRUSTLOGGED" {
t.Error("StatusTrustlogged value incorrect")
}
}
func TestRetryStatusString(t *testing.T) {
if RetryStatusPending != "PENDING" {
t.Error("RetryStatusPending value incorrect")
}
if RetryStatusRetrying != "RETRYING" {
t.Error("RetryStatusRetrying value incorrect")
}
if RetryStatusDeadLetter != "DEAD_LETTER" {
t.Error("RetryStatusDeadLetter value incorrect")
}
}
func TestPersistenceStrategyValues(t *testing.T) {
if StrategyDBOnly.String() != "DB_ONLY" {
t.Errorf("StrategyDBOnly.String() = %s, want DB_ONLY", StrategyDBOnly.String())
}
if StrategyDBAndTrustlog.String() != "DB_AND_TRUSTLOG" {
t.Errorf("StrategyDBAndTrustlog.String() = %s, want DB_AND_TRUSTLOG", StrategyDBAndTrustlog.String())
}
if StrategyTrustlogOnly.String() != "TRUSTLOG_ONLY" {
t.Errorf("StrategyTrustlogOnly.String() = %s, want TRUSTLOG_ONLY", StrategyTrustlogOnly.String())
}
}
func TestDBConfigDefaults(t *testing.T) {
cfg := DefaultDBConfig("postgres", "test-dsn")
if cfg.DriverName != "postgres" {
t.Error("DriverName not set correctly")
}
if cfg.DSN != "test-dsn" {
t.Error("DSN not set correctly")
}
if cfg.MaxOpenConns != 25 {
t.Error("MaxOpenConns not set to default 25")
}
if cfg.MaxIdleConns != 5 {
t.Error("MaxIdleConns not set to default 5")
}
if cfg.ConnMaxLifetime != time.Hour {
t.Error("ConnMaxLifetime not set to default 1 hour")
}
if cfg.ConnMaxIdleTime != 10*time.Minute {
t.Error("ConnMaxIdleTime not set to default 10 minutes")
}
}
func TestPersistenceConfigDefaults(t *testing.T) {
cfg := DefaultPersistenceConfig(StrategyDBAndTrustlog)
if cfg.Strategy != StrategyDBAndTrustlog {
t.Error("Strategy not set correctly")
}
if !cfg.EnableRetry {
t.Error("EnableRetry should be true by default")
}
if cfg.MaxRetryCount != 5 {
t.Error("MaxRetryCount should be 5 by default")
}
if cfg.RetryBatchSize != 100 {
t.Error("RetryBatchSize should be 100 by default")
}
}
func TestRetryWorkerConfigDefaults(t *testing.T) {
cfg := DefaultRetryWorkerConfig()
if cfg.RetryInterval != 30*time.Second {
t.Error("RetryInterval should be 30s by default")
}
if cfg.MaxRetryCount != 5 {
t.Error("MaxRetryCount should be 5 by default")
}
if cfg.BatchSize != 100 {
t.Error("BatchSize should be 100 by default")
}
if cfg.BackoffMultiplier != 2.0 {
t.Error("BackoffMultiplier should be 2.0 by default")
}
if cfg.InitialBackoff != 1*time.Minute {
t.Error("InitialBackoff should be 1 minute by default")
}
}
func TestDDLContainsRequiredTables(t *testing.T) {
// Test operation table
if !strings.Contains(OperationTableDDL, "CREATE TABLE") {
t.Error("OperationTableDDL should contain CREATE TABLE")
}
if !strings.Contains(OperationTableDDL, "operation") {
t.Error("OperationTableDDL should create operation table")
}
if !strings.Contains(OperationTableDDL, "client_ip") {
t.Error("OperationTableDDL should have client_ip field")
}
if !strings.Contains(OperationTableDDL, "server_ip") {
t.Error("OperationTableDDL should have server_ip field")
}
if !strings.Contains(OperationTableDDL, "trustlog_status") {
t.Error("OperationTableDDL should have trustlog_status field")
}
// Test cursor table
if !strings.Contains(CursorTableDDL, "trustlog_cursor") {
t.Error("CursorTableDDL should create trustlog_cursor table")
}
if !strings.Contains(CursorTableDDL, "cursor_key") {
t.Error("CursorTableDDL should have cursor_key field")
}
if !strings.Contains(CursorTableDDL, "cursor_value") {
t.Error("CursorTableDDL should have cursor_value field")
}
// Test retry table
if !strings.Contains(RetryTableDDL, "trustlog_retry") {
t.Error("RetryTableDDL should create trustlog_retry table")
}
if !strings.Contains(RetryTableDDL, "retry_status") {
t.Error("RetryTableDDL should have retry_status field")
}
if !strings.Contains(RetryTableDDL, "retry_count") {
t.Error("RetryTableDDL should have retry_count field")
}
}
func TestGetDialectDDLForDifferentDrivers(t *testing.T) {
drivers := []string{"postgres", "mysql", "sqlite3", "sqlite", "unknown"}
for _, driver := range drivers {
opDDL, cursorDDL, retryDDL, err := GetDialectDDL(driver)
if err != nil {
t.Errorf("GetDialectDDL(%s) returned error: %v", driver, err)
}
if opDDL == "" {
t.Errorf("GetDialectDDL(%s) returned empty operation DDL", driver)
}
if cursorDDL == "" {
t.Errorf("GetDialectDDL(%s) returned empty cursor DDL", driver)
}
if retryDDL == "" {
t.Errorf("GetDialectDDL(%s) returned empty retry DDL", driver)
}
}
}
func TestMySQLDDLHasSpecificSyntax(t *testing.T) {
opDDL, _, _, _ := GetDialectDDL("mysql")
if !strings.Contains(opDDL, "ENGINE=InnoDB") {
t.Error("MySQL DDL should contain ENGINE=InnoDB")
}
if !strings.Contains(opDDL, "CHARSET=utf8mb4") {
t.Error("MySQL DDL should contain CHARSET=utf8mb4")
}
}
func TestPostgresDDLHasCorrectTypes(t *testing.T) {
opDDL, _, _, _ := GetDialectDDL("postgres")
if !strings.Contains(opDDL, "VARCHAR") {
t.Error("Postgres DDL should use VARCHAR types")
}
if !strings.Contains(opDDL, "TIMESTAMP") {
t.Error("Postgres DDL should use TIMESTAMP types")
}
}
func TestSQLiteDDLUsesTEXT(t *testing.T) {
opDDL, _, _, _ := GetDialectDDL("sqlite3")
if !strings.Contains(opDDL, "TEXT") {
t.Error("SQLite DDL should use TEXT types")
}
}