Scientist

Documentation

data ResultCandidate a

Constructors

ResultCandidate

Fields

• resultCandidateName :: Text
• resultCandidateValue :: Either SomeException a
• resultCandidateDuration :: Duration

data ResultControl a

Constructors

ResultControl

Fields

• resultControlName :: Text
• resultControlValue :: a
• resultControlDuration :: Duration

data ResultDetails c a b

Constructors

ResultDetails

Fields

• resultDetailsExperimentName :: Text
• resultDetailsExperimentContext :: Maybe c
• resultDetailsControl :: ResultControl a
• resultDetailsCandidates :: NonEmpty (ResultCandidate b)
• resultDetailsExecutionOrder :: [Text]

data Result c a b

Constructors

ResultSkipped (Control a)

ResultMatched (ResultDetails c a b)

ResultIgnored (ResultDetails c a b)

ResultMismatched (ResultDetails c a b)

resultDetails :: Result c a b -> Maybe (ResultDetails c a b)

resultDetailsCandidate :: ResultDetails c a b -> ResultCandidate b

data Experiment m c a b

newExperiment :: Functor m => Text -> m a -> Experiment m c a b

setExperimentTry :: Functor m => m b -> Experiment m c a b -> Experiment m c a b

A new, candidate code path

If called multiple times, adds multiple candidate paths.

By default, there are no candidate paths and running the experiment will return ResultSkipped.

setExperimentTryNamed :: Functor m => Text -> m b -> Experiment m c a b -> Experiment m c a b

setExperimentEnabled :: m Bool -> Experiment m c a b -> Experiment m c a b

If the candidate paths should be executed

See experimentEnabledPercent for an example.

By default, candidate paths are always run.

setExperimentOnException :: (SomeException -> m ()) -> Experiment m c a b -> Experiment m c a b

How to handle an exception evaluating or publishing

By default, the exception is re-thrown.

setExperimentCompare :: (Control a -> Either SomeException (Candidate b) -> Bool) -> Experiment m c a b -> Experiment m c a b

Decide if a given result is a match.

See experimentCompareEq and experimentCompareBy.

By default, all comparisons fail.

setExperimentIgnore :: (Control a -> Either SomeException (Candidate b) -> Bool) -> Experiment m c a b -> Experiment m c a b

Decide if a given result should be ignored

By default, no results are ignored.

setExperimentRunIf :: Bool -> Experiment m c a b -> Experiment m c a b

Decide if the experiment should run at all

By default, experiments are run.

setExperimentPublish :: (Result c a b -> m ()) -> Experiment m c a b -> Experiment m c a b

How to publish results

By default, results are not published.

getExperimentName :: Experiment m c a b -> Text

getExperimentUse :: Experiment m c a b -> m (Control a)

getExperimentTries :: Experiment m c a b -> Maybe (NonEmpty (NamedCandidate m b))

getExperimentEnabled :: Applicative m => Experiment m c a b -> m Bool

getExperimentOnException :: MonadIO m => Experiment m c a b -> SomeException -> m ()

getExperimentCompare :: Experiment m c a b -> Control a -> Either SomeException (Candidate b) -> Bool

setExperimentContext :: c -> Experiment m c a b -> Experiment m c a b

getExperimentContext :: Experiment m c a b -> Maybe c

getExperimentIgnore :: Experiment m c a b -> Control a -> Either SomeException (Candidate b) -> Bool

getExperimentRunIf :: Experiment m c a b -> Bool

getExperimentPublish :: Applicative m => Experiment m c a b -> Result c a b -> m ()

experimentCompareEq :: Eq a => Control a -> Either SomeException (Candidate a) -> Bool

Compare non-exception candidates with the control by (==)

Exception candidates fail comparison.

experimentCompareOn :: Eq b => (a -> b) -> Control a -> Either SomeException (Candidate a) -> Bool

Compare by equality on some function

Exception candidates fail comparison.

experimentCompareBy :: (a -> b -> Bool) -> Control a -> Either SomeException (Candidate b) -> Bool

Compare by some function

Exception candidates fail comparison.

experimentEnabledPercent :: MonadIO m => Int -> m Bool

Enable the experiment in the given percentage of runs

experimentRun :: MonadUnliftIO m => Experiment m c a b -> m a

experimentRunInternal :: MonadUnliftIO m => Experiment m c a b -> m (Result c a b)

experimentRun but returning the full Result

Used for testing.