Copyright	Copyright © FINN.no AS Inc. All rights reserved.
License	MIT
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Unleash

Description

Functions and types for checking feature toggles and variants.

Synopsis

data Context = Context {
- userId :: Maybe Text
- sessionId :: Maybe Text
- remoteAddress :: Maybe Text
- currentTime :: Maybe Text
- environment :: Maybe Text
- appName :: Maybe Text
- properties :: Maybe (Map Text (Maybe Text))
}
defaultStrategyEvaluator :: StrategyEvaluator
defaultSupportedStrategies :: SupportedStrategies
emptyContext :: Context
emptyVariantResponse :: VariantResponse
featureGetVariant :: MonadIO m => Features -> FeatureToggleName -> Context -> m VariantResponse
featureIsEnabled :: MonadIO m => Features -> FeatureToggleName -> Context -> m Bool
type Features = Map FeatureToggleName Feature
type FeatureToggleName = Text
data MetricsPayload = MetricsPayload {
- appName :: Text
- instanceId :: Text
- start :: UTCTime
- stop :: UTCTime
- toggles :: [(Text, Bool)]
}
data RegisterPayload = RegisterPayload {
- appName :: Text
- instanceId :: Text
- strategies :: SupportedStrategies
- started :: UTCTime
- intervalSeconds :: Int
}
data Strategy = Strategy {
- name :: Text
- parameters :: Maybe (Map Text Text)
- constraints :: Maybe [Constraint]
- segments :: Maybe [Int]
}
type StrategyEvaluator = forall m. MonadIO m => Strategy -> FeatureToggleName -> Context -> m Bool
type SupportedStrategies = [Text]
data VariantResponse = VariantResponse {
- name :: Text
- payload :: Maybe Payload
- enabled :: Bool
}

Documentation

data Context Source #

Client context.

Constructors

Context
Fields userId :: Maybe Text User ID. sessionId :: Maybe Text Session ID. remoteAddress :: Maybe Text Remote address. currentTime :: Maybe Text Current UTC time. environment :: Maybe Text Application environment (e.g. `Production`). appName :: Maybe Text Application name. properties :: Maybe (Map Text (Maybe Text)) Other custom properties.

Instances

Instances details

