mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-30 19:33:01 +00:00
1cddc56f13
* ✨ Cache middleware: Store e2e headers. As defined in RFC2616 - section-13.5.1, shared caches MUST store end-to-end headers from backend response and MUST be transmitted in any response formed from a cache entry. This commit ensures a stronger consistency between responses served from the handlers & from the cache middleware. * ✨ Cache middleware: Add flag for e2e headers. Set flag to prevent e2e headers caching to be the default behavior of the cache middleware. This would otherwise change quite a lot the experience for cache middleware current users. * ✨ Cache middleware: Add Benchmark for additionalHeaders feature. * ✨ Cache middleware: Rename E2Eheaders into StoreResponseHeaders. E2E is an acronym commonly associated with test. While in the present case it refers to end-to-end HTTP headers (by opposition to hop-by-hop), this still remains confusing. This commits renames it to a more generic name. * ✨ Cache middleware: Update README * ✨ Cache middleware: Move map instanciation. This will prevent an extra memory allocation for users not interested in this feature. * ✨ Cache middleware: Prevent memory allocation when StoreResponseHeaders is disabled. * ✨ Cache middleware: Store e2e headers. #1807 - use set instead of add for the headers - copy value from the headers -> prevent problems with mutable values Co-authored-by: wernerr <rene@gofiber.io>
124 lines
2.4 KiB
Go
124 lines
2.4 KiB
Go
package cache
|
|
|
|
import (
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/gofiber/fiber/v2/internal/memory"
|
|
)
|
|
|
|
// go:generate msgp
|
|
// msgp -file="manager.go" -o="manager_msgp.go" -tests=false -unexported
|
|
// don't forget to replace the msgp import path to:
|
|
// "github.com/gofiber/fiber/v2/internal/msgp"
|
|
type item struct {
|
|
body []byte
|
|
ctype []byte
|
|
cencoding []byte
|
|
status int
|
|
exp uint64
|
|
headers map[string][]byte
|
|
}
|
|
|
|
//msgp:ignore manager
|
|
type manager struct {
|
|
pool sync.Pool
|
|
memory *memory.Storage
|
|
storage fiber.Storage
|
|
}
|
|
|
|
func newManager(storage fiber.Storage) *manager {
|
|
// Create new storage handler
|
|
manager := &manager{
|
|
pool: sync.Pool{
|
|
New: func() interface{} {
|
|
return new(item)
|
|
},
|
|
},
|
|
}
|
|
if storage != nil {
|
|
// Use provided storage if provided
|
|
manager.storage = storage
|
|
} else {
|
|
// Fallback to memory storage
|
|
manager.memory = memory.New()
|
|
}
|
|
return manager
|
|
}
|
|
|
|
// acquire returns an *entry from the sync.Pool
|
|
func (m *manager) acquire() *item {
|
|
return m.pool.Get().(*item)
|
|
}
|
|
|
|
// release and reset *entry to sync.Pool
|
|
func (m *manager) release(e *item) {
|
|
// don't release item if we using memory storage
|
|
if m.storage != nil {
|
|
return
|
|
}
|
|
e.body = nil
|
|
e.ctype = nil
|
|
e.status = 0
|
|
e.exp = 0
|
|
e.headers = nil
|
|
m.pool.Put(e)
|
|
}
|
|
|
|
// get data from storage or memory
|
|
func (m *manager) get(key string) (it *item) {
|
|
if m.storage != nil {
|
|
it = m.acquire()
|
|
if raw, _ := m.storage.Get(key); raw != nil {
|
|
if _, err := it.UnmarshalMsg(raw); err != nil {
|
|
return
|
|
}
|
|
}
|
|
return
|
|
}
|
|
if it, _ = m.memory.Get(key).(*item); it == nil {
|
|
it = m.acquire()
|
|
}
|
|
return
|
|
}
|
|
|
|
// get raw data from storage or memory
|
|
func (m *manager) getRaw(key string) (raw []byte) {
|
|
if m.storage != nil {
|
|
raw, _ = m.storage.Get(key)
|
|
} else {
|
|
raw, _ = m.memory.Get(key).([]byte)
|
|
}
|
|
return
|
|
}
|
|
|
|
// set data to storage or memory
|
|
func (m *manager) set(key string, it *item, exp time.Duration) {
|
|
if m.storage != nil {
|
|
if raw, err := it.MarshalMsg(nil); err == nil {
|
|
_ = m.storage.Set(key, raw, exp)
|
|
}
|
|
} else {
|
|
m.memory.Set(key, it, exp)
|
|
}
|
|
}
|
|
|
|
// set data to storage or memory
|
|
func (m *manager) setRaw(key string, raw []byte, exp time.Duration) {
|
|
if m.storage != nil {
|
|
_ = m.storage.Set(key, raw, exp)
|
|
} else {
|
|
m.memory.Set(key, raw, exp)
|
|
}
|
|
}
|
|
|
|
// delete data from storage or memory
|
|
func (m *manager) delete(key string) {
|
|
if m.storage != nil {
|
|
_ = m.storage.Delete(key)
|
|
} else {
|
|
m.memory.Delete(key)
|
|
}
|
|
}
|