Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Adapter.Capability

Contents

Metadata
Artifact requests
Publish
Names
Store maintenance

Description

Registry capabilities used by the ecosystem-neutral pipeline. Adapters own wire formats and share exact source-entry selection for served metadata.

Synopsis

data AdapterMetadata = AdapterMetadata {
- metadataNewReads :: forall posture. TracingPort -> MetricsPort -> (PackageName -> MetadataError -> IO ()) -> (PackageName -> [InvalidEntry] -> IO ()) -> (PackageName -> IO ()) -> OriginFor posture -> MetadataReads posture
- metadataAssemble :: Text -> Map SourceId (Snapshot CachedDoc) -> MergePlan -> Maybe CachedDoc -> CachedDoc
- metadataSerialise :: CachedDoc -> Either RenderRefused LByteString
- metadataFetchManifest :: ManifestFetch
- metadataChargeFactors :: ChargeFactors
}
type ManifestFetch = TracingPort -> OriginClient -> PackageName -> IO (Either MetadataError Manifest)
data AdapterArtifact = AdapterArtifact {
- artifactByFile :: OriginClient -> PackageName -> Text -> Either UrlFormationError Request
- artifactByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request
- artifactHosts :: [Text]
}
data AdapterPublish = AdapterPublish {
- publishRelay :: OriginClient -> PackageName -> ByteString -> IO (Either FetchFault PublishRelayResponse)
- publishDeclaredNames :: LByteString -> [Text]
- publishCodec :: PublishCodec
}
type ProjectName = Text -> Maybe PackageName
data AdapterMaintenance = AdapterMaintenance {
}
data StoreListing = StoreListing {
- listingRequest :: OriginClient -> Either UrlFormationError Request
- listingParser :: Parser [PackageName]
}
data VersionDelete = VersionDelete {
- deleteDocumentRequest :: OriginClient -> PackageName -> Either UrlFormationError Request
- deleteRequests :: OriginClient -> PackageName -> Version -> RegistryResponse -> Either StoreRefusal (NonEmpty Request)
}

Metadata

data AdapterMetadata Source #

The ecosystem's metadata capability: reading a package's metadata from an origin, assembling the served document, and encoding it (pdMetadata).

Constructors

AdapterMetadata

Fields

metadataNewReads :: forall posture. TracingPort -> MetricsPort -> (PackageName -> MetadataError -> IO ()) -> (PackageName -> [InvalidEntry] -> IO ()) -> (PackageName -> IO ()) -> OriginFor posture -> MetadataReads posture
Bind one origin's metadata reads to their observers, carrying its posture.
metadataAssemble :: Text -> Map SourceId (Snapshot CachedDoc) -> MergePlan -> Maybe CachedDoc -> CachedDoc
Select exact admitted entries from the supplied snapshots before rendering their wire shape.
metadataSerialise :: CachedDoc -> Either RenderRefused LByteString
Encode an assembled served document (CachedDoc) to its wire bytes, or refuse a damaged render.
metadataFetchManifest :: ManifestFetch
The raw read under metadataNewReads, without its caching and metrics, for a store sweep.
metadataChargeFactors :: ChargeFactors
What this ecosystem's full reads and listings charge the memory budget per source byte.

type ManifestFetch = TracingPort -> OriginClient -> PackageName -> IO (Either MetadataError Manifest) Source #

Fetching and projecting one package's full manifest from an origin. Every failure is a MetadataError value, as it is through the client built over it.

Artifact requests

data AdapterArtifact Source #

The ecosystem's artifact request formation, by conventional filename or authoritative URL. The serve deps and the worker bundle share it (pdArtifact).

Constructors

AdapterArtifact

Fields

artifactByFile :: OriginClient -> PackageName -> Text -> Either UrlFormationError Request
Address a trusted origin by the conventional filename path under its base URL.
artifactByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request
Build the request at the authoritative upstream URL, which names no origin because the mirror worker's fetch has none to give.
artifactHosts :: [Text]
The hosts the same-host tarball gate admits without the operator naming them. Empty for npm, whose artifacts ride the registry host.

Publish

data AdapterPublish Source #

The ecosystem's publish capability. The composition root marries its codec to the shared publish transport per mounted ecosystem (newMirrorPublish).

Constructors

AdapterPublish

Fields

publishRelay :: OriginClient -> PackageName -> ByteString -> IO (Either FetchFault PublishRelayResponse)
Relay a client's publish document to the target named as the origin, and return its answer.
publishDeclaredNames :: LByteString -> [Text]
Every name a publish body claims, [] when none is readable. The anti-shadowing guard refuses one that disagrees with the URL-path name.
publishCodec :: PublishCodec
Document assembly, request formation, the probe, and the status semantics. The manager, credential mint, and fault classification are the transport's.

Names

type ProjectName = Text -> Maybe PackageName Source #

Canonicalise a raw package-name string under one ecosystem's own grammar, Nothing for a string that grammar refuses. It is the one parser every caller reaches a PackageName through.

Store maintenance

data AdapterMaintenance Source #

The ecosystem's store maintenance verbs, which Ecluse.Core.Registry.Maintenance.Protocol drives. Each is Nothing for a protocol that spells no such verb, and the Dredger then refuses.

Constructors

AdapterMaintenance
Fields maintenanceListing :: Maybe StoreListing How the protocol enumerates a store's packages, where it can. maintenanceVersionDelete :: Maybe VersionDelete How the protocol deletes one version, where it can. maintenanceAlphabet :: NameAlphabet The characters a name may begin with, which partition the store's name space into the buckets a full walk covers one at a time.

data StoreListing Source #

Reading every package a store holds. The protocol's own listing endpoint, which a public registry may well refuse: a listing that does not answer 200 is the caller's fault to report.

Constructors

StoreListing
Fields listingRequest :: OriginClient -> Either UrlFormationError Request Form the listing read against the store. listingParser :: Parser [PackageName] Stream names while skipping unrelated per-package metadata.

data VersionDelete Source #

Deleting one version, as the request sequence the protocol spells it with. It names its own document read, because an install-optimised metadata read may omit the revision the edit needs.

Constructors

VersionDelete

Fields

deleteDocumentRequest :: OriginClient -> PackageName -> Either UrlFormationError Request
Form the read of the document the delete requests are built from.
deleteRequests :: OriginClient -> PackageName -> Version -> RegistryResponse -> Either StoreRefusal (NonEmpty Request)
Form the ordered requests that remove one version, or say why the document admits none. Every one must be sent, in this order, for the version to be gone.