[CDEC-439] Move NtpConfiguration to Ntp.Client

Author: coot

auxx/Main.hs

@@ -11,6 +11,8 @@ import qualified Network.Transport.TCP as TCP (TCPAddr (..))
 import qualified System.IO.Temp as Temp
 import           System.Wlog (LoggerName, logInfo)
 
+import           Ntp.Client (NtpConfiguration)
+
 import qualified Pos.Client.CLI as CLI
 import           Pos.Context (NodeContext (..))
 import           Pos.Core (ConfigurationError, epochSlots)
@@ -21,7 +23,6 @@ import           Pos.Infra.Diffusion.Types (Diffusion, hoistDiffusion)
 import           Pos.Infra.Network.Types (NetworkConfig (..), Topology (..),
                      topologyDequeuePolicy, topologyEnqueuePolicy,
                      topologyFailurePolicy)
-import           Pos.Infra.Ntp.Configuration (NtpConfiguration)
 import           Pos.Launcher (HasConfigurations, NodeParams (..),
                      NodeResources (..), bracketNodeResources, loggerBracket,
                      lpConsoleLog, runNode, runRealMode, withConfigurations)

auxx/cardano-sl-auxx.cabal

@@ -56,6 +56,7 @@ library
                      , cardano-sl-db
                      , cardano-sl-generator
                      , cardano-sl-infra
+                     , cardano-sl-networking
                      , cardano-sl-ssc
                      , cardano-sl-txp
                      , cardano-sl-update

infra/cardano-sl-infra.cabal

@@ -98,9 +98,6 @@ library
                         Pos.Infra.Statistics.Ekg
                         Pos.Infra.Statistics.Statsd
 
-                        -- NTP
-                        Pos.Infra.Ntp.Configuration
-
                         -- Pos.Infra.Binary
                         Pos.Infra.Binary
                         Pos.Infra.Binary.DHTModel
@@ -116,7 +113,6 @@ library
   other-modules:        Paths_cardano_sl_infra
 
   build-depends:        aeson
-                      , aeson-options
                       , async
                       , base
                       , parsec

infra/src/Pos/Infra/Ntp.hs

@@ -23,6 +23,8 @@ import           Text.Parsec (parserFail, try)
 import qualified Text.Parsec.Char as P
 import qualified Text.Parsec.Text as P
 
+import           Ntp.Client (NtpConfiguration)
+
 import           Pos.Block.Configuration (blockConfiguration)
 import           Pos.Client.CLI.NodeOptions (CommonNodeArgs (..))
 import           Pos.Client.CLI.Options (configurationOptions)
@@ -35,7 +37,6 @@ import           Pos.Core.Mockable (CurrentTime, Mockable, currentTime)
 import           Pos.Core.NetworkAddress (addrParser)
 import           Pos.Crypto (decodeAbstractHash)
 import           Pos.Delegation.Configuration (dlgConfiguration)
-import           Pos.Infra.Ntp.Configuration (NtpConfiguration)
 import           Pos.Launcher.Configuration (Configuration (..),
                      HasConfigurations)
 import           Pos.Security.Params (AttackTarget (..), AttackType (..))

infra/src/Pos/Infra/Ntp/Configuration.hs

@@ -34,6 +34,8 @@ import           System.FilePath (takeDirectory)
 import           System.Wlog (LoggerName, WithLogger, askLoggerName, logInfo,
                      usingLoggerName)
 
+import           Ntp.Client (NtpConfiguration)
+
 -- FIXME consistency on the locus of the JSON instances for configuration.
 -- Core keeps them separate, infra update and ssc define them on-site.
 import           Pos.Aeson.Core.Configuration ()
@@ -45,7 +47,6 @@ import           Pos.Block.Configuration
 import           Pos.Configuration
 import           Pos.Core.Configuration
 import           Pos.Delegation.Configuration
-import           Pos.Infra.Ntp.Configuration
 import           Pos.Ssc.Configuration
 import           Pos.Txp.Configuration
 import           Pos.Update.Configuration

lib/src/Pos/Client/CLI/Util.hs

