Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Publish

Contents

What one write declares
The adapter's protocol codec
The shared transport
The married capability

Description

The mirror-write capability: a shared transport, an adapter-provided protocol codec, and the married MirrorPublish handle a worker bundle carries. A new ecosystem contributes a codec and never a transport.

The transport mints the bearer per call and re-seals every request, so no codec can ship a write that follows a redirect.

Synopsis

data PublishPlan = PublishPlan {
- ppVersion :: Version
- ppLatest :: Version
- ppMetadata :: CachedDoc
}
data PublishCodec = PublishCodec {
- pcProbeRequest :: Text -> Maybe Secret -> PackageName -> Either UrlFormationError Request
- pcVersionListParser :: Limits -> Parser VersionListItem
- pcPublishRequest :: Text -> Maybe Secret -> PackageName -> PublishPlan -> MirrorArtifact -> ByteString -> Either PublishFault Request
- pcPublishOutcome :: Int -> Either PublishFault ()
}
fetchVersionList :: Manager -> Limits -> Parser VersionListItem -> Request -> IO (Either FetchFault (BodyOutcome (Either ParseError [Version])))
data MirrorTransport = MirrorTransport {
- ptManager :: Manager
- ptMintToken :: IO (Maybe Secret)
- ptLimits :: Limits
}
data MirrorPublish = MirrorPublish {
- mpProbeMetadata :: PackageName -> IO (Either FetchFault (BodyOutcome (Either ParseError [Version])))
- mpPublishArtifact :: PackageName -> PublishPlan -> MirrorArtifact -> ByteString -> IO (Either PublishFault ())
}
newMirrorPublish :: MirrorTransport -> RegistryUrl -> PublishCodec -> MirrorPublish

What one write declares

data PublishPlan Source #

What one mirror write declares: the version, the release tag the store must carry once it lands, and the version's own metadata. The caller decides the tag, so no codec derives one.

Constructors

PublishPlan
Fields ppVersion :: Version The version these bytes publish. ppLatest :: Version Always a version the store holds after this write, the published one when it is alone. ppMetadata :: CachedDoc Supported source fields paired with the release admitted for mirroring.

Instances

Instances details

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

The adapter's protocol codec

data PublishCodec Source #

One ecosystem's mirror-write protocol, all pure. The endpoint and bearer arrive as arguments, so a codec holds no URL, credential, or connection state.

Constructors

PublishCodec

Fields

pcProbeRequest :: Text -> Maybe Secret -> PackageName -> Either UrlFormationError Request
Form the metadata read the presence probe makes against the mirror target.
pcVersionListParser :: Limits -> Parser VersionListItem
Select usable version identifiers without retaining source release objects.
pcPublishRequest :: Text -> Maybe Secret -> PackageName -> PublishPlan -> MirrorArtifact -> ByteString -> Either PublishFault Request
Form the complete publish request for one verified artifact. A plan whose version object the codec cannot read refuses as a value.
pcPublishOutcome :: Int -> Either PublishFault ()
Classify the status answer. Registries disagree on how an immutable re-publish answers, so the codec counts an idempotent already-present as success.

fetchVersionList :: Manager -> Limits -> Parser VersionListItem -> Request -> IO (Either FetchFault (BodyOutcome (Either ParseError [Version]))) Source #

Read a codec's identifiers inside the response lifetime, preserving transport and HTTP outcomes.

The shared transport

data MirrorTransport Source #

The ecosystem-agnostic half of the mirror write. The composition root builds one per marriage from process-wide parts.

Constructors

MirrorTransport
Fields ptManager :: Manager The trusted-path connection manager the worker dials the mirror target through. ptMintToken :: IO (Maybe Secret) Nothing caches it here: refresh, expiry, and breaker policy live behind the action. ptLimits :: Limits The response bound every exchange with the mirror target is held to (fail-closed).

The married capability

data MirrorPublish Source #

What one worker bundle carries, bound to one mirror-target endpoint under one credential mint. The worker never sees the codec, the transport, or the adapter.

Constructors

MirrorPublish

Fields

mpProbeMetadata :: PackageName -> IO (Either FetchFault (BodyOutcome (Either ParseError [Version])))
Every failure is a FetchFault value, so the probe's fall-through match is total.
mpPublishArtifact :: PackageName -> PublishPlan -> MirrorArtifact -> ByteString -> IO (Either PublishFault ())
Every failure is a PublishFault value, so the worker's retry-vs-drop decision is total at the call site.

newMirrorPublish :: MirrorTransport -> RegistryUrl -> PublishCodec -> MirrorPublish Source #

Marry a protocol codec to the shared transport against one mirror-target endpoint.