Safe Haskell	None
Language	GHC2021

Ecluse.Core.Server.Cache

Contents

Configuration
The cache handle
Cache entries
Resolution
Single-version resolution
Assembled-representation resolution

Description

One provider owns metadata retention. Local single-flight shares active requests. Public metadata and content-addressed responses follow the sharing policy in the web-layer architecture.

Synopsis

data CacheConfig = CacheConfig {
- cacheTtl :: NominalDiffTime
- cacheMaxEntries :: Int
- cacheMaxBytes :: Int
- cacheVersionBudget :: StoreBudget
- cacheAssembledBudget :: StoreBudget
}
data StoreBudget = StoreBudget {
- sbMinEntries :: Int
- sbMinBytes :: Int
}
data MetadataCache
newMetadataCache :: CacheConfig -> IO MetadataCache
newMetadataCacheWithProvider :: CacheProvider -> IO MetadataCache
newtype Source = Source Text
data CacheEntry = CacheEntry {
- entryInfo :: PackageInfo
- entryRaw :: CachedDoc
- entryBodyBytes :: Int
- entryDigest :: ContentDigest
}
resolveMetadata :: MetricsPort -> MetadataCache -> Source -> PackageName -> IO (Either MetadataError CacheEntry) -> IO (Either MetadataError CacheEntry)
metadataKey :: Source -> PackageName -> Text
resolveVersion :: MetricsPort -> MetadataCache -> Source -> PackageName -> Version -> IO (Either MetadataError VersionRead) -> IO (Either MetadataError VersionRead)
prepareVersion :: MetricsPort -> MetadataCache -> Source -> PackageName -> Version -> IO (Either MetadataError VersionRead) -> IO (PreparedStore MetadataError VersionRead)
resolveAssembled :: MetricsPort -> MetadataCache -> Text -> IO ByteString -> IO ByteString

Configuration

data CacheConfig Source #

Retention bounds and the TTL for the local selected-version and assembled stores.

Constructors

CacheConfig
Fields cacheTtl :: NominalDiffTime cacheMaxEntries :: Int One entry bound shared by all eligible local stores. cacheMaxBytes :: Int One accounted-byte bound shared by all eligible local stores. cacheVersionBudget :: StoreBudget The selected-version eviction floor. It reserves no capacity. cacheAssembledBudget :: StoreBudget The assembled-response eviction floor. It reserves no capacity.

Instances

Instances details

Show CacheConfig Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods showsPrec :: Int -> CacheConfig -> ShowS # show :: CacheConfig -> String # showList :: [CacheConfig] -> ShowS #
Eq CacheConfig Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods (==) :: CacheConfig -> CacheConfig -> Bool # (/=) :: CacheConfig -> CacheConfig -> Bool #

data StoreBudget Source #

Retention floors, used only to stop a store evicting its own live entries.

Constructors

StoreBudget
Fields sbMinEntries :: Int Eviction stops before the retained entry count falls below this floor. sbMinBytes :: Int Eviction stops before accounted bytes fall below this floor.

Instances

Instances details

Show StoreBudget Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods showsPrec :: Int -> StoreBudget -> ShowS # show :: StoreBudget -> String # showList :: [StoreBudget] -> ShowS #
Eq StoreBudget Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods (==) :: StoreBudget -> StoreBudget -> Bool # (/=) :: StoreBudget -> StoreBudget -> Bool #

The cache handle

data MetadataCache Source #

One provider supplies every retention capability beside process-local request coalescing.

newMetadataCache :: CacheConfig -> IO MetadataCache Source #

Select the shipped local provider without an external service dependency.

newMetadataCacheWithProvider :: CacheProvider -> IO MetadataCache Source #

Create only transient flight state. The selected provider owns every retained representation.

Cache entries

newtype Source Source #

An upstream base URL partitions entries without carrying credentials.

Constructors

Source Text

Instances

Instances details

Show Source Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods showsPrec :: Int -> Source -> ShowS # show :: Source -> String # showList :: [Source] -> ShowS #
Eq Source Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods (==) :: Source -> Source -> Bool # (/=) :: Source -> Source -> Bool #
Ord Source Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods compare :: Source -> Source -> Ordering # (<) :: Source -> Source -> Bool # (<=) :: Source -> Source -> Bool # (>) :: Source -> Source -> Bool # (>=) :: Source -> Source -> Bool # max :: Source -> Source -> Source # min :: Source -> Source -> Source #

data CacheEntry Source #

A typed view paired with its source representation and complete fetch digest.

Constructors

CacheEntry
Fields entryInfo :: PackageInfo The typed packument view the rules and merge reason over. entryRaw :: CachedDoc The source representation from which the adapter builds the served body. entryBodyBytes :: Int Decompressed source bytes, retained independently of the cache weight. entryDigest :: ContentDigest

Instances

Instances details

Show CacheEntry Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods showsPrec :: Int -> CacheEntry -> ShowS # show :: CacheEntry -> String # showList :: [CacheEntry] -> ShowS #
Eq CacheEntry Source #
Instance details Defined in Ecluse.Core.Server.Cache.Types Methods (==) :: CacheEntry -> CacheEntry -> Bool # (/=) :: CacheEntry -> CacheEntry -> Bool #

Resolution

resolveMetadata :: MetricsPort -> MetadataCache -> Source -> PackageName -> IO (Either MetadataError CacheEntry) -> IO (Either MetadataError CacheEntry) Source #

Coalesce public metadata fetches. Failures reach all waiters and retain nothing.

metadataKey :: Source -> PackageName -> Text Source #

The key a full read of one package from one source is shared and retained under.

Single-version resolution

resolveVersion :: MetricsPort -> MetadataCache -> Source -> PackageName -> Version -> IO (Either MetadataError VersionRead) -> IO (Either MetadataError VersionRead) Source #

Cache a selectively decoded release or its absence. Oversized releases remain uncached.

prepareVersion :: MetricsPort -> MetadataCache -> Source -> PackageName -> Version -> IO (Either MetadataError VersionRead) -> IO (PreparedStore MetadataError VersionRead) Source #

Pin a selected local value, including absence, before any remote work.

Assembled-representation resolution

resolveAssembled :: MetricsPort -> MetadataCache -> Text -> IO ByteString -> IO ByteString Source #

Memoise a response under the content digest of this request's authorised inputs.