forked from TrueCloudLab/distribution
1d33874951
Go 1.13 and up enforce import paths to be versioned if a project contains a go.mod and has released v2 or up. The current v2.x branches (and releases) do not yet have a go.mod, and therefore are still allowed to be imported with a non-versioned import path (go modules add a `+incompatible` annotation in that case). However, now that this project has a `go.mod` file, incompatible import paths will not be accepted by go modules, and attempting to use code from this repository will fail. This patch uses `v3` for the import-paths (not `v2`), because changing import paths itself is a breaking change, which means that the next release should increment the "major" version to comply with SemVer (as go modules dictate). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
81 lines
2.5 KiB
Go
81 lines
2.5 KiB
Go
package cache
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/distribution/distribution/v3"
|
|
dcontext "github.com/distribution/distribution/v3/context"
|
|
prometheus "github.com/distribution/distribution/v3/metrics"
|
|
"github.com/opencontainers/go-digest"
|
|
)
|
|
|
|
type cachedBlobStatter struct {
|
|
cache distribution.BlobDescriptorService
|
|
backend distribution.BlobDescriptorService
|
|
}
|
|
|
|
var (
|
|
// cacheCount is the number of total cache request received/hits/misses
|
|
cacheCount = prometheus.StorageNamespace.NewLabeledCounter("cache", "The number of cache request received", "type")
|
|
)
|
|
|
|
// NewCachedBlobStatter creates a new statter which prefers a cache and
|
|
// falls back to a backend.
|
|
func NewCachedBlobStatter(cache distribution.BlobDescriptorService, backend distribution.BlobDescriptorService) distribution.BlobDescriptorService {
|
|
return &cachedBlobStatter{
|
|
cache: cache,
|
|
backend: backend,
|
|
}
|
|
}
|
|
|
|
func (cbds *cachedBlobStatter) Stat(ctx context.Context, dgst digest.Digest) (distribution.Descriptor, error) {
|
|
cacheCount.WithValues("Request").Inc(1)
|
|
|
|
// try getting from cache
|
|
desc, cacheErr := cbds.cache.Stat(ctx, dgst)
|
|
if cacheErr == nil {
|
|
cacheCount.WithValues("Hit").Inc(1)
|
|
return desc, nil
|
|
}
|
|
|
|
// couldn't get from cache; get from backend
|
|
desc, err := cbds.backend.Stat(ctx, dgst)
|
|
if err != nil {
|
|
return desc, err
|
|
}
|
|
|
|
if cacheErr == distribution.ErrBlobUnknown {
|
|
// cache doesn't have info. update it with info got from backend
|
|
cacheCount.WithValues("Miss").Inc(1)
|
|
if err := cbds.cache.SetDescriptor(ctx, dgst, desc); err != nil {
|
|
dcontext.GetLoggerWithField(ctx, "blob", dgst).WithError(err).Error("error from cache setting desc")
|
|
}
|
|
// we don't need to return cache error upstream if any. continue returning value from backend
|
|
} else {
|
|
// unknown error from cache. just log and error. do not store cache as it may be trigger many set calls
|
|
dcontext.GetLoggerWithField(ctx, "blob", dgst).WithError(cacheErr).Error("error from cache stat(ing) blob")
|
|
cacheCount.WithValues("Error").Inc(1)
|
|
}
|
|
|
|
return desc, nil
|
|
}
|
|
|
|
func (cbds *cachedBlobStatter) Clear(ctx context.Context, dgst digest.Digest) error {
|
|
err := cbds.cache.Clear(ctx, dgst)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = cbds.backend.Clear(ctx, dgst)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (cbds *cachedBlobStatter) SetDescriptor(ctx context.Context, dgst digest.Digest, desc distribution.Descriptor) error {
|
|
if err := cbds.cache.SetDescriptor(ctx, dgst, desc); err != nil {
|
|
dcontext.GetLoggerWithField(ctx, "blob", dgst).WithError(err).Error("error from cache setting desc")
|
|
}
|
|
return nil
|
|
}
|