src/Gargantext/API/Dev.hs

   1 {-|
   2 Module      : Gargantext.API.Dev
   3 Description :
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 -}
  11
  12 -- Use only for dev/repl
  13 module Gargantext.API.Dev where
  14
  15 import Control.Exception (finally)
  16 import Control.Monad (fail)
  17 import Control.Monad.Reader (runReaderT)
  18 import Gargantext.API.Admin.EnvTypes
  19 import Gargantext.API.Admin.Settings
  20 import Gargantext.API.Ngrams (saveNodeStory)
  21 import Gargantext.API.Prelude
  22 import Gargantext.Core.NodeStory
  23 import Gargantext.Database.Prelude
  24 import Gargantext.Prelude
  25 import Gargantext.Prelude.Config (GargConfig(..), readConfig)
  26 import qualified Gargantext.Prelude.Mail as Mail
  27 import Servant
  28 import System.IO (FilePath)
  29
  30 type IniPath  = FilePath
  31 -------------------------------------------------------------------
  32 withDevEnv :: IniPath -> (DevEnv -> IO a) -> IO a
  33 withDevEnv iniPath k = do
  34   env <- newDevEnv
  35   k env -- `finally` cleanEnv env
  36
  37   where
  38     newDevEnv = do
  39       cfg     <- readConfig         iniPath
  40       dbParam <- databaseParameters iniPath
  41       nodeStory_env <- readNodeStoryEnv (_gc_repofilepath cfg)
  42       pool    <- newPool            dbParam
  43       setts   <- devSettings devJwkFile
  44       mail    <- Mail.readConfig iniPath
  45       pure $ DevEnv
  46         { _dev_env_pool     = pool
  47         , _dev_env_nodeStory  = nodeStory_env
  48         , _dev_env_settings = setts
  49         , _dev_env_config   = cfg
  50         , _dev_env_mail      = mail
  51         }
  52
  53 -- | Run Cmd Sugar for the Repl (GHCI)
  54 runCmdRepl :: Show err => Cmd'' DevEnv err a -> IO a
  55 runCmdRepl f = withDevEnv "gargantext.ini" $ \env -> runCmdDev env f
  56
  57 runCmdReplServantErr :: Cmd'' DevEnv ServerError a -> IO a
  58 runCmdReplServantErr = runCmdRepl
  59
  60 -- In particular this writes the repo file after running
  61 -- the command.
  62 -- This function is constrained to the DevEnv rather than
  63 -- using HasConnectionPool and HasRepoVar.
  64 runCmdDev :: (Show err) => DevEnv -> Cmd'' DevEnv err a -> IO a
  65 runCmdDev env f =
  66   (either (fail . show) pure =<< runCmd env f)
  67     `finally`
  68   runReaderT saveNodeStory env
  69
  70 runCmdDevNoErr :: DevEnv -> Cmd' DevEnv () a -> IO a
  71 runCmdDevNoErr = runCmdDev
  72
  73 runCmdDevServantErr :: DevEnv -> Cmd' DevEnv ServerError a -> IO a
  74 runCmdDevServantErr = runCmdDev
  75
  76 runCmdReplEasy :: Cmd'' DevEnv GargError a -> IO a
  77 runCmdReplEasy f = withDevEnv "gargantext.ini" $ \env -> runCmdDev env f