version 0.1.1.1: logging changed (#3)

Author: ozzzzz

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1.1] - 2018-09-12
+### Changed
+- Logging format. Now it is look like: `{"app":"scotty","msg":"GET /v1/ping 200","timestamp":0,"level":"INFO","datetime":"1970-01-01T00:00:00+0000"}`. TODO: use correct time.

src/Web/Template/Log.hs

@@ -0,0 +1,33 @@
+{-# LANGUAGE OverloadedStrings #-}
+
+module Web.Template.Log
+  (
+    bcdlog
+  ) where
+
+import qualified Data.ByteString.Char8                as BS8 (pack)
+import           Data.Default                         (Default (..))
+import           Data.Monoid                          ((<>))
+import           Data.Text.Encoding                   (decodeUtf8)
+import           Network.HTTP.Types.Status            (Status (..))
+import           Network.Wai                          (Middleware, rawPathInfo,
+                                                       requestMethod)
+import           Network.Wai.Middleware.RequestLogger (OutputFormat (..),
+                                                       OutputFormatter,mkRequestLogger,
+                                                       outputFormat)
+import           System.BCD.Log                       (Level (..), Log (..),
+                                                       format)
+import           System.Log.FastLogger                (toLogStr)
+
+bcdlog :: IO Middleware
+bcdlog = mkRequestLogger $ def {outputFormat = CustomOutputFormat customFormatter}
+
+customFormatter :: OutputFormatter
+customFormatter _ request status _ = do
+    let msg' = requestMethod request <> " " <>
+               rawPathInfo request <> " " <>
+               (BS8.pack . show . statusCode $ status)
+    -- TODO: time and formatted time are not correct now. It can be parsed
+    -- from first argument of 'OutputFormatter' and reformatted.
+    let log' = Log "1970-01-01T00:00:00+0000" 0 INFO "scotty" (decodeUtf8 msg')
+    toLogStr . format $ log'

src/Web/Template/Server.hs

@@ -11,33 +11,31 @@ module Web.Template.Server
   , defaultHandleLog
   ) where
 
-import           Control.Monad.RWS                    (evalRWST)
-import           Data.String                          (fromString)
-import           Data.Text.Encoding                   (encodeUtf8)
-import           Data.Text.Lazy                       as TL (Text, toStrict)
-import           Network.HTTP.Types.Status            (status401, status405)
-import           Network.Wai                          (Response)
-import           Network.Wai.Handler.Warp             (defaultSettings,
-                                                       exceptionResponseForDebug,
-                                                       setOnExceptionResponse,
-                                                       setPort)
-import           Network.Wai.Middleware.RequestLogger (logStdout)
-import           Web.Cookie                           (parseCookiesText)
-import           Web.Scotty.Trans                     (Options (..),
-                                                       defaultHandler, header,
-                                                       json, middleware, param,
-                                                       scottyOptsT, status)
-import           Web.Template.Except                  (JsonWebError (..),
-                                                       handleEx)
+import           Control.Monad.RWS         (evalRWST)
+import           Data.String               (fromString)
+import           Data.Text.Encoding        (encodeUtf8)
+import           Data.Text.Lazy            as TL (Text, toStrict)
+import           Network.HTTP.Types.Status (status401, status405)
+import           Network.Wai               (Response)
+import           Network.Wai.Handler.Warp  (defaultSettings,
+                                            exceptionResponseForDebug,
+                                            setOnExceptionResponse, setPort)
+import           Web.Cookie                (parseCookiesText)
+import           Web.Scotty.Trans          (Options (..), defaultHandler,
+                                            header, json, middleware, param,
+                                            scottyOptsT, status)
+import           Web.Template.Except       (JsonWebError (..), handleEx)
+import           Web.Template.Log          (bcdlog)
 import           Web.Template.Types
 
 -- | For given port and server settings run the server.
 runWebServer :: (Monoid w, Show w) => Port -> CustomWebServer r w s -> IO ()
-runWebServer port CustomWebServer{..} = scottyOptsT (scottyOpts port) (handleLog .
-                                                    (\rws -> evalRWST rws readerEnv stateEnv)) $ do
-    middleware logStdout
-    defaultHandler handleEx
-    mapM_ runRoute routes
+runWebServer port CustomWebServer{..} = do
+    customLog <- bcdlog
+    scottyOptsT (scottyOpts port) (handleLog . (\rws -> evalRWST rws readerEnv stateEnv)) $ do
+        middleware customLog
+        defaultHandler handleEx
+        mapM_ runRoute routes
 
 defaultHandleLog :: Show w => IO (Response, w) -> IO Response
 defaultHandleLog = (print . snd <$>) >> (fst <$>)
@@ -70,3 +68,4 @@ checkVersion version route = do
 
 getIdFromCookies :: TL.Text -> Maybe UserId
 getIdFromCookies cookies = lookup "id" $ parseCookiesText $ encodeUtf8 $ toStrict cookies
+

web-template.cabal

@@ -1,5 +1,5 @@
 name:                web-template
-version:             0.1.1.0
+version:             0.1.1.1
 synopsis:            Web template
 description:
             Web template includes:
@@ -24,17 +24,22 @@ library
   other-modules:       Web.Template.Except
                      , Web.Template.Server
                      , Web.Template.Types
+                     , Web.Template.Log
   build-depends:       base >= 4.7 && < 5
-                     , scotty
+                     , aeson
+                     , bytestring
+                     , bcd-log
+                     , cookie
+                     , data-default
+                     , fast-logger
                      , http-types
                      , mtl
-                     , text
                      , optparse-generic
-                     , cookie
-                     , aeson
-                     , warp
+                     , scotty
+                     , text
                      , wai
                      , wai-extra
+                     , warp
   default-language:    Haskell2010
 
 executable web-template