refactoring(logging): rename withLoggerHoisted to withLoggerIO

This will allow us to find all the use site of this function, trying to
see if we can use only `withLogger` or correctly control the logging
verbosity via the `HasLogger` and `LogInitParams`.

src/Gargantext/API.hs

@@ -55,7 +55,7 @@ import Gargantext.Core.Notifications (withNotifications)
 import Gargantext.Database.Prelude qualified as DB
 import Gargantext.MicroServices.ReverseProxy (microServicesProxyApp)
 import Gargantext.Prelude hiding (putStrLn, to)
-import Gargantext.System.Logging (withLoggerHoisted)
+import Gargantext.System.Logging (withLoggerIO)
 import Network.HTTP.Types hiding (Query)
 import Network.Wai (Middleware, Request, requestHeaders)
 import Network.Wai.Handler.Warp hiding (defaultSettings)
@@ -70,7 +70,7 @@ import System.Cron.Schedule qualified as Cron
 
 -- | startGargantext takes as parameters port number and Toml file.
 startGargantext :: Mode -> PortNumber -> SettingsFile -> IO ()
-startGargantext mode port sf@(SettingsFile settingsFile) = withLoggerHoisted mode $ \logger -> do
+startGargantext mode port sf@(SettingsFile settingsFile) = withLoggerIO mode $ \logger -> do
   config <- readConfig sf <&> (gc_frontend_config . fc_appPort) .~ port
   when (port /= config ^. gc_frontend_config . fc_appPort) $
     panicTrace "TODO: conflicting settings of port"

src/Gargantext/API/Dev.hs

@@ -26,13 +26,13 @@ import Gargantext.Core.Config.Utils (readConfig)
 import Gargantext.Core.NodeStory (fromDBNodeStoryEnv)
 import Gargantext.Database.Prelude (Cmd, CmdRandom, connPool, runCmd)
 import Gargantext.Prelude
-import Gargantext.System.Logging ( withLoggerHoisted )
+import Gargantext.System.Logging ( withLoggerIO )
 import Network.HTTP.Client.TLS (newTlsManager)
 import Servant ( ServerError )
 
 -------------------------------------------------------------------
 withDevEnv :: SettingsFile -> (DevEnv -> IO a) -> IO a
-withDevEnv settingsFile k = withLoggerHoisted Dev $ \logger -> do
+withDevEnv settingsFile k = withLoggerIO Dev $ \logger -> do
   env <- newDevEnv logger
   k env -- `finally` cleanEnv env
 

src/Gargantext/Core/Worker/Env.hs

@@ -43,7 +43,7 @@ import Gargantext.Database.Prelude (HasConnectionPool(..))
 import Gargantext.Database.Query.Table.Node.Error (HasNodeError(..))
 import Gargantext.Database.Query.Tree.Error (HasTreeError(..))
 import Gargantext.Prelude hiding (to)
-import Gargantext.System.Logging (HasLogger(..), Logger, LogLevel(..), MonadLogger(..), withLogger, logMsg, withLoggerHoisted)
+import Gargantext.System.Logging (HasLogger(..), Logger, LogLevel(..), MonadLogger(..), withLogger, logMsg, withLoggerIO)
 import Gargantext.Utils.Jobs.Monad ( MonadJobStatus(..), JobHandle )
 import GHC.IO.Exception (IOException(..), IOErrorType(OtherError))
 import Prelude qualified
@@ -68,7 +68,7 @@ data WorkerJobState = WorkerJobState
 
 
 withWorkerEnv :: SettingsFile -> (WorkerEnv -> IO a) -> IO a
-withWorkerEnv settingsFile k = withLoggerHoisted Dev $ \logger -> do
+withWorkerEnv settingsFile k = withLoggerIO Dev $ \logger -> do
   env <- newWorkerEnv logger
   k env -- `finally` cleanEnv env
 

src/Gargantext/System/Logging.hs

@@ -10,7 +10,7 @@ module Gargantext.System.Logging (
   , logLocM
   , logLoc
   , withLogger
-  , withLoggerHoisted
+  , withLoggerIO
   ) where
 
 import Control.Exception.Safe (MonadMask, bracket)
@@ -119,11 +119,11 @@ withLogger params = bracket (initLogger params) destroyLogger
 
 -- | Like 'withLogger', but it allows creating a 'Logger' that can run in
 -- a different monad from within an 'IO' action.
-withLoggerHoisted :: (MonadBaseControl IO m, HasLogger m)
-                  => LogInitParams m
-                  -> (Logger m -> IO a)
-                  -> IO a
-withLoggerHoisted params act = bracket (initLogger params) destroyLogger act
+withLoggerIO :: (MonadBaseControl IO m, HasLogger m)
+             => LogInitParams m
+             -> (Logger m -> IO a)
+             -> IO a
+withLoggerIO params act = bracket (initLogger params) destroyLogger act
 
 -- | A plain logger in the IO monad, waiting for more serious logging solutions like
 -- the one described in https://gitlab.iscpif.fr/gargantext/haskell-gargantext/issues/229

