Add ReaderT of NodeToClientVersion to LocalStateQueryExpr #4809
Conversation
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
newhoggy
commented
Jan 19, 2023
|
|
||
| -- | Execute a local state query expression. | ||
| executeLocalStateQueryExpr | ||
| :: LocalNodeConnectInfo mode | ||
| -> Maybe ChainPoint | ||
| -> (NodeToClientVersion -> LocalStateQueryExpr (BlockInMode mode) ChainPoint (QueryInMode mode) () IO a) |
There was a problem hiding this comment.
The use of ReaderT allows this argument to simplify. This means that a query can be run like this:
executeLocalStateQueryExpr ... $ do
...
expr
...
instead of like this:
executeLocalStateQueryExpr ... $ \ntcVersion -> do
...
expr
...
We are transitioning from the later code because we want the ntcVersion to be checked automatically rather than manually. The ntcVersion argument was passed in via a lambda before because the monadic query expression previously check the version manually which is error prone.
newhoggy
commented
Jan 19, 2023
| @@ -284,7 +284,8 @@ runQueryTip (AnyConsensusModeParams cModeParams) network mOutFile = do | |||
| CardanoMode -> do | |||
| let localNodeConnInfo = LocalNodeConnectInfo cModeParams network sockPath | |||
|
|
|||
| eLocalState <- liftIO $ executeLocalStateQueryExpr localNodeConnInfo Nothing $ \ntcVersion -> do | |||
| eLocalState <- liftIO $ executeLocalStateQueryExpr localNodeConnInfo Nothing $ do | |||
| ntcVersion <- ask | |||
There was a problem hiding this comment.
This monadic expression checks the node to client version manually. It will switch to automatic checking in a future PR to be less error prone, but for until that capability is avilable, ntcVersion is still accessible via ask so manual check is still possible.
newhoggy
requested review from
dcoutts,
Jimbo4350,
erikd,
JaredCorduan,
LudvikGalois and
CarlosLopezDeLara
as code owners
iohk-bors
bot
deleted the
newhoggy/introduce-ReaderT-into-LocalStateQueryExpr
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
NodeToClientVersionfor a connection is established as soon as the connection is created an never changes. This makesReaderTa good fit for holding this value so that it can be retrieved by the monadic query expressions.