PR review

Signed-off-by: Sasha Bogicevic <[email protected]>

Author: v0d1ch

hydra-chain-observer/src/Hydra/ChainObserver.hs

@@ -11,7 +11,7 @@ import Hydra.ChainObserver.NodeClient (ChainObservation, ChainObserverLog (..),
 import Hydra.ChainObserver.Options (Backend (..), Options (..), hydraChainObserverOptions)
 import Hydra.Contract qualified as Contract
 import Hydra.Logging (Verbosity (..), traceWith, withTracer)
-import Hydra.Options (hydraNodeVersion)
+import Hydra.NetworkVersions (hydraNodeVersion)
 import Hydra.Ouroborus.ChainObserver (ouroborusClient)
 import Network.HTTP.Simple (getResponseBody, httpNoBody, parseRequestThrow, setRequestBodyJSON)
 import Network.URI (URI)

hydra-chain-observer/src/Hydra/ChainObserver/Options.hs

@@ -6,8 +6,8 @@ import Hydra.Prelude
 
 import Data.Version (showVersion)
 import Hydra.Cardano.Api (ChainPoint, NetworkId, SocketPath)
+import Hydra.NetworkVersions (hydraNodeVersion)
 import Hydra.Options (
-  hydraNodeVersion,
   networkIdParser,
   nodeSocketParser,
   startChainFromParser,

hydra-node/hydra-node.cabal

@@ -1,10 +1,10 @@
-cabal-version: 3.0
-name:          hydra-node
-version:       0.22.0
-synopsis:      The Hydra node
-author:        IOG
-copyright:     2022 IOG
-license:       Apache-2.0
+cabal-version:      3.0
+name:               hydra-node
+version:            0.22.0
+synopsis:           The Hydra node
+author:             IOG
+copyright:          2022 IOG
+license:            Apache-2.0
 license-files:
   LICENSE
   NOTICE
@@ -327,6 +327,7 @@ test-suite tests
     Hydra.ModelSpec
     Hydra.Network.AuthenticateSpec
     Hydra.NetworkSpec
+    Hydra.NetworkVersionsSpec
     Hydra.Node.InputQueueSpec
     Hydra.Node.RunSpec
     Hydra.NodeSpec

hydra-node/src/Hydra/API/WSServer.hs

@@ -43,7 +43,7 @@ import Hydra.Chain.Direct.State ()
 import Hydra.HeadLogic (ClosedState (ClosedState, readyToFanoutSent), HeadState, StateChanged)
 import Hydra.HeadLogic.State qualified as HeadState
 import Hydra.Logging (Tracer, traceWith)
-import Hydra.Options qualified as Options
+import Hydra.NetworkVersions qualified as NetworkVersions
 import Hydra.Tx (Party)
 import Hydra.Tx.HeadId (HeadId (..))
 import Network.WebSockets (
@@ -104,7 +104,7 @@ wsApp party tracer history callback headStateP headIdP responseChannel ServerOut
             , headStatus = getHeadStatus headState
             , hydraHeadId
             , snapshotUtxo = getSnapshotUtxo headState
-            , hydraNodeVersion = showVersion Options.hydraNodeVersion
+            , hydraNodeVersion = showVersion NetworkVersions.hydraNodeVersion
             }
 
   Projection{getLatest} = headStateP

hydra-node/src/Hydra/NetworkVersions.hs

@@ -1,46 +1,48 @@
-{-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE TemplateHaskell #-}
 
 module Hydra.NetworkVersions where
 
 import Hydra.Prelude hiding (encodeUtf8)
 
-import Control.Lens ((^@..))
-import Data.Aeson (Value (..))
-import Data.Aeson.Key qualified as Key
-import Data.Aeson.KeyMap qualified as KeyMap
-import Data.Aeson.Lens (members, _Object)
+import Control.Lens ((^.), (^?))
+import Data.Aeson (Value (..), encode)
+import Data.Aeson.Lens (key, nonNull, _Key)
 import Data.FileEmbed (embedFile, makeRelativeToProject)
-import Data.List qualified as List
-import Data.Text (pack, splitOn, toLower, unpack)
+import Data.Text (splitOn)
 import Data.Text.Encoding (encodeUtf8)
+import Data.Version (Version (..), showVersion)
 import Hydra.Cardano.Api (TxId, deserialiseFromRawBytesHex)
-import Hydra.Version (gitDescribe)
+import Hydra.Version (embeddedRevision, gitRevision, unknownVersion)
+import Paths_hydra_node (version)
+
+hydraNodeVersion :: Version
+hydraNodeVersion =
+  version & \(Version semver _) -> Version semver revision
+ where
+  revision =
+    maybeToList $
+      embeddedRevision
+        <|> gitRevision
+        <|> Just unknownVersion
 
-{-# NOINLINE networkVersions #-}
 networkVersions :: ByteString
 networkVersions = $(makeRelativeToProject "./networks.json" >>= embedFile)
 
-parseNetworkTxIds :: String -> Either String [TxId]
-parseNetworkTxIds networkString = do
-  let networkTxt = toLower $ pack networkString
-  let info = networkVersions ^@.. members . _Object
-  case find (\(n, _) -> Key.toText n == networkTxt) info of
-    Nothing -> Left $ "Unknown network:" <> unpack networkTxt
-    Just (_, t) -> getLastTxId t
+parseNetworkTxIds :: MonadFail m => Version -> String -> m [TxId]
+parseNetworkTxIds hydraVersion network = do
+  case networkVersions ^? key (network ^. _Key) of
+    Nothing -> fail $ "Unknown network: " <> toString network
+    Just t -> getLastTxId t
  where
   getLastTxId t = do
-    lastTxIds <-
-      case gitDescribe of
-        Nothing -> Left "Missing hydra-node revision."
-        Just fullRev -> do
-          let rev = List.head $ splitOn "-" $ pack fullRev
-          case List.find (String rev ==) (KeyMap.elems t) of
-            Just (String s) -> Right s
-            _ -> Left "Failed to find released hydra-node version in networks.json."
-    mapM parseToTxId (splitOn "," lastTxIds)
+    case splitOn "-" $ fromString $ showVersion hydraVersion of
+      [] -> fail "Failed to parse hydra-node revision."
+      (rev : _) -> do
+        case encode t ^? key (rev ^. _Key) . nonNull of
+          Just (String s) -> mapM parseToTxId $ splitOn "," s
+          _ -> fail "Failed to find released hydra-node version in networks.json."
 
   parseToTxId textTxId = do
     case deserialiseFromRawBytesHex $ encodeUtf8 textTxId of
-      Left _ -> Left $ "Failed to parse string to TxId: " <> unpack textTxId
-      Right txid -> Right txid
+      Left _ -> fail $ "Failed to parse string to TxId: " <> toString textTxId
+      Right txid -> pure txid

hydra-node/src/Hydra/Options.hs

@@ -19,7 +19,7 @@ import Data.ByteString.Char8 qualified as BSC
 import Data.IP (IP (IPv4), toIPv4, toIPv4w)
 import Data.Text (unpack)
 import Data.Text qualified as T
-import Data.Version (Version (..), showVersion)
+import Data.Version (showVersion)
 import Hydra.Cardano.Api (
   ChainPoint (..),
   File (..),
@@ -38,11 +38,10 @@ import Hydra.Contract qualified as Contract
 import Hydra.Ledger.Cardano ()
 import Hydra.Logging (Verbosity (..))
 import Hydra.Network (Host (..), NodeId (NodeId), PortNumber, WhichEtcd (..), readHost, readPort, showHost)
-import Hydra.NetworkVersions (parseNetworkTxIds)
+import Hydra.NetworkVersions (hydraNodeVersion, parseNetworkTxIds)
 import Hydra.Node.DepositPeriod (DepositPeriod (..))
 import Hydra.Tx.ContestationPeriod (ContestationPeriod, fromNominalDiffTime)
 import Hydra.Tx.HeadId (HeadSeed)
-import Hydra.Version (embeddedRevision, gitRevision, unknownVersion)
 import Options.Applicative (
   Parser,
   ParserInfo,
@@ -79,7 +78,6 @@ import Options.Applicative (
  )
 import Options.Applicative.Builder (str)
 import Options.Applicative.Help (vsep)
-import Paths_hydra_node (version)
 import Test.QuickCheck (elements, listOf, listOf1, oneof, vectorOf)
 
 data Command
@@ -814,9 +812,9 @@ hydraScriptsDefaultParser =
  where
   validateNetwork arg =
     case arg of
-      "preview" -> parseNetworkTxIds arg
-      "preprod" -> parseNetworkTxIds arg
-      "mainnet" -> parseNetworkTxIds arg
+      "preview" -> parseNetworkTxIds hydraNodeVersion arg
+      "preprod" -> parseNetworkTxIds hydraNodeVersion arg
+      "mainnet" -> parseNetworkTxIds hydraNodeVersion arg
       _ -> Left $ "Unknown network: " <> arg
 
 persistenceDirParser :: Parser FilePath
@@ -864,16 +862,6 @@ hydraNodeCommand =
       (decodeUtf8 $ encodePretty Contract.scriptInfo)
       (long "script-info" <> help "Dump script info as JSON")
 
-hydraNodeVersion :: Version
-hydraNodeVersion =
-  version & \(Version semver _) -> Version semver revision
- where
-  revision =
-    maybeToList $
-      embeddedRevision
-        <|> gitRevision
-        <|> Just unknownVersion
-
 defaultContestationPeriod :: ContestationPeriod
 defaultContestationPeriod = 600
 

hydra-node/test/Hydra/API/ServerSpec.hs

@@ -43,7 +43,7 @@ import Hydra.HeadLogic.StateEvent (StateEvent (..), genStateEvent)
 import Hydra.Ledger.Simple (SimpleTx (..))
 import Hydra.Logging (Tracer, showLogsOnFailure)
 import Hydra.Network (PortNumber)
-import Hydra.Options qualified as Options
+import Hydra.NetworkVersions qualified as NetworkVersions
 import Hydra.Tx.Party (Party)
 import Hydra.Tx.Snapshot (Snapshot (Snapshot, utxo, utxoToCommit))
 import Network.Simple.WSS qualified as WSS
@@ -88,7 +88,7 @@ spec =
                 version <- waitMatch 5 conn $ \v -> do
                   guard $ matchGreetings v
                   v ^? key "hydraNodeVersion"
-                version `shouldBe` toJSON (showVersion Options.hydraNodeVersion)
+                version `shouldBe` toJSON (showVersion NetworkVersions.hydraNodeVersion)
 
     it "sends server outputs to all connected clients" $ do
       queue <- atomically newTQueue

hydra-node/test/Hydra/NetworkVersionsSpec.hs

@@ -0,0 +1,36 @@
+module Hydra.NetworkVersionsSpec where
+
+import Hydra.Prelude
+import Test.Hydra.Prelude
+
+import Data.Version (Version, makeVersion)
+import Hydra.NetworkVersions (hydraNodeVersion, parseNetworkTxIds)
+import Test.QuickCheck (Property, counterexample, forAll, property)
+
+spec :: Spec
+spec =
+  describe "NetworkVersions" $ do
+    it "parseNetworkTxIds produces list TxId" $ do
+      let networks = ["mainnet", "preview", "preprod"]
+      let versions = makeVersion . (\v -> [0, v, 0]) <$> [13 .. 21]
+      forM_ networks $ \network ->
+        forM_ versions $ \version -> do
+          case parseNetworkTxIds version network of
+            Left err -> failure $ "Failed to parse network tx ids: " <> err
+            Right txIds -> txIds `shouldSatisfy` not . null
+
+    prop "parseNetworkTxIds works with expected versions and networks" $
+      forAll arbitrary $ \version ->
+        forAll arbitrary $ \network ->
+          propParseNetworkTxIds version network
+
+propParseNetworkTxIds :: Version -> String -> Property
+propParseNetworkTxIds version network = do
+  let varlidNetworks = ["mainnet", "preview", "preprod"]
+  let validVersions = (makeVersion . (\v -> [0, v, 0]) <$> [13 .. 21]) <> [hydraNodeVersion]
+  case parseNetworkTxIds version network of
+    Left err ->
+      if network `elem` varlidNetworks && version `elem` validVersions
+        then property False & counterexample ("error: " <> err)
+        else property True
+    Right txIds -> property $ not (null txIds)

hydra-node/test/Hydra/OptionsSpec.hs

@@ -16,7 +16,6 @@ import Hydra.Cardano.Api (
  )
 import Hydra.Chain (maximumNumberOfParties)
 import Hydra.Network (Host (Host))
-import Hydra.NetworkVersions (parseNetworkTxIds)
 import Hydra.Options (
   BlockfrostOptions (..),
   CardanoChainConfig (..),
@@ -325,23 +324,6 @@ spec = parallel $
             { chainConfig = Cardano (defaultCardanoChainConfig & #chainBackendOptions .~ Blockfrost (BlockfrostOptions "blockfrost-project.txt"))
             }
 
-    it "parses --network into related tx ids" $ do
-      -- NOTE: we should be able to parse both upper and lower case network names
-      let networks = ["Mainnet", "preview", "Preprod"]
-      forM_ networks $ \network -> do
-        case parseNetworkTxIds network of
-          Left err ->
-            err `shouldSatisfy` \case
-              "Failed to find released hydra-node version in networks.json." -> True
-              "Missing hydra-node revision." -> True
-              _ -> False
-          Right txIds ->
-            ["--network", network]
-              `shouldParse` Run
-                defaultRunOptions
-                  { chainConfig = Cardano defaultCardanoChainConfig{hydraScriptsTxId = txIds}
-                  }
-
     it "switches to offline mode when using --offline-head-seed and --initial-utxo" $
       mconcat
         [ ["--offline-head-seed", "0100"]