updating eulerhs test file changes

juspay · Aug 25, 2023 · b9be8bf · b9be8bf
1 parent 9bc4544
commit b9be8bf
Show file tree

Hide file tree

Showing 126 changed files with 2,021 additions and 1,062 deletions.
diff --git a/cabal.project b/cabal.project
diff --git a/euler-hs.cabal b/euler-hs.cabal
@@ -1,13 +1,11 @@
 cabal-version: 3.0
 name:          euler-hs
 version:       3.3.2.0
-synopsis:      The Flow framework for Euler.
-description:
-homepage:       https://github.com/juspay/euler-hs
-license:
+synopsis:      The Flow framework for web backends
+license:       Apache-2.0
 author:        Juspay Technologies Pvt Ltd
-maintainer:    euler@juspay.in
-copyright:     (C) Juspay Technologies Pvt Ltd 2019-2020
+maintainer:    opensource@juspay.in
+copyright:     (C) Juspay Technologies Pvt Ltd 2019-2022
 category:      Euler
 build-type:    Simple
 tested-with:   GHC ==8.8.4 || ==8.10.7

diff --git a/src/EulerHS/ART/DBReplay.hs b/src/EulerHS/ART/DBReplay.hs
@@ -1,3 +1,14 @@
+{- |
+Module      :  EulerHS.ART.DBReplay
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+
+This module contains interpreters and methods for running `Flow` scenarios.
+-}
+
 {-# LANGUAGE DerivingStrategies  #-}
 {-# LANGUAGE RankNTypes          #-}
 {-# LANGUAGE ScopedTypeVariables #-}

diff --git a/src/EulerHS/ART/EnvVars.hs b/src/EulerHS/ART/EnvVars.hs
@@ -1,3 +1,14 @@
+{- |
+Module      :  EulerHS.ART.EnvVars
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+
+This module contains interpreters and methods for running `Flow` scenarios.
+-}
+
 {-# LANGUAGE ScopedTypeVariables #-}
 
 module EulerHS.ART.EnvVars where

diff --git a/src/EulerHS/ART/FlowUtils.hs b/src/EulerHS/ART/FlowUtils.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.ART.FlowUtils
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE AllowAmbiguousTypes #-}
 {-# LANGUAGE RankNTypes          #-}
 {-# LANGUAGE ScopedTypeVariables #-}

diff --git a/src/EulerHS/ART/ReplayFunctions.hs b/src/EulerHS/ART/ReplayFunctions.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.ART.ReplayFunctions
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE RankNTypes     #-}
 {-# LANGUAGE DerivingStrategies      #-}
 {-# LANGUAGE ScopedTypeVariables #-}

diff --git a/src/EulerHS/ART/Types.hs b/src/EulerHS/ART/Types.hs
@@ -1,3 +1,15 @@
+{- |
+Module      :  EulerHS.ART.Types
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+
+This module contains types for ART recording.
+Import this module qualified as import EulerHS.ART.Types as ART
+-}
+
 {-# LANGUAGE DerivingStrategies  #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 

diff --git a/src/EulerHS/ART/Utils.hs b/src/EulerHS/ART/Utils.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.ART.Utils
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE ScopedTypeVariables #-}
 
 module EulerHS.ART.Utils where

diff --git a/src/EulerHS/Api.hs b/src/EulerHS/Api.hs
@@ -1,3 +1,15 @@
+{- |
+Module      :  EulerHS.Api
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+
+This module contains the definition of the `EulerClient` type, which is a wrapper around `Servant.Client.Client` type.
+It also contains the definition of the `ApiTag` type, which is used to tag API calls in the logs.
+-}
+
 {-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE DeriveAnyClass #-}
 {-# LANGUAGE  RankNTypes #-}
@@ -14,11 +26,16 @@ import           Servant.Client.Core.RunClient (RunClient)
 import qualified Servant.Client.Free as SCF
 import qualified EulerHS.Options as T
 import qualified EulerHS.Logger.Types as Log
+import qualified Servant.Client as SC
+import qualified Servant.Client.Core as SCC
 
 newtype EulerClient a = EulerClient (Free SCF.ClientF a)
     deriving newtype (Functor, Applicative, Monad, RunClient)
     -- deriving stock (Show,Generic)
 
+client :: SC.HasClient EulerClient api => Proxy api -> SC.Client EulerClient api
+client api = SCC.clientIn api $ Proxy @EulerClient
+
 data LogServantRequest
   = LogServantRequest
     { url         :: String

diff --git a/src/EulerHS/ApiHelpers.hs b/src/EulerHS/ApiHelpers.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.ApiHelpers
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE RankNTypes     #-}
 {-# LANGUAGE RecordWildCards     #-}
 module EulerHS.ApiHelpers where

diff --git a/src/EulerHS/BinaryString.hs b/src/EulerHS/BinaryString.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.BinaryString
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 module EulerHS.BinaryString
 ( BinaryString(..)
 , LBinaryString(..)
@@ -15,7 +24,7 @@ import qualified Data.Text.Encoding as Encoding
 import           EulerHS.Prelude
 import           Text.Read (read)
 
--- TODO: Move to euler-db
+
 
 --------------------------------------------------------------------------
 -- Base64 encoding/decoding helpers

diff --git a/src/EulerHS/CachedSqlDBQuery.hs b/src/EulerHS/CachedSqlDBQuery.hs
@@ -1,3 +1,16 @@
+{- |
+Module      :  EulerHS.CachedSqlDBQuery
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+
+This module contains the function to create, update, delete and find rows in the database.
+This module has functions which are being used in Flows for KVDB operations.
+
+-}
+
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE AllowAmbiguousTypes #-}
 {-# OPTIONS_GHC -Wno-error=unused-top-binds #-}

diff --git a/src/EulerHS/Common.hs b/src/EulerHS/Common.hs
@@ -1,3 +1,13 @@
+{- |
+Module      :  EulerHS.Common
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+This module contains common types and functions used in EulerHS.
+-}
+
 {-# LANGUAGE DerivingVia #-}
 
 module EulerHS.Common

diff --git a/src/EulerHS/Core/Api.hs b/src/EulerHS/Core/Api.hs
@@ -1,6 +1,3 @@
-{-# LANGUAGE DerivingStrategies         #-}
-{-# LANGUAGE GeneralizedNewtypeDeriving #-}
-
 {- |
 Module      :  EulerHS.Core.Api
 Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
@@ -14,6 +11,9 @@ This module contains implementation of the low-level HTTP client subsystem.
 This is an internal module. Import EulerHS.Types instead.
 -}
 
+{-# LANGUAGE DerivingStrategies         #-}
+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
+
 
 module EulerHS.Core.Api where
 import           EulerHS.Prelude

diff --git a/src/EulerHS/Core/KVDB/Interpreter.hs b/src/EulerHS/Core/KVDB/Interpreter.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.KVDB.Interpreter
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE AllowAmbiguousTypes #-}
 module EulerHS.Core.KVDB.Interpreter
   (

diff --git a/src/EulerHS/Core/KVDB/Language.hs b/src/EulerHS/Core/KVDB/Language.hs
@@ -1,7 +1,3 @@
-{-# OPTIONS_GHC -Werror #-}
-{-# LANGUAGE DerivingStrategies    #-}
-{-# LANGUAGE MultiParamTypeClasses #-}
-
 {- |
 Module      :  EulerHS.Core.KVDB.Language
 Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
@@ -19,6 +15,10 @@ This module is internal and should not imported in the projects.
 Import 'EulerHS.Language' instead.
 -}
 
+{-# OPTIONS_GHC -Werror #-}
+{-# LANGUAGE DerivingStrategies    #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
+
 module EulerHS.Core.KVDB.Language
   (
   -- * KVDB language

diff --git a/src/EulerHS/Core/Language.hs b/src/EulerHS/Core/Language.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.Language
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {- |
 Module      :  EulerHS.Core.Language
 Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022

diff --git a/src/EulerHS/Core/Logger/Impl/TinyLogger.hs b/src/EulerHS/Core/Logger/Impl/TinyLogger.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.Logger.Impl.TinyLogger
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 module EulerHS.Core.Logger.Impl.TinyLogger
   (
     -- * TinyLogger Implementation

diff --git a/src/EulerHS/Core/Logger/Interpreter.hs b/src/EulerHS/Core/Logger/Interpreter.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.Logger.Interpreter
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE BangPatterns #-}
 
 module EulerHS.Core.Logger.Interpreter

diff --git a/src/EulerHS/Core/Logger/Language.hs b/src/EulerHS/Core/Logger/Language.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.Logger.Language
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 {-# LANGUAGE GADTs           #-}
 {-# LANGUAGE TemplateHaskell #-}
 

diff --git a/src/EulerHS/Core/Masking.hs b/src/EulerHS/Core/Masking.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.Masking
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 module EulerHS.Core.Masking where
 
 

diff --git a/src/EulerHS/Core/PubSub/Interpreter.hs b/src/EulerHS/Core/PubSub/Interpreter.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.PubSub.Interpreter
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 module EulerHS.Core.PubSub.Interpreter where
 
 import           EulerHS.Prelude

diff --git a/src/EulerHS/Core/PubSub/Language.hs b/src/EulerHS/Core/PubSub/Language.hs
@@ -1,5 +1,3 @@
-{-# LANGUAGE DeriveFunctor #-}
-
 {- |
 Module      :  EulerHS.Core.PubSub.Language
 Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
@@ -14,6 +12,8 @@ This module is internal and should not imported in the projects.
 Import 'EulerHS.Language' instead.
 -}
 
+{-# LANGUAGE DeriveFunctor #-}
+
 module EulerHS.Core.PubSub.Language where
 
 import           EulerHS.Prelude

diff --git a/src/EulerHS/Core/Runtime.hs b/src/EulerHS/Core/Runtime.hs
@@ -45,7 +45,7 @@ import           EulerHS.Core.Types.DB as X (withTransaction)
 import qualified System.Logger as Log
 
 
--- TODO: add StaticLoggerRuntimeContext if we'll need more than a single Bool
+
 data LoggerRuntime
   = LoggerRuntime
     { _flowFormatter    :: T.FlowFormatter
@@ -62,12 +62,6 @@ data CoreRuntime = CoreRuntime
     { _loggerRuntime :: LoggerRuntime
     }
 
--- createLoggerRuntime :: LoggerConfig -> IO LoggerRuntime
--- createLoggerRuntime (MemoryLoggerConfig cfgLogLevel) =
---   MemoryLoggerRuntime cfgLogLevel <$> newMVar []
--- createLoggerRuntime cfg = do
---   counter <- initLogCounter
---   LoggerRuntime (_level cfg) (_logRawSql cfg) counter Nothing Nothing (_logMaskingConfig cfg)<$> Impl.createLogger cfg
 
 createMemoryLoggerRuntime :: T.FlowFormatter -> T.LogLevel -> IO LoggerRuntime
 createMemoryLoggerRuntime flowFormatter logLevel =

diff --git a/src/EulerHS/Core/SqlDB/Interpreter.hs b/src/EulerHS/Core/SqlDB/Interpreter.hs
@@ -1,3 +1,12 @@
+{- |
+Module      :  EulerHS.Core.SqlDB.Interpreter
+Copyright   :  (C) Juspay Technologies Pvt Ltd 2019-2022
+License     :  Apache 2.0 (see the file LICENSE)
+Maintainer  :  opensource@juspay.in
+Stability   :  experimental
+Portability :  non-portable
+-}
+
 module EulerHS.Core.SqlDB.Interpreter
   (
   -- * SQL DB Interpreter
@@ -11,7 +20,6 @@ import qualified EulerHS.Core.Types as T
 
 import           Control.Exception (throwIO)
 
--- TODO: The runner runner gets composed in in `sqlDBMethod`. Move it into the interpreter!
 interpretSqlDBMethod
   :: T.NativeSqlConn
   -> (Text -> IO ())