FromJSON Context Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods parseJSON :: Value -> Parser Context # parseJSONList :: Value -> Parser [Context] #
ToJSON Context Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: Context -> Value # toEncoding :: Context -> Encoding # toJSONList :: [Context] -> Value # toEncodingList :: [Context] -> Encoding #
Generic Context Source #
Instance details Defined in Unleash.Internal.JsonTypes Associated Types type Rep Context :: Type -> Type # Methods from :: Context -> Rep Context x # to :: Rep Context x -> Context #
Show Context Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #
Eq Context Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: Context -> Context -> Bool # (/=) :: Context -> Context -> Bool #
type Rep Context Source #
Instance details Defined in Unleash.Internal.JsonTypes type Rep Context = D1 ('MetaData "Context" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-inplace" 'False) (C1 ('MetaCons "Context" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "remoteAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "currentTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text (Maybe Text))))))))

defaultStrategyEvaluator :: StrategyEvaluator Source #

Implementation of default strategies.

defaultSupportedStrategies :: SupportedStrategies Source #

A list of currently supported strategies for this library.

emptyContext :: Context Source #

An initial client context.

emptyVariantResponse :: VariantResponse Source #

The default (disabled) variant response.

featureGetVariant Source #

Arguments

:: MonadIO m
=> Features	Full set of features fetched from a server.
-> FeatureToggleName	Feature toggle name (as it is represented on the server).
-> Context	User context.
-> m VariantResponse	Variant.

Get a variant for a given feature toggle.

featureIsEnabled Source #

Arguments

:: MonadIO m
=> Features	Full set of features fetched from a server.
-> FeatureToggleName	Feature toggle name (as it is represented on the server).
-> Context	User context.
-> m Bool	Feature toggle state.

Check whether or not a feature toggle is enabled.

type Features = Map FeatureToggleName Feature Source #

Map of feature toggles keyed on toggle names. Typically the full set of features fetched from a server.

type FeatureToggleName = Text Source #

Alias used for feature toggle names (as they are represented on Unleash servers).

data MetricsPayload Source #

Metrics payload.

Constructors

MetricsPayload
Fields appName :: Text Application name. instanceId :: Text Instance identifier (typically hostname). start :: UTCTime Start timestamp for this interval. stop :: UTCTime End timestamp for this interval. toggles :: [(Text, Bool)] Feature toggle usage metrics.

Instances

Instances details

Generic MetricsPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Associated Types type Rep MetricsPayload :: Type -> Type # Methods from :: MetricsPayload -> Rep MetricsPayload x # to :: Rep MetricsPayload x -> MetricsPayload #
Show MetricsPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> MetricsPayload -> ShowS # show :: MetricsPayload -> String # showList :: [MetricsPayload] -> ShowS #
Eq MetricsPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: MetricsPayload -> MetricsPayload -> Bool # (/=) :: MetricsPayload -> MetricsPayload -> Bool #
type Rep MetricsPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes type Rep MetricsPayload = D1 ('MetaData "MetricsPayload" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-inplace" 'False) (C1 ('MetaCons "MetricsPayload" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :: (S1 ('MetaSel ('Just "stop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "toggles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Bool)])))))

data RegisterPayload Source #

Client registration payload.

Constructors

RegisterPayload
Fields appName :: Text Application name. instanceId :: Text Instance identifier (typically hostname). strategies :: SupportedStrategies Supported strategies. started :: UTCTime Client application startup timestamp. intervalSeconds :: Int Intended metrics sending interval.

Instances

Instances details

ToJSON RegisterPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: RegisterPayload -> Value # toEncoding :: RegisterPayload -> Encoding # toJSONList :: [RegisterPayload] -> Value # toEncodingList :: [RegisterPayload] -> Encoding #
Generic RegisterPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Associated Types type Rep RegisterPayload :: Type -> Type # Methods from :: RegisterPayload -> Rep RegisterPayload x # to :: Rep RegisterPayload x -> RegisterPayload #
Show RegisterPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> RegisterPayload -> ShowS # show :: RegisterPayload -> String # showList :: [RegisterPayload] -> ShowS #
Eq RegisterPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: RegisterPayload -> RegisterPayload -> Bool # (/=) :: RegisterPayload -> RegisterPayload -> Bool #
type Rep RegisterPayload Source #
Instance details Defined in Unleash.Internal.JsonTypes type Rep RegisterPayload = D1 ('MetaData "RegisterPayload" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-inplace" 'False) (C1 ('MetaCons "RegisterPayload" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "strategies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SupportedStrategies) :: (S1 ('MetaSel ('Just "started") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "intervalSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))))

data Strategy Source #

Strategy. Encompasses all (supported) types of strategies.

Constructors

Strategy
Fields name :: Text parameters :: Maybe (Map Text Text) constraints :: Maybe [Constraint] segments :: Maybe [Int]

Instances

Instances details

FromJSON Strategy Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods parseJSON :: Value -> Parser Strategy # parseJSONList :: Value -> Parser [Strategy] #
ToJSON Strategy Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: Strategy -> Value # toEncoding :: Strategy -> Encoding # toJSONList :: [Strategy] -> Value # toEncodingList :: [Strategy] -> Encoding #
Generic Strategy Source #
Instance details Defined in Unleash.Internal.JsonTypes Associated Types type Rep Strategy :: Type -> Type # Methods from :: Strategy -> Rep Strategy x # to :: Rep Strategy x -> Strategy #
Show Strategy Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> Strategy -> ShowS # show :: Strategy -> String # showList :: [Strategy] -> ShowS #
Eq Strategy Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: Strategy -> Strategy -> Bool # (/=) :: Strategy -> Strategy -> Bool #
type Rep Strategy Source #
Instance details Defined in Unleash.Internal.JsonTypes type Rep Strategy = D1 ('MetaData "Strategy" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-inplace" 'False) (C1 ('MetaCons "Strategy" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))) :: (S1 ('MetaSel ('Just "constraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Constraint])) :*: S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Int])))))

type StrategyEvaluator = forall m. MonadIO m => Strategy -> FeatureToggleName -> Context -> m Bool Source #

Functions that implement strategies.

type SupportedStrategies = [Text] Source #

Alias for a list of supported strategies.

data VariantResponse Source #

Variant response.

Constructors

VariantResponse
Fields name :: Text Variant name. payload :: Maybe Payload Variant payload. enabled :: Bool Variant state.

Instances

Instances details

FromJSON VariantResponse Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods parseJSON :: Value -> Parser VariantResponse # parseJSONList :: Value -> Parser [VariantResponse] #
ToJSON VariantResponse Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: VariantResponse -> Value # toEncoding :: VariantResponse -> Encoding # toJSONList :: [VariantResponse] -> Value # toEncodingList :: [VariantResponse] -> Encoding #
Generic VariantResponse Source #
Instance details Defined in Unleash.Internal.JsonTypes Associated Types type Rep VariantResponse :: Type -> Type # Methods from :: VariantResponse -> Rep VariantResponse x # to :: Rep VariantResponse x -> VariantResponse #
Show VariantResponse Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> VariantResponse -> ShowS # show :: VariantResponse -> String # showList :: [VariantResponse] -> ShowS #
Eq VariantResponse Source #
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: VariantResponse -> VariantResponse -> Bool # (/=) :: VariantResponse -> VariantResponse -> Bool #
type Rep VariantResponse Source #
Instance details Defined in Unleash.Internal.JsonTypes type Rep VariantResponse = D1 ('MetaData "VariantResponse" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-inplace" 'False) (C1 ('MetaCons "VariantResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Payload)) :: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))