Update API response object #4994
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
Performance Report✔️ no performance regression detected Full benchmark results
|
|
This API is very strange, there must be another way such that routes do not have to expose the status code publishBlock(block: allForks.SignedBeaconBlock): Promise<HttpStatusCode>; |
nazarhussain
force-pushed
the
nh/4993-node-health
branch
from
eccb215 to
923137f
Compare
wemeetagain
reviewed
Jan 16, 2023
|
|
||
| /** | ||
| * REST HTTP client for lightclient routes | ||
| */ | ||
| export function getClient(_config: IChainForkConfig, httpClient: IHttpClient): Api { | ||
| export function getClient<ErrorAsResponse extends boolean = false>( |
There was a problem hiding this comment.
Can you document the behavior of ErrorAsResponse somewhere?
Seems that depending on the option passed, you can make errors either throw or return.
Do we need both behaviors? Might be simpler to pick a convention (ie always return) and stick with it.
There was a problem hiding this comment.
@wemeetagain My preference is to use always return case. But to avoid backward compatibility, I made it optional for now. If we all agree to one approach we can stick to it.
nazarhussain
changed the title
…nto nh/4993-node-health
wemeetagain
reviewed
Jan 19, 2023
| @@ -11,8 +11,10 @@ Typescript REST client for the [Ethereum Consensus API spec](https://github.com/ | |||
|
|
|||
| ## Usage | |||
|
|
|||
| We use more typesafe approach for the API client, where all the errors are returned not thrown. This approach is more easy to document and better to handle all possible error cases. | |||
There was a problem hiding this comment.
Maybe also reference the similarity to the Response type.
| // For `getState()` generate request serializer | ||
| const fetchOptsSerializers = getFetchOptsSerializers<Api, ReqTypes>(routesData, reqSerializers); | ||
|
|
||
| return { | ||
| ...client, | ||
|
|
||
| // TODO: Debug the type issue |
There was a problem hiding this comment.
Can you also think about how we would be able to incorporate this? ethereum/beacon-APIs#250
There was a problem hiding this comment.
We already have support for SZZ encoding for few endpoints, similarly we can support for others when required.
There was a problem hiding this comment.
This beacon-apis PR is about systematically supporting SSZ for all endpoints, not just supporting one-by-one.
Edit: I'm not suggesting to tackle this in this PR, just more an FYI of possible improvement that will be desired.
dapplion
reviewed
Jan 19, 2023
| * Hypertext Transfer Protocol (HTTP) response status codes. | ||
| * @see {@link https://www.rfc-editor.org/rfc/rfc7231#section-6} | ||
| */ | ||
| export enum HttpStatusCode { |
There was a problem hiding this comment.
Who is using all these protocols? What's the point of declaring this?
There was a problem hiding this comment.
To create types for the API which is completely matching the specification.
There was a problem hiding this comment.
I mean just declare the codes actually used, not every single code out there
dapplion
reviewed
Jan 19, 2023
Do we need to change the monorepo to 2.0 for this? We should consider:
|
|
@dapplion @wemeetagain I think we consider from a product mindset. This is not a breaking change for the Lodestar users. Where as it concerns for |
wemeetagain
changed the title
wemeetagain
approved these changes
Jan 20, 2023
Closed
11 tasks
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
Make the
/eth/v1/node/healthcompliance with the spec.Description
Read/Write the http status code for the node health.
Closes #4993
Steps to test or reproduce
Run all tests.