module Ecluse.Core.Registry.Metadata.Fetch (
fetchManifest,
fetchVersion,
chargingSelectedReads,
readManifest,
readVersion,
) where
import GHC.Conc (pseq)
import Ecluse.Core.Package (PackageName)
import Ecluse.Core.Registry (FetchFault (FetchUrlUnformable))
import Ecluse.Core.Registry.Exchange (accumulatingCharge, chargedRead, chargedReadWith, digestingRead, formThen, withSuccessBodyUsing)
import Ecluse.Core.Registry.Json.Intern (newInternTable, newTableKey)
import Ecluse.Core.Registry.JsonStream (StreamResult (streamBytes, streamValue))
import Ecluse.Core.Registry.Metadata (Manifest (..), MetadataError, VersionRead, metadataResponse)
import Ecluse.Core.Registry.Metadata.EntryFloor (noRetainedEntries)
import Ecluse.Core.Registry.Metadata.Fetch.Types (Body (Body), DocumentWalk, EcosystemRead (..), ManifestFetch, ReadTerms (..))
import Ecluse.Core.Registry.Origin (OriginClient (ocBaseRequest, ocChargeFullRead, ocClient, ocLimits, ocPublicControl, ocReadKind, ocToken), originBaseUrl)
import Ecluse.Core.Registry.Public (ReadControl (..))
import Ecluse.Core.Registry.Request (sealRequest)
import Ecluse.Core.Security (BodyLimit (MetadataBodyLimit), LimitError, Limits (maxMetadataBytes, progressFloor))
import Ecluse.Core.Telemetry.Span (TracingPort (spanMetadataDecode, spanMetadataFetch))
import Ecluse.Core.Telemetry.Upstream (PublicReadKind (Listing, SelectedRead))
import Ecluse.Core.Version (Version)
chargingSelectedReads :: (ByteString -> Int) -> (Int -> IO ()) -> EcosystemRead -> EcosystemRead
chargingSelectedReads :: (ByteString -> Int)
-> (Int -> IO ()) -> EcosystemRead -> EcosystemRead
chargingSelectedReads ByteString -> Int
weigh Int -> IO ()
charge EcosystemRead{BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest :: BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest :: EcosystemRead
-> BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest, [Text]
erUniqueFields :: [Text]
erUniqueFields :: EcosystemRead -> [Text]
erUniqueFields, Limits -> PackageName -> Text -> DocumentWalk full
erWalkFull :: Limits -> PackageName -> Text -> DocumentWalk full
erWalkFull :: ()
erWalkFull, Limits
-> PackageName
-> Text
-> StreamResult full
-> Either MetadataError (PackageInfo, CachedDoc)
erFinishFull :: Limits
-> PackageName
-> Text
-> StreamResult full
-> Either MetadataError (PackageInfo, CachedDoc)
erFinishFull :: ()
erFinishFull, full -> RetainedEntries
erRetainedEntries :: full -> RetainedEntries
erRetainedEntries :: ()
erRetainedEntries, Limits -> PackageName -> Version -> DocumentWalk selected
erWalkSelected :: Limits -> PackageName -> Version -> DocumentWalk selected
erWalkSelected :: ()
erWalkSelected, Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
erFinishSelected :: Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
erFinishSelected :: ()
erFinishSelected} =
EcosystemRead
{ BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest :: BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest :: BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest
, [Text]
erUniqueFields :: [Text]
erUniqueFields :: [Text]
erUniqueFields
, Limits -> PackageName -> Text -> DocumentWalk full
erWalkFull :: Limits -> PackageName -> Text -> DocumentWalk full
erWalkFull :: Limits -> PackageName -> Text -> DocumentWalk full
erWalkFull
, Limits
-> PackageName
-> Text
-> StreamResult full
-> Either MetadataError (PackageInfo, CachedDoc)
erFinishFull :: Limits
-> PackageName
-> Text
-> StreamResult full
-> Either MetadataError (PackageInfo, CachedDoc)
erFinishFull :: Limits
-> PackageName
-> Text
-> StreamResult full
-> Either MetadataError (PackageInfo, CachedDoc)
erFinishFull
, full -> RetainedEntries
erRetainedEntries :: full -> RetainedEntries
erRetainedEntries :: full -> RetainedEntries
erRetainedEntries
, erWalkSelected :: Limits -> PackageName -> Version -> DocumentWalk selected
erWalkSelected = \Limits
limits PackageName
name Version
version BodyLimit
bound InternTable
table IO ByteString
readChunk -> do
pay <- (Int -> IO ()) -> IO (Int -> IO ())
accumulatingCharge Int -> IO ()
charge
erWalkSelected limits name version bound table (chargedReadWith (pay . weigh) readChunk)
, Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
erFinishSelected :: Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
erFinishSelected :: Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
erFinishSelected
}
fetchManifest :: EcosystemRead -> ManifestFetch
fetchManifest :: EcosystemRead -> ManifestFetch
fetchManifest EcosystemRead
eco TracingPort
tracing OriginClient
origin PackageName
name = EcosystemRead
-> TracingPort
-> ReadTerms
-> PackageName
-> Body
-> IO (Either MetadataError Manifest)
readManifest EcosystemRead
eco TracingPort
tracing (OriginClient -> ReadTerms
originTerms OriginClient
origin) PackageName
name (PublicReadKind
-> EcosystemRead -> OriginClient -> PackageName -> Body
originBody PublicReadKind
Listing EcosystemRead
eco OriginClient
origin PackageName
name)
fetchVersion :: EcosystemRead -> TracingPort -> OriginClient -> PackageName -> Version -> IO (Either MetadataError VersionRead)
fetchVersion :: EcosystemRead
-> TracingPort
-> OriginClient
-> PackageName
-> Version
-> IO (Either MetadataError VersionRead)
fetchVersion EcosystemRead
eco TracingPort
tracing OriginClient
origin PackageName
name Version
version = EcosystemRead
-> TracingPort
-> ReadTerms
-> PackageName
-> Version
-> Body
-> IO (Either MetadataError VersionRead)
readVersion EcosystemRead
eco TracingPort
tracing (OriginClient -> ReadTerms
originTerms OriginClient
origin) PackageName
name Version
version (PublicReadKind
-> EcosystemRead -> OriginClient -> PackageName -> Body
originBody PublicReadKind
SelectedRead EcosystemRead
eco OriginClient
origin PackageName
name)
readManifest :: EcosystemRead -> TracingPort -> ReadTerms -> PackageName -> Body -> IO (Either MetadataError Manifest)
readManifest :: EcosystemRead
-> TracingPort
-> ReadTerms
-> PackageName
-> Body
-> IO (Either MetadataError Manifest)
readManifest EcosystemRead{erUniqueFields :: EcosystemRead -> [Text]
erUniqueFields = [Text]
uniqueFields, erWalkFull :: ()
erWalkFull = Limits -> PackageName -> Text -> DocumentWalk full
walk, erFinishFull :: ()
erFinishFull = Limits
-> PackageName
-> Text
-> StreamResult full
-> Either MetadataError (PackageInfo, CachedDoc)
finish, erRetainedEntries :: ()
erRetainedEntries = full -> RetainedEntries
retained} TracingPort
tracing ReadTerms
terms PackageName
name Body
body = do
result <- TracingPort
-> PackageName
-> Body
-> (IO ByteString
-> IO (Either LimitError (StreamResult full, ContentDigest)))
-> IO (Either MetadataError (StreamResult full, ContentDigest))
forall a.
TracingPort
-> PackageName
-> Body
-> (IO ByteString -> IO (Either LimitError a))
-> IO (Either MetadataError a)
exchange TracingPort
tracing PackageName
name Body
body ((IO ByteString -> IO (Either LimitError (StreamResult full)))
-> IO ByteString
-> IO (Either LimitError (StreamResult full, ContentDigest))
forall e a.
(IO ByteString -> IO (Either e a))
-> IO ByteString -> IO (Either e (a, ContentDigest))
digestingRead IO ByteString -> IO (Either LimitError (StreamResult full))
decode (IO ByteString
-> IO (Either LimitError (StreamResult full, ContentDigest)))
-> (IO ByteString -> IO ByteString)
-> IO ByteString
-> IO (Either LimitError (StreamResult full, ContentDigest))
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Int -> IO ()) -> IO ByteString -> IO ByteString
chargedRead (ReadTerms -> Int -> IO ()
rtChargeFullRead ReadTerms
terms))
pure $ do
(streamed, digest) <- result
let !bodyBytes = StreamResult full -> Int
forall a. StreamResult a -> Int
streamBytes StreamResult full
streamed
!entries = (ParseError -> RetainedEntries)
-> (full -> RetainedEntries)
-> Either ParseError full
-> RetainedEntries
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (RetainedEntries -> ParseError -> RetainedEntries
forall a b. a -> b -> a
const RetainedEntries
noRetainedEntries) full -> RetainedEntries
retained (StreamResult full -> Either ParseError full
forall a. StreamResult a -> Either ParseError a
streamValue StreamResult full
streamed)
(info, raw) <- finish limits name base streamed
pure (raw `pseq` Manifest{manifestInfo = info, manifestRaw = raw, manifestBodyBytes = bodyBytes, manifestRetainedEntries = entries, manifestDigest = digest})
where
limits :: Limits
limits = ReadTerms -> Limits
rtLimits ReadTerms
terms
base :: Text
base = ReadTerms -> Text
rtBaseUrl ReadTerms
terms
decode :: IO ByteString -> IO (Either LimitError (StreamResult full))
decode = TracingPort
-> PackageName
-> Limits
-> [Text]
-> DocumentWalk full
-> IO ByteString
-> IO (Either LimitError (StreamResult full))
forall s.
TracingPort
-> PackageName
-> Limits
-> [Text]
-> DocumentWalk s
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
decoding TracingPort
tracing PackageName
name Limits
limits [Text]
uniqueFields (Limits -> PackageName -> Text -> DocumentWalk full
walk Limits
limits PackageName
name Text
base)
readVersion :: EcosystemRead -> TracingPort -> ReadTerms -> PackageName -> Version -> Body -> IO (Either MetadataError VersionRead)
readVersion :: EcosystemRead
-> TracingPort
-> ReadTerms
-> PackageName
-> Version
-> Body
-> IO (Either MetadataError VersionRead)
readVersion EcosystemRead{erUniqueFields :: EcosystemRead -> [Text]
erUniqueFields = [Text]
uniqueFields, erWalkSelected :: ()
erWalkSelected = Limits -> PackageName -> Version -> DocumentWalk selected
walk, erFinishSelected :: ()
erFinishSelected = Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
finish} TracingPort
tracing ReadTerms
terms PackageName
name Version
version Body
body =
(Either MetadataError (StreamResult selected)
-> (StreamResult selected -> Either MetadataError VersionRead)
-> Either MetadataError VersionRead
forall a b.
Either MetadataError a
-> (a -> Either MetadataError b) -> Either MetadataError b
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Limits
-> PackageName
-> Text
-> Version
-> StreamResult selected
-> Either MetadataError VersionRead
finish Limits
limits PackageName
name (ReadTerms -> Text
rtBaseUrl ReadTerms
terms) Version
version)
(Either MetadataError (StreamResult selected)
-> Either MetadataError VersionRead)
-> IO (Either MetadataError (StreamResult selected))
-> IO (Either MetadataError VersionRead)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> TracingPort
-> PackageName
-> Body
-> (IO ByteString
-> IO (Either LimitError (StreamResult selected)))
-> IO (Either MetadataError (StreamResult selected))
forall a.
TracingPort
-> PackageName
-> Body
-> (IO ByteString -> IO (Either LimitError a))
-> IO (Either MetadataError a)
exchange TracingPort
tracing PackageName
name Body
body (TracingPort
-> PackageName
-> Limits
-> [Text]
-> DocumentWalk selected
-> IO ByteString
-> IO (Either LimitError (StreamResult selected))
forall s.
TracingPort
-> PackageName
-> Limits
-> [Text]
-> DocumentWalk s
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
decoding TracingPort
tracing PackageName
name Limits
limits [Text]
uniqueFields (Limits -> PackageName -> Version -> DocumentWalk selected
walk Limits
limits PackageName
name Version
version))
where
limits :: Limits
limits = ReadTerms -> Limits
rtLimits ReadTerms
terms
keyedRead :: Limits -> [Text] -> DocumentWalk s -> IO ByteString -> IO (Either LimitError (StreamResult s))
keyedRead :: forall s.
Limits
-> [Text]
-> DocumentWalk s
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
keyedRead Limits
limits [Text]
uniqueFields DocumentWalk s
walk IO ByteString
readChunk = do
table <- SipKey -> [Text] -> InternTable
newInternTable (SipKey -> [Text] -> InternTable)
-> IO SipKey -> IO ([Text] -> InternTable)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> IO SipKey
newTableKey IO ([Text] -> InternTable) -> IO [Text] -> IO InternTable
forall a b. IO (a -> b) -> IO a -> IO b
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> [Text] -> IO [Text]
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure [Text]
uniqueFields
walk (MetadataBodyLimit (maxMetadataBytes limits)) table readChunk
decoding :: TracingPort -> PackageName -> Limits -> [Text] -> DocumentWalk s -> IO ByteString -> IO (Either LimitError (StreamResult s))
decoding :: forall s.
TracingPort
-> PackageName
-> Limits
-> [Text]
-> DocumentWalk s
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
decoding TracingPort
tracing PackageName
name Limits
limits [Text]
uniqueFields DocumentWalk s
walk = TracingPort -> forall a. PackageName -> IO a -> IO a
spanMetadataDecode TracingPort
tracing PackageName
name (IO (Either LimitError (StreamResult s))
-> IO (Either LimitError (StreamResult s)))
-> (IO ByteString -> IO (Either LimitError (StreamResult s)))
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Limits
-> [Text]
-> DocumentWalk s
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
forall s.
Limits
-> [Text]
-> DocumentWalk s
-> IO ByteString
-> IO (Either LimitError (StreamResult s))
keyedRead Limits
limits [Text]
uniqueFields DocumentWalk s
walk
exchange :: TracingPort -> PackageName -> Body -> (IO ByteString -> IO (Either LimitError a)) -> IO (Either MetadataError a)
exchange :: forall a.
TracingPort
-> PackageName
-> Body
-> (IO ByteString -> IO (Either LimitError a))
-> IO (Either MetadataError a)
exchange TracingPort
tracing PackageName
name (Body forall a.
(IO ByteString -> IO (Either LimitError a))
-> IO (Either FetchFault (BodyOutcome a))
overChunks) IO ByteString -> IO (Either LimitError a)
consume = Either FetchFault (BodyOutcome a) -> Either MetadataError a
forall a.
Either FetchFault (BodyOutcome a) -> Either MetadataError a
metadataResponse (Either FetchFault (BodyOutcome a) -> Either MetadataError a)
-> IO (Either FetchFault (BodyOutcome a))
-> IO (Either MetadataError a)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> TracingPort -> forall a. PackageName -> IO a -> IO a
spanMetadataFetch TracingPort
tracing PackageName
name ((IO ByteString -> IO (Either LimitError a))
-> IO (Either FetchFault (BodyOutcome a))
forall a.
(IO ByteString -> IO (Either LimitError a))
-> IO (Either FetchFault (BodyOutcome a))
overChunks IO ByteString -> IO (Either LimitError a)
consume)
originTerms :: OriginClient -> ReadTerms
originTerms :: OriginClient -> ReadTerms
originTerms OriginClient
origin = ReadTerms{rtLimits :: Limits
rtLimits = OriginClient -> Limits
ocLimits OriginClient
origin, rtBaseUrl :: Text
rtBaseUrl = OriginClient -> Text
originBaseUrl OriginClient
origin, rtChargeFullRead :: Int -> IO ()
rtChargeFullRead = OriginClient -> Int -> IO ()
ocChargeFullRead OriginClient
origin}
originBody :: PublicReadKind -> EcosystemRead -> OriginClient -> PackageName -> Body
originBody :: PublicReadKind
-> EcosystemRead -> OriginClient -> PackageName -> Body
originBody PublicReadKind
kind EcosystemRead
eco OriginClient
origin PackageName
name =
(forall a.
(IO ByteString -> IO (Either LimitError a))
-> IO (Either FetchFault (BodyOutcome a)))
-> Body
Body
( \IO ByteString -> IO (Either LimitError a)
consume ->
(UrlFormationError -> FetchFault)
-> (Request -> IO (Either FetchFault (BodyOutcome a)))
-> Either UrlFormationError Request
-> IO (Either FetchFault (BodyOutcome a))
forall fault a.
(UrlFormationError -> fault)
-> (Request -> IO (Either fault a))
-> Either UrlFormationError Request
-> IO (Either fault a)
formThen
UrlFormationError -> FetchFault
FetchUrlUnformable
(ReadControl
-> ExchangeClient
-> ProgressFloor
-> (IO ByteString -> IO (Either LimitError a))
-> Request
-> IO (Either FetchFault (BodyOutcome a))
forall a.
ReadControl
-> ExchangeClient
-> ProgressFloor
-> (IO ByteString -> IO (Either LimitError a))
-> Request
-> IO (Either FetchFault (BodyOutcome a))
withSuccessBodyUsing ReadControl
control (OriginClient -> ExchangeClient
ocClient OriginClient
origin) (Limits -> ProgressFloor
progressFloor (OriginClient -> Limits
ocLimits OriginClient
origin)) IO ByteString -> IO (Either LimitError a)
consume)
(Request -> Request
sealRequest (Request -> Request)
-> Either UrlFormationError Request
-> Either UrlFormationError Request
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> EcosystemRead
-> BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
erRequest EcosystemRead
eco (OriginClient -> BaseRequest
ocBaseRequest OriginClient
origin) (OriginClient -> Maybe ClientCredential
ocToken OriginClient
origin) PackageName
name)
)
where
control :: ReadControl
control = ReadControl
-> (PublicControl -> ReadControl)
-> Maybe PublicControl
-> ReadControl
forall b a. b -> (a -> b) -> Maybe a -> b
maybe ReadControl
Uncontrolled (\PublicControl
handle -> PublicControl -> PublicReadKind -> ReadControl
Controlled PublicControl
handle (PublicReadKind -> Maybe PublicReadKind -> PublicReadKind
forall a. a -> Maybe a -> a
fromMaybe PublicReadKind
kind (OriginClient -> Maybe PublicReadKind
ocReadKind OriginClient
origin))) (OriginClient -> Maybe PublicControl
ocPublicControl OriginClient
origin)