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

Unleash.Client

Description

Functions and types that constitute an Unleash client SDK.

This module re-exports select constructors from unleash-client-haskell-core.

Synopsis

makeUnleashConfig :: MonadIO m => Text -> Text -> BaseUrl -> Maybe Text -> m UnleashConfig
data UnleashConfig = UnleashConfig {
- applicationName :: Text
- instanceId :: Text
- state :: MVar Features
- statePollIntervalInSeconds :: Int
- metrics :: MVar [(Text, Bool)]
- metricsBucketStart :: MVar UTCTime
- metricsPushIntervalInSeconds :: Int
- apiKey :: Maybe Text
- httpClientEnvironment :: ClientEnv
}
class HasUnleash r where
- getUnleashConfig :: r -> UnleashConfig
registerClient :: (HasUnleash r, MonadReader r m, MonadIO m) => m (Either ClientError ())
registerClientWithCustomStrategies :: (HasUnleash r, MonadReader r m, MonadIO m) => SupportedStrategies -> m (Either ClientError ())
pollToggles :: (HasUnleash r, MonadReader r m, MonadIO m) => m (Either ClientError ())
pollTogglesWithCustomStrategies :: (HasUnleash r, MonadReader r m, MonadIO m) => StrategyEvaluator -> m (Either ClientError ())
pushMetrics :: (HasUnleash r, MonadReader r m, MonadIO m) => m (Either ClientError ())
isEnabled :: (HasUnleash r, MonadReader r m, MonadIO m) => Text -> m Bool
isEnabledWithContext :: (HasUnleash r, MonadReader r m, MonadIO m) => Text -> Context -> m Bool
tryIsEnabled :: (HasUnleash r, MonadReader r m, MonadIO m) => Text -> m Bool
tryIsEnabledWithContext :: (HasUnleash r, MonadReader r m, MonadIO m) => Text -> Context -> m Bool
getVariant :: (HasUnleash r, MonadReader r m, MonadIO m) => Text -> Context -> m VariantResponse
tryGetVariant :: (HasUnleash r, MonadReader r m, MonadIO m) => Text -> Context -> m VariantResponse
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))
}
emptyContext :: Context
type FeatureToggleName = Text
data Strategy = Strategy {
- name :: Text
- parameters :: Maybe (Map Text Text)
- constraints :: Maybe [Constraint]
- segments :: Maybe [Int]
}
type StrategyEvaluator = forall (m :: Type -> Type). MonadIO m => Strategy -> FeatureToggleName -> Context -> m Bool
type SupportedStrategies = [Text]
data VariantResponse = VariantResponse {
- name :: Text
- payload :: Maybe Payload
- enabled :: Bool
}

Documentation

makeUnleashConfig Source #

Arguments

:: MonadIO m
=> Text	Application name.
-> Text	Instance identifier.
-> BaseUrl	Unleash server base URL.
-> Maybe Text	API key for authorization.
-> m UnleashConfig	Configuration instance.

Smart constructor for Unleash client configuration. Initializes the mutable variables properly.

data UnleashConfig Source #

Unleash client configuration. Use the smart constructor or make sure the mutable metrics variables are not empty.

Constructors

UnleashConfig

Fields

applicationName :: Text
Application name.
instanceId :: Text
Instance identifier.
state :: MVar Features
Full client feature set state.
statePollIntervalInSeconds :: Int
Feature set state update interval.
metrics :: MVar [(Text, Bool)]
Collected metrics state.
metricsBucketStart :: MVar UTCTime
Current metrics bucket start time.
metricsPushIntervalInSeconds :: Int
Metrics sending interval.
apiKey :: Maybe Text
API key for authorization.
httpClientEnvironment :: ClientEnv
HTTP client environment.

class HasUnleash r where Source #

Reader monad convenience class. Use this to get an Unleash configuration from inside of an application configuration (for example).

Methods

getUnleashConfig :: r -> UnleashConfig Source #

registerClient :: (HasUnleash r, MonadReader r m, MonadIO m) => m (Either ClientError ()) Source #

Register client for the Unleash server. Call this on application startup before calling the state poller and metrics pusher functions.

registerClientWithCustomStrategies :: (HasUnleash r, MonadReader r m, MonadIO m) => SupportedStrategies -> m (Either ClientError ()) Source #

Register client for the Unleash server. Custom strategies are added to default strategies. Call this on application startup before calling the state poller and metrics pusher functions.

pollToggles :: (HasUnleash r, MonadReader r m, MonadIO m) => m (Either ClientError ()) Source #

Fetch the most recent feature toggle set from the Unleash server. Meant to be run every statePollIntervalInSeconds. Non-blocking.

pollTogglesWithCustomStrategies :: (HasUnleash r, MonadReader r m, MonadIO m) => StrategyEvaluator -> m (Either ClientError ()) Source #

Fetch the most recent feature toggle set from the Unleash server. Custom strategies are added to default strategies. Meant to be run every statePollIntervalInSeconds. Non-blocking.

pushMetrics :: (HasUnleash r, MonadReader r m, MonadIO m) => m (Either ClientError ()) Source #

