{-# LANGUAGE TupleSections #-}
module Ecluse.Core.Registry.PyPI.Adapter (
pypiAdapter,
pypiPublish,
) where
import Data.Map.Strict qualified as Map
import Network.HTTP.Client (Request (method, requestBody, requestHeaders), RequestBody (RequestBodyBS))
import Network.HTTP.Types (hContentType)
import Ecluse.Core.Registry.Metadata.Fetch.Preparation (staticRead)
import Ecluse.Core.Registry.Request (StoreOperation (StoreWrite), attachCredential, parseRequestEither, presentedMapping)
import Ecluse.Core.Ecosystem (Ecosystem (PyPI))
import Ecluse.Core.Registry.Adapter.Capability (
AdapterArtifact (..),
AdapterMaintenance (..),
AdapterMetadata (..),
AdapterPublish (..),
MirrorRequirements (..),
MirrorStateRequirement (..),
PrivateArtifactAddressing (..),
PublishExtras (NoPublishExtras),
PublishRequestBody (..),
UploadEndpointRequirement (..),
UploadIdentityRequirement (..),
WorkerMetadataRead (..),
)
import Ecluse.Core.Registry.Adapter.Types (AdapterServe (..), RegistryAdapter (..))
import Ecluse.Core.Registry.FirstParty (FirstPartyDeclaration (FirstPartyDeclaration))
import Ecluse.Core.Registry.Maintenance.NameSpace (mkNameAlphabet)
import Ecluse.Core.Registry.Origin (OriginClient (ocToken), originBaseUrl)
import Ecluse.Core.Registry.Publish (relayPublishRequest)
import Ecluse.Core.Registry.PyPI.Credential (pypiCredential)
import Ecluse.Core.Registry.PyPI.Filter (assembleSimpleDocument, serialiseSimpleDocument)
import Ecluse.Core.Registry.PyPI.FirstParty (pypiFirstPartyNames)
import Ecluse.Core.Registry.PyPI.Metadata (preparePyPIRead, pypiChargeFactors, pypiMirrorRead)
import Ecluse.Core.Registry.PyPI.Mirror (pypiMirrorDocuments, pypiStateFormat)
import Ecluse.Core.Registry.PyPI.Project (projectName, pypiNameLeadChars)
import Ecluse.Core.Registry.PyPI.Publish (pypiPublishCodec)
import Ecluse.Core.Registry.PyPI.Publish.Multipart qualified as Multipart
import Ecluse.Core.Registry.PyPI.Request qualified as PyPIRequest
import Ecluse.Core.Registry.PyPI.Route qualified as PyPIRoute
import Ecluse.Core.Rules.Types (RuleType (AllowScopeType, DenyExternalDependenciesType, DenyIfDeprecatedType, DenyInstallTimeExecutionType))
pypiAdapter :: RegistryAdapter
pypiAdapter :: RegistryAdapter
pypiAdapter =
RegistryAdapter
{ adapterEcosystem :: Ecosystem
adapterEcosystem = Ecosystem
PyPI
, adapterRuleBlocks :: Map RuleType Text
adapterRuleBlocks =
[(RuleType, Text)] -> Map RuleType Text
forall k a. Ord k => [(k, a)] -> Map k a
Map.fromList
[ (RuleType
DenyInstallTimeExecutionType, Text
"Most PyPI releases offer a source distribution, which runs its own build on install, so this rule would deny nearly every release.")
, (RuleType
DenyExternalDependenciesType, Text
"The PyPI adapter does not read where a release's dependencies install from.")
, (RuleType
DenyIfDeprecatedType, Text
"The PyPI adapter supplies no deprecation flag.")
, (RuleType
AllowScopeType, Text
"A PyPI project name has no scope, so this rule can never match one.")
]
, adapterServe :: AdapterServe
adapterServe =
AdapterServe
{ serveRouter :: MountRouter
serveRouter = MountRouter
PyPIRoute.pypiRouter
, serveRoutes :: NonEmpty RouteSpec
serveRoutes = NonEmpty RouteSpec
PyPIRoute.pypiRouteSpecs
, serveCredential :: CredentialMapping
serveCredential = CredentialMapping
pypiCredential
}
, adapterMetadata :: AdapterMetadata
adapterMetadata =
AdapterMetadata
{ metadataRead :: PrepareRead
metadataRead = PrepareRead
preparePyPIRead
, metadataAssemble :: Text
-> Map SourceId (Snapshot CachedDoc)
-> MergePlan
-> Maybe CachedDoc
-> CachedDoc
metadataAssemble = Text
-> Map SourceId (Snapshot CachedDoc)
-> MergePlan
-> Maybe CachedDoc
-> CachedDoc
assembleSimpleDocument
, metadataSerialise :: CachedDoc -> Either RenderRefused LByteString
metadataSerialise = CachedDoc -> Either RenderRefused LByteString
serialiseSimpleDocument
, metadataChargeFactors :: ChargeFactors
metadataChargeFactors = ChargeFactors
pypiChargeFactors
}
, adapterArtifact :: AdapterArtifact
adapterArtifact =
AdapterArtifact
{ artifactByFile :: OriginClient
-> PackageName -> Text -> Either UrlFormationError Request
artifactByFile = \OriginClient
origin -> Text
-> Maybe ClientCredential
-> PackageName
-> Text
-> Either UrlFormationError Request
PyPIRequest.artifactRequestByFile (OriginClient -> Text
originBaseUrl OriginClient
origin) (OriginClient -> Maybe ClientCredential
ocToken OriginClient
origin)
, artifactByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request
artifactByUrl = Maybe ClientCredential -> Text -> Either UrlFormationError Request
PyPIRequest.artifactRequestByUrl
, artifactHosts :: [Text]
artifactHosts = [Text]
PyPIRequest.pypiArtifactHosts
, artifactPrivateAddressing :: PrivateArtifactAddressing
artifactPrivateAddressing = PrivateArtifactAddressing
IndexedArtifactLocation
}
, adapterProjectName :: ProjectName
adapterProjectName = Either ParseError PackageName -> Maybe PackageName
forall l r. Either l r -> Maybe r
rightToMaybe (Either ParseError PackageName -> Maybe PackageName)
-> (Text -> Either ParseError PackageName) -> ProjectName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> Either ParseError PackageName
projectName
, adapterFirstParty :: FirstPartyDeclaration
adapterFirstParty = FirstPartyNames PyPIFirstParty -> FirstPartyDeclaration
forall entry.
(Eq entry, Show entry, Typeable entry) =>
FirstPartyNames entry -> FirstPartyDeclaration
FirstPartyDeclaration FirstPartyNames PyPIFirstParty
pypiFirstPartyNames
, adapterPublish :: Maybe AdapterPublish
adapterPublish = AdapterPublish -> Maybe AdapterPublish
forall a. a -> Maybe a
Just AdapterPublish
pypiPublish
, adapterMaintenance :: AdapterMaintenance
adapterMaintenance =
AdapterMaintenance
{ maintenanceListing :: Maybe StoreListing
maintenanceListing = Maybe StoreListing
forall a. Maybe a
Nothing
, maintenanceVersionDelete :: Maybe VersionDelete
maintenanceVersionDelete = Maybe VersionDelete
forall a. Maybe a
Nothing
, maintenanceAlphabet :: NameAlphabet
maintenanceAlphabet = String -> NameAlphabet
mkNameAlphabet String
pypiNameLeadChars
}
}
pypiPublish :: AdapterPublish
pypiPublish :: AdapterPublish
pypiPublish =
AdapterPublish
{ publishCredential :: CredentialMapping
publishCredential = CredentialMapping
pypiCredential
, publishRequestExtras :: RequestHeaders -> Either PublishBodyFault PublishExtras
publishRequestExtras = Either PublishBodyFault PublishExtras
-> RequestHeaders -> Either PublishBodyFault PublishExtras
forall a b. a -> b -> a
const (PublishExtras -> Either PublishBodyFault PublishExtras
forall a b. b -> Either a b
Right PublishExtras
NoPublishExtras)
, publishRelay :: ServicePresentation
-> OriginClient
-> PackageName
-> PublishRequestBody
-> IO (Either FetchFault PublishRelayResponse)
publishRelay = \ServicePresentation
presentation OriginClient
origin PackageName
_ PublishRequestBody
body ->
OriginClient
-> Either UrlFormationError Request
-> IO (Either FetchFault PublishRelayResponse)
relayPublishRequest
OriginClient
origin
( do
base <- Text -> Either UrlFormationError Request
parseRequestEither (OriginClient -> Text
originBaseUrl OriginClient
origin)
pure . attachCredential (presentedMapping presentation StoreWrite pypiCredential) (ocToken origin) $
base
{ method = "POST"
, requestHeaders = maybeToList (fmap (hContentType,) (publishBodyContentType body)) <> requestHeaders base
, requestBody = RequestBodyBS (publishBodyBytes body)
}
)
, publishUploadClaims :: Limits
-> (SourceId -> IO ())
-> Text
-> PublishRequestBody
-> IO (Either PublishBodyFault [Text])
publishUploadClaims = \Limits
limits SourceId -> IO ()
_ Text
_ PublishRequestBody
body -> Limits
-> Maybe Method -> Method -> IO (Either PublishBodyFault [Text])
Multipart.uploadClaims Limits
limits (PublishRequestBody -> Maybe Method
publishBodyContentType PublishRequestBody
body) (PublishRequestBody -> Method
publishBodyBytes PublishRequestBody
body)
, publishCodec :: ServicePresentation -> PublishCodec
publishCodec = ServicePresentation -> PublishCodec
pypiPublishCodec
, publishMirrorRequirements :: MirrorRequirements
publishMirrorRequirements = WorkerMetadataRead
-> MirrorStateFormat
-> MirrorStateRequirement
-> MirrorRequirements
MirrorRequirements (PrepareRead -> WorkerMetadataRead
ChargedWorkerRead (EcosystemRead -> PrepareRead
staticRead EcosystemRead
pypiMirrorRead)) MirrorStateFormat
pypiStateFormat (MirrorDocuments -> MirrorStateRequirement
DurableVersionState MirrorDocuments
pypiMirrorDocuments)
, publishUploadEndpoint :: UploadEndpointRequirement
publishUploadEndpoint = UploadEndpointRequirement
ExplicitUploadEndpoint
, publishIdentity :: UploadIdentityRequirement
publishIdentity = UploadIdentityRequirement
NamedIdentity
}