module Ecluse.Core.Registry.Adapter.Capability (
AdapterMetadata (..),
AdapterArtifact (..),
PrivateArtifactAddressing (..),
AdapterPublish (..),
PublishRequestBody (..),
PublishExtras (..),
MirrorRequirements (..),
WorkerMetadataRead (..),
MirrorStateRequirement (..),
durableMirrorDocuments,
companionsAgree,
UploadEndpointRequirement (..),
UploadIdentityRequirement (..),
ProjectName,
AdapterMaintenance (..),
StoreListing (..),
VersionDelete (..),
) where
import Data.JsonStream.Lexer (Cursor)
import Network.HTTP.Client (Request)
import Network.HTTP.Types.Header (RequestHeaders)
import Ecluse.Core.Credential (ClientCredential, Secret)
import Ecluse.Core.Mirror.Documents (MirrorDocuments)
import Ecluse.Core.Mirror.State.Format (MirrorStateFormat (msfCompanions))
import Ecluse.Core.Package (PackageName)
import Ecluse.Core.Package.Merge (MergePlan, SourceId)
import Ecluse.Core.Registry (
CompanionRequirement (NativeCompanions),
FetchFault,
PublishBodyFault,
PublishRelayResponse,
RegistryResponse,
UrlFormationError,
)
import Ecluse.Core.Registry.CachedDocument (CachedDoc)
import Ecluse.Core.Registry.Json.Walk (Step)
import Ecluse.Core.Registry.Maintenance (StoreRefusal)
import Ecluse.Core.Registry.Maintenance.NameSpace (NameAlphabet)
import Ecluse.Core.Registry.Metadata.Fetch.Preparation (PrepareRead)
import Ecluse.Core.Registry.Origin (OriginClient)
import Ecluse.Core.Registry.Publish (PublishCodec (pcMirrorCompanion))
import Ecluse.Core.Registry.Request (CredentialMapping, ServicePresentation, nativePresentation)
import Ecluse.Core.Registry.ServedDocument (RenderRefused)
import Ecluse.Core.Security (Limits)
import Ecluse.Core.Server.Admission.Types (ChargeFactors)
import Ecluse.Core.Snapshot (Snapshot)
import Ecluse.Core.Version (Version)
type ProjectName = Text -> Maybe PackageName
data AdapterMetadata = AdapterMetadata
{ AdapterMetadata -> PrepareRead
metadataRead :: PrepareRead
, AdapterMetadata
-> Text
-> Map SourceId (Snapshot CachedDoc)
-> MergePlan
-> Maybe CachedDoc
-> CachedDoc
metadataAssemble :: Text -> Map SourceId (Snapshot CachedDoc) -> MergePlan -> Maybe CachedDoc -> CachedDoc
, AdapterMetadata -> CachedDoc -> Either RenderRefused LByteString
metadataSerialise :: CachedDoc -> Either RenderRefused LByteString
, AdapterMetadata -> ChargeFactors
metadataChargeFactors :: ChargeFactors
}
data PrivateArtifactAddressing
= ConventionalArtifactPath
| IndexedArtifactLocation
|
AdmittedIndexedArtifactLocation
deriving stock (PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool
(PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool)
-> (PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool)
-> Eq PrivateArtifactAddressing
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool
== :: PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool
$c/= :: PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool
/= :: PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool
Eq, SourceId -> PrivateArtifactAddressing -> ShowS
[PrivateArtifactAddressing] -> ShowS
PrivateArtifactAddressing -> String
(SourceId -> PrivateArtifactAddressing -> ShowS)
-> (PrivateArtifactAddressing -> String)
-> ([PrivateArtifactAddressing] -> ShowS)
-> Show PrivateArtifactAddressing
forall a.
(SourceId -> a -> ShowS)
-> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: SourceId -> PrivateArtifactAddressing -> ShowS
showsPrec :: SourceId -> PrivateArtifactAddressing -> ShowS
$cshow :: PrivateArtifactAddressing -> String
show :: PrivateArtifactAddressing -> String
$cshowList :: [PrivateArtifactAddressing] -> ShowS
showList :: [PrivateArtifactAddressing] -> ShowS
Show)
data AdapterArtifact = AdapterArtifact
{ AdapterArtifact
-> OriginClient
-> PackageName
-> Text
-> Either UrlFormationError Request
artifactByFile :: OriginClient -> PackageName -> Text -> Either UrlFormationError Request
, AdapterArtifact
-> Maybe ClientCredential
-> Text
-> Either UrlFormationError Request
artifactByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request
, AdapterArtifact -> [Text]
artifactHosts :: [Text]
, AdapterArtifact -> PrivateArtifactAddressing
artifactPrivateAddressing :: PrivateArtifactAddressing
}
data PublishRequestBody = PublishRequestBody
{ PublishRequestBody -> ByteString
publishBodyBytes :: ByteString
, PublishRequestBody -> Maybe ByteString
publishBodyContentType :: Maybe ByteString
, PublishRequestBody -> PublishExtras
publishBodyExtras :: PublishExtras
}
data
=
|
PublishOneTimePassword Secret
deriving stock (PublishExtras -> PublishExtras -> Bool
(PublishExtras -> PublishExtras -> Bool)
-> (PublishExtras -> PublishExtras -> Bool) -> Eq PublishExtras
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PublishExtras -> PublishExtras -> Bool
== :: PublishExtras -> PublishExtras -> Bool
$c/= :: PublishExtras -> PublishExtras -> Bool
/= :: PublishExtras -> PublishExtras -> Bool
Eq, SourceId -> PublishExtras -> ShowS
[PublishExtras] -> ShowS
PublishExtras -> String
(SourceId -> PublishExtras -> ShowS)
-> (PublishExtras -> String)
-> ([PublishExtras] -> ShowS)
-> Show PublishExtras
forall a.
(SourceId -> a -> ShowS)
-> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: SourceId -> PublishExtras -> ShowS
showsPrec :: SourceId -> PublishExtras -> ShowS
$cshow :: PublishExtras -> String
show :: PublishExtras -> String
$cshowList :: [PublishExtras] -> ShowS
showList :: [PublishExtras] -> ShowS
Show)
data WorkerMetadataRead
= CachedWorkerRead
| ChargedWorkerRead PrepareRead
| NativeChargedWorkerRead PrepareRead
data MirrorStateRequirement
= NativeVersionState
|
DurableVersionState MirrorDocuments
durableMirrorDocuments :: MirrorStateRequirement -> Maybe MirrorDocuments
durableMirrorDocuments :: MirrorStateRequirement -> Maybe MirrorDocuments
durableMirrorDocuments = \case
MirrorStateRequirement
NativeVersionState -> Maybe MirrorDocuments
forall a. Maybe a
Nothing
DurableVersionState MirrorDocuments
documents -> MirrorDocuments -> Maybe MirrorDocuments
forall a. a -> Maybe a
Just MirrorDocuments
documents
data UploadEndpointRequirement
= ReadRootUpload
| ExplicitUploadEndpoint
deriving stock (UploadEndpointRequirement -> UploadEndpointRequirement -> Bool
(UploadEndpointRequirement -> UploadEndpointRequirement -> Bool)
-> (UploadEndpointRequirement -> UploadEndpointRequirement -> Bool)
-> Eq UploadEndpointRequirement
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: UploadEndpointRequirement -> UploadEndpointRequirement -> Bool
== :: UploadEndpointRequirement -> UploadEndpointRequirement -> Bool
$c/= :: UploadEndpointRequirement -> UploadEndpointRequirement -> Bool
/= :: UploadEndpointRequirement -> UploadEndpointRequirement -> Bool
Eq, SourceId -> UploadEndpointRequirement -> ShowS
[UploadEndpointRequirement] -> ShowS
UploadEndpointRequirement -> String
(SourceId -> UploadEndpointRequirement -> ShowS)
-> (UploadEndpointRequirement -> String)
-> ([UploadEndpointRequirement] -> ShowS)
-> Show UploadEndpointRequirement
forall a.
(SourceId -> a -> ShowS)
-> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: SourceId -> UploadEndpointRequirement -> ShowS
showsPrec :: SourceId -> UploadEndpointRequirement -> ShowS
$cshow :: UploadEndpointRequirement -> String
show :: UploadEndpointRequirement -> String
$cshowList :: [UploadEndpointRequirement] -> ShowS
showList :: [UploadEndpointRequirement] -> ShowS
Show)
data UploadIdentityRequirement
= TokenIdentity
| NamedIdentity
deriving stock (UploadIdentityRequirement -> UploadIdentityRequirement -> Bool
(UploadIdentityRequirement -> UploadIdentityRequirement -> Bool)
-> (UploadIdentityRequirement -> UploadIdentityRequirement -> Bool)
-> Eq UploadIdentityRequirement
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: UploadIdentityRequirement -> UploadIdentityRequirement -> Bool
== :: UploadIdentityRequirement -> UploadIdentityRequirement -> Bool
$c/= :: UploadIdentityRequirement -> UploadIdentityRequirement -> Bool
/= :: UploadIdentityRequirement -> UploadIdentityRequirement -> Bool
Eq, SourceId -> UploadIdentityRequirement -> ShowS
[UploadIdentityRequirement] -> ShowS
UploadIdentityRequirement -> String
(SourceId -> UploadIdentityRequirement -> ShowS)
-> (UploadIdentityRequirement -> String)
-> ([UploadIdentityRequirement] -> ShowS)
-> Show UploadIdentityRequirement
forall a.
(SourceId -> a -> ShowS)
-> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: SourceId -> UploadIdentityRequirement -> ShowS
showsPrec :: SourceId -> UploadIdentityRequirement -> ShowS
$cshow :: UploadIdentityRequirement -> String
show :: UploadIdentityRequirement -> String
$cshowList :: [UploadIdentityRequirement] -> ShowS
showList :: [UploadIdentityRequirement] -> ShowS
Show)
data MirrorRequirements = MirrorRequirements
{ MirrorRequirements -> WorkerMetadataRead
mirrorWorkerRead :: WorkerMetadataRead
, MirrorRequirements -> MirrorStateFormat
mirrorStateFormat :: MirrorStateFormat
, MirrorRequirements -> MirrorStateRequirement
mirrorStateRequirement :: MirrorStateRequirement
}
data AdapterPublish = AdapterPublish
{ AdapterPublish -> CredentialMapping
publishCredential :: CredentialMapping
, :: RequestHeaders -> Either PublishBodyFault PublishExtras
, AdapterPublish
-> ServicePresentation
-> OriginClient
-> PackageName
-> PublishRequestBody
-> IO (Either FetchFault PublishRelayResponse)
publishRelay :: ServicePresentation -> OriginClient -> PackageName -> PublishRequestBody -> IO (Either FetchFault PublishRelayResponse)
, AdapterPublish
-> Limits
-> (SourceId -> IO ())
-> Text
-> PublishRequestBody
-> IO (Either PublishBodyFault [Text])
publishUploadClaims :: Limits -> (Int -> IO ()) -> Text -> PublishRequestBody -> IO (Either PublishBodyFault [Text])
, AdapterPublish -> ServicePresentation -> PublishCodec
publishCodec :: ServicePresentation -> PublishCodec
, AdapterPublish -> MirrorRequirements
publishMirrorRequirements :: MirrorRequirements
, AdapterPublish -> UploadEndpointRequirement
publishUploadEndpoint :: UploadEndpointRequirement
, AdapterPublish -> UploadIdentityRequirement
publishIdentity :: UploadIdentityRequirement
}
companionsAgree :: AdapterPublish -> Bool
companionsAgree :: AdapterPublish -> Bool
companionsAgree AdapterPublish
publish = Maybe MirrorCompanion -> Bool
forall a. Maybe a -> Bool
isJust (PublishCodec -> Maybe MirrorCompanion
pcMirrorCompanion (AdapterPublish -> ServicePresentation -> PublishCodec
publishCodec AdapterPublish
publish ServicePresentation
nativePresentation)) Bool -> Bool -> Bool
forall a. Eq a => a -> a -> Bool
== (CompanionRequirement
required CompanionRequirement -> CompanionRequirement -> Bool
forall a. Eq a => a -> a -> Bool
== CompanionRequirement
NativeCompanions)
where
required :: CompanionRequirement
required = MirrorStateFormat -> CompanionRequirement
msfCompanions (MirrorRequirements -> MirrorStateFormat
mirrorStateFormat (AdapterPublish -> MirrorRequirements
publishMirrorRequirements AdapterPublish
publish))
data AdapterMaintenance = AdapterMaintenance
{ AdapterMaintenance -> Maybe StoreListing
maintenanceListing :: Maybe StoreListing
, AdapterMaintenance -> Maybe VersionDelete
maintenanceVersionDelete :: Maybe VersionDelete
, AdapterMaintenance -> NameAlphabet
maintenanceAlphabet :: NameAlphabet
}
data StoreListing = StoreListing
{ StoreListing -> OriginClient -> Either UrlFormationError Request
listingRequest :: OriginClient -> Either UrlFormationError Request
, StoreListing -> Cursor -> Step [PackageName]
listingWalk :: Cursor -> Step [PackageName]
}
data VersionDelete = VersionDelete
{ VersionDelete
-> OriginClient -> PackageName -> Either UrlFormationError Request
deleteDocumentRequest :: OriginClient -> PackageName -> Either UrlFormationError Request
, VersionDelete
-> OriginClient
-> PackageName
-> Version
-> RegistryResponse
-> Either StoreRefusal (NonEmpty Request)
deleteRequests ::
OriginClient ->
PackageName ->
Version ->
RegistryResponse ->
Either StoreRefusal (NonEmpty Request)
}