Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Spec.CliReporterDAG

Description

Synopsis

type Success = Bool
data UIName
- = SpecListViewportName
- | SpecListViewName
data PreviousStates = PreviousStates {
- procTime :: Maybe ElapsedSeconds
- finishedTime :: Maybe ElapsedSeconds
- blockedTime :: Maybe ElapsedSeconds
}
prevStatesFinishedTime :: PreviousStates -> Maybe ElapsedSeconds
type ElapsedSeconds = Integer
data StateInfo bk = StateInfo {
- state :: TaskState bk
- specName :: Text
- dbName :: Text
- taskType :: TaskType
- previousStates :: PreviousStates
}
type States bk = Map TaskId (StateInfo bk)
data DrawState bk = DrawState {
- startTime :: UTCTime
- showPostProcessedTableRef :: Bool
- taskStates :: States bk
- elapsedTime :: ElapsedSeconds
- processingTime :: ElapsedSeconds
- runDone :: Bool
- wantsToQuit :: Bool
- eta :: EtaType
- totalStats :: QueryStats bk
- showError :: Bool
- specListView :: SpecListView bk
}
type SpecListView bk = List UIName (StateLine bk)
data UpdateEvent b
- = Event TaskId (TaskState b)
- | RunDone
- | Tick
eventHandler :: HasBackendQueryStats b => BrickEvent UIName (UpdateEvent b) -> EventM UIName (DrawState b) ()
cliReporter :: HasBackendQueryStats b => RuntimeEventQueueDAG b -> (SpecTableName -> Ref Table) -> TasksDAG Full bk -> EtaType -> IO Success
success :: DrawState b -> Success
prettyElapsedTime :: Integer -> Text
printFinalReport :: forall b. HasBackendQueryStats b => DrawState b -> IO ()
filterByState :: (TaskState bk -> Bool) -> States bk -> States bk
infoState :: HasBackendQueryStats bk => States bk -> Bool -> TaskState bk -> Maybe Text
drawScreen :: HasBackendQueryStats bk => DrawState bk -> [Widget UIName]
prettyUTCTime :: UTCTime -> Text
data StateLine bk = StateLine {
- specName :: Text
- dbName :: Text
- _type :: Text
- state :: TaskState bk
- previousStates :: PreviousStates
}
sortedStatesList :: States bk -> [StateLine bk]
renderOneState :: HasBackendQueryStats bk => ElapsedSeconds -> Bool -> States bk -> Bool -> StateLine bk -> Widget UIName
cliAttrMap :: AttrMap
tableRowSelected :: AttrName
successStateLine :: AttrName
skippedStateLine :: AttrName
failureStateLine :: AttrName
processingStateLine :: AttrName
pendingStateLine :: AttrName
blockedStateLine :: AttrName
introBox :: AttrName
errorBox :: AttrName
tableStatus :: AttrName
tableStatusError :: AttrName
napkinText :: [Text]

Documentation

type Success = Bool #

data UIName #

Unique names for user interface elements necessary for brick.

Constructors

SpecListViewportName
SpecListViewName

Instances

Instances details

Show UIName #
Instance details Defined in Napkin.Spec.CliReporterDAG Methods showsPrec :: Int -> UIName -> ShowS # show :: UIName -> String # showList :: [UIName] -> ShowS #
Eq UIName #
Instance details Defined in Napkin.Spec.CliReporterDAG Methods (==) :: UIName -> UIName -> Bool # (/=) :: UIName -> UIName -> Bool #
Ord UIName #
Instance details Defined in Napkin.Spec.CliReporterDAG Methods compare :: UIName -> UIName -> Ordering # (<) :: UIName -> UIName -> Bool # (<=) :: UIName -> UIName -> Bool # (>) :: UIName -> UIName -> Bool # (>=) :: UIName -> UIName -> Bool # max :: UIName -> UIName -> UIName # min :: UIName -> UIName -> UIName #

data PreviousStates #

Constructors

PreviousStates
Fields procTime :: Maybe ElapsedSeconds finishedTime :: Maybe ElapsedSeconds blockedTime :: Maybe ElapsedSeconds

Instances

Instances details

