{-# LANGUAGE CPP                   #-}
{-# LANGUAGE DataKinds             #-}
{-# LANGUAGE DeriveFunctor         #-}
{-# LANGUAGE FlexibleContexts      #-}
{-# LANGUAGE FlexibleInstances     #-}
{-# LANGUAGE GADTs                 #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedLabels      #-}
{-# LANGUAGE TypeFamilies          #-}

{- |
Copyright:  (c) 2018-2022 Kowainik
SPDX-License-Identifier: MPL-2.0
Maintainer: Kowainik <xrom.xkov@gmail.com>

This module contains logging messages data types along with the formatting and
logging actions for them.
-}

module Colog.Message
       ( -- * Simple message type
         -- ** Type
         SimpleMsg (..)
         -- ** Logging
       , logText
         -- ** Formatting
       , fmtSimpleMessage
       , formatWith

         -- * Core messaging
         -- ** Types
       , Msg (..)
       , Message
         -- ** Logging
       , log
       , logDebug
       , logInfo
       , logWarning
       , logError
       , logException
         -- ** Formatting
       , fmtMessage
       , showSeverity
       , showSourceLoc
       , showTime
       , showTimeOffset
       , showThreadId

         -- * Externally extensible message type
         -- ** Field of the dependent map
       , FieldType
       , MessageField (..)
       , unMessageField
       , extractField
         -- ** Dependent map that allows to extend logging message
       , FieldMap
       , defaultFieldMap

         -- ** Extensible message
       , RichMessage
       , RichMsg (..)
       , fmtRichMessageDefault
       , fmtSimpleRichMessageDefault
       , fmtRichMessageCustomDefault
       , upgradeMessageAction
       ) where

import Prelude hiding (log)

import Control.Concurrent (ThreadId, myThreadId)
import Control.Exception (Exception, displayException)
import Control.Monad.IO.Class (MonadIO (..))
import Data.Kind (Type)
import Data.Text (Text)
import Data.Text.Lazy (toStrict)
import Data.TypeRepMap (TypeRepMap)
import GHC.Exts (IsList (..))
import GHC.OverloadedLabels (IsLabel (..))
import GHC.Stack (CallStack, SrcLoc (..), callStack, getCallStack, withFrozenCallStack)
import GHC.TypeLits (KnownSymbol, Symbol)
import System.Console.ANSI (Color (..), ColorIntensity (Vivid), ConsoleLayer (Foreground), SGR (..),
                            setSGRCode)

import Colog.Core (LogAction, Severity (..), cmap)
import Colog.Monad (WithLog, logMsg)

import qualified Chronos as C
import qualified Chronos.Locale.English as C
import qualified Data.Text as T
import qualified Data.Text.Lazy.Builder as TB
import qualified Data.Text.Lazy.Builder.Int as TB
import qualified Data.TypeRepMap as TM
import qualified Data.Vector as Vector

----------------------------------------------------------------------------
-- Plain message
----------------------------------------------------------------------------

{- | General logging message data type. Contains the following fields:

1. Polymorphic severity. This can be anything you want if you need more
flexibility.
2. Function 'CallStack'. It provides useful information about source code
locations where each particular function was called.
3. Custom text for logging.
-}
data Msg sev = Msg
    { Msg sev -> sev
msgSeverity :: !sev
    , Msg sev -> CallStack
msgStack    :: !CallStack
    , Msg sev -> Text
msgText     ::  Text
    }

{- | Message data type without 'Severity'. Use 'logText' to log
messages of this type.

@since 0.4.0.0
-}
data SimpleMsg = SimpleMsg
    { SimpleMsg -> CallStack
simpleMsgStack :: !CallStack
    , SimpleMsg -> Text
simpleMsgText  :: !Text
    }

{- | 'Msg' parametrized by the 'Severity' type. Most formatting functions in
this module work with 'Severity' from @co-log-core@.
-}
type Message = Msg Severity

-- | Logs the message with given severity @sev@.
log :: WithLog env (Msg sev) m => sev -> Text -> m ()
log :: sev -> Text -> m ()
log sev
msgSeverity Text
msgText =
    (HasCallStack => m ()) -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (Msg sev -> m ()
forall msg env (m :: * -> *). WithLog env msg m => msg -> m ()
logMsg Msg :: forall sev. sev -> CallStack -> Text -> Msg sev
Msg{ msgStack :: CallStack
msgStack = CallStack
HasCallStack => CallStack
callStack, sev
Text
msgText :: Text
msgSeverity :: sev
msgText :: Text
msgSeverity :: sev
.. })

-- | Logs the message with the 'Debug' severity.
logDebug :: WithLog env Message m => Text -> m ()
logDebug :: Text -> m ()
logDebug = (HasCallStack => Text -> m ()) -> Text -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (Severity -> Text -> m ()
forall env sev (m :: * -> *).
WithLog env (Msg sev) m =>
sev -> Text -> m ()
log Severity
Debug)

-- | Logs the message with the 'Info' severity.
logInfo :: WithLog env Message m => Text -> m ()
logInfo :: Text -> m ()
logInfo = (HasCallStack => Text -> m ()) -> Text -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (Severity -> Text -> m ()
forall env sev (m :: * -> *).
WithLog env (Msg sev) m =>
sev -> Text -> m ()
log Severity
Info)

-- | Logs the message with the 'Warning' severity.
logWarning :: WithLog env Message m => Text -> m ()
logWarning :: Text -> m ()
logWarning = (HasCallStack => Text -> m ()) -> Text -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (Severity -> Text -> m ()
forall env sev (m :: * -> *).
WithLog env (Msg sev) m =>
sev -> Text -> m ()
log Severity
Warning)

-- | Logs the message with the 'Error' severity.
logError :: WithLog env Message m => Text -> m ()
logError :: Text -> m ()
logError = (HasCallStack => Text -> m ()) -> Text -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (Severity -> Text -> m ()
forall env sev (m :: * -> *).
WithLog env (Msg sev) m =>
sev -> Text -> m ()
log Severity
Error)

-- | Logs 'Exception' message with the 'Error' severity.
logException :: forall e m env . (WithLog env Message m, Exception e) => e -> m ()
logException :: e -> m ()
logException = (HasCallStack => e -> m ()) -> e -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (Text -> m ()
forall env (m :: * -> *). WithLog env Message m => Text -> m ()
logError (Text -> m ()) -> (e -> Text) -> e -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack (String -> Text) -> (e -> String) -> e -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. e -> String
forall e. Exception e => e -> String
displayException)

{- | Logs 'SimpleMsg' without severity, only 'CallStack' and 'Text'
body message.

@since 0.4.0.0
-}
logText :: WithLog env SimpleMsg m => Text -> m ()
logText :: Text -> m ()
logText Text
msgText = (HasCallStack => m ()) -> m ()
forall a. HasCallStack => (HasCallStack => a) -> a
withFrozenCallStack (SimpleMsg -> m ()
forall msg env (m :: * -> *). WithLog env msg m => msg -> m ()
logMsg SimpleMsg :: CallStack -> Text -> SimpleMsg
SimpleMsg{ simpleMsgStack :: CallStack
simpleMsgStack = CallStack
HasCallStack => CallStack
callStack, simpleMsgText :: Text
simpleMsgText = Text
msgText })

{- | Formats the 'Message' type according to the following format:

@
[Severity] [SourceLocation] \<Text message\>
@

__Examples:__

@
[Warning] [Main.app#39] Starting application...
[Debug]   [Main.example#34] app: First message...
@

See 'fmtRichMessageDefault' for a richer format.
-}
fmtMessage :: Message -> Text
fmtMessage :: Message -> Text
fmtMessage Msg{CallStack
Severity
Text
msgText :: Text
msgStack :: CallStack
msgSeverity :: Severity
msgText :: forall sev. Msg sev -> Text
msgStack :: forall sev. Msg sev -> CallStack
msgSeverity :: forall sev. Msg sev -> sev
..} =
    Severity -> Text
showSeverity Severity
msgSeverity
    Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> CallStack -> Text
showSourceLoc CallStack
msgStack
    Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
msgText

{- | Formats the 'SimpleMsg' type in according to the following format:

@
[SourceLocation] \<Text message\>
@

__Examples:__

@
[Main.app#39] Starting application...
[Main.example#34] app: First message...
@

See 'fmtSimpleRichMessageDefault' for richer format.

@since 0.4.0.0
-}
fmtSimpleMessage :: SimpleMsg -> Text
fmtSimpleMessage :: SimpleMsg -> Text
fmtSimpleMessage SimpleMsg{CallStack
Text
simpleMsgText :: Text
simpleMsgStack :: CallStack
simpleMsgText :: SimpleMsg -> Text
simpleMsgStack :: SimpleMsg -> CallStack
..} = CallStack -> Text
showSourceLoc CallStack
simpleMsgStack Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
simpleMsgText

{- | Alias for 'cmap' specialized for formatting purposes. If you have
an action that can output 'Text' (for example
'Colog.Actions.logTextStdout'), you can convert it to the action that
can print 'SimpleMsg' or 'Message':

@
logSimpleMsgStdout :: 'LogAction' 'IO' 'SimpleMsg'
logSimpleMsgStdout = 'formatWith' 'fmtSimpleMessage' 'Colog.Actions.logTextStdout'

logMessageStdout :: 'LogAction' 'IO' 'Message'
logMessageStdout = 'formatWith' 'fmtMessage' 'Colog.Actions.logTextStdout'
@

@since 0.4.0.0
-}
formatWith :: (msg -> Text) -> LogAction m Text -> LogAction m msg
formatWith :: (msg -> Text) -> LogAction m Text -> LogAction m msg
formatWith = (msg -> Text) -> LogAction m Text -> LogAction m msg
forall a b (m :: * -> *).
(a -> b) -> LogAction m b -> LogAction m a
cmap
{-# INLINE formatWith #-}

{- | Formats severity in different colours with alignment.
-}
showSeverity :: Severity -> Text
showSeverity :: Severity -> Text
showSeverity = \case
    Severity
Debug   -> Color -> Text -> Text
color Color
Green  Text
"[Debug]   "
    Severity
Info    -> Color -> Text -> Text
color Color
Blue   Text
"[Info]    "
    Severity
Warning -> Color -> Text -> Text
color Color
Yellow Text
"[Warning] "
    Severity
Error   -> Color -> Text -> Text
color Color
Red    Text
"[Error]   "
 where
    color :: Color -> Text -> Text
    color :: Color -> Text -> Text
color Color
c Text
txt =
        String -> Text
T.pack ([SGR] -> String
setSGRCode [ConsoleLayer -> ColorIntensity -> Color -> SGR
SetColor ConsoleLayer
Foreground ColorIntensity
Vivid Color
c])
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
txt
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack ([SGR] -> String
setSGRCode [SGR
Reset])

square :: Text -> Text
square :: Text -> Text
square Text
t = Text
"[" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
t Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"] "

{- | Shows source code locations in the following format:

@
[Main.example#35]
@
-}
showSourceLoc :: CallStack -> Text
showSourceLoc :: CallStack -> Text
showSourceLoc CallStack
cs = Text -> Text
square Text
showCallStack
  where
    showCallStack :: Text
    showCallStack :: Text
showCallStack = case CallStack -> [(String, SrcLoc)]
getCallStack CallStack
cs of
        []                             -> Text
"<unknown loc>"
        [(String
name, SrcLoc
loc)]                  -> String -> SrcLoc -> Text
showLoc String
name SrcLoc
loc
        (String
_, SrcLoc
loc) : (String
callerName, SrcLoc
_) : [(String, SrcLoc)]
_ -> String -> SrcLoc -> Text
showLoc String
callerName SrcLoc
loc

    showLoc :: String -> SrcLoc -> Text
    showLoc :: String -> SrcLoc -> Text
showLoc String
name SrcLoc{Int
String
srcLocPackage :: SrcLoc -> String
srcLocModule :: SrcLoc -> String
srcLocFile :: SrcLoc -> String
srcLocStartLine :: SrcLoc -> Int
srcLocStartCol :: SrcLoc -> Int
srcLocEndLine :: SrcLoc -> Int
srcLocEndCol :: SrcLoc -> Int
srcLocEndCol :: Int
srcLocEndLine :: Int
srcLocStartCol :: Int
srcLocStartLine :: Int
srcLocFile :: String
srcLocModule :: String
srcLocPackage :: String
..} =
        String -> Text
T.pack String
srcLocModule Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"." Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack String
name Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"#" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
srcLocStartLine)

----------------------------------------------------------------------------
-- Externally extensible message
----------------------------------------------------------------------------

{- | Open type family that maps some user defined tags (type names) to actual
types. The type family is open so you can add new instances.
-}
type family FieldType (fieldName :: Symbol) :: Type
type instance FieldType "threadId"  = ThreadId
type instance FieldType "posixTime" = C.Time

{- | @newtype@ wrapper. Stores monadic ability to extract value of 'FieldType'.

__Implementation detail:__ this exotic writing of 'MessageField' is required in
order to use it nicer with type applications. So users can write

@
MessageField @"threadId" myThreadId
@

instead of

@
MessageField @_ @"threadId" myThreadId
@

Simpler version of this @newtype@:

@
newtype MessageField m fieldName = MessageField
    { unMesssageField :: m (FieldType fieldName)
    }
@
-}
newtype MessageField (m :: Type -> Type) (fieldName :: Symbol) where
    MessageField :: forall fieldName m . m (FieldType fieldName) -> MessageField m fieldName

-- | Extracts field from the 'MessageField' constructor.
unMessageField :: forall fieldName m . MessageField m fieldName -> m (FieldType fieldName)
unMessageField :: MessageField m fieldName -> m (FieldType fieldName)
unMessageField (MessageField m (FieldType fieldName)
f) = m (FieldType fieldName)
f
{-# INLINE unMessageField #-}

instance (KnownSymbol fieldName, a ~ m (FieldType fieldName))
      => IsLabel fieldName (a -> TM.WrapTypeable (MessageField m)) where
#if MIN_VERSION_base(4,11,0)
    fromLabel :: a -> WrapTypeable (MessageField m)
fromLabel a
field = MessageField m fieldName -> WrapTypeable (MessageField m)
forall k (a :: k) (f :: k -> *).
Typeable a =>
f a -> WrapTypeable f
TM.WrapTypeable (MessageField m fieldName -> WrapTypeable (MessageField m))
-> MessageField m fieldName -> WrapTypeable (MessageField m)
forall a b. (a -> b) -> a -> b
$ m (FieldType fieldName) -> MessageField m fieldName
forall (fieldName :: Symbol) (m :: * -> *).
m (FieldType fieldName) -> MessageField m fieldName
MessageField @fieldName a
m (FieldType fieldName)
field
#else
    fromLabel field = TM.WrapTypeable $ MessageField  @_ @fieldName field
#endif
    {-# INLINE fromLabel #-}

-- | Helper function to deal with 'MessageField' when looking it up in the 'FieldMap'.
extractField
    :: Applicative m
    => Maybe (MessageField m fieldName)
    -> m (Maybe (FieldType fieldName))
extractField :: Maybe (MessageField m fieldName) -> m (Maybe (FieldType fieldName))
extractField = (MessageField m fieldName -> m (FieldType fieldName))
-> Maybe (MessageField m fieldName)
-> m (Maybe (FieldType fieldName))
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
traverse MessageField m fieldName -> m (FieldType fieldName)
forall (fieldName :: Symbol) (m :: * -> *).
MessageField m fieldName -> m (FieldType fieldName)
unMessageField
{-# INLINE extractField #-}

-- same as:
-- extractField = \case
--    Nothing -> pure Nothing
--    Just (MessageField field) -> Just <$> field

{- | Depedent map from type level strings to the corresponding types. See
'FieldType' for mapping between names and types.
-}
type FieldMap (m :: Type -> Type) = TypeRepMap (MessageField m)

{- | Default message map that contains actions to extract 'ThreadId' and
'C.Time'. Basically, the following mapping:

@
"threadId"  -> 'myThreadId'
"posixTime" -> 'C.now'
@
-}
defaultFieldMap :: MonadIO m => FieldMap m
defaultFieldMap :: FieldMap m
defaultFieldMap = [Item (FieldMap m)] -> FieldMap m
forall l. IsList l => [Item l] -> l
fromList
    [ IsLabel "threadId" (m ThreadId -> WrapTypeable (MessageField m))
m ThreadId -> WrapTypeable (MessageField m)
#threadId  (IO ThreadId -> m ThreadId
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO IO ThreadId
myThreadId)
    , IsLabel "posixTime" (m Time -> WrapTypeable (MessageField m))
m Time -> WrapTypeable (MessageField m)
#posixTime (IO Time -> m Time
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO IO Time
C.now)
    ]

{- | Contains additional data to 'Message' to display more verbose information.

@since 0.4.0.0
-}
data RichMsg (m :: Type -> Type) (msg :: Type) = RichMsg
    { RichMsg m msg -> msg
richMsgMsg :: !msg
    , RichMsg m msg -> FieldMap m
richMsgMap :: {-# UNPACK #-} !(FieldMap m)
    } deriving stock (a -> RichMsg m b -> RichMsg m a
(a -> b) -> RichMsg m a -> RichMsg m b
(forall a b. (a -> b) -> RichMsg m a -> RichMsg m b)
-> (forall a b. a -> RichMsg m b -> RichMsg m a)
-> Functor (RichMsg m)
forall a b. a -> RichMsg m b -> RichMsg m a
forall a b. (a -> b) -> RichMsg m a -> RichMsg m b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
forall (m :: * -> *) a b. a -> RichMsg m b -> RichMsg m a
forall (m :: * -> *) a b. (a -> b) -> RichMsg m a -> RichMsg m b
<$ :: a -> RichMsg m b -> RichMsg m a
$c<$ :: forall (m :: * -> *) a b. a -> RichMsg m b -> RichMsg m a
fmap :: (a -> b) -> RichMsg m a -> RichMsg m b
$cfmap :: forall (m :: * -> *) a b. (a -> b) -> RichMsg m a -> RichMsg m b
Functor)

-- | Specialised version of 'RichMsg' that stores severity, callstack and text message.
type RichMessage m = RichMsg m Message

{- | Formats 'RichMessage' in the following way:

@
[Severity] [Time] [SourceLocation] [ThreadId] \<Text message\>
@

__Examples:__

@
[Debug]   [03 May 2019 05:23:19.058 +00:00] [Main.example#34] [ThreadId 11] app: First message...
[Info]    [03 May 2019 05:23:19.059 +00:00] [Main.example#35] [ThreadId 11] app: Second message...
@

See 'fmtMessage' if you don't need both time and thread ID.
-}
fmtRichMessageDefault :: MonadIO m => RichMessage m -> m Text
fmtRichMessageDefault :: RichMessage m -> m Text
fmtRichMessageDefault RichMessage m
msg = RichMessage m
-> (Maybe ThreadId -> Maybe Time -> Message -> Text) -> m Text
forall (m :: * -> *) msg.
MonadIO m =>
RichMsg m msg
-> (Maybe ThreadId -> Maybe Time -> msg -> Text) -> m Text
fmtRichMessageCustomDefault RichMessage m
msg Maybe ThreadId -> Maybe Time -> Message -> Text
formatRichMessage
  where
    formatRichMessage :: Maybe ThreadId -> Maybe C.Time -> Message -> Text
    formatRichMessage :: Maybe ThreadId -> Maybe Time -> Message -> Text
formatRichMessage (Text -> (ThreadId -> Text) -> Maybe ThreadId -> Text
forall b a. b -> (a -> b) -> Maybe a -> b
maybe Text
"" ThreadId -> Text
showThreadId -> Text
thread) (Text -> (Time -> Text) -> Maybe Time -> Text
forall b a. b -> (a -> b) -> Maybe a -> b
maybe Text
"" Time -> Text
showTime -> Text
time) Msg{CallStack
Severity
Text
msgText :: Text
msgStack :: CallStack
msgSeverity :: Severity
msgText :: forall sev. Msg sev -> Text
msgStack :: forall sev. Msg sev -> CallStack
msgSeverity :: forall sev. Msg sev -> sev
..} =
        Severity -> Text
showSeverity Severity
msgSeverity
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
time
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> CallStack -> Text
showSourceLoc CallStack
msgStack
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
thread
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
msgText

{- | Formats 'RichMessage' in the following way:

@
[Time] [SourceLocation] [ThreadId] \<Text message\>
@

__Examples:__

@
[03 May 2019 05:23:19.058 +00:00] [Main.example#34] [ThreadId 11] app: First message...
[03 May 2019 05:23:19.059 +00:00] [Main.example#35] [ThreadId 11] app: Second message...
@

Practically, it formats a message as 'fmtRichMessageDefault' without the severity information.

@since 0.4.0.0
-}
fmtSimpleRichMessageDefault :: MonadIO m => RichMsg m SimpleMsg -> m Text
fmtSimpleRichMessageDefault :: RichMsg m SimpleMsg -> m Text
fmtSimpleRichMessageDefault RichMsg m SimpleMsg
msg = RichMsg m SimpleMsg
-> (Maybe ThreadId -> Maybe Time -> SimpleMsg -> Text) -> m Text
forall (m :: * -> *) msg.
MonadIO m =>
RichMsg m msg
-> (Maybe ThreadId -> Maybe Time -> msg -> Text) -> m Text
fmtRichMessageCustomDefault RichMsg m SimpleMsg
msg Maybe ThreadId -> Maybe Time -> SimpleMsg -> Text
formatRichMessage
  where
    formatRichMessage :: Maybe ThreadId -> Maybe C.Time -> SimpleMsg -> Text
    formatRichMessage :: Maybe ThreadId -> Maybe Time -> SimpleMsg -> Text
formatRichMessage (Text -> (ThreadId -> Text) -> Maybe ThreadId -> Text
forall b a. b -> (a -> b) -> Maybe a -> b
maybe Text
"" ThreadId -> Text
showThreadId -> Text
thread) (Text -> (Time -> Text) -> Maybe Time -> Text
forall b a. b -> (a -> b) -> Maybe a -> b
maybe Text
"" Time -> Text
showTime -> Text
time) SimpleMsg{CallStack
Text
simpleMsgText :: Text
simpleMsgStack :: CallStack
simpleMsgText :: SimpleMsg -> Text
simpleMsgStack :: SimpleMsg -> CallStack
..} =
        Text
time
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> CallStack -> Text
showSourceLoc CallStack
simpleMsgStack
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
thread
     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
simpleMsgText
{- | Custom formatting function for 'RichMsg'. It extracts 'ThreadId'
and 'C.Time' from fields and allows you to specify how to format them.

@since 0.4.0.0
-}
fmtRichMessageCustomDefault
    :: MonadIO m
    => RichMsg m msg
    -> (Maybe ThreadId -> Maybe C.Time -> msg -> Text)
    -> m Text
fmtRichMessageCustomDefault :: RichMsg m msg
-> (Maybe ThreadId -> Maybe Time -> msg -> Text) -> m Text
fmtRichMessageCustomDefault RichMsg{msg
FieldMap m
richMsgMap :: FieldMap m
richMsgMsg :: msg
richMsgMap :: forall (m :: * -> *) msg. RichMsg m msg -> FieldMap m
richMsgMsg :: forall (m :: * -> *) msg. RichMsg m msg -> msg
..} Maybe ThreadId -> Maybe Time -> msg -> Text
formatter = do
    Maybe ThreadId
maybeThreadId  <- Maybe (MessageField m "threadId")
-> m (Maybe (FieldType "threadId"))
forall (m :: * -> *) (fieldName :: Symbol).
Applicative m =>
Maybe (MessageField m fieldName) -> m (Maybe (FieldType fieldName))
extractField (Maybe (MessageField m "threadId")
 -> m (Maybe (FieldType "threadId")))
-> Maybe (MessageField m "threadId")
-> m (Maybe (FieldType "threadId"))
forall a b. (a -> b) -> a -> b
$ FieldMap m -> Maybe (MessageField m "threadId")
forall k (a :: k) (f :: k -> *).
Typeable a =>
TypeRepMap f -> Maybe (f a)
TM.lookup @"threadId"  FieldMap m
richMsgMap
    Maybe Time
maybePosixTime <- Maybe (MessageField m "posixTime")
-> m (Maybe (FieldType "posixTime"))
forall (m :: * -> *) (fieldName :: Symbol).
Applicative m =>
Maybe (MessageField m fieldName) -> m (Maybe (FieldType fieldName))
extractField (Maybe (MessageField m "posixTime")
 -> m (Maybe (FieldType "posixTime")))
-> Maybe (MessageField m "posixTime")
-> m (Maybe (FieldType "posixTime"))
forall a b. (a -> b) -> a -> b
$ FieldMap m -> Maybe (MessageField m "posixTime")
forall k (a :: k) (f :: k -> *).
Typeable a =>
TypeRepMap f -> Maybe (f a)
TM.lookup @"posixTime" FieldMap m
richMsgMap
    Text -> m Text
forall (f :: * -> *) a. Applicative f => a -> f a
pure (Text -> m Text) -> Text -> m Text
forall a b. (a -> b) -> a -> b
$ Maybe ThreadId -> Maybe Time -> msg -> Text
formatter Maybe ThreadId
maybeThreadId Maybe Time
maybePosixTime msg
richMsgMsg

{- | Shows time in the following format:

>>> showTime $ C.Time 1577656800000000000
"[29 Dec 2019 22:00:00.000 +00:00] "
-}
showTime :: C.Time -> Text
showTime :: Time -> Text
showTime Time
t =
    Text -> Text
square
    (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
$ Text -> Text
toStrict
    (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
$ Builder -> Text
TB.toLazyText
    (Builder -> Text) -> Builder -> Text
forall a b. (a -> b) -> a -> b
$ OffsetDatetime -> Builder
builderDmyHMSz (Offset -> Time -> OffsetDatetime
C.timeToOffsetDatetime (Int -> Offset
C.Offset Int
0) Time
t)

{- | Shows time in the following format:

>>> showTimeOffset $ C.timeToOffsetDatetime (C.Offset $ -120) $ C.Time 1577656800000000000
"[29 Dec 2019 20:00:00.000 -02:00] "
-}
showTimeOffset :: C.OffsetDatetime -> Text
showTimeOffset :: OffsetDatetime -> Text
showTimeOffset = Text -> Text
square (Text -> Text)
-> (OffsetDatetime -> Text) -> OffsetDatetime -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> Text
toStrict (Text -> Text)
-> (OffsetDatetime -> Text) -> OffsetDatetime -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Builder -> Text
TB.toLazyText (Builder -> Text)
-> (OffsetDatetime -> Builder) -> OffsetDatetime -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OffsetDatetime -> Builder
builderDmyHMSz

----------------------------------------------------------------------------
-- Chronos extra
----------------------------------------------------------------------------

{- | Given a 'OffsetDatetime', constructs a 'Text' 'TB.Builder' corresponding to a
Day\/Month\/Year,Hour\/Minute\/Second\/Offset encoding of the given 'OffsetDatetime'.

Example: @29 Dec 2019 22:00:00.000 +00:00@
-}
builderDmyHMSz :: C.OffsetDatetime -> TB.Builder
builderDmyHMSz :: OffsetDatetime -> Builder
builderDmyHMSz (C.OffsetDatetime (C.Datetime Date
date TimeOfDay
time) Offset
offset) =
       Date -> Builder
builderDmy Date
date
    Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> Builder
spaceSep
    Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
C.builder_HMS (Int -> SubsecondPrecision
C.SubsecondPrecisionFixed Int
3) (Char -> Maybe Char
forall a. a -> Maybe a
Just Char
':') TimeOfDay
time
    Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> Builder
spaceSep
    Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> OffsetFormat -> Offset -> Builder
C.builderOffset OffsetFormat
C.OffsetFormatColonOn Offset
offset
  where
    spaceSep :: TB.Builder
    spaceSep :: Builder
spaceSep = Char -> Builder
TB.singleton Char
' '

    {- Given a 'Date' construct a 'Text' 'TB.Builder'
    corresponding to a Day\/Month\/Year encoding.

    Example: @01 Jan 2020@
    -}
    builderDmy :: C.Date -> TB.Builder
    builderDmy :: Date -> Builder
builderDmy (C.Date (C.Year Int
y) Month
m DayOfMonth
d) =
           DayOfMonth -> Builder
zeroPadDayOfMonth DayOfMonth
d
        Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> Builder
spaceSep
        Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> Text -> Builder
TB.fromText (MonthMatch Text -> Month -> Text
forall a. MonthMatch a -> Month -> a
C.caseMonth MonthMatch Text
C.abbreviated Month
m)
        Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> Builder
spaceSep
        Builder -> Builder -> Builder
forall a. Semigroup a => a -> a -> a
<> Int -> Builder
forall a. Integral a => a -> Builder
TB.decimal Int
y


    zeroPadDayOfMonth :: C.DayOfMonth -> TB.Builder
    zeroPadDayOfMonth :: DayOfMonth -> Builder
zeroPadDayOfMonth (C.DayOfMonth Int
d) =
        if Int
d Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
100
        then Vector Builder -> Int -> Builder
forall a. Vector a -> Int -> a
Vector.unsafeIndex Vector Builder
twoDigitTextBuilder Int
d
        else Int -> Builder
forall a. Integral a => a -> Builder
TB.decimal Int
d

    twoDigitTextBuilder :: Vector.Vector TB.Builder
    twoDigitTextBuilder :: Vector Builder
twoDigitTextBuilder = [Builder] -> Vector Builder
forall a. [a] -> Vector a
Vector.fromList ([Builder] -> Vector Builder) -> [Builder] -> Vector Builder
forall a b. (a -> b) -> a -> b
$
        (String -> Builder) -> [String] -> [Builder]
forall a b. (a -> b) -> [a] -> [b]
map (Text -> Builder
TB.fromText (Text -> Builder) -> (String -> Text) -> String -> Builder
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack) [String]
twoDigitStrings
    {-# NOINLINE twoDigitTextBuilder #-}

    twoDigitStrings :: [String]
    twoDigitStrings :: [String]
twoDigitStrings =
        [ String
"00",String
"01",String
"02",String
"03",String
"04",String
"05",String
"06",String
"07",String
"08",String
"09"
        , String
"10",String
"11",String
"12",String
"13",String
"14",String
"15",String
"16",String
"17",String
"18",String
"19"
        , String
"20",String
"21",String
"22",String
"23",String
"24",String
"25",String
"26",String
"27",String
"28",String
"29"
        , String
"30",String
"31",String
"32",String
"33",String
"34",String
"35",String
"36",String
"37",String
"38",String
"39"
        , String
"40",String
"41",String
"42",String
"43",String
"44",String
"45",String
"46",String
"47",String
"48",String
"49"
        , String
"50",String
"51",String
"52",String
"53",String
"54",String
"55",String
"56",String
"57",String
"58",String
"59"
        , String
"60",String
"61",String
"62",String
"63",String
"64",String
"65",String
"66",String
"67",String
"68",String
"69"
        , String
"70",String
"71",String
"72",String
"73",String
"74",String
"75",String
"76",String
"77",String
"78",String
"79"
        , String
"80",String
"81",String
"82",String
"83",String
"84",String
"85",String
"86",String
"87",String
"88",String
"89"
        , String
"90",String
"91",String
"92",String
"93",String
"94",String
"95",String
"96",String
"97",String
"98",String
"99"
        ]

----------------------------------------------------------------------------
-- Utility functions
----------------------------------------------------------------------------

{- | Shows a thread id in the following format:

__>>__ showThreadId <$> Control.Concurrent.myThreadId
"[ThreadId 4898] "
-}
showThreadId :: ThreadId -> Text
showThreadId :: ThreadId -> Text
showThreadId = Text -> Text
square (Text -> Text) -> (ThreadId -> Text) -> ThreadId -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack (String -> Text) -> (ThreadId -> String) -> ThreadId -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ThreadId -> String
forall a. Show a => a -> String
show

{- | Allows to extend basic 'Message' type with given dependent map of fields.
-}
upgradeMessageAction
    :: forall m msg .
       FieldMap m
    -> LogAction m (RichMsg m msg)
    -> LogAction m msg
upgradeMessageAction :: FieldMap m -> LogAction m (RichMsg m msg) -> LogAction m msg
upgradeMessageAction FieldMap m
fieldMap = (msg -> RichMsg m msg)
-> LogAction m (RichMsg m msg) -> LogAction m msg
forall a b (m :: * -> *).
(a -> b) -> LogAction m b -> LogAction m a
cmap msg -> RichMsg m msg
addMap
  where
    addMap :: msg -> RichMsg m msg
    addMap :: msg -> RichMsg m msg
addMap msg
msg = msg -> FieldMap m -> RichMsg m msg
forall (m :: * -> *) msg. msg -> FieldMap m -> RichMsg m msg
RichMsg msg
msg FieldMap m
fieldMap