Improve system api to perform HTTP requests #2631
Draft
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
jvff
force-pushed
the
improve-http-request-system-api
branch
3 times, most recently
from
0f528cb to
2cc7ab5
Compare
jvff
force-pushed
the
improve-http-request-system-api
branch
from
2cc7ab5 to
550315e
Compare
Make it easier to find feature definitions.
Prepare to allow applications to specify the HTTP method to use.
Prepare to support other HTTP methods.
Allow specifying which HTTP method should be used for the request.
Allow specifying multiple headers for the request.
Use a broader name since now the HTTP method can be specified.
They don't seem to be used.
Make it simpler to tweak how it is serialized and formatted for debug output.
Represent useful information from an HTTP response.
Instead of just the response body.
Collect all the parameters for `http_request` into a single type.
Simplify the API a bit, and make it simpler to change the types in the future if needed.
Allow creating some simple common HTTP requests.
Make it easy to add headers to `http::Request`s.
The API is already available in the WIT interface, so it makes sense to expose it in a more discoverable way.
Allow services to write unit tests using the new API.
Provide access to the `http::Request` and `http::Response` types needed to use the APIs.
Allow it to be enabled for testing.
Make it simple to create a new `Response` with just a status code and no headers or body.
Make it easy to build simple success responses.
Make it easy to build simple unauthorized error responses.
Make it easy to add headers to `http::Response`s.
jvff
force-pushed
the
improve-http-request-system-api
branch
from
550315e to
26a5299
Compare
ma2bd
reviewed
Jan 15, 2025
| /// A POST request. | ||
| Post, | ||
|
|
||
| /// A PUT request. |
There was a problem hiding this comment.
Should we support all these methods?
Where do we expect the contract (whose state and code are both public) to get this information? 🤔 |
This use case specifically was needed in the service for the airdrop demo. But yeah, for contracts other custom headers might be more relevant. |
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
Linera applications can perform HTTP requests to external services, but the available
http_postAPI was very limited, and prevented applications from configuring the request. This is often needed in order to add custom headers, for example for authentication.Proposal
Replace the
http_postAPI with a broaderhttp_requestAPI, which allows sending more configurablehttp::Requests, and returns a more detailedhttp::Response.Test Plan
TODO
Release Plan
devnetand release a newSDK soon.
linera-sdkAPI.Links