Files
sub2api-ht/backend/internal/service/ops_cleanup_overlay_test.go
erio c4598aa9b6 fix(ops-cleanup): 让 UI 数据保留策略真正生效
UI 上 admin 改的数据保留策略(cron + retention 天数)此前只写入 settings 表的
ops_advanced_settings.data_retention,但 OpsCleanupService 启动时只读
cfg.Ops.Cleanup(config.yaml / 环境变量),从未读取 settings 表,导致 UI 配置
完全不生效——cron 实际仍按默认 0 2 * * * 每日跑、retention 30 天。

改动:
- OpsCleanupService 增加 settingRepo 依赖,新增 effective 配置 + Reload 方法。
  Start/Reload 时从 settings.ops_advanced_settings.data_retention 覆盖
  cfg.Ops.Cleanup(Enabled、Schedule、*RetentionDays),无 settings 时整体
  fallback 到 cfg。runScheduled 顶部刷新一次 effective,让 retention 改动当次
  即生效(schedule/enabled 改动需要 Reload 才换 cron)。
- 用 mu + started/stopped 替换 startOnce/stopOnce 以支持 Reload 重建 cron。
- OpsService 增加 CleanupReloader 接口与 SetCleanupReloader setter;
  UpdateOpsAdvancedSettings 写入后调用 Reload。
- wire 通过 setter 注入 cleanup hook,避免构造期循环依赖。
- 新增单测覆盖 overlay 五种情形 + Update 触发 Reload。
2026-05-04 12:43:15 +08:00

197 lines
5.8 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//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)
}
}