Generic PreviousStates #
Instance details Defined in Napkin.Spec.CliReporterDAG Associated Types type Rep PreviousStates :: Type -> Type # Methods from :: PreviousStates -> Rep PreviousStates x # to :: Rep PreviousStates x -> PreviousStates #
Default PreviousStates #
Instance details Defined in Napkin.Spec.CliReporterDAG Methods def :: PreviousStates #
type Rep PreviousStates #
Instance details Defined in Napkin.Spec.CliReporterDAG type Rep PreviousStates = D1 ('MetaData "PreviousStates" "Napkin.Spec.CliReporterDAG" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "PreviousStates" 'PrefixI 'True) (S1 ('MetaSel ('Just "procTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ElapsedSeconds)) :: (S1 ('MetaSel ('Just "finishedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ElapsedSeconds)) :: S1 ('MetaSel ('Just "blockedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ElapsedSeconds)))))

prevStatesFinishedTime :: PreviousStates -> Maybe ElapsedSeconds #

type ElapsedSeconds = Integer #

data StateInfo bk #

Constructors

StateInfo
Fields state :: TaskState bk specName :: Text dbName :: Text taskType :: TaskType previousStates :: PreviousStates

Instances

Instances details

Generic (StateInfo bk) #
Instance details Defined in Napkin.Spec.CliReporterDAG Associated Types type Rep (StateInfo bk) :: Type -> Type # Methods from :: StateInfo bk -> Rep (StateInfo bk) x # to :: Rep (StateInfo bk) x -> StateInfo bk #
type Rep (StateInfo bk) #
Instance details Defined in Napkin.Spec.CliReporterDAG type Rep (StateInfo bk) = D1 ('MetaData "StateInfo" "Napkin.Spec.CliReporterDAG" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "StateInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaskState bk)) :: S1 ('MetaSel ('Just "specName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "taskType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TaskType) :: S1 ('MetaSel ('Just "previousStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PreviousStates)))))

type States bk = Map TaskId (StateInfo bk) #

data DrawState bk #

Constructors

DrawState
Fields startTime :: UTCTime showPostProcessedTableRef :: Bool taskStates :: States bk elapsedTime :: ElapsedSeconds processingTime :: ElapsedSeconds runDone :: Bool wantsToQuit :: Bool eta :: EtaType totalStats :: QueryStats bk showError :: Bool specListView :: SpecListView bk

Instances

Instances details

Generic (DrawState bk) #
Instance details Defined in Napkin.Spec.CliReporterDAG Associated Types type Rep (DrawState bk) :: Type -> Type # Methods from :: DrawState bk -> Rep (DrawState bk) x # to :: Rep (DrawState bk) x -> DrawState bk #
type Rep (DrawState bk) #
Instance details Defined in Napkin.Spec.CliReporterDAG type Rep (DrawState bk) = D1 ('MetaData "DrawState" "Napkin.Spec.CliReporterDAG" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "DrawState" 'PrefixI 'True) (((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "showPostProcessedTableRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "taskStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (States bk)) :: (S1 ('MetaSel ('Just "elapsedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ElapsedSeconds) :: S1 ('MetaSel ('Just "processingTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ElapsedSeconds)))) :: ((S1 ('MetaSel ('Just "runDone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Just "wantsToQuit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "eta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EtaType))) :: (S1 ('MetaSel ('Just "totalStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (QueryStats bk)) :: (S1 ('MetaSel ('Just "showError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "specListView") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SpecListView bk)))))))

type SpecListView bk = List UIName (StateLine bk) #

data UpdateEvent b #

Constructors

Event TaskId (TaskState b)
RunDone
Tick

eventHandler :: HasBackendQueryStats b => BrickEvent UIName (UpdateEvent b) -> EventM UIName (DrawState b) () #

cliReporter :: HasBackendQueryStats b => RuntimeEventQueueDAG b -> (SpecTableName -> Ref Table) -> TasksDAG Full bk -> EtaType -> IO Success #

Pump the runtime event queue to display Spec execution progress in the terminal. Returns after all Specs are completed.

success :: DrawState b -> Success #

prettyElapsedTime :: Integer -> Text #

printFinalReport :: forall b. HasBackendQueryStats b => DrawState b -> IO () #

filterByState :: (TaskState bk -> Bool) -> States bk -> States bk #

infoState :: HasBackendQueryStats bk => States bk -> Bool -> TaskState bk -> Maybe Text #

drawScreen :: HasBackendQueryStats bk => DrawState bk -> [Widget UIName] #

prettyUTCTime :: UTCTime -> Text #

data StateLine bk #

Constructors

StateLine
Fields specName :: Text dbName :: Text _type :: Text state :: TaskState bk previousStates :: PreviousStates

Instances

Instances details

Generic (StateLine bk) #
Instance details Defined in Napkin.Spec.CliReporterDAG Associated Types type Rep (StateLine bk) :: Type -> Type # Methods from :: StateLine bk -> Rep (StateLine bk) x # to :: Rep (StateLine bk) x -> StateLine bk #
type Rep (StateLine bk) #
Instance details Defined in Napkin.Spec.CliReporterDAG type Rep (StateLine bk) = D1 ('MetaData "StateLine" "Napkin.Spec.CliReporterDAG" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "StateLine" 'PrefixI 'True) ((S1 ('MetaSel ('Just "specName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaskState bk)) :: S1 ('MetaSel ('Just "previousStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PreviousStates)))))

sortedStatesList :: States bk -> [StateLine bk] #

renderOneState :: HasBackendQueryStats bk => ElapsedSeconds -> Bool -> States bk -> Bool -> StateLine bk -> Widget UIName #

cliAttrMap :: AttrMap #

tableRowSelected :: AttrName #

successStateLine :: AttrName #

skippedStateLine :: AttrName #

failureStateLine :: AttrName #

processingStateLine :: AttrName #

pendingStateLine :: AttrName #

blockedStateLine :: AttrName #

introBox :: AttrName #

errorBox :: AttrName #

tableStatus :: AttrName #

tableStatusError :: AttrName #

napkinText :: [Text] #