test/Test/API/Private/Remote.hs

@@ -32,10 +32,10 @@ withTwoServerInstances :: (SpecContext (TestEnv,Wai.Application,Warp.Port) -> IO
 withTwoServerInstances action =
   withTestDB $ \testEnv1 -> do
     withTestDB $ \testEnv2 -> do
-      garg1App <- withLoggerHoisted Mock $ \ioLogger -> do
+      garg1App <- withLoggerIO Mock $ \ioLogger -> do
                    env <- newTestEnv testEnv1 ioLogger server1Port
                    makeApp env
-      garg2App <- withLoggerHoisted Mock $ \ioLogger -> do
+      garg2App <- withLoggerIO Mock $ \ioLogger -> do
                    env <- newTestEnv testEnv2 ioLogger server2Port
                    makeApp env
 

test/Test/API/Setup.hs

@@ -109,8 +109,8 @@ nc = NotificationsConfig { _nc_central_exchange_bind = "tcp://*:15560"
 -- for concurrent tests to be executed in parallel, if we need to.
 withTestDBAndPort :: (SpecContext () -> IO ()) -> IO ()
 withTestDBAndPort action = withNotifications nc $ \dispatcher -> do
-  withTestDB $ \testEnv -> do    
-    withLoggerHoisted Mock $ \ioLogger -> do
+  withTestDB $ \testEnv -> do
+    withLoggerIO Mock $ \ioLogger -> do
       env <- newTestEnv testEnv ioLogger 8080
              <&> env_dispatcher .~ dispatcher
       app <- makeApp env
@@ -133,21 +133,21 @@ withTestDBAndPort action = withNotifications nc $ \dispatcher -> do
                 withLogger () $ \ioLogger' ->
                   logTxt ioLogger' ERROR $ "[withTestDBAndPort] unknown exception: " <> show err
                 throw err
-        
+
         -- re-throw any other exceptions
         , Handler $ \(err :: SomeException) -> throw err ]
-        
+
 
 -- | Starts the backend server /and/ the microservices proxy, the former at
 -- a random port, the latter at a predictable port.
 withBackendServerAndProxy :: (((TestEnv, Warp.Port, Warp.Port)) -> IO ()) -> IO ()
 withBackendServerAndProxy action =
   withTestDB $ \testEnv -> do
-    gargApp <- withLoggerHoisted Mock $ \ioLogger -> do
+    gargApp <- withLoggerIO Mock $ \ioLogger -> do
                  env <- newTestEnv testEnv ioLogger 8080
                  makeApp env
     proxyCache <- InMemory.newCache Nothing
-    proxyApp <- withLoggerHoisted Mock $ \ioLogger -> do
+    proxyApp <- withLoggerIO Mock $ \ioLogger -> do
                   env <- newTestEnv testEnv ioLogger 8080
                   pure $ microServicesProxyApp proxyCache env
 
@@ -186,7 +186,7 @@ dbEnvSetup ctx = do
   _ <- createAliceAndBob testEnv
 
   pure ctx
-  
+
 -- show the full exceptions during testing, rather than shallowing them under a generic
 -- "Something went wrong".
 showDebugExceptions :: SomeException -> Wai.Response

test/Test/Database/Setup.hs

@@ -28,7 +28,7 @@ import Gargantext.Core.NodeStory (fromDBNodeStoryEnv)
 import Gargantext.Core.Worker (initWorkerState)
 import Gargantext.Core.Worker.Env (WorkerEnv(..))
 import Gargantext.Prelude
-import Gargantext.System.Logging (withLoggerHoisted)
+import Gargantext.System.Logging (withLoggerIO)
 import Paths_gargantext
 import Prelude qualified
 import Shelly hiding (FilePath, run)
@@ -98,7 +98,7 @@ setup = do
       bootstrapDB db pool gargConfig
       ugen <- emptyCounter
       test_nodeStory <- fromDBNodeStoryEnv pool
-      withLoggerHoisted Mock $ \logger -> do
+      withLoggerIO Mock $ \logger -> do
   
         let wPoolConfig = defaultPoolConfig (PG.connectPostgreSQL (Tmp.toConnectionString db))
                                             PG.close
@@ -107,7 +107,7 @@ setup = do
         wPool <- newPool (setNumStripes (Just 2) wPoolConfig)
         wNodeStory <- fromDBNodeStoryEnv wPool
         _w_env_job_state <- newTVarIO Nothing
-        withLoggerHoisted Mock $ \wioLogger -> do
+        withLoggerIO Mock $ \wioLogger -> do
           let wEnv = WorkerEnv { _w_env_config = gargConfig
                                , _w_env_logger = wioLogger
                                , _w_env_pool = wPool