Merge pull request #1367 from input-output-hk/fix-tutorial

Fix tutorial download instructions

Author: ch1bo

.github/workflows/check-tutorial.yaml

@@ -31,7 +31,7 @@ jobs:
         import re
         with open("docs/docs/tutorial/index.md", "r") as tutorial:
             body = tutorial.read()
-            usedCardanoNodeVersions = re.findall(r"cardano-node-.*-([0-9]+\.[0-9]+\.[0-9]+).zip", body)
+            usedCardanoNodeVersions = re.findall(r"cardano-node-([0-9]+\.[0-9]+\.[0-9]+)-.*\.tar\.gz", body)
 
         with open("hydra-cluster/test/Test/CardanoNodeSpec.hs", "r") as cardanoNodeSpecFile:
             body = cardanoNodeSpecFile.read()

CHANGELOG.md

@@ -11,7 +11,7 @@ changes.
 
 ## [0.16.0] - UNRELEASED
 
-- Update to and tested against `cardano-node 8.9.0` and `cardano-cli 8.20.3.0`.
+- Tested with `cardano-node 8.9.0`, `cardano-cli 8.20.3.0` and `mithril 2408.0`.
 
 - **BREAKING** Hydra scripts changed due to updates in the `plutus` toolchain:
   - Overall slight increase in script size.

docs/docs/tutorial/index.md

@@ -45,8 +45,8 @@ version=0.15.0
 curl -L -O https://github.com/input-output-hk/hydra/releases/download/${version}/hydra-x86_64-linux-${version}.zip
 unzip -d bin hydra-x86_64-linux-${version}.zip
 curl -L -o - https://github.com/input-output-hk/cardano-node/releases/download/8.9.0/cardano-node-8.9.0-linux.tar.gz \
