listStakePools - Include metadata in API responses #1159
Merged
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
KtorZ
reviewed
Dec 11, 2019
| getRegistryZipUrl :: IO String | ||
| getRegistryZipUrl = fromMaybe cardanoFoundationRegistryZip <$> lookupEnv var | ||
| where | ||
| var = "CARDANO_WALLET_STAKE_POOL_REGISTRY_URL" |
KtorZ
reviewed
Dec 11, 2019
lib/core/src/Cardano/Pool/Metrics.hs
Outdated
| newStakePoolLayer db@DBLayer{..} nl tr = StakePoolLayer | ||
| { listStakePools = do | ||
| lift $ logTrace tr MsgListStakePoolsBegin | ||
| stakePools <- rankKnownPools |
There was a problem hiding this comment.
[remark]
You have used to forbidden word (i.e. rank) 😱
It makes things clearer though 👍
KtorZ
reviewed
Dec 11, 2019
rvl
force-pushed
the
rvl/1065/list-stake-pools-meta
branch
from
82cb177
to
c6b2edc
Compare
…tegration test setup
KtorZ
force-pushed
the
rvl/1065/list-stake-pools-meta
branch
from
c6b2edc
to
4de52ca
Compare
KtorZ
reviewed
Dec 11, 2019
| (Map.fromList [(pid, [owner])]) | ||
| [(owner, Just md)] | ||
|
|
||
| res `shouldBe` [(MsgMetadataUsing pid owner md, Just md)] |
KtorZ
reviewed
Dec 11, 2019
| (Map.fromList [(PoolId "1", [PoolOwner "a"])]) | ||
| [(PoolOwner "a", Nothing)] | ||
|
|
||
| res `shouldBe` [(MsgMetadataMissing (PoolId "1"), Nothing)] |
KtorZ
reviewed
Dec 11, 2019
| md `shouldSatisfy` sameStakePoolMetadata mdb | ||
| _ -> fail $ "wrong log message " ++ show msg | ||
|
|
||
| fmap (sameStakePoolMetadata mda) res `shouldBe` Just True |
KtorZ
approved these changes
Dec 11, 2019
…ion with other tests
…treated correctly
…for zipping correctly!
KtorZ
force-pushed
the
rvl/1065/list-stake-pools-meta
branch
from
02fa548
to
baddeec
Compare
KtorZ
approved these changes
Dec 11, 2019
| @@ -170,6 +183,30 @@ spec = do | |||
| expectResponseCode @IO HTTP.status405 r | |||
| expectErrorMessage errMsg405 r | |||
|
|
|||
| it "STAKE_POOLS_LIST_04 - Discovers new pools when they are registered" $ \ctx -> do | |||
There was a problem hiding this comment.
@rvl I added a rather extensive integration test. The setup behind registerStakePool is a bit complex because we have to do everything with jcli and use accounts to pay for the registration certificate! I got to the end of it and.. nicely caught a small bug in the "zipping logic" from the listStakePools endpoint (cf my last commit).
Please have another round of review / fixes and let's get this merged!
Some outstanding points remaining after that:
- Maybe do some caching? I expect this endpoint to be quite heavily hammered by clients like Daedalus. The registry won't change very often. Renewing a cache every hour or so should also mitigate the concern.
- Currently the handler for
joinStakePoolrelies onlistStakePoolto get a list of known stake pool... that's kinda lame becauselistStakePoolis a very heavy operation and, all stake pools ids can be known by simply making a database call. So we should fix that. - Apparent performance could be wrong for brief times (because of multiple sources of truth) #1158
|
bors try |
tryBuild failed |
https://github.com/input-output-hk/testnet-stake-pool-registry/archive/master.zip Current revision: c6d196f630b28869bffb9e3af453a9c65be2fa7c
|
bors r+ |
iohk-bors bot
added a commit
that referenced
this pull request
Dec 12, 2019
1159: listStakePools - Include metadata in API responses r=rvl a=rvl Relates to #1065. # Overview - Modified Api.Server.listPools and StakePoolLayer listStakePools to include metadata. - Made it possible to use an environment variable for the registry url. - Handles the case where different stake pool owners register different metadata by logging and then ignoring all inconsistent data. # Comments - This is a draft. Co-authored-by: Rodney Lorrimar <rodney.lorrimar@iohk.io> Co-authored-by: KtorZ <matthias.benkort@gmail.com>
Build succeeded |
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.
Relates to #1065.
Overview
Comments