Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Admin.EnvTypes

Synopsis

data GargJob
- = TableNgramsJob
- | ForgotPasswordJob
- | UpdateNgramsListJobJSON
- | UpdateNgramsListJobCSV
- | AddContactJob
- | AddFileJob
- | DocumentFromWriteNodeJob
- | UpdateNodeJob
- | UploadFrameCalcJob
- | UploadDocumentJob
- | NewNodeJob
- | AddCorpusQueryJob
- | AddCorpusFormJob
- | AddCorpusFileJob
- | AddAnnuaireFormJob
- | RecomputeGraphJob
data Env = Env {
- _env_settings :: ~Settings
- _env_logger :: ~(Logger (GargM Env BackendInternalError))
- _env_pool :: ~(Pool Connection)
- _env_nodeStory :: ~NodeStoryEnv
- _env_manager :: ~Manager
- _env_self_url :: ~BaseUrl
- _env_scrapers :: ~ScrapersEnv
- _env_jobs :: ~(JobEnv GargJob (Seq JobLog) JobLog)
- _env_config :: ~GargConfig
- _env_mail :: ~MailConfig
- _env_nlp :: ~NLPServerMap
}
data Mode
- = Dev
- | Mock
- | Prod
modeToLoggingLevels :: Mode -> [LogLevel]
mkJobHandle :: JobID 'Safe -> LoggerM (GargM Env err) JobLog -> ConcreteJobHandle err
env_logger :: Lens' Env (Logger (GargM Env BackendInternalError))
env_manager :: Lens' Env Manager
env_self_url :: Lens' Env BaseUrl
menv_firewall :: Iso' MockEnv FireWall
dev_env_logger :: Lens' DevEnv (Logger (GargM DevEnv BackendInternalError))
data MockEnv = MockEnv {
- _menv_firewall :: !FireWall
}
data DevEnv = DevEnv {
- _dev_env_settings :: !Settings
- _dev_env_config :: !GargConfig
- _dev_env_logger :: !(Logger (GargM DevEnv BackendInternalError))
- _dev_env_pool :: !(Pool Connection)
- _dev_env_nodeStory :: !NodeStoryEnv
- _dev_env_mail :: !MailConfig
- _dev_env_nlp :: !NLPServerMap
}
data DevJobHandle = DevJobHandle
data ConcreteJobHandle err

Documentation

data GargJob #

Constructors

TableNgramsJob
ForgotPasswordJob
UpdateNgramsListJobJSON
UpdateNgramsListJobCSV
AddContactJob
AddFileJob
DocumentFromWriteNodeJob
UpdateNodeJob
UploadFrameCalcJob
UploadDocumentJob
NewNodeJob
AddCorpusQueryJob
AddCorpusFormJob
AddCorpusFileJob
AddAnnuaireFormJob
RecomputeGraphJob

Instances

Instances details

Bounded GargJob #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods minBound :: GargJob # maxBound :: GargJob #
Enum GargJob #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods succ :: GargJob -> GargJob # pred :: GargJob -> GargJob # toEnum :: Int -> GargJob # fromEnum :: GargJob -> Int # enumFrom :: GargJob -> [GargJob] # enumFromThen :: GargJob -> GargJob -> [GargJob] # enumFromTo :: GargJob -> GargJob -> [GargJob] # enumFromThenTo :: GargJob -> GargJob -> GargJob -> [GargJob] #
Show GargJob #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods showsPrec :: Int -> GargJob -> ShowS # show :: GargJob -> String # showList :: [GargJob] -> ShowS #
Eq GargJob #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods (==) :: GargJob -> GargJob -> Bool # (/=) :: GargJob -> GargJob -> Bool #
Ord GargJob #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods compare :: GargJob -> GargJob -> Ordering # (<) :: GargJob -> GargJob -> Bool # (<=) :: GargJob -> GargJob -> Bool # (>) :: GargJob -> GargJob -> Bool # (>=) :: GargJob -> GargJob -> Bool # max :: GargJob -> GargJob -> GargJob # min :: GargJob -> GargJob -> GargJob #
MonadJob (GargM Env err) GargJob (Seq JobLog) JobLog #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getJobEnv :: GargM Env err (JobEnv GargJob (Seq JobLog) JobLog) #