Push metrics to the Unleash server. Meant to be run every metricsPushIntervalInSeconds. Blocks if the mutable metrics variables are empty.

isEnabled Source #

Arguments

:: (HasUnleash r, MonadReader r m, MonadIO m)
=> Text	Feature toggle name.
-> m Bool	Client context.

Check if a feature is enabled or not. Blocks until first feature toggle set is received. Blocks if the mutable metrics variables are empty.

isEnabledWithContext Source #

Arguments

:: (HasUnleash r, MonadReader r m, MonadIO m)
=> Text	Feature toggle name.
-> Context	Client context.
-> m Bool	Whether or not the feature toggle is enabled.

Check if a feature is enabled or not. Blocks until first feature toggle set is received. Blocks if the mutable metrics variables are empty.

tryIsEnabled Source #

Arguments

:: (HasUnleash r, MonadReader r m, MonadIO m)
=> Text	Feature toggle name.
-> m Bool	Client context.

Check if a feature is enabled or not. Returns false for all toggles until first toggle set is received. Blocks if the mutable metrics variables are empty.

tryIsEnabledWithContext Source #

Arguments

:: (HasUnleash r, MonadReader r m, MonadIO m)
=> Text	Feature toggle name.
-> Context	Client context.
-> m Bool	Whether or not the feature toggle is enabled.

Check if a feature is enabled or not. Returns false for all toggles until first toggle set is received. Blocks if the mutable metrics variables are empty.

getVariant Source #

Arguments

:: (HasUnleash r, MonadReader r m, MonadIO m)
=> Text	Feature toggle name.
-> Context	Client context.
-> m VariantResponse	Variant.

Get a variant. Blocks until first feature toggle set is received.

tryGetVariant Source #

Arguments

:: (HasUnleash r, MonadReader r m, MonadIO m)
=> Text	Feature toggle name.
-> Context	Client context.
-> m VariantResponse	Variant.

Get a variant. Returns an empty variant until first toggle set is received.

data Context #

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
Instance details Defined in Unleash.Internal.JsonTypes Methods parseJSON :: Value -> Parser Context # parseJSONList :: Value -> Parser [Context] #
ToJSON Context
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: Context -> Value # toEncoding :: Context -> Encoding # toJSONList :: [Context] -> Value # toEncodingList :: [Context] -> Encoding #
Generic Context
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
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #
Eq Context
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: Context -> Context -> Bool # (/=) :: Context -> Context -> Bool #
type Rep Context
Instance details Defined in Unleash.Internal.JsonTypes type Rep Context = D1 ('MetaData "Context" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-8vB3e9Qkwy0Bxo8PcypJr9" '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))))))))

emptyContext :: Context #

An initial client context.

type FeatureToggleName = Text #

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

data Strategy #

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
Instance details Defined in Unleash.Internal.JsonTypes Methods parseJSON :: Value -> Parser Strategy # parseJSONList :: Value -> Parser [Strategy] #
ToJSON Strategy
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: Strategy -> Value # toEncoding :: Strategy -> Encoding # toJSONList :: [Strategy] -> Value # toEncodingList :: [Strategy] -> Encoding #
Generic Strategy
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
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> Strategy -> ShowS # show :: Strategy -> String # showList :: [Strategy] -> ShowS #
Eq Strategy
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: Strategy -> Strategy -> Bool # (/=) :: Strategy -> Strategy -> Bool #
type Rep Strategy
Instance details Defined in Unleash.Internal.JsonTypes type Rep Strategy = D1 ('MetaData "Strategy" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-8vB3e9Qkwy0Bxo8PcypJr9" '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 :: Type -> Type). MonadIO m => Strategy -> FeatureToggleName -> Context -> m Bool #

Functions that implement strategies.

type SupportedStrategies = [Text] #

Alias for a list of supported strategies.

data VariantResponse #

Variant response.

Constructors

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

Instances

Instances details

FromJSON VariantResponse
Instance details Defined in Unleash.Internal.JsonTypes Methods parseJSON :: Value -> Parser VariantResponse # parseJSONList :: Value -> Parser [VariantResponse] #
ToJSON VariantResponse
Instance details Defined in Unleash.Internal.JsonTypes Methods toJSON :: VariantResponse -> Value # toEncoding :: VariantResponse -> Encoding # toJSONList :: [VariantResponse] -> Value # toEncodingList :: [VariantResponse] -> Encoding #
Generic VariantResponse
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
Instance details Defined in Unleash.Internal.JsonTypes Methods showsPrec :: Int -> VariantResponse -> ShowS # show :: VariantResponse -> String # showList :: [VariantResponse] -> ShowS #
Eq VariantResponse
Instance details Defined in Unleash.Internal.JsonTypes Methods (==) :: VariantResponse -> VariantResponse -> Bool # (/=) :: VariantResponse -> VariantResponse -> Bool #
type Rep VariantResponse
Instance details Defined in Unleash.Internal.JsonTypes type Rep VariantResponse = D1 ('MetaData "VariantResponse" "Unleash.Internal.JsonTypes" "unleash-client-haskell-core-0.11.0-8vB3e9Qkwy0Bxo8PcypJr9" '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))))