apply anviking hints

rename constructors and functions in the PipeliningStrategy module
cardano-foundation · May 13, 2022 · 3f185c7 · 3f185c7
1 parent 3ea5876
commit 3f185c7
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 47 deletions.
diff --git a/.gitignore b/.gitignore
@@ -40,7 +40,7 @@ hie.yaml
 
 ### auto-generated faulty JSON golden tests ###
 *.faulty.json
-*.faulty.json
+*.faulty.reencoded.json
 lib/shelley/test/data/balanceTx/**/actual
 
 ### Release scripts output
@@ -49,5 +49,7 @@ lib/shelley/test/data/balanceTx/**/actual
 ### Docs build
 /_build/
 .vscode/settings.json
+
+## local ignored space
 ignore-me
 
diff --git a/lib/core/src/Ouroboros/Network/Client/Wallet.hs b/lib/core/src/Ouroboros/Network/Client/Wallet.hs
@@ -396,10 +396,11 @@ chainSyncWithBlocks tr pipeliningStrategy chainFollower =
                     then oneByOne
                     else pipeline 
                         (fromIntegral 
-                            $ min distance 
-                            $ getPipeliningNumber 
-                            $ pipeliningStrategy 
-                            $ NE.last blocks'
+                            . min distance 
+                            . getPipeliningNumber 
+                            . pipeliningStrategy 
+                            . NE.last 
+                            $ blocks'
                         ) 
                         Zero
             clientStIdle strategy

diff --git a/lib/shelley/bench/latency-bench.hs b/lib/shelley/bench/latency-bench.hs
@@ -49,6 +49,7 @@ import Cardano.Wallet.Logging
 import Cardano.Wallet.Network.Ports
     ( portFromURL )
 import Cardano.Wallet.PipeliningStrategy
+    ( variablePipelining )
 import Cardano.Wallet.Primitive.AddressDerivation
     ( NetworkDiscriminant (..) )
 import Cardano.Wallet.Primitive.SyncProgress

diff --git a/lib/shelley/bench/restore-bench.hs b/lib/shelley/bench/restore-bench.hs
@@ -85,8 +85,11 @@ import Cardano.Wallet.Network
     , ChainSyncLog (..)
     , NetworkLayer (..)
     )
-
 import Cardano.Wallet.PipeliningStrategy
+    ( PredefinedPipeliningStrategy (..)
+    , pipeliningStrategyFromPredefined
+    , variablePipelining
+    )
 import Cardano.Wallet.Primitive.AddressDerivation
     ( Depth (..)
     , NetworkDiscriminant (..)
@@ -666,7 +669,7 @@ bench_baseline_restoration
         ( NetworkDiscriminantVal n
         , HasNetworkId n
         )
-    => PipeliningStrat
+    => PredefinedPipeliningStrategy
     -> Proxy n
     -> Tracer IO (BenchmarkLog n)
     -> Trace IO Text
@@ -691,7 +694,7 @@ bench_baseline_restoration
         withWalletLayerTracer benchName pipeliningStrat traceToDisk $ \progressTrace ->
             withNetworkLayer 
                 networkTrace 
-                (stratPipelining pipeliningStrat np)
+                (pipeliningStrategyFromPredefined pipeliningStrat np)
                 networkId np socket vData sTol $ \nw ->
                     action progressTrace nw
       where
@@ -750,7 +753,7 @@ bench_restoration
         , Buildable results
         , ToJSON results
         )
-    => PipeliningStrat
+    => PredefinedPipeliningStrategy
     -> Proxy n
     -> Tracer IO (BenchmarkLog n)
     -> Trace IO Text -- ^ For wallet tracing
@@ -775,7 +778,7 @@ bench_restoration
     let networkId = networkIdVal proxy
     let tl = newTransactionLayer @k networkId
     let gp = genesisParameters np
-    withNetworkLayer (trMessageText wlTr) (stratPipelining pipeliningStrat np) 
+    withNetworkLayer (trMessageText wlTr) (pipeliningStrategyFromPredefined pipeliningStrat np) 
         networkId np socket vData sTol $ \nw' -> do
             let convert = fromCardanoBlock gp
             let nw = convert <$> nw'

