Implement standard keymanager API - review #3880
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
dapplion
changed the title
Performance Report✔️ no performance regression detected Full benchmark results
|
dapplion
commented
Apr 3, 2022
| @@ -80,7 +76,7 @@ export class KeymanagerApi implements Api { | |||
| message?: string; | |||
| }[]; | |||
| }> { | |||
| const interchange = (slashingProtectionStr as unknown) as Interchange; | |||
| const interchange = JSON.parse(slashingProtectionStr) as Interchange; | |||
There was a problem hiding this comment.
@dadepo do you know why JSON.parse() was not necessary if slashingProtectionStr is supposed to be a string?
There was a problem hiding this comment.
That's because the arguments to the function is passed in as an http body and fastify parses it already, so by the time our code calls finds the relevant handler here it is already an object hence no need to use JSON.parse within the function.
I also think the types safety of the function is weaker as it is decoupled from the calling logic in here so at runtime, it is an object that is passed in, which is then attempted to be parsed into JSON
My guess is that If it were a query path or params, then the parsing will be needed.
There was a problem hiding this comment.
So can you add a nice long comment explaining this above my change and do conditional parsing?
const interchange: Interchange = typeof slashingProtectionStr === "string" ? JSON.parse(slashingProtectionStr) : slashingProtectionStr;There was a problem hiding this comment.
I added a comment but I feel that the conditional parsing is not necessary since the endpoint is going to be called with the payload within the body of the request.
Also the snippet you shared won't work. What will work will require changing the type for slashingProtectionStr: SlashingProtectionData | Record<string, unknown> and then have the conditional parsing as follows:
const interchange = typeof slashingProtectionStr === "string"
? (JSON.parse(slashingProtectionStr) as Interchange)
: ((slashingProtectionStr as unknown) as Interchange);
Which I think is a bit too much since payload will always come within the body
dapplion
commented
Apr 3, 2022
Codecov Report
@@ Coverage Diff @@
## master #3880 +/- ##
==========================================
- Coverage 36.25% 34.96% -1.29%
==========================================
Files 328 328
Lines 9142 10683 +1541
Branches 1438 1790 +352
==========================================
+ Hits 3314 3735 +421
- Misses 5682 6795 +1113
- Partials 146 153 +7 |
Closed
|
@dadepo Please if you can fix the test I broken and approve if it looks good then 🙏 |
Tests are now passing! |
g11tech
approved these changes
Apr 8, 2022
wemeetagain
approved these changes
Apr 8, 2022
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.
Motivation
Post-merge review of #3522
Description
Fixes some potential issues: