Skip to content

Commit fb2871d

Browse files
newhoggynewhoggy
committed
Standardise on default output format of json for 'query ledger-peer-snapshot' command. Also support json-pretty and yaml output.
1 parent cb80252 commit fb2871d

File tree

7 files changed

+81
-31
lines changed

7 files changed

+81
-31
lines changed

‎cardano-cli/src/Cardano/CLI/EraBased/Query/Command.hs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ data QueryLedgerStateCmdArgs = QueryLedgerStateCmdArgs
149149

150150
data QueryLedgerPeerSnapshotCmdArgs = QueryLedgerPeerSnapshotCmdArgs
151151
{ commons :: !QueryCommons
152+
, outputFormat :: !(Vary [FormatJson, FormatJsonPretty, FormatYaml])
152153
, mOutFile :: !(Maybe (File () Out))
153154
}
154155
deriving (Generic, Show)

‎cardano-cli/src/Cardano/CLI/EraBased/Query/Option.hs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,12 @@ pQueryLedgerPeerSnapshotCmd era envCli =
427427
fmap QueryLedgerPeerSnapshotCmd $
428428
QueryLedgerPeerSnapshotCmdArgs
429429
<$> pQueryCommons era envCli
430+
<*> pFormatFlags
431+
"ledger-peer-snapshot output"
432+
[ flagFormatJson & setDefault
433+
, flagFormatJsonPretty
434+
, flagFormatYaml
435+
]
430436
<*> pMaybeOutputFile
431437

432438
pQueryProtocolStateCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)

‎cardano-cli/src/Cardano/CLI/EraBased/Query/Run.hs

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ import Data.Text.Encoding qualified as Text
9292
import Data.Text.IO qualified as T
9393
import Data.Text.Lazy.IO qualified as LT
9494
import Data.Time.Clock
95+
import Data.Yaml qualified as Yaml
9596
import GHC.Exts (IsList (..))
9697
import GHC.Generics
9798
import Lens.Micro ((^.))
@@ -852,25 +853,51 @@ runQueryLedgerPeerSnapshot
852853
{ Cmd.nodeConnInfo
853854
, Cmd.target
854855
}
856+
, Cmd.outputFormat
855857
, Cmd.mOutFile
856858
} = do
857-
join $
858-
lift
859-
( executeLocalStateQueryExpr nodeConnInfo target $ runExceptT $ do
860-
AnyCardanoEra era <-
861-
lift queryCurrentEra
862-
& onLeft (left . QueryCmdUnsupportedNtcVersion)
859+
result <-
860+
join $
861+
lift
862+
( executeLocalStateQueryExpr nodeConnInfo target $ runExceptT $ do
863+
AnyCardanoEra era <-
864+
lift queryCurrentEra
865+
& onLeft (left . QueryCmdUnsupportedNtcVersion)
863866

864-
sbe <-
865-
requireShelleyBasedEra era
866-
& onNothing (left QueryCmdByronEra)
867+
sbe <-
868+
requireShelleyBasedEra era
869+
& onNothing (left QueryCmdByronEra)
867870

868-
result <- easyRunQuery (queryLedgerPeerSnapshot sbe)
871+
result <- easyRunQuery (queryLedgerPeerSnapshot sbe)
869872

870-
pure $ shelleyBasedEraConstraints sbe (writeLedgerPeerSnapshot mOutFile) result
871-
)
872-
& onLeft (left . QueryCmdAcquireFailure)
873-
& onLeft left
873+
pure $
874+
shelleyBasedEraConstraints sbe $
875+
case decodeBigLedgerPeerSnapshot result of
876+
Left (bs, _decoderError) -> pure $ Left bs
877+
Right snapshot -> pure $ Right snapshot
878+
)
879+
& onLeft (left . QueryCmdAcquireFailure)
880+
& onLeft left
881+
882+
case result of
883+
Left (bs :: LBS.ByteString) -> do
884+
firstExceptT QueryCmdHelpersError $ pPrintCBOR bs
885+
Right (snapshot :: LedgerPeerSnapshot) -> do
886+
outputContents <-
887+
outputFormat
888+
& ( id
889+
. Vary.on (\FormatJson -> pure $ Aeson.encode snapshot)
890+
. Vary.on (\FormatJsonPretty -> pure $ encodePretty snapshot)
891+
. Vary.on (\FormatYaml -> pure $ LBS.fromStrict $ Yaml.encode snapshot)
892+
$ Vary.exhaustiveCase
893+
)
894+
895+
let writeOutputContents =
896+
case mOutFile of
897+
Nothing -> liftIO . LBS.putStrLn
898+
Just (File outFile) -> liftIO . LBS.writeFile outFile
899+
900+
writeOutputContents outputContents
874901

875902
runQueryProtocolStateCmd
876903
:: ()
@@ -1077,23 +1104,6 @@ writeStakeAddressInfo
10771104
mDRep = Map.lookup addr voteDelegatees
10781105
]
10791106