data Env #

Constructors

Env
Fields _env_settings :: ~Settings _env_logger :: ~(Logger (GargM Env BackendInternalError)) _env_pool :: ~(Pool Connection) _env_nodeStory :: ~NodeStoryEnv _env_manager :: ~Manager _env_self_url :: ~BaseUrl _env_scrapers :: ~ScrapersEnv _env_jobs :: ~(JobEnv GargJob (Seq JobLog) JobLog) _env_config :: ~GargConfig _env_mail :: ~MailConfig _env_nlp :: ~NLPServerMap

Instances

Instances details

Generic Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types type Rep Env :: Type -> Type # Methods from :: Env -> Rep Env x # to :: Rep Env x -> Env #
HasSettings Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods settings :: Getter Env Settings #
HasMail Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods mailSettings :: Getter Env MailConfig #
HasNLPServer Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods nlpServer :: Getter Env NLPServerMap # nlpServerGet :: Lang -> Getter Env NLPServerConfig #
HasNodeArchiveStoryImmediateSaver Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasNodeArchiveStoryImmediateSaver :: Getter Env (NodeId -> ArchiveList -> IO ArchiveList) #
HasNodeStoryEnv Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasNodeStory :: Getter Env NodeStoryEnv #
HasNodeStoryImmediateSaver Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasNodeStoryImmediateSaver :: Getter Env (NodeId -> ArchiveList -> IO ()) #
HasConfig Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasConfig :: Getter Env GargConfig #
HasConnectionPool Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods connPool :: Getter Env (Pool Connection) #
HasJobEnv Env JobLog JobLog #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods job_env :: Lens' Env (JobEnv JobLog JobLog) #
HasEnv Env (Job JobLog JobLog) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods _env :: Lens' Env (Env0 (Job JobLog JobLog)) #
HasLogger (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types data Logger (GargM Env BackendInternalError) # type LogInitParams (GargM Env BackendInternalError) # type LogPayload (GargM Env BackendInternalError) # Methods initLogger :: LogInitParams (GargM Env BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 (Logger (GargM Env BackendInternalError)) # destroyLogger :: Logger (GargM Env BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 () # logMsg :: Logger (GargM Env BackendInternalError) -> LogLevel -> LogPayload (GargM Env BackendInternalError) -> GargM Env BackendInternalError () # logTxt :: Logger (GargM Env BackendInternalError) -> LogLevel -> Text -> GargM Env BackendInternalError () #
MonadLogger (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getLogger :: GargM Env BackendInternalError (Logger (GargM Env BackendInternalError)) #
MonadJobStatus (GargM Env err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types type JobHandle (GargM Env err) # type JobType (GargM Env err) # type JobOutputType (GargM Env err) # type JobEventType (GargM Env err) # Methods noJobHandle :: Proxy (GargM Env err) -> JobHandle (GargM Env err) # getLatestJobStatus :: JobHandle (GargM Env err) -> GargM Env err (JobEventType (GargM Env err)) # withTracer :: Logger (JobEventType (GargM Env err)) -> JobHandle (GargM Env err) -> (JobHandle (GargM Env err) -> GargM Env err a) -> GargM Env err a # markStarted :: Int -> JobHandle (GargM Env err) -> GargM Env err () # markProgress :: Int -> JobHandle (GargM Env err) -> GargM Env err () # markFailure :: ToHumanFriendlyError e => Int -> Maybe e -> JobHandle (GargM Env err) -> GargM Env err () # markComplete :: JobHandle (GargM Env err) -> GargM Env err () # markFailed :: ToHumanFriendlyError e => Maybe e -> JobHandle (GargM Env err) -> GargM Env err () # addMoreSteps :: Int -> JobHandle (GargM Env err) -> GargM Env err () #
MonadJob (GargM Env err) GargJob (Seq JobLog) JobLog #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getJobEnv :: GargM Env err (JobEnv GargJob (Seq JobLog) JobLog) #
type Rep Env #
Instance details Defined in Gargantext.API.Admin.EnvTypes type Rep Env = D1 ('MetaData "Env" "Gargantext.API.Admin.EnvTypes" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Env" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_env_settings") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Settings) :: S1 ('MetaSel ('Just "_env_logger") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 (Logger (GargM Env BackendInternalError)))) :: (S1 ('MetaSel ('Just "_env_pool") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 (Pool Connection)) :: (S1 ('MetaSel ('Just "_env_nodeStory") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 NodeStoryEnv) :: S1 ('MetaSel ('Just "_env_manager") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Manager)))) :: ((S1 ('MetaSel ('Just "_env_self_url") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 BaseUrl) :: (S1 ('MetaSel ('Just "_env_scrapers") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 ScrapersEnv) :: S1 ('MetaSel ('Just "_env_jobs") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 (JobEnv GargJob (Seq JobLog) JobLog)))) :: (S1 ('MetaSel ('Just "_env_config") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 GargConfig) :: (S1 ('MetaSel ('Just "_env_mail") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 MailConfig) :: S1 ('MetaSel ('Just "_env_nlp") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 NLPServerMap))))))
type LogInitParams (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type LogInitParams (GargM Env BackendInternalError) = Mode
type LogPayload (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type LogPayload (GargM Env BackendInternalError) = LogStr
data Logger (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes data Logger (GargM Env BackendInternalError) = GargLogger { logger_mode :: Mode logger_set :: LoggerSet }
type JobEventType (GargM Env err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobEventType (GargM Env err) = JobLog
type JobHandle (GargM Env err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobHandle (GargM Env err) = ConcreteJobHandle err
type JobOutputType (GargM Env err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobOutputType (GargM Env err) = JobLog
type JobType (GargM Env err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobType (GargM Env err) = GargJob

data Mode #

Constructors

Dev
Mock
Prod

Instances

Instances details

Generic Mode #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types type Rep Mode :: Type -> Type # Methods from :: Mode -> Rep Mode x # to :: Rep Mode x -> Mode #
Read Mode #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods readsPrec :: Int -> ReadS Mode # readList :: ReadS [Mode] # readPrec :: ReadPrec Mode # readListPrec :: ReadPrec [Mode] #
Show Mode #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
type Rep Mode #
Instance details Defined in Gargantext.API.Admin.EnvTypes type Rep Mode = D1 ('MetaData "Mode" "Gargantext.API.Admin.EnvTypes" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Dev" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Prod" 'PrefixI 'False) (U1 :: Type -> Type)))

modeToLoggingLevels :: Mode -> [LogLevel] #

Given the Mode the server is running in, it returns the list of allowed levels. For example for production we ignore everything which has priority lower than "warning".

mkJobHandle :: JobID 'Safe -> LoggerM (GargM Env err) JobLog -> ConcreteJobHandle err #

Creates a new concrete JobHandle, given its underlying JobID and the logging function to be used to report the status.

env_logger :: Lens' Env (Logger (GargM Env BackendInternalError)) #

env_manager :: Lens' Env Manager #

env_self_url :: Lens' Env BaseUrl #

menv_firewall :: Iso' MockEnv FireWall #

dev_env_logger :: Lens' DevEnv (Logger (GargM DevEnv BackendInternalError)) #

data MockEnv #

Constructors

MockEnv
Fields _menv_firewall :: !FireWall

Instances

Instances details

Generic MockEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types type Rep MockEnv :: Type -> Type # Methods from :: MockEnv -> Rep MockEnv x # to :: Rep MockEnv x -> MockEnv #
type Rep MockEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes type Rep MockEnv = D1 ('MetaData "MockEnv" "Gargantext.API.Admin.EnvTypes" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "MockEnv" 'PrefixI 'True) (S1 ('MetaSel ('Just "_menv_firewall") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FireWall)))

data DevEnv #

Constructors

DevEnv
Fields _dev_env_settings :: !Settings _dev_env_config :: !GargConfig _dev_env_logger :: !(Logger (GargM DevEnv BackendInternalError)) _dev_env_pool :: !(Pool Connection) _dev_env_nodeStory :: !NodeStoryEnv _dev_env_mail :: !MailConfig _dev_env_nlp :: !NLPServerMap

Instances

Instances details

HasSettings DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods settings :: Getter DevEnv Settings #
HasMail DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods mailSettings :: Getter DevEnv MailConfig #
HasNLPServer DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods nlpServer :: Getter DevEnv NLPServerMap # nlpServerGet :: Lang -> Getter DevEnv NLPServerConfig #
HasNodeArchiveStoryImmediateSaver DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasNodeArchiveStoryImmediateSaver :: Getter DevEnv (NodeId -> ArchiveList -> IO ArchiveList) #
HasNodeStoryEnv DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasNodeStory :: Getter DevEnv NodeStoryEnv #
HasNodeStoryImmediateSaver DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasNodeStoryImmediateSaver :: Getter DevEnv (NodeId -> ArchiveList -> IO ()) #
HasConfig DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods hasConfig :: Getter DevEnv GargConfig #
HasConnectionPool DevEnv #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods connPool :: Getter DevEnv (Pool Connection) #
HasLogger (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types data Logger (GargM DevEnv BackendInternalError) # type LogInitParams (GargM DevEnv BackendInternalError) # type LogPayload (GargM DevEnv BackendInternalError) # Methods initLogger :: LogInitParams (GargM DevEnv BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 (Logger (GargM DevEnv BackendInternalError)) # destroyLogger :: Logger (GargM DevEnv BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 () # logMsg :: Logger (GargM DevEnv BackendInternalError) -> LogLevel -> LogPayload (GargM DevEnv BackendInternalError) -> GargM DevEnv BackendInternalError () # logTxt :: Logger (GargM DevEnv BackendInternalError) -> LogLevel -> Text -> GargM DevEnv BackendInternalError () #
MonadLogger (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getLogger :: GargM DevEnv BackendInternalError (Logger (GargM DevEnv BackendInternalError)) #
MonadJobStatus (GargM DevEnv err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types type JobHandle (GargM DevEnv err) # type JobType (GargM DevEnv err) # type JobOutputType (GargM DevEnv err) # type JobEventType (GargM DevEnv err) # Methods noJobHandle :: Proxy (GargM DevEnv err) -> JobHandle (GargM DevEnv err) # getLatestJobStatus :: JobHandle (GargM DevEnv err) -> GargM DevEnv err (JobEventType (GargM DevEnv err)) # withTracer :: Logger (JobEventType (GargM DevEnv err)) -> JobHandle (GargM DevEnv err) -> (JobHandle (GargM DevEnv err) -> GargM DevEnv err a) -> GargM DevEnv err a # markStarted :: Int -> JobHandle (GargM DevEnv err) -> GargM DevEnv err () # markProgress :: Int -> JobHandle (GargM DevEnv err) -> GargM DevEnv err () # markFailure :: ToHumanFriendlyError e => Int -> Maybe e -> JobHandle (GargM DevEnv err) -> GargM DevEnv err () # markComplete :: JobHandle (GargM DevEnv err) -> GargM DevEnv err () # markFailed :: ToHumanFriendlyError e => Maybe e -> JobHandle (GargM DevEnv err) -> GargM DevEnv err () # addMoreSteps :: Int -> JobHandle (GargM DevEnv err) -> GargM DevEnv err () #
type LogInitParams (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type LogInitParams (GargM DevEnv BackendInternalError) = Mode
type LogPayload (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type LogPayload (GargM DevEnv BackendInternalError) = LogStr
data Logger (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes data Logger (GargM DevEnv BackendInternalError) = GargDevLogger { dev_logger_mode :: Mode dev_logger_set :: LoggerSet }
type JobEventType (GargM DevEnv err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobEventType (GargM DevEnv err) = JobLog
type JobHandle (GargM DevEnv err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobHandle (GargM DevEnv err) = DevJobHandle
type JobOutputType (GargM DevEnv err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobOutputType (GargM DevEnv err) = JobLog
type JobType (GargM DevEnv err) #
Instance details Defined in Gargantext.API.Admin.EnvTypes type JobType (GargM DevEnv err) = GargJob

data DevJobHandle #

Our mock job handle.

Constructors

DevJobHandle

data ConcreteJobHandle err #

The concrete JobHandle in use with our GargM (production) monad. Its constructor it's not exported, to not leak internal details of its implementation.