Files
sub2api/backend/internal/service/ops_cleanup_overlay_test.go
T
erio d218b6c2aa refactor(ops-cleanup): 拆分 executor + table-driven + 提取常量 + 补测试
代码审查反馈:

1. 文件行数超标:ops_cleanup_service.go 594→413 行。
   拆 opsCleanupPlan / deleteOldRowsByID / truncateOpsTable / isMissingRelationError
   + counts struct 到 ops_cleanup_executor.go (164 行)。

2. runCleanupOnce 89 行→30 行(table-driven):
   用 []opsCleanupTarget 循环替代三组重复的 opsCleanupPlan → runOne → assign。

3. 魔法值提取常量:
   opsCleanupDefaultSchedule / opsCleanupBatchSize / opsCleanupCronStopTimeout /
   opsCleanupRunTimeout / opsCleanupHeartbeatTimeout。
   ops_settings.go 中 "0 2 * * *" 也统一引用 opsCleanupDefaultSchedule。

4. 补 5 个缺失测试:
   - Reload 未 Start 时 no-op
   - Reload 已 Stop 后 no-op
   - cleanupReloader==nil 时 Update 不 panic
   - Start 重复调用幂等
   - refreshEffectiveBeforeRun 正确更新 snapshot
2026-05-04 13:35:26 +08:00

258 lines
7.6 KiB
Go

