Safe Haskell	None
Language	GHC2021

Ecluse.Core.Osv.Ecosystem

Description

What one OSV compile pass needs to know about the ecosystem it compiles.

osv.dev and Écluse do not always agree on the spelling, so a pass that carried one name would either fetch a directory that does not exist or write an artifact the proxy's sync refuses. The pass also needs the version grammar that orders the advisory bounds it ingests, and the fan-out an ordinary advisory of the feed stays under.

Synopsis

data OsvEcosystem = OsvEcosystem {
- osvExportDirectory :: Text
- osvWireName :: Text
- osvEcosystemTag :: Maybe Ecosystem
- osvMaxAdvisoryFanOut :: Int
}
osvEcosystemFor :: Ecosystem -> OsvEcosystem
osvEcosystemNamed :: Text -> OsvEcosystem

Documentation

data OsvEcosystem Source #

The two spellings, the version grammar, and the fan-out bound one compile pass needs.

Constructors

OsvEcosystem

Fields

osvExportDirectory :: Text
osv.dev's own spelling: the directory its export archive sits under, and the value an advisory's affected package carries, which is what the row filter matches.
osvWireName :: Text
Écluse's spelling (ecosystemName): it names the published artifact and stamps the meta row the proxy's sync checks.
osvEcosystemTag :: Maybe Ecosystem
The ecosystem whose version grammar orders this pass's advisory bounds. Nothing for a name this build does not serve, and then the pass tallies nothing.
osvMaxAdvisoryFanOut :: Int
Ranges one advisory of this feed may expand into before the ingest flags it as anomalous. The ingest keeps the advisory either way, so the number only sizes the alarm.

Instances

Instances details

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

osvEcosystemFor :: Ecosystem -> OsvEcosystem Source #

An ecosystem's pair of spellings. npm agrees with osv.dev, PyPI and RubyGems do not.

>>> osvEcosystemFor PyPI
OsvEcosystem {osvExportDirectory = "PyPI", osvWireName = "pypi", osvEcosystemTag = Just PyPI, osvMaxAdvisoryFanOut = 4096}

osvEcosystemNamed :: Text -> OsvEcosystem Source #

The pair for a name a one-shot compile was given: a name this build serves resolves through osvEcosystemFor, and any other spells itself on both halves.

>>> osvEcosystemNamed "pypi"
OsvEcosystem {osvExportDirectory = "PyPI", osvWireName = "pypi", osvEcosystemTag = Just PyPI, osvMaxAdvisoryFanOut = 4096}