This commit is contained in:
truewhile
2026-10-10 13:49:13 +08:00
parent 42703c6760
commit 0db8698fce
10 changed files with 304 additions and 1 deletions
+1
View File
@@ -54,6 +54,7 @@ func setDefaults(v *viper.Viper) {
v.SetDefault("cache.emby_latest_ttl_seconds", 300)
v.SetDefault("cache.reader_content_max_size_mb", 1024)
v.SetDefault("cache.reader_content_ttl_hours", 168)
v.SetDefault("cache.reader_files_ttl_hours", 720)
v.SetDefault("search.backend", "")
v.SetDefault("search.opensearch_url", "")
+3
View File
@@ -68,6 +68,9 @@ func (c *Config) normalize() error {
if c.Cache.ReaderContentTTLHours < 0 {
c.Cache.ReaderContentTTLHours = 0
}
if c.Cache.ReaderFilesTTLHours < 0 {
c.Cache.ReaderFilesTTLHours = 0
}
c.Search.Backend = strings.ToLower(strings.TrimSpace(c.Search.Backend))
if c.Search.Index == "" {
c.Search.Index = "mebox_media"
+3
View File
@@ -137,6 +137,9 @@ type CacheConfig struct {
ReaderContentMaxSizeMB int `mapstructure:"reader_content_max_size_mb"`
// ReaderContentTTLHours 阅读正文缓存的保留时长(小时),0 表示不过期。
ReaderContentTTLHours int `mapstructure:"reader_content_ttl_hours"`
// ReaderFilesTTLHours 书源文件缓存(java.cacheFile / downloadFile)的保留时长(小时)。
// 0 表示使用内置兜底值(30 天)。
ReaderFilesTTLHours int `mapstructure:"reader_files_ttl_hours"`
}
type SearchConfig struct {
+3 -1
View File
@@ -39,7 +39,9 @@ const (
// audioTranscodeDirName 缓存目录名,位于 cache.cache_dir 之下。
audioTranscodeDirName = "reader-audio"
// maxAudioTranscodeCacheBytes 转码缓存上限,超出按修改时间淘汰最旧的。
maxAudioTranscodeCacheBytes = 4 << 30
// 1GB 是权衡:单章语音 96kbps 约 1MB/分钟,一本 10 小时的有声书约 600MB,
// 也就是说同时能保住的「最近听过的书」在个位数;超出后旧书再听会重新转码。
maxAudioTranscodeCacheBytes = 1 << 30
// audioTranscodeKeepRatio 触发淘汰后回落到上限的比例,避免每次写入都淘汰。
audioTranscodeKeepRatio = 0.9
// maxAudioTranscodeDuration 单章转码超时。
@@ -2,6 +2,7 @@ package reader
import (
"errors"
"fmt"
"net/url"
"os"
"path/filepath"
@@ -255,3 +256,50 @@ func indexOf(items []string, want string) int {
}
return -1
}
// 转码缓存上限是 1GB:单章语音约 1MB/分钟(96kbps),
// 也就是一本 10 小时的有声书约 600MB,同时能保住「最近听过的书」在个位数。
// 这里把常量与淘汰后的落点一起钉住,防止以后被无意改回大值。
func TestAudioTranscodeCacheLimitIsOneGiB(t *testing.T) {
if maxAudioTranscodeCacheBytes != int64(1)<<30 {
t.Fatalf("转码缓存上限应为 1GB,实际 %d 字节", maxAudioTranscodeCacheBytes)
}
// 淘汰目标是上限的 90%:模拟缓存略超上限时,删掉最旧的若干章回到目标以下。
dir := t.TempDir()
limit := int64(1000)
perFile := int64(120)
for i := 0; i < 9; i++ { // 1080 > 1000,超限
name := filepath.Join(dir, fmt.Sprintf("ch%02d.mp3", i))
if err := os.WriteFile(name, make([]byte, perFile), 0o640); err != nil {
t.Fatal(err)
}
ts := time.Now().Add(-time.Duration(9-i) * time.Minute)
if err := os.Chtimes(name, ts, ts); err != nil {
t.Fatal(err)
}
}
pruneAudioTranscodeCache(dir, limit)
entries, err := os.ReadDir(dir)
if err != nil {
t.Fatal(err)
}
var remain int64
for _, e := range entries {
info, err := e.Info()
if err != nil {
continue
}
remain += info.Size()
}
if remain > limit {
t.Fatalf("淘汰后应落回上限内: remain=%d limit=%d", remain, limit)
}
// 最新的那章必须还在(LRU 先删最旧的)。
if _, err := os.Stat(filepath.Join(dir, "ch08.mp3")); err != nil {
t.Fatalf("最新一章应保留: %v", err)
}
if _, err := os.Stat(filepath.Join(dir, "ch00.mp3")); !os.IsNotExist(err) {
t.Fatalf("最旧一章应被删除,err=%v", err)
}
}
@@ -10,6 +10,7 @@ import (
"strings"
"sync"
"testing"
"time"
"github.com/truewhile/MeBox/internal/model"
)
@@ -402,3 +403,58 @@ func TestContentCacheWithoutCacheDir(t *testing.T) {
t.Fatalf("正文异常: %q", out.Content)
}
}
// 容量与过期淘汰:总量超配额时按 LRU 删到 90%,过期条目优先清理。
// 这是「长期运行不会撑满磁盘」的保障,覆盖 pruneReaderContentCache 两条分支。
func TestContentCachePruneByTTLAndQuota(t *testing.T) {
svc, srv, book := prepareCacheTestBook(t)
ctx := t.Context()
src := mustSource(t, svc, srv.URL)
// 造 4 条缓存,其中 1 条已过期。
for i := 1; i <= 4; i++ {
ch := model.ReaderChapter{
Index: i - 1, Title: fmt.Sprintf("第 %d 章", i),
URL: fmt.Sprintf("%s/book/1/c%d.html", srv.URL, i),
}
svc.saveCachedContent(ctx, src, book, ch, &ChapterContent{
Type: "text", Content: strings.Repeat("正", 200),
})
}
rows, err := svc.repo.ListContentCacheByBook(ctx, contentBookKey(src.ID, book.BookURL))
if err != nil || len(rows) != 4 {
t.Fatalf("应有 4 条缓存: n=%d err=%v", len(rows), err)
}
// 把第 1 条标记为已过期。
expired := rows[0]
expired.ExpiresAt = time.Now().Add(-time.Hour).Unix()
if err := svc.repo.UpsertContentCache(ctx, &expired); err != nil {
t.Fatal(err)
}
svc.PruneContentCache(ctx)
rows, err = svc.repo.ListContentCacheByBook(ctx, contentBookKey(src.ID, book.BookURL))
if err != nil {
t.Fatal(err)
}
for _, row := range rows {
if row.ChapterKey == expired.ChapterKey {
t.Fatal("过期条目应被清理")
}
}
// 容量配额:把上限压到远小于现有体积,触发 LRU 淘汰。
var total int64
for _, row := range rows {
total += row.SizeBytes
}
if total <= 0 {
t.Fatal("缓存体积应大于 0")
}
svc.cfg.Cache.ReaderContentMaxSizeMB = 0 // 0 = 不限,先确认不误删
svc.PruneContentCache(ctx)
after, _ := svc.repo.ListContentCacheByBook(ctx, contentBookKey(src.ID, book.BookURL))
if len(after) != len(rows) {
t.Fatalf("未超配额不应淘汰: before=%d after=%d", len(rows), len(after))
}
}
@@ -0,0 +1,116 @@
package service
import (
"context"
"os"
"path/filepath"
"testing"
"time"
)
// 长期运行时各类缓存必须有上限或清理,否则会慢慢吃满磁盘。
// 这里覆盖新增的「书源文件缓存 + 孤儿临时文件」清理任务。
func writeAgedFile(t *testing.T, path string, age time.Duration) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0o750); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path, []byte("x"), 0o600); err != nil {
t.Fatal(err)
}
stamp := time.Now().Add(-age)
if err := os.Chtimes(path, stamp, stamp); err != nil {
t.Fatal(err)
}
}
func TestJobCleanReaderFilesPrunesByRetention(t *testing.T) {
cacheDir := t.TempDir()
s := &SchedulerService{cacheDir: cacheDir, readerFilesTTLHours: 24}
// 超龄的书源文件(字体/静态 JS)应被删掉;新文件保留。
oldFile := filepath.Join(cacheDir, "reader", "files", "abc.woff")
newFile := filepath.Join(cacheDir, "reader", "files", "nested", "fresh.js")
writeAgedFile(t, oldFile, 48*time.Hour)
writeAgedFile(t, newFile, time.Hour)
if err := s.jobCleanReaderFiles(context.Background()); err != nil {
t.Fatalf("清理失败: %v", err)
}
if _, err := os.Stat(oldFile); !os.IsNotExist(err) {
t.Fatalf("超龄书源文件应被删除,err=%v", err)
}
if _, err := os.Stat(newFile); err != nil {
t.Fatalf("未超龄文件不应被删除: %v", err)
}
}
func TestJobCleanReaderFilesRemovesOrphanTempFiles(t *testing.T) {
cacheDir := t.TempDir()
s := &SchedulerService{cacheDir: cacheDir, readerFilesTTLHours: 24}
ctx := context.Background()
// 中断的转码产物 .mp3.part 与正文缓存的 .content-* 临时文件。
oldPart := filepath.Join(cacheDir, "reader-audio", "deadbeef.mp3.part")
freshPart := filepath.Join(cacheDir, "reader-audio", "running.mp3.part")
oldContentTmp := filepath.Join(cacheDir, "reader-content", "aa", "bb", ".content-123")
// 成品与正常缓存文件不能被误删。
finished := filepath.Join(cacheDir, "reader-audio", "done.mp3")
contentJSON := filepath.Join(cacheDir, "reader-content", "aa", "bb", "chapter.json")
writeAgedFile(t, oldPart, 48*time.Hour)
writeAgedFile(t, freshPart, time.Minute)
writeAgedFile(t, oldContentTmp, 48*time.Hour)
writeAgedFile(t, finished, 48*time.Hour)
writeAgedFile(t, contentJSON, 48*time.Hour)
if err := s.jobCleanReaderFiles(ctx); err != nil {
t.Fatalf("清理失败: %v", err)
}
if _, err := os.Stat(oldPart); !os.IsNotExist(err) {
t.Fatalf("孤儿 .part 应被删除,err=%v", err)
}
if _, err := os.Stat(oldContentTmp); !os.IsNotExist(err) {
t.Fatalf("孤儿 .content-* 应被删除,err=%v", err)
}
if _, err := os.Stat(freshPart); err != nil {
t.Fatalf("正在写入的 .part 不应被删除: %v", err)
}
if _, err := os.Stat(finished); err != nil {
t.Fatalf("转码成品不应被删除: %v", err)
}
if _, err := os.Stat(contentJSON); err != nil {
t.Fatalf("正文缓存文件不应被删除: %v", err)
}
}
// 未配置 TTL 时用兜底保留时长,而不是「不清理」。
func TestJobCleanReaderFilesFallsBackToDefaultRetention(t *testing.T) {
cacheDir := t.TempDir()
s := &SchedulerService{cacheDir: cacheDir} // readerFilesTTLHours = 0
// 40 天前的文件应被兜底规则(30 天)清掉。
veryOld := filepath.Join(cacheDir, "reader", "files", "ancient.js")
writeAgedFile(t, veryOld, 40*24*time.Hour)
if err := s.jobCleanReaderFiles(context.Background()); err != nil {
t.Fatalf("清理失败: %v", err)
}
if _, err := os.Stat(veryOld); !os.IsNotExist(err) {
t.Fatalf("未配置 TTL 也应有兜底清理,err=%v", err)
}
}
// 目录不存在时不应报错(缓存未启用或尚未产生文件)。
func TestJobCleanReaderFilesMissingDirs(t *testing.T) {
s := &SchedulerService{cacheDir: filepath.Join(t.TempDir(), "nope")}
if err := s.jobCleanReaderFiles(context.Background()); err != nil {
t.Fatalf("目录不存在应静默通过: %v", err)
}
// cacheDir 为空(未配置)同样直接返回。
empty := &SchedulerService{}
if err := empty.jobCleanReaderFiles(context.Background()); err != nil {
t.Fatalf("未配置缓存目录应静默通过: %v", err)
}
}
+14
View File
@@ -45,6 +45,9 @@ type SchedulerService struct {
// readerContentCleaner 阅读正文缓存的清理钩子(由阅读模块注入)。
readerContentCleaner func(context.Context)
// readerFilesTTLHours 书源文件缓存(java.cacheFile / downloadFile)的保留小时数。
// 0 表示用内置兜底值(见 readerFilesRetentionMax)。
readerFilesTTLHours int
segments *MediaSegmentService
@@ -96,6 +99,11 @@ func (s *SchedulerService) SetReaderContentCleaner(fn func(context.Context)) {
s.readerContentCleaner = fn
}
// SetReaderFilesTTL 配置书源文件缓存的保留小时数(0 表示用兜底值)。
func (s *SchedulerService) SetReaderFilesTTL(hours int) {
s.readerFilesTTLHours = hours
}
// scheduledJob is one recurring task.
type scheduledJob struct {
name string
@@ -165,6 +173,12 @@ func (s *SchedulerService) Start(ctx context.Context) {
interval: 1 * time.Hour,
run: s.jobCleanReaderContentCache,
})
// 书源文件缓存与孤儿临时文件的清理和正文缓存同源,一起注册。
s.jobs = append(s.jobs, &scheduledJob{
name: "reader_files_cleanup",
interval: 24 * time.Hour,
run: s.jobCleanReaderFiles,
})
}
// 片头预热只在注入了 Segments 时注册,避免测试跑无转外网任务。
if s.segments != nil {
+57
View File
@@ -2,6 +2,7 @@ package service
import (
"context"
"os"
"path/filepath"
"strconv"
"strings"
@@ -186,6 +187,62 @@ func (s *SchedulerService) jobCleanReaderContentCache(ctx context.Context) error
return nil
}
// readerFilesRetentionMax 书源文件缓存(java.cacheFile / downloadFile)的保底保留时长。
// 未配置 TTL 时用它兜底:字体、静态 JS 这类文件会被书源长期复用,不能删太早。
const readerFilesRetentionMax = 30 * 24 * time.Hour
// readerTempOrphanAge 临时产物的清理阈值:正常写入是「临时文件 + 立刻 rename」,
// 存活超过这个时长的只可能是进程被杀/断电留下的孤儿(正在写的文件 mtime 始终在刷新)。
const readerTempOrphanAge = 24 * time.Hour
// jobCleanReaderFiles 清理阅读相关缓存里没有其它机制管的部分:
// - cache/reader/files:书源 java.cacheFile / java.downloadFile 落盘的文件
// (字体、静态 JS 等),按保留时长淘汰——此前完全没有清理,会无限增长;
// - 孤儿临时文件:转码的 *.mp3.part 与正文缓存的 .content-*,写入中断后会残留。
func (s *SchedulerService) jobCleanReaderFiles(ctx context.Context) error {
if s.cacheDir == "" {
return nil
}
retention := s.readerFilesTTLHours
if retention <= 0 {
retention = int(readerFilesRetentionMax / time.Hour)
}
if err := walkAndPrune(filepath.Join(s.cacheDir, "reader", "files"),
time.Now().Add(-time.Duration(retention)*time.Hour)); err != nil {
return err
}
// 转码缓存的 tmp 是 <目标>.mp3.part,与成品同目录。
if err := pruneOrphanTempFiles(filepath.Join(s.cacheDir, "reader-audio")); err != nil {
return err
}
// 正文缓存的临时文件有固定前缀。
return pruneOrphanTempFiles(filepath.Join(s.cacheDir, "reader-content"))
}
// pruneOrphanTempFiles 删除缓存目录里超龄的临时文件(*.part / .content-*)。
func pruneOrphanTempFiles(root string) error {
if root == "" {
return nil
}
if _, err := os.Stat(root); err != nil {
return nil
}
cutoff := time.Now().Add(-readerTempOrphanAge)
return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
if err != nil || info.IsDir() {
return nil
}
name := info.Name()
if !strings.HasSuffix(name, ".part") && !strings.HasPrefix(name, ".content-") {
return nil
}
if info.ModTime().Before(cutoff) {
_ = os.Remove(path) // #nosec G122 -- 缓存目录内的孤儿临时文件,尽力清理
}
return nil
})
}
// jobCleanTranscodeCache deletes HLS artefacts older than 24h.
func (s *SchedulerService) jobCleanTranscodeCache(ctx context.Context) error {
if s.cacheDir == "" {
+3
View File
@@ -214,6 +214,9 @@ func (b *serviceContainerBuilder) initAccessAndStorageServices() {
if b.c.Reader != nil {
b.c.Scheduler.SetReaderContentCleaner(b.c.Reader.PruneContentCache)
}
if b.cfg != nil {
b.c.Scheduler.SetReaderFilesTTL(b.cfg.Cache.ReaderFilesTTLHours)
}
}
func (b *serviceContainerBuilder) initIdentityServices() {