diff --git a/lib/shelley/src/Cardano/Wallet/PipeliningStrategy.hs b/lib/shelley/src/Cardano/Wallet/PipeliningStrategy.hs
@@ -1,58 +1,55 @@
+{-# LANGUAGE DataKinds #-}
 {-# LANGUAGE NumericUnderscores #-}
 
-module Cardano.Wallet.PipeliningStrategy where
+module Cardano.Wallet.PipeliningStrategy
+  ( variablePipelining
+  , pipeliningStrategyFromPredefined
+  , PredefinedPipeliningStrategy (..)
+  )
+where
+
+import Prelude
 
 import Cardano.Wallet.Primitive.Types
-    ( blockHeight, header, NetworkParameters, genesisParameters )
+    ( NetworkParameters, blockHeight, genesisParameters, header )
 import Cardano.Wallet.Shelley.Compatibility
     ( CardanoBlock, StandardCrypto, fromCardanoBlock )
-import Data.List
-    ( find )
 import Data.Quantity
     ( Quantity (Quantity) )
-import Numeric.Natural
-    ( Natural )
+import Data.Word
+    ( Word32 )
 import Ouroboros.Network.Client.Wallet
     ( Pipelining (Pipelining), PipeliningStrategy )
-import Prelude
 
-data PipeliningStrat = ConstPipelining | VariablePipelining deriving (Show)
+-- | Pipelining strategies that have been in use
+
+data PredefinedPipeliningStrategy 
+    = ConstPipelining 
+    | VariablePipelining 
+    deriving (Show)
 
 pipeliningsOfStrat
-    :: Num y
-    => PipeliningStrat
-    -> ([(Quantity x y, Natural)], Natural)
-pipeliningsOfStrat ConstPipelining = ([], 1000)
-pipeliningsOfStrat VariablePipelining =
-    ( [ (Quantity 5_200_000, 1000)
-        , (Quantity 6_100_000, 200)
-        , (Quantity 6_500_000, 100)
-        ]
-    , 100
-    )
-
-pipeliningsOfHeight
-    :: (Ord y, Num y)
-    => PipeliningStrat
-    -> Quantity x y
+    :: PredefinedPipeliningStrategy
+    -> Quantity "block" Word32
     -> Pipelining
-pipeliningsOfHeight strat tip =
-    Pipelining $
-        maybe bed snd (find (\(q, _) -> q >= tip) pipelinings)
-    where
-        (pipelinings, bed) = pipeliningsOfStrat strat
+pipeliningsOfStrat ConstPipelining _ = Pipelining 1000
+pipeliningsOfStrat VariablePipelining (Quantity blockNo)
+    | blockNo <= 5_200_000 = Pipelining 1000
+    | blockNo <= 6_100_000 = Pipelining 200
+    | blockNo <= 6_500_000 = Pipelining 100
+    | otherwise            = Pipelining 75
 
 variablePipelining
     :: NetworkParameters
     -> PipeliningStrategy (CardanoBlock StandardCrypto)
-variablePipelining = stratPipelining VariablePipelining
+variablePipelining = pipeliningStrategyFromPredefined VariablePipelining
 
-stratPipelining 
-    :: PipeliningStrat
-    -> NetworkParameters 
+pipeliningStrategyFromPredefined
+    :: PredefinedPipeliningStrategy
+    -> NetworkParameters
     -> PipeliningStrategy (CardanoBlock StandardCrypto)
-stratPipelining strat gp =
-    pipeliningsOfHeight strat
+pipeliningStrategyFromPredefined strat gp =
+    pipeliningsOfStrat strat
         . blockHeight
         . header
         . fromCardanoBlock (genesisParameters gp)
diff --git a/lib/shelley/test/integration/shelley-integration-test.hs b/lib/shelley/test/integration/shelley-integration-test.hs
@@ -16,7 +16,6 @@ module Main where
 
 import Prelude
 
-import Cardano.Wallet.PipeliningStrategy
 import Cardano.BM.Data.Severity
     ( Severity (..) )
 import Cardano.BM.Data.Tracer
@@ -46,6 +45,8 @@ import Cardano.Wallet.Logging
     ( BracketLog, bracketTracer, stdoutTextTracer, trMessageText )
 import Cardano.Wallet.Network.Ports
     ( portFromURL )
+import Cardano.Wallet.PipeliningStrategy
+    ( variablePipelining )
 import Cardano.Wallet.Primitive.AddressDerivation
     ( NetworkDiscriminant (..) )
 import Cardano.Wallet.Primitive.SyncProgress

diff --git a/lib/shelley/test/unit/Cardano/Wallet/Shelley/NetworkSpec.hs b/lib/shelley/test/unit/Cardano/Wallet/Shelley/NetworkSpec.hs
@@ -14,6 +14,8 @@ import Cardano.BM.Trace
     ( nullTracer, traceInTVarIO )
 import Cardano.Wallet.Network
     ( NetworkLayer (..) )
+import Cardano.Wallet.PipeliningStrategy
+    ( variablePipelining )
 import Cardano.Wallet.Primitive.SyncProgress
     ( SyncTolerance (..) )
 import Cardano.Wallet.Primitive.Types
@@ -57,7 +59,6 @@ import UnliftIO.STM
 
 import qualified Data.Map as Map
 import qualified Data.Set as Set
-import Cardano.Wallet.PipeliningStrategy (variablePipelining)
 
 {-------------------------------------------------------------------------------
                                       Spec