cache

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 24, 2026 License: MIT Imports: 33 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrHostnameRequired is returned if the given hostName to New is not given.
	ErrHostnameRequired = errors.New("hostName is required")

	// ErrHostnameMustNotContainScheme is returned if the given hostName to New contained a scheme.
	ErrHostnameMustNotContainScheme = errors.New("hostName must not contain scheme")

	// ErrHostnameNotValid is returned if the given hostName to New is not valid.
	ErrHostnameNotValid = errors.New("hostName is not valid")

	// ErrHostnameMustNotContainPath is returned if the given hostName to New contained a path.
	ErrHostnameMustNotContainPath = errors.New("hostName must not contain a path")

	// ErrCDCDisabled is returned when CDC is required but not enabled.
	ErrCDCDisabled = errors.New("CDC must be enabled and chunk store configured for migration")

	// ErrNarAlreadyChunked is returned when the nar is already chunked.
	ErrNarAlreadyChunked = errors.New("nar is already chunked")
)

Functions

func IsUploadOnly added in v0.9.0 

func IsUploadOnly(ctx context.Context) bool

IsUploadOnly checks if the context specifies skipping upstream checks.

func MigrateNarInfo added in v0.8.0 

func MigrateNarInfo(
	ctx context.Context,
	locker lock.Locker,
	db database.Querier,
	narInfoStore storage.NarInfoStore,
	hash string,
	ni *narinfo.NarInfo,
) error

MigrateNarInfo migrates a single narinfo from storage to the database. It uses distributed locking to coordinate with other instances (if a distributed locker is provided). This function is used both by Cache.MigrateNarInfoToDatabase and the CLI migrate-narinfo command.

Parameters:

  • ctx: Context for the operation
  • locker: Distributed locker for coordination (can be in-memory for single-instance)
  • db: Database querier for storing the narinfo
  • narInfoStore: Optional storage backend to delete from after migration (nil to skip deletion)
  • hash: The narinfo hash to migrate
  • ni: The parsed narinfo to migrate

Returns an error if migration fails. Returns nil if the narinfo is already migrated or if another instance is currently migrating it.

func WithUploadOnly added in v0.9.0 

func WithUploadOnly(ctx context.Context) context.Context

WithUploadOnly returns a context that instructs the cache to skip upstream checks.

Types

type Cache 

type Cache struct {
	// contains filtered or unexported fields
}

Cache represents the main cache service.

func New 

func New(
	ctx context.Context,
	hostName string,
	db database.Querier,

	configStore storage.ConfigStore,
	narInfoStore storage.NarInfoStore,
	narStore storage.NarStore,
	secretKeyPath string,
	downloadLocker lock.Locker,
	cacheLocker lock.RWLocker,
	downloadLockTTL time.Duration,
	downloadPollTimeout time.Duration,
	cacheLockTTL time.Duration,
) (*Cache, error)

New returns a new Cache.

func (*Cache) AddLRUCronJob added in v0.0.11 

func (c *Cache) AddLRUCronJob(ctx context.Context, schedule cron.Schedule)

AddLRUCronJob adds a job for LRU.

func (*Cache) AddUpstreamCaches added in v0.0.11 

func (c *Cache) AddUpstreamCaches(ctx context.Context, ucs ...*upstream.Cache)

AddUpstreamCaches adds one or more upstream caches with lazy loading support.

func (*Cache) BackgroundMigrateNarToChunks added in v0.9.0 

func (c *Cache) BackgroundMigrateNarToChunks(ctx context.Context, narURL nar.URL)

BackgroundMigrateNarToChunks migrates a traditional NAR blob to content-defined chunks in the background.

func (*Cache) Close added in v0.8.0 

func (c *Cache) Close()

Close waits for all background operations to complete.

func (*Cache) DeleteNar added in v0.0.4 

func (c *Cache) DeleteNar(ctx context.Context, narURL nar.URL) error

DeleteNar deletes the nar from the store.

func (*Cache) DeleteNarInfo added in v0.0.4 

func (c *Cache) DeleteNarInfo(ctx context.Context, hash string) error

DeleteNarInfo deletes the narInfo from the store.

func (*Cache) GetConfig added in v0.8.0 

func (c *Cache) GetConfig() *config.Config

GetConfig returns the configuration instance. It's useful for testing the behavior of ncps.

func (*Cache) GetHealthChecker added in v0.3.0 

func (c *Cache) GetHealthChecker() *healthcheck.HealthChecker

GetHealthChecker returns the instance of haelth checker used by the cache. It's useful for testing the behavior of ncps.

func (*Cache) GetHealthyUpstreamCount added in v0.6.0 

func (c *Cache) GetHealthyUpstreamCount() int

GetHealthyUpstreamCount returns the number of healthy upstream caches.

func (*Cache) GetHealthyUpstreamCountLocked added in v0.9.0 

func (c *Cache) GetHealthyUpstreamCountLocked() int

