Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

A cache storage that is not available is logged and skipped; Souin then serves from its unbounded in-memory storage

Đang mở
  • Có gì không ổn?
#145 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go
Lĩnh vực
backend, devops

Hướng nghiên cứu

Start in dispatch.go at parseStorages and trace how configured storage UUIDs are registered and looked up during Provision, including the call immediately after s.parseStorages(ctx). Reproduce the large size lookup mismatch and failed SimpleFS provisioning described in the issue. Done means provisioning fails when a configured storage is unavailable, so Caddy does not silently serve from the in-memory default.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Versions: Caddy v2.11.4, cache-handler v0.17.0, github.com/darkweak/storages/simplefs/caddy v0.0.20 (built with xcaddy, nothing else).

When the storage a cache block configures is not available, cache-handler logs it and Souin serves every response from its in-memory default storage. Caddy accepts the configuration, caddy reload included, so its automatic rollback never applies, and every cached response then lives in Caddy's heap with no cap, although the configuration asked for a disk-backed, size-capped storage.

Two ways to get there, both reproduced on the versions above with this Caddyfile (only the configuration block changes):

{
	admin off
	cache {
		ttl 60s
		simplefs {
			configuration {
				path /tmp/simplefs
				size 1000000
			}
		}
	}
}
:8080 {
	cache
	header Cache-Control "public, max-age=60"
	respond "hello" 200
}

1. size of 1,000,000 or more. The storer provisions and creates its directory, but the lookup does not find it: the name cache-handler composes for the lookup formats the decoded size (a float64) as 1e+06, while the storer registers under 1000000. The only log line is Souin's warning:

{"level":"warn","logger":"http.handlers.cache","msg":"You're running Souin with the default storage that is not optimized and for development purpose. ..."}

and every hit reports Cache-Status: Souin; hit; ttl=59; key=GET-http-127.0.0.1:8080-/; detail=DEFAULT, with nothing written under /tmp/simplefs. With size 1000 the same Caddyfile serves detail=SIMPLEFS and writes the body files.

2. A storage that fails to provision, e.g. path /nope/simplefs (a directory the process cannot create). parseStorages (dispatch.go) logs the error and carries on:

{"level":"error","logger":"http.handlers.cache","msg":"Error during SimpleFS init, did you include the SimpleFS storage (--with github.com/darkweak/storages/simplefs/caddy)? provision storages.cache.simplefs: mkdir /nope: read-only file system"}

then the same warning, and the same detail=DEFAULT hits.

Suggested fix: fail Provision when a configured storage (Found) is not registered under the UUID Souin looks it up by. That covers both cases: a reload is then refused and Caddy keeps the config it ran, and a start fails. We run this as a small patch, called right after s.parseStorages(ctx) and before middleware.NewHTTPCacheHandler:

func (s *SouinCaddyMiddleware) requireConfiguredStorages() error {
	dc := s.Configuration.DefaultCache
	for _, configured := range []struct {
		name     string
		provider configurationtypes.CacheProvider
	}{
		{"badger", dc.Badger}, {"etcd", dc.Etcd}, {"nats", dc.Nats}, {"nuts", dc.Nuts},
		{"olric", dc.Olric}, {"otter", dc.Otter}, {"redis", dc.Redis}, {"simplefs", dc.SimpleFS},
	} {
		if configured.provider.Found &&
			(configured.provider.Uuid == "" || core.GetRegisteredStorer(configured.provider.Uuid) == nil) {
			return fmt.Errorf("the %s storage is configured but is not available (its error is logged above): refusing to serve from the in-memory storage", configured.name)
		}
	}
	return nil
}

Case 1 could also be fixed at the source, by formatting size as an integer in the lookup name, or by asking the provisioned storer for the name it registered under. Happy to open a PR for either.

Ngôn ngữ chính
Go
Star
395
Fork
30
Merge trung bình
32 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của caddyserver/cache-handler

Tất cả issue của caddyserver/cache-handler

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.