Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Metadata

Contents

The read handle
The full-manifest result
One version's read
Errors
Single-version resolution

Description

The per-request metadata handle and typed outcomes shared by registry adapters. HTTP refusals retain their cause before projection. The serve pipeline owns fallback policy.

Synopsis

data MetadataClient = MetadataClient {
- fetchFullManifest :: PackageName -> IO (Either MetadataError Manifest)
- fetchVersionMetadata :: PackageName -> Version -> IO (Either MetadataError VersionRead)
}
data Manifest = Manifest {
- manifestInfo :: PackageInfo
- manifestRaw :: CachedDoc
- manifestBodyBytes :: Int
- manifestDigest :: ContentDigest
}
data ContentDigest
digestBytes :: ContentDigest -> ByteString
data VersionDoc = VersionDoc {
- vdDetails :: PackageDetails
- vdRaw :: Maybe CachedDoc
}
data VersionRead = VersionRead {
- vrVersion :: Maybe VersionDoc
- vrBodyBytes :: Int
- vrUpstreamLatest :: Maybe Version
}
data MetadataError
metadataResponse :: Either FetchFault (BodyOutcome a) -> Either MetadataError a
data VersionEvaluation
fetchVersionDetails :: MetadataClient -> PackageName -> Version -> IO VersionEvaluation
versionEvaluation :: Either MetadataError VersionRead -> VersionEvaluation
versionTransience :: VersionEvaluation -> Maybe Transience

The read handle

data MetadataClient Source #

Per-origin metadata operations with typed failures and caller-selected caching.

Constructors

MetadataClient
Fields fetchFullManifest :: PackageName -> IO (Either MetadataError Manifest) Return the full manifest or a typed failure, including explicit access refusal. fetchVersionMetadata :: PackageName -> Version -> IO (Either MetadataError VersionRead) One version's projection with the document's own `latest`. Errors retain the upstream failure.

The full-manifest result

data Manifest Source #

A package snapshot with ecosystem-owned serving data and the original source digest.

Constructors

Manifest
Fields manifestInfo :: PackageInfo The typed packument view the rules and merge reason over. manifestRaw :: CachedDoc The supported source fields (`CachedDoc`) used to assemble the served body. manifestBodyBytes :: Int Decompressed byte count from the source read, before projection. manifestDigest :: ContentDigest Digest of the wire bytes behind `manifestInfo` and `manifestRaw`.

data ContentDigest Source #

Fingerprint the exact upstream bytes used to build a manifest.

Instances

Instances details

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

digestBytes :: ContentDigest -> ByteString Source #

The digest's raw 32 bytes, for feeding into a wider fingerprint.

One version's read

data VersionDoc Source #

One version's typed projection paired with the object the source declared it with, built once from one body and never re-paired, so the mirror write republishes what the rules admitted.

Constructors

VersionDoc
Fields vdDetails :: PackageDetails The typed view the rules engine decides on. vdRaw :: Maybe CachedDoc Supported fields from the selected source version. `Nothing` when the adapter retains none.

Instances

Instances details

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

data VersionRead Source #

The requested version and the latest tag the same document declared. Both come from one bounded read, so a caller needing the tag adds no second fetch.

Constructors

VersionRead
Fields vrVersion :: Maybe VersionDoc The pair. `Nothing` means the package resolved without this version. vrBodyBytes :: Int Decompressed size of the whole source document, including unselected versions. vrUpstreamLatest :: Maybe Version `Nothing` when the document declares none, or the ecosystem has no such tag.

Instances

Instances details

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

Errors

data MetadataError Source #

Why a metadata fetch could not yield a usable result.

Constructors

MetadataAuthorisationFailure Int	The upstream explicitly refused access. Carries the original 401 or 403.
MetadataAbsent	The upstream answered 404. Its body cannot establish a package's identity.
MetadataHttpFailure Int	Another non-success HTTP status, retained for the consumer's retry policy.
MetadataFetch FetchFault	A failed exchange, with request-formation, bound, and transport causes kept distinct.
MetadataBoundExceeded LimitError	The decoded structure crossed a limit, distinct from an exchange body-size failure.
MetadataUndecodable	Malformed bytes or a missing package identity prevented manifest decoding.
MetadataNameMismatch Text	An invalid package identity, carried for diagnostics and excluded from the requested package.

Instances

Instances details

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

metadataResponse :: Either FetchFault (BodyOutcome a) -> Either MetadataError a Source #

Classify a metadata exchange. A 404 cannot establish identity, and a refusal keeps its status.

Single-version resolution

data VersionEvaluation Source #

A version lookup result shared by public admission and mirror workers.

Constructors

VersionPresent VersionDoc (Maybe Version)	The version resolved and projected. The second field is the same document's `latest`.
VersionMissing	The package exists but does not supply the requested version.
VersionMetadataUnavailable	Metadata was unavailable. Public admission and workers retain their retry policy.

Instances

Instances details

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

fetchVersionDetails :: MetadataClient -> PackageName -> Version -> IO VersionEvaluation Source #

Classify a version lookup for public admission and workers, treating metadata failures as transient.

versionEvaluation :: Either MetadataError VersionRead -> VersionEvaluation Source #

Classify a resolved selected read without changing its acquisition lifetime.

versionTransience :: VersionEvaluation -> Maybe Transience Source #

Classify unsuccessful lookups for retry. A resolved version has no transience.