@@ -24,6 +24,8 @@ import           Universum
 
 import qualified Data.Aeson as J
 
+import           Ntp.Client (NtpConfiguration)
+
 import           Pos.Block.Configuration (HasBlockConfiguration,
                      withBlockConfiguration)
 import           Pos.Configuration (HasNodeConfiguration, withNodeConfiguration)
@@ -33,7 +35,6 @@ import           Pos.Core.Configuration (CoreConfiguration (..),
 import           Pos.Core.Genesis (GenesisSpec (..))
 import           Pos.Crypto (ProtocolMagic)
 import           Pos.Delegation (HasDlgConfiguration, withDlgConfiguration)
-import           Pos.Infra.Ntp.Configuration (NtpConfiguration)
 import           Pos.Launcher.Configuration (Configuration (..),
                      HasConfigurations)
 import           Pos.Ssc.Configuration (HasSscConfiguration,

lib/src/Pos/Launcher/Configuration.hs

@@ -41,6 +41,7 @@ Library
   other-modules:        Data.NonEmptySet
 
   build-depends:        aeson
+                      , aeson-options
                       , async
                       , attoparsec
                       , base

lib/src/Test/Pos/Configuration.hs

@@ -11,7 +11,9 @@
 -- | This module implements functionality of NTP client.
 
 module Ntp.Client
-    ( NtpClientSettings (..)
+    ( NtpConfiguration (..)
+    , NtpClientSettings (..)
+    , ntpClientSettings
     , NtpStatus (..)
     , withNtpClient
     ) where
@@ -24,11 +26,15 @@ import           Control.Concurrent.Async (async, cancel, concurrently_, race,
 import           Control.Concurrent.STM (TVar, modifyTVar', retry)
 import           Control.Exception (Exception, IOException, catch, handle)
 import           Control.Monad (forever)
+import           Data.Aeson (FromJSON (..), ToJSON (..), genericParseJSON,
+                     genericToJSON)
+import           Data.Aeson.Options (defaultOptions)
 import           Data.Binary (decodeOrFail)
 import qualified Data.ByteString.Lazy as LBS
 import qualified Data.List.NonEmpty as NE
 import           Data.Semigroup (Last (..))
-import           Data.Time.Units (Microsecond, TimeUnit, toMicroseconds)
+import           Data.Time.Units (Microsecond, TimeUnit, fromMicroseconds,
+                     toMicroseconds)
 import           Data.Typeable (Typeable)
 import           Formatting (sformat, shown, (%))
 import qualified Network.Socket as Socket
@@ -80,6 +86,32 @@ data NtpClient = NtpClient
       -- ^ Ntp client configuration.
     }
 
+data NtpConfiguration = NtpConfiguration
+    {
+      ntpcServers         :: [String]
+      -- ^ List of DNS names of ntp servers
+    , ntpcResponseTimeout :: !Integer
+      -- ^ how long to await for responses from ntp servers (in microseconds)
+    , ntpcPollDelay       :: !Integer
+      -- ^ how long to wait between sending requests to the ntp servers (in
+      -- microseconds)
+    } deriving (Show, Generic)
+
+instance FromJSON NtpConfiguration where
+    parseJSON = genericParseJSON defaultOptions
+
+instance ToJSON NtpConfiguration where
+    toJSON = genericToJSON defaultOptions
+
+ntpClientSettings :: NtpConfiguration -> NtpClientSettings
+ntpClientSettings NtpConfiguration {..} = NtpClientSettings
+    { ntpServers         = ntpcServers
+    , ntpResponseTimeout = fromMicroseconds $ ntpcResponseTimeout
+    , ntpPollDelay       = fromMicroseconds $ ntpcPollDelay
+    , ntpSelection       = minimum . NE.map abs
+    -- ^ Take minmum of received offsets.
+    }
+
 mkNtpClient :: NtpClientSettings -> TVar NtpStatus -> Sockets -> IO NtpClient
 mkNtpClient ncSettings ncStatus sock = liftIO $ do
     ncSockets <- newTVarIO sock

networking/cardano-sl-networking.cabal

@@ -13,13 +13,14 @@ import           Universum
 import           Data.Maybe (fromJust)
 import           System.Wlog (LoggerName, logInfo)
 
+import           Ntp.Client (NtpConfiguration)
+
 import           Pos.Binary ()
 import           Pos.Client.CLI (CommonNodeArgs (..), NodeArgs (..),
                      SimpleNodeArgs (..))
 import qualified Pos.Client.CLI as CLI
 import           Pos.Core.Mockable (Production (..), runProduction)
 import           Pos.Crypto (ProtocolMagic)
-import           Pos.Infra.Ntp.Configuration (NtpConfiguration)
 import           Pos.Launcher (HasConfigurations, NodeParams (..),
                      loggerBracket, runNodeReal, withConfigurations)
 import           Pos.Launcher.Configuration (AssetLockPath (..))

networking/src/Ntp/Client.hs

@@ -20,6 +20,7 @@ executable cardano-node-simple
                      , cardano-sl-crypto
                      , cardano-sl-ssc
                      , cardano-sl-infra
+                     , cardano-sl-networking
                      , cardano-sl-util
                      , cardano-sl
                      , log-warper

node/Main.hs

@@ -16643,7 +16643,6 @@ license = stdenv.lib.licenses.mit;
 ({
   mkDerivation
 , aeson
-, aeson-options
 , async
 , base
 , base64-bytestring
@@ -16719,7 +16718,6 @@ configureFlags = [
 ];
 libraryHaskellDepends = [
 aeson
-aeson-options
 async
 base
 base64-bytestring
@@ -16984,6 +16982,7 @@ license = stdenv.lib.licenses.mit;
 ({
   mkDerivation
 , aeson
+, aeson-options
 , async
 , attoparsec
 , base
@@ -17038,6 +17037,7 @@ isLibrary = true;
 isExecutable = true;
 libraryHaskellDepends = [
 aeson
+aeson-options
 async
 attoparsec
 base

node/cardano-sl-node.cabal

@@ -10,16 +10,15 @@ import           Universum
 
 import           Control.Concurrent.STM (newTQueueIO)
 import           Data.Maybe (fromJust)
-import           Ntp.Client (NtpStatus, withNtpClient)
+import           Ntp.Client (NtpConfiguration, NtpStatus, ntpClientSettings,
+                     withNtpClient)
 import qualified Pos.Client.CLI as CLI
 import           Pos.Context (ncUserSecret)
 import           Pos.Core (epochSlots)
 import           Pos.Core.Mockable (Production (..), runProduction)
 import           Pos.Crypto (ProtocolMagic)
 import           Pos.DB.DB (initNodeDBs)
 import           Pos.Infra.Diffusion.Types (Diffusion)
-import           Pos.Infra.Ntp.Configuration (NtpConfiguration,
-                     ntpClientSettings)
 import           Pos.Launcher (NodeParams (..), NodeResources (..),
                      bpLoggingParams, bracketNodeResources, loggerBracket,
                      lpDefaultName, runNode, withConfigurations)

pkgs/default.nix

@@ -11,6 +11,7 @@ module Pos.Wallet.Web.Server.Handlers
 import           Universum
 
 import           Ntp.Client (NtpStatus)
+
 import           Pos.Wallet.Web.Swagger.Spec (swaggerSpecForWalletApi)
 import           Servant.API ((:<|>) ((:<|>)))
 import           Servant.Generic (AsServerT, GenericProduct, ToServant,

wallet-new/server/Main.hs

@@ -20,10 +20,11 @@ import qualified Control.Exception.Safe as E
 import           Control.Monad.Except (MonadError (throwError))
 import qualified Control.Monad.Reader as Mtl
 import           Network.Wai (Application)
-import           Ntp.Client (NtpStatus)
 import           Servant.Server (Handler)
 import           System.Wlog (logInfo, usingLoggerName)
 
+import           Ntp.Client (NtpStatus)
+
 import           Cardano.NodeIPC (startNodeJsIPC)
 import           Pos.Core.Mockable (Production (..), runProduction)
 import           Pos.Core.NetworkAddress (NetworkAddress)