middleware/cache/config.go (2)

62-69: Defaults for MaxBytes and CacheControl: code vs. runtime behavior mismatch

You updated comments/defaults to 1 MiB and true, but configDefault(...) does not populate these when a partial Config literal is passed (common usage). That means:

• New() → CacheControl=true, MaxBytes=1MiB
• New(Config{...}) (omit) → CacheControl=false, MaxBytes=0 (unlimited)

This is surprising given the docs. Two options:

• Short term (docs): clearly document that omitted fields in a provided literal take Go zero-values and must be explicitly set to match defaults.
• Long term (API): consider tri-state config (e.g., CacheControl *bool, MaxBytes *uint) or a sentinel for unlimited to let configDefault apply real defaults without breaking explicit false/0.

If you want, I can draft a non-breaking docs note now and an RFC for tri-state in v3.

---

101-121: configDefault doesn’t apply new defaults to MaxBytes/CacheControl

Consider whether you want defaults to apply when users pass a partial Config. If yes, you’ll need a tri-state approach for bool/uint (breaking) or companion flags (e.g., MaxBytesUnlimited bool) to preserve “0 means unlimited” while still defaulting to 1 MiB when omitted. Otherwise, add a prominent doc note (see docs comment).

middleware/cache/cache.go (1)

93-96: Ticker-based timestamp updater — LGTM; consider lifecycle

Using time.Ticker avoids drift. Minor: the goroutine has no shutdown path, so defer ticker.Stop() won’t run. Optional: tie ticker to app lifecycle or a done channel for clean shutdowns in long-lived tests.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

docs/middleware/cache.md (1)

112-116: Defaults update looks correct; missing prior omissions are now covered

Expiration=5m and CacheControl=true reflected; KeyGenerator and CacheInvalidator rows restored. Nice.

docs/middleware/cache.md (4)

9-10: Unify size unit (1 MiB) for consistency with defaults

Top note says “1 MB” while the table uses 1 * 1024 * 1024 (~1 MB). Recommend “1 MiB (~1 MB)” to avoid ambiguity.

-By default, cached responses expire after five minutes and the middleware stores up to 1 MB of response bodies.
+By default, cached responses expire after five minutes and the middleware stores up to 1 MiB (~1 MB) of response bodies.

---

109-122: Add a note about zero-values when passing partial Config literals

Readers may assume documented defaults apply when only some fields are set. Clarify that omitted fields take Go zero-values.

 | Methods              | `[]string`                                     | Methods specifies the HTTP methods to cache.                                                                                                                                                                                                                                                                   | `[]string{fiber.MethodGet, fiber.MethodHead}`                    |
 |
+> Note: When passing a partial `cache.Config` literal to `cache.New(...)`, omitted fields take Go zero-values
+> (e.g., `CacheControl` becomes `false`, `MaxBytes` becomes `0`). To keep the documented defaults while
+> customizing, either set them explicitly (e.g., `CacheControl: true`, `MaxBytes: 1*1024*1024`) or start from
+> `cfg := cache.ConfigDefault` and override only what you need.

---

114-114: Specify exact header semantics for CacheControl=true

Document what header is emitted (e.g., “Cache-Control: public, max-age=”) and how its value relates to Expiration/ExpirationGenerator.

-| CacheControl         | `bool`                                          | CacheControl enables client-side caching if set to true. Set to `false` to omit the `Cache-Control` header. | `true`                                                          |
+| CacheControl         | `bool`                                          | When `true`, emits a `Cache-Control` response header (max-age equals the effective expiration). Set to `false` to omit the header. | `true`                                                          |

---

120-120: Clarify behavior when MaxBytes is reached

Does the middleware evict entries (LRU/size-based) or skip writing new ones? Add one sentence describing the policy.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Learnt from: hcancelik
PR: gofiber/fiber#3036
File: docs/middleware/cache.md:103-103
Timestamp: 2024-10-08T19:06:06.583Z
Learning: There are no hard tabs in the lines 100 to 105 of the `docs/middleware/cache.md` file. Future comments about formatting should accurately reflect the actual content.