1080-
-- | Writes JSON-encoded big ledger peer snapshot
1081-
writeLedgerPeerSnapshot
1082-
:: Maybe (File () Out)
1083-
-> Serialised LedgerPeerSnapshot
1084-
-> ExceptT QueryCmdError IO ()
1085-
writeLedgerPeerSnapshot mOutPath serBigLedgerPeerSnapshot = do
1086-
case decodeBigLedgerPeerSnapshot serBigLedgerPeerSnapshot of
1087-
Left (bs, _decoderError) ->
1088-
firstExceptT QueryCmdHelpersError $ pPrintCBOR bs
1089-
Right snapshot ->
1090-
case mOutPath of
1091-
Nothing -> liftIO . LBS.putStrLn $ Aeson.encode snapshot
1092-
Just fpath ->
1093-
firstExceptT QueryCmdWriteFileError $
1094-
newExceptT . writeLazyByteStringFile fpath $
1095-
encodePretty snapshot
1096-
10971107
writeStakeSnapshots
10981108
:: forall era
10991109
. Maybe (File () Out)

‎cardano-cli/test/cardano-cli-golden/files/golden/help.cli

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -493,6 +493,10 @@ Usage: cardano-cli query ledger-peer-snapshot
493493
[ --volatile-tip
494494
| --immutable-tip
495495
]
496+
[ --output-json
497+
| --output-json-pretty
498+
| --output-yaml
499+
]
496500
[--out-file FILEPATH]
497501

498502
Dump the current snapshot of big ledger peers. These are the largest pools
@@ -2048,6 +2052,10 @@ Usage: cardano-cli conway query ledger-peer-snapshot
20482052
[ --volatile-tip
20492053
| --immutable-tip
20502054
]
2055+
[ --output-json
2056+
| --output-json-pretty
2057+
| --output-yaml
2058+
]
20512059
[--out-file FILEPATH]
20522060

20532061
Dump the current snapshot of ledger peers.These are the largest pools that
@@ -4285,6 +4293,10 @@ Usage: cardano-cli latest query ledger-peer-snapshot
42854293
[ --volatile-tip
42864294
| --immutable-tip
42874295
]
4296+
[ --output-json
4297+
| --output-json-pretty
4298+
| --output-yaml
4299+
]
42884300
[--out-file FILEPATH]
42894301

42904302
Dump the current snapshot of ledger peers.These are the largest pools that

‎cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_ledger-peer-snapshot.cli

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Usage: cardano-cli conway query ledger-peer-snapshot
88
[ --volatile-tip
99
| --immutable-tip
1010
]
11+
[ --output-json
12+
| --output-json-pretty
13+
| --output-yaml
14+
]
1115
[--out-file FILEPATH]
1216

1317
Dump the current snapshot of ledger peers.These are the largest pools that
@@ -30,5 +34,8 @@ Available options:
3034
--volatile-tip Use the volatile tip as a target. (This is the
3135
default)
3236
--immutable-tip Use the immutable tip as a target.
37+
--output-json Format ledger-peer-snapshot output to JSON (default).
38+
--output-json-pretty Format ledger-peer-snapshot output to JSON.
39+
--output-yaml Format ledger-peer-snapshot output to YAML.
3340
--out-file FILEPATH Optional output file. Default is to write to stdout.
3441
-h,--help Show this help text

‎cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_ledger-peer-snapshot.cli

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Usage: cardano-cli latest query ledger-peer-snapshot
88
[ --volatile-tip
99
| --immutable-tip
1010
]
11+
[ --output-json
12+
| --output-json-pretty
13+
| --output-yaml
14+
]
1115
[--out-file FILEPATH]
1216

1317
Dump the current snapshot of ledger peers.These are the largest pools that
@@ -30,5 +34,8 @@ Available options:
3034
--volatile-tip Use the volatile tip as a target. (This is the
3135
default)
3236
--immutable-tip Use the immutable tip as a target.
37+
--output-json Format ledger-peer-snapshot output to JSON (default).
38+
--output-json-pretty Format ledger-peer-snapshot output to JSON.
39+
--output-yaml Format ledger-peer-snapshot output to YAML.
3340
--out-file FILEPATH Optional output file. Default is to write to stdout.
3441
-h,--help Show this help text

‎cardano-cli/test/cardano-cli-golden/files/golden/help/query_ledger-peer-snapshot.cli

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Usage: cardano-cli query ledger-peer-snapshot
88
[ --volatile-tip
99
| --immutable-tip
1010
]
11+
[ --output-json
12+
| --output-json-pretty
13+
| --output-yaml
14+
]
1115
[--out-file FILEPATH]
1216

1317
Dump the current snapshot of big ledger peers. These are the largest pools
@@ -30,5 +34,8 @@ Available options:
3034
--volatile-tip Use the volatile tip as a target. (This is the
3135
default)
3236
--immutable-tip Use the immutable tip as a target.
37+
--output-json Format ledger-peer-snapshot output to JSON (default).
38+
--output-json-pretty Format ledger-peer-snapshot output to JSON.
39+
--output-yaml Format ledger-peer-snapshot output to YAML.
3340
--out-file FILEPATH Optional output file. Default is to write to stdout.
3441
-h,--help Show this help text

0 commit comments

Comments
 (0)