//go:build unit
package service
import (
"context"
"encoding/json"
"testing"
"github.com/Wei-Shaw/sub2api/internal/config"
)
// makeOverlayService 构造一个没有 cron / db 的 cleanup service,仅用来测试 effective overlay。
func makeOverlayService(repo SettingRepository, base config.OpsCleanupConfig) *OpsCleanupService {
cfg := &config.Config{}
cfg.Ops.Cleanup = base
return &OpsCleanupService{
cfg: cfg,
settingRepo: repo,
}
}
func writeAdvancedSettings(t *testing.T, repo *runtimeSettingRepoStub, dr OpsDataRetentionSettings) {
t.Helper()
adv := OpsAdvancedSettings{DataRetention: dr}
raw, err := json.Marshal(adv)
if err != nil {
t.Fatalf("marshal: %v", err)
}
if err := repo.Set(context.Background(), SettingKeyOpsAdvancedSettings, string(raw)); err != nil {
t.Fatalf("set: %v", err)
}
}
func TestComputeEffective_FallbackToCfgWhenSettingsAbsent(t *testing.T) {
repo := newRuntimeSettingRepoStub()
base := config.OpsCleanupConfig{
Enabled: false,
Schedule: "0 2 * * *",
ErrorLogRetentionDays: 30,
MinuteMetricsRetentionDays: 30,
HourlyMetricsRetentionDays: 30,
}
svc := makeOverlayService(repo, base)
svc.computeEffectiveLocked(context.Background())
if svc.effective != base {
t.Fatalf("expected effective == cfg base, got %#v", svc.effective)
}
}
func TestComputeEffective_SettingsOverridesAll(t *testing.T) {
repo := newRuntimeSettingRepoStub()
writeAdvancedSettings(t, repo, OpsDataRetentionSettings{
CleanupEnabled: true,
CleanupSchedule: "0 * * * *",
ErrorLogRetentionDays: 0,
MinuteMetricsRetentionDays: 7,
HourlyMetricsRetentionDays: 14,
})
base := config.OpsCleanupConfig{
Enabled: false,
Schedule: "0 2 * * *",
ErrorLogRetentionDays: 30,
MinuteMetricsRetentionDays: 30,
HourlyMetricsRetentionDays: 30,
}
svc := makeOverlayService(repo, base)
svc.computeEffectiveLocked(context.Background())
want := config.OpsCleanupConfig{
Enabled: true,
Schedule: "0 * * * *",
ErrorLogRetentionDays: 0,
MinuteMetricsRetentionDays: 7,
HourlyMetricsRetentionDays: 14,
}
if svc.effective != want {
t.Fatalf("effective mismatch:\nwant %#v\n got %#v", want, svc.effective)
}
}
func TestComputeEffective_EmptyScheduleFallbackToCfg(t *testing.T) {
repo := newRuntimeSettingRepoStub()
writeAdvancedSettings(t, repo, OpsDataRetentionSettings{
CleanupEnabled: true,
CleanupSchedule: " ", // 空白被 trim 后视为空
ErrorLogRetentionDays: 5,
MinuteMetricsRetentionDays: 5,
HourlyMetricsRetentionDays: 5,
})
base := config.OpsCleanupConfig{
Enabled: false,
Schedule: "0 2 * * *",
ErrorLogRetentionDays: 30,
MinuteMetricsRetentionDays: 30,
HourlyMetricsRetentionDays: 30,
}
svc := makeOverlayService(repo, base)
svc.computeEffectiveLocked(context.Background())
if svc.effective.Schedule != "0 2 * * *" {
t.Fatalf("expected schedule fallback to cfg, got %q", svc.effective.Schedule)
}
if !svc.effective.Enabled {
t.Fatalf("expected enabled=true from settings")
}
if svc.effective.ErrorLogRetentionDays != 5 {
t.Fatalf("expected retention=5 from settings, got %d", svc.effective.ErrorLogRetentionDays)
}
}
func TestComputeEffective_NegativeRetentionFallsBackToCfg(t *testing.T) {
repo := newRuntimeSettingRepoStub()
writeAdvancedSettings(t, repo, OpsDataRetentionSettings{
CleanupEnabled: true,
CleanupSchedule: "0 * * * *",
ErrorLogRetentionDays: -1,
MinuteMetricsRetentionDays: -1,
HourlyMetricsRetentionDays: -1,
})
base := config.OpsCleanupConfig{
Enabled: false,
Schedule: "0 2 * * *",
ErrorLogRetentionDays: 30,
MinuteMetricsRetentionDays: 60,
HourlyMetricsRetentionDays: 90,
}
svc := makeOverlayService(repo, base)
svc.computeEffectiveLocked(context.Background())
if svc.effective.ErrorLogRetentionDays != 30 ||
svc.effective.MinuteMetricsRetentionDays != 60 ||
svc.effective.HourlyMetricsRetentionDays != 90 {
t.Fatalf("expected retention fallback to cfg, got %#v", svc.effective)
}
}
func TestComputeEffective_BadJSONFallsBackToCfg(t *testing.T) {
repo := newRuntimeSettingRepoStub()
if err := repo.Set(context.Background(), SettingKeyOpsAdvancedSettings, "{not json"); err != nil {
t.Fatalf("set: %v", err)
}
base := config.OpsCleanupConfig{
Enabled: true,
Schedule: "0 3 * * *",
ErrorLogRetentionDays: 30,
MinuteMetricsRetentionDays: 30,
HourlyMetricsRetentionDays: 30,
}
svc := makeOverlayService(repo, base)
svc.computeEffectiveLocked(context.Background())
if svc.effective != base {
t.Fatalf("expected fallback to cfg on bad JSON, got %#v", svc.effective)
}
}
// 验证 OpsService.UpdateOpsAdvancedSettings 写入后会调用 cleanupReloader.Reload。
type fakeCleanupReloader struct {
calls int
last context.Context
err error
}
func (f *fakeCleanupReloader) Reload(ctx context.Context) error {
f.calls++
f.last = ctx
return f.err
}
func TestUpdateOpsAdvancedSettings_TriggersReload(t *testing.T) {
repo := newRuntimeSettingRepoStub()
reloader := &fakeCleanupReloader{}
svc := &OpsService{settingRepo: repo}
svc.SetCleanupReloader(reloader)
cfg := defaultOpsAdvancedSettings()
cfg.DataRetention.CleanupEnabled = true
cfg.DataRetention.CleanupSchedule = "0 * * * *"
cfg.DataRetention.ErrorLogRetentionDays = 3
cfg.DataRetention.MinuteMetricsRetentionDays = 3
cfg.DataRetention.HourlyMetricsRetentionDays = 3
if _, err := svc.UpdateOpsAdvancedSettings(context.Background(), cfg); err != nil {
t.Fatalf("update: %v", err)
}
if reloader.calls != 1 {
t.Fatalf("expected reloader.Reload called once, got %d", reloader.calls)
}
}
func TestReload_BeforeStart_IsNoop(t *testing.T) {
svc := &OpsCleanupService{}
if err := svc.Reload(context.Background()); err != nil {
t.Fatalf("Reload before Start should return nil, got %v", err)
}
}
func TestReload_AfterStop_IsNoop(t *testing.T) {
svc := &OpsCleanupService{started: true, stopped: true}
if err := svc.Reload(context.Background()); err != nil {
t.Fatalf("Reload after Stop should return nil, got %v", err)
}
}
func TestUpdateOpsAdvancedSettings_NilReloader_NoPanic(t *testing.T) {
repo := newRuntimeSettingRepoStub()
svc := &OpsService{settingRepo: repo}
// cleanupReloader intentionally nil
cfg := defaultOpsAdvancedSettings()
cfg.DataRetention.ErrorLogRetentionDays = 7
// should not panic
if _, err := svc.UpdateOpsAdvancedSettings(context.Background(), cfg); err != nil {
t.Fatalf("update with nil reloader: %v", err)
}
}
func TestStart_IdempotentSecondCall(t *testing.T) {
svc := &OpsCleanupService{started: true}
svc.Start() // second call should be noop, not panic
}
func TestRefreshEffectiveBeforeRun_UpdatesSnapshot(t *testing.T) {
repo := newRuntimeSettingRepoStub()
base := config.OpsCleanupConfig{
Enabled: true,
Schedule: "0 2 * * *",
ErrorLogRetentionDays: 30,
}
svc := makeOverlayService(repo, base)
svc.computeEffectiveLocked(context.Background())
if svc.effective.ErrorLogRetentionDays != 30 {
t.Fatalf("initial retention should be 30, got %d", svc.effective.ErrorLogRetentionDays)
}
// simulate UI change
writeAdvancedSettings(t, repo, OpsDataRetentionSettings{
CleanupEnabled: true,
CleanupSchedule: "0 * * * *",
ErrorLogRetentionDays: 7,
})
svc.refreshEffectiveBeforeRun(context.Background())
snap := svc.snapshotEffective()
if snap.ErrorLogRetentionDays != 7 {
t.Fatalf("after refresh, retention should be 7, got %d", snap.ErrorLogRetentionDays)
}
}