Make the explorer persistent #1281
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,12 +5,23 @@ import Hydra.Prelude | |
|
|
||
| import Control.Concurrent.Class.MonadSTM (modifyTVar', newTVarIO, readTVarIO) | ||
| import Hydra.API.APIServerLog (APIServerLog (..), Method (..), PathInfo (..)) | ||
| import Hydra.Cardano.Api (NetworkId (..), NetworkMagic (..), Tx, unFile) | ||
| import Hydra.Chain (OnChainTx) | ||
| import Hydra.Chain.Direct.Handlers (convertObservation) | ||
| import Hydra.Chain.Direct.Tx ( | ||
| HeadObservation (..), | ||
| ) | ||
| import Hydra.Explorer.ExplorerState (ExplorerState, HeadState, aggregateOnChainTx) | ||
| import Hydra.Explorer.Options (Options (..), hydraExplorerOptions) | ||
| import Hydra.Logging (Tracer, Verbosity (..), traceWith, withTracer) | ||
| import Hydra.Logging.Messages (HydraLog (..)) | ||
| import Hydra.Network (Host (..)) | ||
| import Hydra.Node (HydraNodeLog (..)) | ||
| import Hydra.Options qualified as Options | ||
| import Hydra.Persistence (PersistenceIncremental (..), createPersistenceIncremental, loadAll) | ||
| import Network.Wai (Middleware, Request (..)) | ||
| import Network.Wai.Handler.Warp qualified as Warp | ||
| import Options.Applicative (execParser) | ||
| import Servant (Server, throwError) | ||
| import Servant.API (Get, Header, JSON, addHeader, (:>)) | ||
| import Servant.API.ResponseHeaders (Headers) | ||
|
|
@@ -32,8 +43,8 @@ type API = | |
|
|
||
| type GetHeads = IO [HeadState] | ||
|
|
||
| explorerAPI :: Proxy API | ||
| explorerAPI = Proxy | ||
|
|
||
| server :: GetHeads -> Server API | ||
| server = handleGetHeads | ||
|
|
@@ -68,41 +79,68 @@ logMiddleware tracer app' req sendResponse = do | |
|
|
||
| httpApp :: Tracer IO APIServerLog -> GetHeads -> Application | ||
| httpApp tracer getHeads = | ||
| logMiddleware tracer $ serve explorerAPI $ server getHeads | ||
|
|
||
| observerHandler :: | ||
| TVar IO ExplorerState -> | ||
| PersistenceIncremental (OnChainTx Tx) IO -> | ||
| [HeadObservation] -> | ||
| IO () | ||
| observerHandler explorerState PersistenceIncremental{append} observations = do | ||
| let onChainTxs = mapMaybe convertObservation observations | ||
| forM_ onChainTxs append | ||
| atomically $ | ||
| modifyTVar' explorerState $ \currentState -> | ||
| foldl' aggregateOnChainTx currentState onChainTxs | ||
|
|
||
| readModelGetHeadIds :: TVar IO ExplorerState -> GetHeads | ||
| readModelGetHeadIds = readTVarIO | ||
|
|
||
| main :: IO () | ||
| main = do | ||
| withTracer (Verbose "hydra-explorer") $ \(tracer :: Tracer IO (HydraLog Tx ())) -> do | ||
| opts <- execParser hydraExplorerOptions | ||
| let Options | ||
| { networkId | ||
| , host = Host{hostname, port} | ||
| , nodeSocket | ||
| , startChainFrom | ||
| , persistenceDir | ||
| } = opts | ||
| persistence <- createPersistenceIncremental $ persistenceDir <> "/explorer-state" | ||
| explorerState <- do | ||
| let nodeTracer = contramap Node tracer | ||
| events <- loadAll persistence | ||
| traceWith nodeTracer LoadedState{numberOfEvents = fromIntegral $ length events} | ||
| let initialState = mempty | ||
| recoveredSt = foldl' aggregateOnChainTx initialState events | ||
| newTVarIO recoveredSt | ||
|
There was a problem hiding this comment. Must: include chain information in persisted data to avoid inconsistencies by design This This must be avoided! Having an explorer synchronizing everything from a fixed point ( I would like to discuss the premise of this whole PR please. |
||
|
|
||
| let getHeads = readModelGetHeadIds explorerState | ||
|
|
||
| apiTracer = contramap APIServer tracer | ||
|
|
||
| chainObserverArgs = | ||
| ["--node-socket", unFile nodeSocket] | ||
| <> case networkId of | ||
| Mainnet -> ["--mainnet"] | ||
| Testnet (NetworkMagic magic) -> ["--testnet-magic", show magic] | ||
| <> Options.toArgStartChainFrom startChainFrom | ||
|
There was a problem hiding this comment. Could: make this consistent Either use all the Eventually we need to get rid of using them anyway as we can not depend on |
||
| race | ||
| ( withArgs chainObserverArgs $ | ||
| Hydra.ChainObserver.main (observerHandler explorerState persistence) | ||
| ) | ||
| ( traceWith apiTracer (APIServerStarted port) | ||
| *> Warp.runSettings (settings apiTracer port hostname) (httpApp apiTracer getHeads) | ||
| ) | ||
| >>= \case | ||
| Left{} -> error "Something went wrong" | ||
| Right a -> pure a | ||
| where | ||
| settings tracer port hostname = | ||
| Warp.defaultSettings | ||
| & Warp.setPort (fromIntegral port) | ||
| & Warp.setHost (fromString . toString $ hostname) | ||
| & Warp.setOnException (\_ e -> traceWith tracer $ APIConnectionError{reason = show e}) | ||
|
|
||
| addCorsHeaders :: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| module Hydra.Explorer.Options where | ||
|
|
||
| import Hydra.Prelude | ||
|
|
||
| import Hydra.Cardano.Api (ChainPoint (..), NetworkId, SocketPath) | ||
| import Hydra.Network (Host) | ||
| import Hydra.Options ( | ||
| networkIdParser, | ||
| nodeSocketParser, | ||
| peerParser, | ||
| persistenceDirParser, | ||
| startChainFromParser, | ||
| ) | ||
| import Options.Applicative (Parser, ParserInfo, fullDesc, header, helper, info, progDesc) | ||
|
|
||
| type Options :: Type | ||
| data Options = Options | ||
| { networkId :: NetworkId | ||
| , host :: Host | ||
| , nodeSocket :: SocketPath | ||
| , startChainFrom :: Maybe ChainPoint | ||
| , persistenceDir :: FilePath | ||
| } | ||
| deriving stock (Show, Eq) | ||
|
|
||
| optionsParser :: Parser Options | ||
| optionsParser = | ||
| Options | ||
| <$> networkIdParser | ||
| <*> peerParser | ||
| <*> nodeSocketParser | ||
| <*> optional startChainFromParser | ||
| <*> persistenceDirParser | ||
|
|
||
| hydraExplorerOptions :: ParserInfo Options | ||
| hydraExplorerOptions = | ||
| info | ||
| ( optionsParser | ||
| <**> helper | ||
| ) | ||
| ( fullDesc | ||
| <> progDesc "Explore hydra heads from chain." | ||
| <> header "hydra-explorer" | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should: not re-use
hydra-nodelibrary, but create new trace data types.This makes it harder to decouple this later from it (and
hydra-chain-observer). Also, we are not logging from ahydra-nodehere, but from the explorer.