-  | tar xz -C bin ./cardano-node ./cardano-cli
-curl -L -o - https://github.com/input-output-hk/mithril/releases/download/2347.0/mithril-2347.0-linux-x64.tar.gz \
+  | tar xz ./bin/cardano-node ./bin/cardano-cli
+curl -L -o - https://github.com/input-output-hk/mithril/releases/download/2408.0/mithril-2408.0-linux-x64.tar.gz \
   | tar xz -C bin mithril-client
 chmod +x bin/*
 ```
@@ -59,10 +59,10 @@ mkdir -p bin
 version=0.15.0
 curl -L -O https://github.com/input-output-hk/hydra/releases/download/${version}/hydra-aarch64-darwin-${version}.zip
 unzip -d bin hydra-aarch64-darwin-${version}.zip
-curl -L -o - https://github.com/input-output-hk/hydra/releases/download/${version}/cardano-node-aarch-darwin-8.9.0.zip
-unzip -d bin cardano-node-8.9.0-linux.zip
 curl -L -o - https://github.com/input-output-hk/cardano-node/releases/download/8.9.0/cardano-node-8.9.0-macos.tar.gz \
-  | tar xz -C bin --wildcards ./cardano-node ./cardano-cli '*.dylib'
+  | tar xz --wildcards ./bin/cardano-node ./bin/cardano-cli './bin/*.dylib'
+curl -L -o - https://github.com/input-output-hk/mithril/releases/download/2408.0/mithril-2408.0-macos-x64.tar.gz \
+  | tar xz -C bin
 chmod +x bin/*
 ```
 
@@ -122,8 +122,7 @@ We will be using the `mithril-client` configured to download from
 `preprod` network to download the latest blockchain snapshot:
 
 ```shell
-SNAPSHOT_DIGEST=$(mithril-client snapshot list --json | jq -r '.[0].digest')
-mithril-client snapshot download $SNAPSHOT_DIGEST
+mithril-client snapshot download latest
 ```
 
 <details>

flake.lock

@@ -19,7 +19,7 @@
       flake = false;
     };
     cardano-node.url = "github:intersectmbo/cardano-node/8.9.0";
-    mithril.url = "github:input-output-hk/mithril/2347.0";
+    mithril.url = "github:input-output-hk/mithril/2408.0";
     nix-npm-buildpackage.url = "github:serokell/nix-npm-buildpackage";
   };
 

flake.nix

@@ -10,12 +10,12 @@ import Data.ByteString qualified as BS
 import Hydra.Cluster.Fixture (KnownNetwork (..))
 import Network.HTTP.Simple (getResponseBody, httpBS, parseRequest)
 import System.IO.Error (isEOFError)
-import System.Process.Typed (createPipe, getStdout, proc, setStdout, withProcessWait_)
+import System.Process.Typed (createPipe, getStderr, proc, setStderr, withProcessWait_)
 
 data MithrilLog
   = StartSnapshotDownload {network :: KnownNetwork, directory :: FilePath}
-  | -- | Output captured directly from mithril-client
-    StdOut {output :: Value}
+  | -- | Output captured directly from mithril-client stderr.
+    StdErr {output :: Value}
   deriving stock (Eq, Show, Generic)
   deriving anyclass (ToJSON, FromJSON)
 
@@ -28,7 +28,7 @@ downloadLatestSnapshotTo tracer network directory = do
       traceWith tracer StartSnapshotDownload{network, directory}
       genesisKey <- parseRequest genesisKeyURL >>= httpBS <&> getResponseBody
       let cmd =
-            setStdout createPipe $
+            setStderr createPipe $
               proc "mithril-client" $
                 concat
                   [ ["--aggregator-endpoint", aggregatorEndpoint]
@@ -37,15 +37,15 @@ downloadLatestSnapshotTo tracer network directory = do
                   , ["--download-dir", directory]
                   , ["--json"]
                   ]
-      withProcessWait_ cmd traceStdout
+      withProcessWait_ cmd traceStderr
     _ -> error $ "Network " <> show network <> " not supported by mithril."
  where
-  traceStdout p =
+  traceStderr p =
     ignoreEOFErrors . forever $ do
-      bytes <- BS.hGetLine (getStdout p)
+      bytes <- BS.hGetLine (getStderr p)
       case Aeson.eitherDecodeStrict bytes of
         Left err -> error $ "failed to decode: \n" <> show bytes <> "\nerror: " <> show err
-        Right output -> traceWith tracer StdOut{output}
+        Right output -> traceWith tracer StdErr{output}
 
   ignoreEOFErrors =
     handleJust (guard . isEOFError) (const $ pure ())

hydra-cluster/src/Hydra/Cluster/Mithril.hs

@@ -4,8 +4,8 @@ import Hydra.Prelude
 import Test.Hydra.Prelude
 
 import Control.Concurrent.Class.MonadSTM (newTVarIO, readTVarIO)
-import Control.Lens ((^?!))
-import Data.Aeson.Lens (key, _Number)
+import Control.Lens ((^?))
+import Data.Aeson.Lens (key)
 import Hydra.Cluster.Mithril (MithrilLog (..), downloadLatestSnapshotTo)
 import Hydra.Logging (Envelope (..), Tracer, traceInTVar)
 import System.Directory (doesDirectoryExist)
@@ -22,19 +22,19 @@ spec = parallel $ do
         doesDirectoryExist dbPath `shouldReturn` False
         race_
           (downloadLatestSnapshotTo tracer network tmpDir)
-          (waitForStep 3 getTraces)
+          (waitForDownload getTraces)
 
--- | Wait for the 'StdOut' message that matches the given step number.
-waitForStep :: HasCallStack => Natural -> IO [Envelope MithrilLog] -> IO ()
-waitForStep step getTraces = do
+-- | Wait for the 'StdErr' message to indicate it starts downloading.
+waitForDownload :: HasCallStack => IO [Envelope MithrilLog] -> IO ()
+waitForDownload getTraces = do
   traces <- getTraces
-  unless (any isRightStep traces) $ do
+  unless (any isRightTrace traces) $ do
     threadDelay 1
-    waitForStep step getTraces
+    waitForDownload getTraces
  where
-  isRightStep = \case
-    Envelope{message = StdOut{output}} ->
-      output ^?! key "step_num" . _Number == fromIntegral step
+  isRightTrace = \case
+    Envelope{message = StdErr{output}} ->
+      isJust $ output ^? key "bytes_downloaded"
     _ -> False
 
 -- | Create a tracer that captures all messages and a function to retrieve all