Compare commits
1
Commits
next
..
bf047df6f4
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bf047df6f4 |
@@ -81,10 +81,7 @@ prevent abuse, and allowlisted source hosts for open access.
|
|||||||
|
|
||||||
Multiple source paths may reference the same content blob; the
|
Multiple source paths may reference the same content blob; the
|
||||||
database tracks references rather than using filesystem refcounting.
|
database tracks references rather than using filesystem refcounting.
|
||||||
Toward a target of 1-5k r/s, pixa keeps in memory the content types of
|
In-process caching of request-to-output mappings targets 1-5k r/s.
|
||||||
the 10,000 transformed images most recently cached or served, so a
|
|
||||||
cache hit on one of them reads only the image file from disk and not
|
|
||||||
the metadata file stored beside it.
|
|
||||||
|
|
||||||
### Routes
|
### Routes
|
||||||
|
|
||||||
|
|||||||
@@ -36,17 +36,6 @@ P2: security: referer blacklist
|
|||||||
`750`, then runs the server as `pixad`; data left by an earlier run under
|
`750`, then runs the server as `pixad`; data left by an earlier run under
|
||||||
another uid is taken over this way; "Running under upaas" in `README.md` no
|
another uid is taken over this way; "Running under upaas" in `README.md` no
|
||||||
longer tells the operator to create or chown the host directory.
|
longer tells the operator to create or chown the host directory.
|
||||||
- 2026-09-29 variant content types kept in memory (closes #70):
|
|
||||||
`Cache.metaCache` holds the content types of up to 10,000 variants in an LRU
|
|
||||||
(`github.com/hashicorp/golang-lru/v2`), filled by `StoreVariant` and by
|
|
||||||
`GetVariant` after it reads a `.meta` file, where a type `StoreVariant` added
|
|
||||||
meanwhile is kept over the one read, and never with the
|
|
||||||
`application/octet-stream` served for a variant without one; for a variant it
|
|
||||||
holds, `GetVariant` skips the `.meta` read, still opening the variant file and
|
|
||||||
taking the size from it; eviction removes the entry before deleting the files,
|
|
||||||
and `GetVariant` removes it when the file will not open; the cap is a
|
|
||||||
constant, not a setting; the unused `variantMeta` type is gone; `README.md`
|
|
||||||
describes it.
|
|
||||||
- 2026-09-29 maintenance mode refuses image requests (closes #71): while
|
- 2026-09-29 maintenance mode refuses image requests (closes #71): while
|
||||||
`maintenance_mode` is on, `/v1/image/` and `/v1/e/` answer 503 with a
|
`maintenance_mode` is on, `/v1/image/` and `/v1/e/` answer 503 with a
|
||||||
`Retry-After` header and the JSON error body, from one middleware in
|
`Retry-After` header and the JSON error body, from one middleware in
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ require (
|
|||||||
github.com/go-chi/httprate v0.16.0
|
github.com/go-chi/httprate v0.16.0
|
||||||
github.com/gorilla/csrf v1.7.3
|
github.com/gorilla/csrf v1.7.3
|
||||||
github.com/gorilla/securecookie v1.1.2
|
github.com/gorilla/securecookie v1.1.2
|
||||||
github.com/hashicorp/golang-lru/v2 v2.0.7
|
|
||||||
github.com/prometheus/client_golang v1.23.2
|
github.com/prometheus/client_golang v1.23.2
|
||||||
github.com/slok/go-http-metrics v0.13.0
|
github.com/slok/go-http-metrics v0.13.0
|
||||||
github.com/spf13/cobra v1.10.2
|
github.com/spf13/cobra v1.10.2
|
||||||
|
|||||||
@@ -228,8 +228,6 @@ github.com/hashicorp/go-version v1.2.1/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09
|
|||||||
github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
|
github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
|
||||||
github.com/hashicorp/golang-lru v0.5.4 h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc=
|
github.com/hashicorp/golang-lru v0.5.4 h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc=
|
||||||
github.com/hashicorp/golang-lru v0.5.4/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4=
|
github.com/hashicorp/golang-lru v0.5.4/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4=
|
||||||
github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
|
|
||||||
github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
|
|
||||||
github.com/hashicorp/hcl v1.0.1-vault-7 h1:ag5OxFVy3QYTFTJODRzTKVZ6xvdfLLCA1cy/Y6xGI0I=
|
github.com/hashicorp/hcl v1.0.1-vault-7 h1:ag5OxFVy3QYTFTJODRzTKVZ6xvdfLLCA1cy/Y6xGI0I=
|
||||||
github.com/hashicorp/hcl v1.0.1-vault-7/go.mod h1:XYhtn6ijBSAj6n4YqAaf7RBPS4I06AItNorpy+MoQNM=
|
github.com/hashicorp/hcl v1.0.1-vault-7/go.mod h1:XYhtn6ijBSAj6n4YqAaf7RBPS4I06AItNorpy+MoQNM=
|
||||||
github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
|
github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
|
||||||
|
|||||||
+12
-61
@@ -14,7 +14,6 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
lru "github.com/hashicorp/golang-lru/v2"
|
|
||||||
"sneak.berlin/go/pixa/internal/httpfetcher"
|
"sneak.berlin/go/pixa/internal/httpfetcher"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -27,10 +26,6 @@ var (
|
|||||||
// HTTP status code for successful fetch.
|
// HTTP status code for successful fetch.
|
||||||
const httpStatusOK = 200
|
const httpStatusOK = 200
|
||||||
|
|
||||||
// metaCacheSize is how many variants' content types metaCache holds. A
|
|
||||||
// variant not among them is served as before, reading its .meta file.
|
|
||||||
const metaCacheSize = 10000
|
|
||||||
|
|
||||||
// CacheConfig holds cache configuration.
|
// CacheConfig holds cache configuration.
|
||||||
type CacheConfig struct {
|
type CacheConfig struct {
|
||||||
StateDir string
|
StateDir string
|
||||||
@@ -54,6 +49,12 @@ type CacheConfig struct {
|
|||||||
Logger *slog.Logger
|
Logger *slog.Logger
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// variantMeta stores content type for fast cache hits without reading .meta file.
|
||||||
|
type variantMeta struct {
|
||||||
|
ContentType string
|
||||||
|
Size int64
|
||||||
|
}
|
||||||
|
|
||||||
// Cache implements the caching layer for the image proxy.
|
// Cache implements the caching layer for the image proxy.
|
||||||
type Cache struct {
|
type Cache struct {
|
||||||
db *sql.DB
|
db *sql.DB
|
||||||
@@ -75,10 +76,9 @@ type Cache struct {
|
|||||||
evictionStarted bool
|
evictionStarted bool
|
||||||
evictionStopOnce sync.Once
|
evictionStopOnce sync.Once
|
||||||
|
|
||||||
// metaCache holds the content types of the variants most recently
|
// In-memory cache of variant metadata (content type, size) to avoid
|
||||||
// stored or served, so a hit does not read the variant's .meta file.
|
// reading .meta files
|
||||||
// It never stands in for the variant file, which is always opened.
|
metaCache map[VariantKey]variantMeta
|
||||||
metaCache *lru.Cache[VariantKey, string]
|
|
||||||
|
|
||||||
// contentLocks serializes StoreSource and evictSourceBlob per
|
// contentLocks serializes StoreSource and evictSourceBlob per
|
||||||
// content hash, closing the race window between an eviction's row
|
// content hash, closing the race window between an eviction's row
|
||||||
@@ -101,11 +101,6 @@ func NewCache(db *sql.DB, config CacheConfig) (*Cache, error) {
|
|||||||
log = slog.Default()
|
log = slog.Default()
|
||||||
}
|
}
|
||||||
|
|
||||||
metaCache, err := lru.New[VariantKey, string](metaCacheSize)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to create variant content type cache: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
c := &Cache{
|
c := &Cache{
|
||||||
db: db,
|
db: db,
|
||||||
config: config,
|
config: config,
|
||||||
@@ -114,7 +109,7 @@ func NewCache(db *sql.DB, config CacheConfig) (*Cache, error) {
|
|||||||
evictionPressure: make(chan struct{}, 1),
|
evictionPressure: make(chan struct{}, 1),
|
||||||
evictionStop: make(chan struct{}),
|
evictionStop: make(chan struct{}),
|
||||||
evictionDone: make(chan struct{}),
|
evictionDone: make(chan struct{}),
|
||||||
metaCache: metaCache,
|
metaCache: make(map[VariantKey]variantMeta),
|
||||||
contentLocks: newContentLock(),
|
contentLocks: newContentLock(),
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -182,30 +177,13 @@ func (c *Cache) Lookup(ctx context.Context, req *ImageRequest) (*LookupResult, e
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetVariant returns a reader, size, and content type for a cached
|
// GetVariant returns a reader, size, and content type for a cached variant.
|
||||||
// variant. The content type comes from metaCache, or else from the
|
|
||||||
// variant's .meta file and is then kept in metaCache. A variant with
|
|
||||||
// no .meta file is served as application/octet-stream, which is not
|
|
||||||
// kept.
|
|
||||||
func (c *Cache) GetVariant(cacheKey VariantKey) (io.ReadCloser, int64, string, error) {
|
func (c *Cache) GetVariant(cacheKey VariantKey) (io.ReadCloser, int64, string, error) {
|
||||||
if c.disabled {
|
if c.disabled {
|
||||||
return nil, 0, "", ErrNotFound
|
return nil, 0, "", ErrNotFound
|
||||||
}
|
}
|
||||||
|
|
||||||
contentType, known := c.metaCache.Get(cacheKey)
|
return c.variants.LoadWithMeta(cacheKey)
|
||||||
if !known {
|
|
||||||
return c.loadVariantWithMeta(cacheKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, size, err := c.variants.LoadWithSize(cacheKey)
|
|
||||||
if err != nil {
|
|
||||||
// The file is gone, e.g. deleted outside pixa
|
|
||||||
c.metaCache.Remove(cacheKey)
|
|
||||||
|
|
||||||
return nil, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
return reader, size, contentType, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// StoreSource stores fetched source content and metadata. On a
|
// StoreSource stores fetched source content and metadata. On a
|
||||||
@@ -308,8 +286,6 @@ func (c *Cache) StoreVariant(
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.metaCache.Add(cacheKey, contentType)
|
|
||||||
|
|
||||||
_, err = c.db.ExecContext(ctx, `
|
_, err = c.db.ExecContext(ctx, `
|
||||||
INSERT INTO variant_content (cache_key, size_bytes, content_type)
|
INSERT INTO variant_content (cache_key, size_bytes, content_type)
|
||||||
VALUES (?, ?, ?)
|
VALUES (?, ?, ?)
|
||||||
@@ -523,31 +499,6 @@ func (c *Cache) IncrementTransformCount(ctx context.Context) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadVariantWithMeta is GetVariant for a variant metaCache does not
|
|
||||||
// hold: it reads the content type from the variant's .meta file and
|
|
||||||
// keeps it in metaCache, unless a StoreVariant has put one there
|
|
||||||
// meanwhile, as the store's is newer. A read that finds no .meta file,
|
|
||||||
// as one can between a store's writing of the variant file and of its
|
|
||||||
// .meta file, serves application/octet-stream and keeps nothing, so
|
|
||||||
// metaCache only ever holds a type read from a .meta file or passed to
|
|
||||||
// StoreVariant.
|
|
||||||
func (c *Cache) loadVariantWithMeta(
|
|
||||||
cacheKey VariantKey,
|
|
||||||
) (io.ReadCloser, int64, string, error) {
|
|
||||||
reader, size, contentType, err := c.variants.LoadWithMeta(cacheKey)
|
|
||||||
if err != nil {
|
|
||||||
return nil, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if contentType == "" {
|
|
||||||
return reader, size, fallbackContentType, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
c.metaCache.ContainsOrAdd(cacheKey, contentType)
|
|
||||||
|
|
||||||
return reader, size, contentType, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeMetadataSidecar writes the JSON metadata sidecar of a stored source.
|
// writeMetadataSidecar writes the JSON metadata sidecar of a stored source.
|
||||||
// A failure is logged and is otherwise non-fatal; the metadata is in the
|
// A failure is logged and is otherwise non-fatal; the metadata is in the
|
||||||
// database.
|
// database.
|
||||||
|
|||||||
@@ -39,8 +39,8 @@ const tempFilePrefix = ".tmp-"
|
|||||||
// to each variant file.
|
// to each variant file.
|
||||||
const variantMetaSuffix = ".meta"
|
const variantMetaSuffix = ".meta"
|
||||||
|
|
||||||
// fallbackContentType is the content type given to a variant file that
|
// fallbackContentType is recorded when a reconciled variant file has
|
||||||
// has no readable .meta sidecar, when it is served or reconciled.
|
// no readable .meta sidecar.
|
||||||
const fallbackContentType = "application/octet-stream"
|
const fallbackContentType = "application/octet-stream"
|
||||||
|
|
||||||
// UsageBytes returns the total number of bytes of cache content
|
// UsageBytes returns the total number of bytes of cache content
|
||||||
@@ -271,9 +271,7 @@ func (c *Cache) sourceCandidates(ctx context.Context) ([]evictionCandidate, erro
|
|||||||
|
|
||||||
// evictVariant removes one variant: accounting row first, then the
|
// evictVariant removes one variant: accounting row first, then the
|
||||||
// content and .meta files, so the database never references a deleted
|
// content and .meta files, so the database never references a deleted
|
||||||
// file. The metaCache entry goes before the files; a GetVariant that
|
// file.
|
||||||
// read them just before may put it back, and the next GetVariant then
|
|
||||||
// fails to open the file and removes it again.
|
|
||||||
func (c *Cache) evictVariant(ctx context.Context, cacheKey VariantKey) error {
|
func (c *Cache) evictVariant(ctx context.Context, cacheKey VariantKey) error {
|
||||||
_, err := c.db.ExecContext(ctx,
|
_, err := c.db.ExecContext(ctx,
|
||||||
`DELETE FROM variant_content WHERE cache_key = ?`, string(cacheKey))
|
`DELETE FROM variant_content WHERE cache_key = ?`, string(cacheKey))
|
||||||
@@ -281,8 +279,6 @@ func (c *Cache) evictVariant(ctx context.Context, cacheKey VariantKey) error {
|
|||||||
return fmt.Errorf("failed to delete variant accounting row: %w", err)
|
return fmt.Errorf("failed to delete variant accounting row: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
c.metaCache.Remove(cacheKey)
|
|
||||||
|
|
||||||
err = c.variants.DeleteWithMeta(cacheKey)
|
err = c.variants.DeleteWithMeta(cacheKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
|
|||||||
@@ -1,349 +0,0 @@
|
|||||||
package imgcache
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// webpRequest returns a request for a 100x100 WebP variant of path.
|
|
||||||
func webpRequest(path string) *ImageRequest {
|
|
||||||
return &ImageRequest{
|
|
||||||
SourceHost: testHostCDN,
|
|
||||||
SourcePath: path,
|
|
||||||
Size: Size{Width: 100, Height: 100},
|
|
||||||
Format: FormatWebP,
|
|
||||||
Quality: 85,
|
|
||||||
FitMode: FitCover,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertVariantServed checks that GetVariant serves key with the given
|
|
||||||
// content and the image/webp content type storeEvictionTestVariant stores.
|
|
||||||
func assertVariantServed(t *testing.T, cache *Cache, key VariantKey, content []byte) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
reader, size, contentType, err := cache.GetVariant(key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetVariant(%s) error = %v", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() { _ = reader.Close() }()
|
|
||||||
|
|
||||||
got, err := io.ReadAll(reader)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("reading variant %s: %v", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !bytes.Equal(got, content) {
|
|
||||||
t.Errorf("GetVariant(%s) content = %q, want %q", key, got, content)
|
|
||||||
}
|
|
||||||
|
|
||||||
if size != int64(len(content)) {
|
|
||||||
t.Errorf("GetVariant(%s) size = %d, want %d", key, size, len(content))
|
|
||||||
}
|
|
||||||
|
|
||||||
if contentType != testContentTypeWebP {
|
|
||||||
t.Errorf("GetVariant(%s) content type = %q, want %q",
|
|
||||||
key, contentType, testContentTypeWebP)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertVariantNotFound checks that GetVariant refuses key with
|
|
||||||
// ErrNotFound.
|
|
||||||
func assertVariantNotFound(t *testing.T, cache *Cache, key VariantKey) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
reader, _, _, err := cache.GetVariant(key)
|
|
||||||
if err == nil {
|
|
||||||
_ = reader.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
if !errors.Is(err, ErrNotFound) {
|
|
||||||
t.Errorf("GetVariant(%s) error = %v, want ErrNotFound", key, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertLookupMisses checks that Lookup reports request as a miss.
|
|
||||||
func assertLookupMisses(t *testing.T, cache *Cache, request *ImageRequest) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
lookup, err := cache.Lookup(t.Context(), request)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Lookup(%s) error = %v", request.SourcePath, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if lookup.Hit {
|
|
||||||
t.Errorf("Lookup(%s) is a hit, want a miss", request.SourcePath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// renameFile renames the file at from to to.
|
|
||||||
func renameFile(t *testing.T, from, to string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
err := os.Rename(from, to)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("renaming %s: %v", from, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSecondHitDoesNotReadMetaFile checks that once a variant has been
|
|
||||||
// stored or read, a hit takes its content type from memory: with the
|
|
||||||
// .meta file deleted, GetVariant must still return the stored content
|
|
||||||
// type rather than the application/octet-stream it uses without one.
|
|
||||||
func TestSecondHitDoesNotReadMetaFile(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1<<20)
|
|
||||||
content := []byte("webp variant bytes")
|
|
||||||
|
|
||||||
storeEvictionTestVariant(t, cache, testVariantKeyOne, content)
|
|
||||||
|
|
||||||
// A second Cache on the same state directory starts with nothing in
|
|
||||||
// memory, as pixad does after a restart, so its first read uses the
|
|
||||||
// .meta file.
|
|
||||||
restarted, err := NewCache(cache.db, cache.config)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewCache() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertVariantServed(t, restarted, testVariantKeyOne, content)
|
|
||||||
|
|
||||||
err = os.Remove(cache.variants.keyToPath(testVariantKeyOne) + ".meta")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("removing .meta file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertVariantServed(t, cache, testVariantKeyOne, content)
|
|
||||||
assertVariantServed(t, restarted, testVariantKeyOne, content)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestReadDuringStoreKeepsStoredContentType checks that a GetVariant
|
|
||||||
// which began before StoreVariant finished cannot replace the content
|
|
||||||
// type the store kept in memory. Such a read can find the variant file
|
|
||||||
// but not yet its .meta file, and so gets application/octet-stream. The
|
|
||||||
// test deletes the .meta file after the store, then runs the part of
|
|
||||||
// GetVariant that comes after its check of memory.
|
|
||||||
func TestReadDuringStoreKeepsStoredContentType(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1<<20)
|
|
||||||
content := []byte("webp variant bytes")
|
|
||||||
|
|
||||||
storeEvictionTestVariant(t, cache, testVariantKeyOne, content)
|
|
||||||
|
|
||||||
err := os.Remove(cache.variants.keyToPath(testVariantKeyOne) + ".meta")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("removing .meta file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, _, contentType, err := cache.loadVariantWithMeta(testVariantKeyOne)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("loadVariantWithMeta(%s) error = %v", testVariantKeyOne, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = reader.Close()
|
|
||||||
|
|
||||||
t.Logf("the read without a .meta file got content type %q", contentType)
|
|
||||||
|
|
||||||
assertVariantServed(t, cache, testVariantKeyOne, content)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestReadOfOlderMetaFileKeepsStoredContentType checks that a read
|
|
||||||
// which got its content type from a .meta file that StoreVariant had
|
|
||||||
// not yet rewritten cannot replace the type the store kept in memory.
|
|
||||||
// The test writes such a .meta file, with a different content type,
|
|
||||||
// after the store, then runs the part of GetVariant that comes after
|
|
||||||
// its check of memory.
|
|
||||||
func TestReadOfOlderMetaFileKeepsStoredContentType(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1<<20)
|
|
||||||
content := []byte("webp variant bytes")
|
|
||||||
|
|
||||||
storeEvictionTestVariant(t, cache, testVariantKeyOne, content)
|
|
||||||
|
|
||||||
olderMeta, err := json.Marshal(VariantMeta{
|
|
||||||
ContentType: testContentTypeJPEG,
|
|
||||||
Size: int64(len(content)),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("encoding .meta file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
metaPath := cache.variants.keyToPath(testVariantKeyOne) + ".meta"
|
|
||||||
|
|
||||||
err = os.WriteFile(metaPath, olderMeta, StorageFilePerm)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("writing .meta file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, _, contentType, err := cache.loadVariantWithMeta(testVariantKeyOne)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("loadVariantWithMeta(%s) error = %v", testVariantKeyOne, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = reader.Close()
|
|
||||||
|
|
||||||
if contentType != testContentTypeJPEG {
|
|
||||||
t.Fatalf("loadVariantWithMeta(%s) content type = %q, want %q from the .meta file",
|
|
||||||
testVariantKeyOne, contentType, testContentTypeJPEG)
|
|
||||||
}
|
|
||||||
|
|
||||||
kept, _ := cache.metaCache.Get(testVariantKeyOne)
|
|
||||||
if kept != testContentTypeWebP {
|
|
||||||
t.Errorf("content type in memory = %q, want the stored %q",
|
|
||||||
kept, testContentTypeWebP)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFailedReadDuringStoreKeepsStoredContentType checks that a read
|
|
||||||
// which found no .meta file cannot leave application/octet-stream in
|
|
||||||
// memory, even when another read has removed the content type
|
|
||||||
// StoreVariant kept there. In this order: the store; a read that finds
|
|
||||||
// the variant in memory but cannot open its file, and so removes it
|
|
||||||
// from memory; a read that opened the variant file before the store
|
|
||||||
// wrote its .meta file. Later hits must get the stored content type.
|
|
||||||
func TestFailedReadDuringStoreKeepsStoredContentType(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1<<20)
|
|
||||||
content := []byte("webp variant bytes")
|
|
||||||
variantPath := cache.variants.keyToPath(testVariantKeyOne)
|
|
||||||
metaPath := variantPath + ".meta"
|
|
||||||
|
|
||||||
storeEvictionTestVariant(t, cache, testVariantKeyOne, content)
|
|
||||||
|
|
||||||
renameFile(t, variantPath, variantPath+".hidden")
|
|
||||||
assertVariantNotFound(t, cache, testVariantKeyOne)
|
|
||||||
renameFile(t, variantPath+".hidden", variantPath)
|
|
||||||
|
|
||||||
renameFile(t, metaPath, metaPath+".hidden")
|
|
||||||
|
|
||||||
reader, _, contentType, err := cache.GetVariant(testVariantKeyOne)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetVariant(%s) error = %v", testVariantKeyOne, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = reader.Close()
|
|
||||||
|
|
||||||
t.Logf("the read without a .meta file got content type %q", contentType)
|
|
||||||
|
|
||||||
renameFile(t, metaPath+".hidden", metaPath)
|
|
||||||
|
|
||||||
assertVariantServed(t, cache, testVariantKeyOne, content)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestEvictedVariantIsNotServed checks that a variant the evictor
|
|
||||||
// removed is a miss and cannot be read, although it had been stored
|
|
||||||
// and served before.
|
|
||||||
func TestEvictedVariantIsNotServed(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1500)
|
|
||||||
|
|
||||||
oldRequest := webpRequest("/old.jpg")
|
|
||||||
newRequest := webpRequest("/new.jpg")
|
|
||||||
oldKey := CacheKey(oldRequest)
|
|
||||||
newKey := CacheKey(newRequest)
|
|
||||||
oldContent := bytes.Repeat([]byte{0x01}, 1000)
|
|
||||||
newContent := bytes.Repeat([]byte{0x02}, 1000)
|
|
||||||
|
|
||||||
storeEvictionTestVariant(t, cache, oldKey, oldContent)
|
|
||||||
storeEvictionTestVariant(t, cache, newKey, newContent)
|
|
||||||
assertVariantServed(t, cache, oldKey, oldContent)
|
|
||||||
setVariantLastAccessed(t, cache, oldKey, time.Now().Add(-time.Hour))
|
|
||||||
|
|
||||||
err := cache.EvictToLimit(t.Context())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("EvictToLimit() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertLookupMisses(t, cache, oldRequest)
|
|
||||||
assertVariantNotFound(t, cache, oldKey)
|
|
||||||
assertVariantServed(t, cache, newKey, newContent)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestVariantDeletedFromDiskIsNotServed checks that a variant whose
|
|
||||||
// file was deleted by something other than the evictor cannot be read,
|
|
||||||
// and is a miss afterwards.
|
|
||||||
func TestVariantDeletedFromDiskIsNotServed(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1<<20)
|
|
||||||
|
|
||||||
request := webpRequest("/deleted.jpg")
|
|
||||||
key := CacheKey(request)
|
|
||||||
content := []byte("webp variant bytes")
|
|
||||||
|
|
||||||
storeEvictionTestVariant(t, cache, key, content)
|
|
||||||
assertVariantServed(t, cache, key, content)
|
|
||||||
|
|
||||||
err := os.Remove(cache.variants.keyToPath(key))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("removing variant file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertVariantNotFound(t, cache, key)
|
|
||||||
assertLookupMisses(t, cache, request)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestConcurrentVariantStoreReadAndEvict stores, reads and evicts
|
|
||||||
// variants from several goroutines at once, for the race detector.
|
|
||||||
func TestConcurrentVariantStoreReadAndEvict(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, _ := newEvictionTestCache(t, 1<<20)
|
|
||||||
ctx := t.Context()
|
|
||||||
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
|
|
||||||
for goroutine := range 8 {
|
|
||||||
wg.Go(func() {
|
|
||||||
key := VariantKey(fmt.Sprintf("aabbccdd01%02d", goroutine))
|
|
||||||
content := []byte(key)
|
|
||||||
|
|
||||||
for range 20 {
|
|
||||||
err := cache.StoreVariant(
|
|
||||||
ctx, key, bytes.NewReader(content), testContentTypeWebP)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("StoreVariant(%s) error = %v", key, err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, _, contentType, err := cache.GetVariant(key)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("GetVariant(%s) error = %v", key, err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = reader.Close()
|
|
||||||
|
|
||||||
if contentType != testContentTypeWebP {
|
|
||||||
t.Errorf("GetVariant(%s) content type = %q, want %q",
|
|
||||||
key, contentType, testContentTypeWebP)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = cache.evictVariant(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("evictVariant(%s) error = %v", key, err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
assertVariantNotFound(t, cache, key)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
wg.Wait()
|
|
||||||
}
|
|
||||||
@@ -506,44 +506,32 @@ func (s *VariantStorage) Load(key VariantKey) (io.ReadCloser, error) {
|
|||||||
return f, nil
|
return f, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadWithSize returns a reader and file size for the content at the
|
// LoadWithMeta returns a reader, size, and content type for the content at
|
||||||
// given key.
|
// the given key.
|
||||||
func (s *VariantStorage) LoadWithSize(key VariantKey) (io.ReadCloser, int64, error) {
|
func (s *VariantStorage) LoadWithMeta(
|
||||||
|
key VariantKey,
|
||||||
|
) (io.ReadCloser, int64, string, error) {
|
||||||
path := s.keyToPath(key)
|
path := s.keyToPath(key)
|
||||||
|
metaPath := path + ".meta"
|
||||||
|
|
||||||
f, err := os.Open(path) //nolint:gosec // path derived from cache key
|
f, err := os.Open(path) //nolint:gosec // path derived from cache key
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if os.IsNotExist(err) {
|
if os.IsNotExist(err) {
|
||||||
return nil, 0, ErrNotFound
|
return nil, 0, "", ErrNotFound
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, 0, fmt.Errorf("failed to open content: %w", err)
|
return nil, 0, "", fmt.Errorf("failed to open content: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
stat, err := f.Stat()
|
stat, err := f.Stat()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = f.Close()
|
_ = f.Close()
|
||||||
|
|
||||||
return nil, 0, fmt.Errorf("failed to stat content: %w", err)
|
return nil, 0, "", fmt.Errorf("failed to stat content: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return f, stat.Size(), nil
|
// Load metadata for content type
|
||||||
}
|
contentType := "application/octet-stream" // fallback
|
||||||
|
|
||||||
// LoadWithMeta returns a reader, size, and content type for the content at
|
|
||||||
// the given key. The content type is read from the .meta file, and is
|
|
||||||
// empty when that file is missing or unreadable.
|
|
||||||
func (s *VariantStorage) LoadWithMeta(
|
|
||||||
key VariantKey,
|
|
||||||
) (io.ReadCloser, int64, string, error) {
|
|
||||||
f, size, err := s.LoadWithSize(key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
var contentType string
|
|
||||||
|
|
||||||
metaPath := s.keyToPath(key) + ".meta"
|
|
||||||
|
|
||||||
metaData, err := os.ReadFile(metaPath) //nolint:gosec // path derived from cache key
|
metaData, err := os.ReadFile(metaPath) //nolint:gosec // path derived from cache key
|
||||||
if err == nil {
|
if err == nil {
|
||||||
@@ -553,7 +541,7 @@ func (s *VariantStorage) LoadWithMeta(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return f, size, contentType, nil
|
return f, stat.Size(), contentType, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Exists checks if content exists at the given key.
|
// Exists checks if content exists at the given key.
|
||||||
|
|||||||
@@ -24,7 +24,6 @@ const (
|
|||||||
testHostExample = "example.com"
|
testHostExample = "example.com"
|
||||||
testPathCat = "/photos/cat.jpg"
|
testPathCat = "/photos/cat.jpg"
|
||||||
testContentTypeJPEG = "image/jpeg"
|
testContentTypeJPEG = "image/jpeg"
|
||||||
testContentTypeWebP = "image/webp"
|
|
||||||
testHeaderContentType = "Content-Type"
|
testHeaderContentType = "Content-Type"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user