GetHealthyUpstreamCountLocked returns the number of healthy upstream caches. It assumes the caller holds at least a read lock on upstreamCachesMu.

func (*Cache) GetHostname 

func (c *Cache) GetHostname() string

GetHostname returns the hostname.

func (*Cache) GetNar 

func (c *Cache) GetNar(ctx context.Context, narURL nar.URL) (int64, io.ReadCloser, error)

GetNar returns the nar given a hash and compression from the store. If the nar is not found in the store, it's pulled from an upstream, stored in the stored and finally returned. NOTE: It's the caller responsibility to close the body.

func (*Cache) GetNarFileSize added in v0.9.0 

func (c *Cache) GetNarFileSize(ctx context.Context, nu nar.URL) (int64, error)

GetNarFileSize returns the size of the NAR file from the database if it exists.

func (*Cache) GetNarInfo 

func (c *Cache) GetNarInfo(ctx context.Context, hash string) (*narinfo.NarInfo, error)

GetNarInfo returns the narInfo given a hash from the store. If the narInfo is not found in the store, it's pulled from an upstream, stored in the stored and finally returned.

func (*Cache) HasNarFileRecord added in v0.9.0 

func (c *Cache) HasNarFileRecord(ctx context.Context, narURL nar.URL) (bool, error)

HasNarFileRecord checks if a NAR file record exists in the database, regardless of chunking completion status. This is used for coordination to allow progressive streaming while chunking is in progress.

func (*Cache) HasNarInChunks added in v0.9.0 

func (c *Cache) HasNarInChunks(ctx context.Context, narURL nar.URL) (bool, error)

HasNarInChunks returns true if the NAR is already in chunks and chunking is complete.

func (*Cache) MigrateNarInfoToDatabase added in v0.8.0 

func (c *Cache) MigrateNarInfoToDatabase(
	ctx context.Context,
	hash string,
	ni *narinfo.NarInfo,
	deleteFromStorage bool,
) error

MigrateNarInfoToDatabase migrates a single narinfo from storage to the database. It uses distributed locking to coordinate with other instances (if Redis is configured). This is a convenience wrapper around MigrateNarInfo for use within the Cache.

func (*Cache) MigrateNarToChunks added in v0.9.0 

func (c *Cache) MigrateNarToChunks(ctx context.Context, narURL *nar.URL) error

MigrateNarToChunks migrates a traditional NAR blob to content-defined chunks. narURL is taken by pointer because storeNarWithCDC normalizes compression to "none".

func (*Cache) PublicKey 

func (c *Cache) PublicKey() signature.PublicKey

PublicKey returns the public key of the server.

func (*Cache) PutNar added in v0.0.3 

func (c *Cache) PutNar(ctx context.Context, narURL nar.URL, r io.ReadCloser) error

PutNar records the NAR (given as an io.Reader) into the store.

func (*Cache) PutNarInfo added in v0.0.3 

func (c *Cache) PutNarInfo(ctx context.Context, hash string, r io.ReadCloser) error

PutNarInfo records the narInfo (given as an io.Reader) into the store and signs it.

func (*Cache) RegisterUpstreamMetrics added in v0.6.0 

func (c *Cache) RegisterUpstreamMetrics(m metric.Meter) error

RegisterUpstreamMetrics register metrics related to upstream caches.

func (*Cache) SetCDCConfiguration added in v0.9.0 

func (c *Cache) SetCDCConfiguration(enabled bool, minSize, avgSize, maxSize uint32) error

SetCDCConfiguration enables and configures CDC.

func (*Cache) SetCacheSignNarinfo added in v0.2.0 

func (c *Cache) SetCacheSignNarinfo(shouldSignNarinfo bool)

SetCacheSignNarinfo configure ncps to sign or not sign narinfos.

func (*Cache) SetChunkStore added in v0.9.0 

func (c *Cache) SetChunkStore(cs chunk.Store)

SetChunkStore sets the chunk store.

func (*Cache) SetMaxSize added in v0.0.11 

func (c *Cache) SetMaxSize(maxSize uint64)

SetMaxSize sets the maxsize of the cache. This will be used by the LRU cronjob to automatically clean-up the store.

func (*Cache) SetRecordAgeIgnoreTouch added in v0.0.6 

func (c *Cache) SetRecordAgeIgnoreTouch(d time.Duration)

SetRecordAgeIgnoreTouch changes the duration at which a record is considered up to date and a touch is not invoked.

func (*Cache) SetTempDir added in v0.3.0 

func (c *Cache) SetTempDir(d string)

SetTempDir sets the temporary directory.

func (*Cache) SetupCron added in v0.0.11 

func (c *Cache) SetupCron(ctx context.Context, timezone *time.Location)

SetupCron creates a cron instance in the cache.

func (*Cache) StartCron added in v0.0.11 

func (c *Cache) StartCron(ctx context.Context)

StartCron starts the cron scheduler in its own go-routine, or no-op if already started.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.