module Ecluse.Core.Server.Pipeline.Tarball.Refusal (
artifactOutcomeStatus,
artifactError,
internalArtifactError,
crossHostRefused,
upstreamUnavailable,
upstreamCooling,
versionAbsent,
privateMissRefusal,
privateReadRefusal,
) where
import Network.HTTP.Types (ResponseHeaders, status403, status500)
import Ecluse.Core.Package (PackageName)
import Ecluse.Core.Registry.Metadata (
VersionEvaluation (VersionMetadataUnavailable, VersionMissing),
versionTransience,
)
import Ecluse.Core.Server.Context (PackumentDeps (pdFirstParty, pdHelp))
import Ecluse.Core.Server.Pipeline.Origin (OriginMiss (MissAbsent, MissUnresolved), ReadFailure (ReadInvalid, ReadUnavailable), readFailureRefusal)
import Ecluse.Core.Server.Pipeline.Shared
import Ecluse.Core.Server.Pipeline.Tarball.Types (TarballReplies (tarballError))
import Ecluse.Core.Server.Response (
ArtifactStatus (BadGateway, Forbidden, NotFound, Ok, ServerError, Unavailable'),
RejectReason (ByPolicy, UpstreamInvalid),
Rejection (Rejection, rejectionMessage),
RetryAfter,
ServeDecision (Admit, Reject),
Transience (WillResolve, WontResolve),
artifactHttpStatus,
artifactStatus,
mkRefusal,
rejectUnavailable,
)
artifactOutcomeStatus :: ServeDecision -> ArtifactStatus
artifactOutcomeStatus :: ServeDecision -> ArtifactStatus
artifactOutcomeStatus ServeDecision
decision
| ServeDecision
decision ServeDecision -> [ServeDecision] -> Bool
forall (f :: * -> *) a.
(Foldable f, DisallowElem f, Eq a) =>
a -> f a -> Bool
`elem` [ServeDecision
versionAbsent, ServeDecision
firstPartyAbsent] = ArtifactStatus
NotFound
| Bool
otherwise = ServeDecision -> ArtifactStatus
artifactStatus ServeDecision
decision
artifactError :: TarballReplies response -> PackumentDeps -> ServeDecision -> response
artifactError :: forall response.
TarballReplies response
-> PackumentDeps -> ServeDecision -> response
artifactError TarballReplies response
replies PackumentDeps
deps ServeDecision
decision =
TarballReplies response
-> Status -> ResponseHeaders -> Refusal -> response
forall response.
TarballReplies response
-> Status -> ResponseHeaders -> Refusal -> response
tarballError TarballReplies response
replies (ArtifactStatus -> Status
artifactHttpStatus ArtifactStatus
status) ResponseHeaders
retryHeaders (Maybe HelpMessage -> Text -> Refusal
mkRefusal (PackumentDeps -> Maybe HelpMessage
pdHelp PackumentDeps
deps) Text
message)
where
status :: ArtifactStatus
status :: ArtifactStatus
status = ServeDecision -> ArtifactStatus
artifactOutcomeStatus ServeDecision
decision
retryHeaders :: ResponseHeaders
retryHeaders :: ResponseHeaders
retryHeaders = case ArtifactStatus
status of
Unavailable' Maybe RetryAfter
retry -> Maybe RetryAfter -> ResponseHeaders
retryAfterHeaders Maybe RetryAfter
retry
ArtifactStatus
Ok -> []
ArtifactStatus
Forbidden -> []
ArtifactStatus
ServerError -> []
ArtifactStatus
BadGateway -> []
ArtifactStatus
NotFound -> []
message :: Text
message :: Text
message = case ServeDecision
decision of
ServeDecision
Admit -> Text
"the artifact is available"
Reject Rejection
rej -> Rejection -> Text
rejectionMessage Rejection
rej
internalArtifactError :: TarballReplies response -> response
internalArtifactError :: forall response. TarballReplies response -> response
internalArtifactError TarballReplies response
replies =
TarballReplies response
-> Status -> ResponseHeaders -> Refusal -> response
forall response.
TarballReplies response
-> Status -> ResponseHeaders -> Refusal -> response
tarballError TarballReplies response
replies Status
status500 [] (Maybe HelpMessage -> Text -> Refusal
mkRefusal Maybe HelpMessage
forall a. Maybe a
Nothing Text
"could not form the upstream artifact URL")
crossHostRefused :: TarballReplies response -> response
crossHostRefused :: forall response. TarballReplies response -> response
crossHostRefused TarballReplies response
replies =
TarballReplies response
-> Status -> ResponseHeaders -> Refusal -> response
forall response.
TarballReplies response
-> Status -> ResponseHeaders -> Refusal -> response
tarballError TarballReplies response
replies Status
status403 [] (Maybe HelpMessage -> Text -> Refusal
mkRefusal Maybe HelpMessage
forall a. Maybe a
Nothing Text
"the upstream artifact host is not permitted by the tarball-host policy")
upstreamUnavailable :: ServeDecision
upstreamUnavailable :: ServeDecision
upstreamUnavailable =
VersionEvaluation -> Text -> ServeDecision
versionUnresolved VersionEvaluation
VersionMetadataUnavailable Text
upstreamUnavailableMessage
upstreamUnavailableMessage :: Text
upstreamUnavailableMessage :: Text
upstreamUnavailableMessage = Text
"the upstream registry was unavailable"
versionAbsent :: ServeDecision
versionAbsent :: ServeDecision
versionAbsent =
VersionEvaluation -> Text -> ServeDecision
versionUnresolved VersionEvaluation
VersionMissing Text
"the requested version was not found upstream"
privateMissRefusal :: PackumentDeps -> PackageName -> OriginMiss -> Maybe ServeDecision
privateMissRefusal :: PackumentDeps -> PackageName -> OriginMiss -> Maybe ServeDecision
privateMissRefusal PackumentDeps
deps PackageName
name = \case
MissUnresolved ReadFailure
failure -> ServeDecision -> Maybe ServeDecision
forall a. a -> Maybe a
Just (PackumentDeps -> PackageName -> ReadFailure -> ServeDecision
privateReadRefusal PackumentDeps
deps PackageName
name ReadFailure
failure)
OriginMiss
MissAbsent
| PackumentDeps -> PackageName -> Bool
pdFirstParty PackumentDeps
deps PackageName
name -> ServeDecision -> Maybe ServeDecision
forall a. a -> Maybe a
Just ServeDecision
firstPartyAbsent
| Bool
otherwise -> Maybe ServeDecision
forall a. Maybe a
Nothing
privateReadRefusal :: PackumentDeps -> PackageName -> ReadFailure -> ServeDecision
privateReadRefusal :: PackumentDeps -> PackageName -> ReadFailure -> ServeDecision
privateReadRefusal PackumentDeps
deps PackageName
name ReadFailure
failure
| PackumentDeps -> PackageName -> Bool
pdFirstParty PackumentDeps
deps PackageName
name = case ReadFailure
failure of
ReadUnavailable Maybe RetryAfter
retry -> Maybe RetryAfter -> ServeDecision
firstPartyUnresolved Maybe RetryAfter
retry
ReadFailure
ReadInvalid -> ServeDecision
firstPartyInvalid
| Bool
otherwise = Text -> Text -> ReadFailure -> ServeDecision
readFailureRefusal Text
"the private upstream" Text
upstreamUnavailableMessage ReadFailure
failure
firstPartyAbsent :: ServeDecision
firstPartyAbsent :: ServeDecision
firstPartyAbsent =
Rejection -> ServeDecision
Reject
( RejectReason -> Text -> Rejection
Rejection
(RuleName -> [Reason] -> RejectReason
ByPolicy RuleName
firstPartyRule [])
Text
"the requested artifact is first-party to this deployment, so it is served from the private upstream only and is never fetched from the public registry"
)
firstPartyUnresolved :: Maybe RetryAfter -> ServeDecision
firstPartyUnresolved :: Maybe RetryAfter -> ServeDecision
firstPartyUnresolved Maybe RetryAfter
retry =
Transience -> Text -> ServeDecision
rejectUnavailable
(Maybe RetryAfter -> Transience
WillResolve Maybe RetryAfter
retry)
Text
"the private upstream for this first-party artifact was unavailable"
firstPartyInvalid :: ServeDecision
firstPartyInvalid :: ServeDecision
firstPartyInvalid =
Rejection -> ServeDecision
Reject
( RejectReason -> Text -> Rejection
Rejection
RejectReason
UpstreamInvalid
Text
"the private upstream for this first-party artifact returned an invalid or unusable reply"
)
versionUnresolved :: VersionEvaluation -> Text -> ServeDecision
versionUnresolved :: VersionEvaluation -> Text -> ServeDecision
versionUnresolved VersionEvaluation
eval = Transience -> Text -> ServeDecision
rejectUnavailable (Transience -> Maybe Transience -> Transience
forall a. a -> Maybe a -> a
fromMaybe Transience
WontResolve (VersionEvaluation -> Maybe Transience
versionTransience VersionEvaluation
eval))