feat: library `canhttp` by gregorydemay · Pull Request #364 · dfinity/evm-rpc-canister

gregorydemay · 2025-02-03T15:49:52Z

Starts extracting the logic to handle HTTPs outcalls into a separate library, named canhttp, that temporarily lives in the same repository. The main idea is to start from a low-level client implementing the tower::Service trait that can be extended by additional middlewares. This PR focusses on this low-level client and a first middleware handling cycles accounting.

Left for future PRs:

Add a mapping layer so that requests are of type http::Request<> and responses are of type http::Response<>. This will allow to be able to use the Request builder from the http crate as well as various HTTP-specific middlewares such as the ones from the tower-http crate. In particular, the TraceLayer will allow to react on requests/responses to add the appropriates metrics and logs.
Add an additional mapping layer for JSON-RPC applications so that requests are of type http::Request<JsonRpcRequest<>> and responses are of type http::Response<JsonRpcResponse<>> to easily make JSON-RPC requests.

# Conflicts: # src/memory.rs

gregorydemay

Thanks @lpahlavi for the review and the interesting questions!

canhttp/src/client/mod.rs

canhttp/src/cycles/mod.rs

canhttp/src/cycles/tests.rs

src/memory.rs

Co-authored-by: Louis Pahlavi <louis.pahlavi@gmail.com>

lpahlavi

@gregorydemay thanks a lot for the detailed explanation!

I was a little bit confused at cycles_to_attach and cycles_to_charge but actually it makes complete sense now. I think ultimately a little explanation in the README for example could make sense, but I would take care of this kind of documentation only once the library is close to being done.

Overall the code LGTM! Thanks again for the PR!

canhttp/src/cycles/mod.rs

# Conflicts: # Cargo.toml

lpahlavi

@gregorydemay I think it looks very good now, especially with the changes suggested by @ninegua! LGTM 🚀

Follow-up on #364 to add a new observability layer to take care of logging and metrics. Unfortunately, [`tower_http::trace`](https://docs.rs/tower-http/latest/tower_http/trace/index.html) cannot be used in a canister environment because it measures call latency with `Instant::now`. The proposed layer, while inspired by [`tower_http::trace`](https://docs.rs/tower-http/latest/tower_http/trace/index.html), is also simpler because it does not have to deal with streaming responses. --------- Co-authored-by: Louis Pahlavi <louis.pahlavi@gmail.com>

Follow-up on #370 and #364 to add a conversion layer between request and responses so that the caller only has to deal with types from the Rust [`http`](https://crates.io/crates/http) crate. This has several advantages from the caller's point of view: 1. Can re-use existing types like `Request::builder` or `StatusCode`. 2. Requests are automatically sanitized and canonicalized (e.g. header names are validated and lower cased). 3. Can re-use existing middlewares, like from the `[tower-http`](https://crates.io/crates/tower-http) crate, since many of them require a client that uses the [`http`](https://crates.io/crates/http) crate.

Follow-up on #370, #364, and #374 to add a conversion layer between request and responses to handle [JSON RPC](https://www.jsonrpc.org/specification) over HTTP. Concretely: 1. Refactor existing infrastructure to handle errors explicitly, instead of having to downcast `BoxError`. This is beneficial since errors may happen at different layers and they all need to be handled by the above observability layer, e.g., add the corresponding metric in case the response has a non successful status. 2. Refactor existing infrastructure to transform request and response to use a single `Convert` trait to convert one type into another with some potential error. 3. Add a layer for `http::Request` and `http::Response` to transform their body into a JSON RPC type. This uses the above `Convert` trait. This conversion layer is behind a feature flag (`json`) since it requires `serde_json` to handle the serialization/deserialization 4. Add a new layer to filter out non-successful HTTP responses.

Follow-up on #370, #364, #374, and #375 to automatically retry requests by doubling its `max_response_bytes` when the response was too big.

Starts extracting the logic to handle HTTPs outcalls into a separate library, named `canhttp`, that temporarily lives in the same repository. The main idea is to start from a low-level client implementing the [`tower::Service`](https://docs.rs/tower/latest/tower/trait.Service.html) trait that can be extended by additional middlewares. This PR focusses on this low-level client and a first middleware handling cycles accounting. Left for future PRs: 1. Add a mapping layer so that requests are of type `http::Request<>` and responses are of type `http::Response<>`. This will allow to be able to use the `Request` builder from the [`http`](https://crates.io/crates/http) crate as well as various HTTP-specific middlewares such as the ones from the [`tower-http`](https://crates.io/crates/tower-http) crate. In particular, the [`TraceLayer`](https://docs.rs/tower-http/latest/tower_http/trace/index.html) will allow to react on requests/responses to add the appropriates metrics and logs. 2. Add an additional mapping layer for JSON-RPC applications so that requests are of type `http::Request<JsonRpcRequest<>>` and responses are of type `http::Response<JsonRpcResponse<>>` to easily make JSON-RPC requests. --------- Co-authored-by: Louis Pahlavi <louis.pahlavi@gmail.com>

Follow-up on dfinity/evm-rpc-canister#364 to add a new observability layer to take care of logging and metrics. Unfortunately, [`tower_http::trace`](https://docs.rs/tower-http/latest/tower_http/trace/index.html) cannot be used in a canister environment because it measures call latency with `Instant::now`. The proposed layer, while inspired by [`tower_http::trace`](https://docs.rs/tower-http/latest/tower_http/trace/index.html), is also simpler because it does not have to deal with streaming responses. --------- Co-authored-by: Louis Pahlavi <louis.pahlavi@gmail.com>

Follow-up on dfinity/evm-rpc-canister#370 and dfinity/evm-rpc-canister#364 to add a conversion layer between request and responses so that the caller only has to deal with types from the Rust [`http`](https://crates.io/crates/http) crate. This has several advantages from the caller's point of view: 1. Can re-use existing types like `Request::builder` or `StatusCode`. 2. Requests are automatically sanitized and canonicalized (e.g. header names are validated and lower cased). 3. Can re-use existing middlewares, like from the `[tower-http`](https://crates.io/crates/tower-http) crate, since many of them require a client that uses the [`http`](https://crates.io/crates/http) crate.

Follow-up on dfinity/evm-rpc-canister#370, dfinity/evm-rpc-canister#364, and dfinity/evm-rpc-canister#374 to add a conversion layer between request and responses to handle [JSON RPC](https://www.jsonrpc.org/specification) over HTTP. Concretely: 1. Refactor existing infrastructure to handle errors explicitly, instead of having to downcast `BoxError`. This is beneficial since errors may happen at different layers and they all need to be handled by the above observability layer, e.g., add the corresponding metric in case the response has a non successful status. 2. Refactor existing infrastructure to transform request and response to use a single `Convert` trait to convert one type into another with some potential error. 3. Add a layer for `http::Request` and `http::Response` to transform their body into a JSON RPC type. This uses the above `Convert` trait. This conversion layer is behind a feature flag (`json`) since it requires `serde_json` to handle the serialization/deserialization 4. Add a new layer to filter out non-successful HTTP responses.

Follow-up on dfinity/evm-rpc-canister#370, dfinity/evm-rpc-canister#364, dfinity/evm-rpc-canister#374, and dfinity/evm-rpc-canister#375 to automatically retry requests by doubling its `max_response_bytes` when the response was too big.

The library `canhttp` that was initially in the EVM RPC canister [repository](https://github.com/dfinity/evm-rpc-canister) was moved **as is** from commit [3995dbd](https://github.com/dfinity/evm-rpc-canister/tree/3995dbd3eb3b03a781aaf35453d6757fa6edac47/canhttp) to this repository as commit [d41568a](d41568a) while preserving the Git history (using `git filter-repo --subdirectory-filter canhttp` as described [here](https://gist.github.com/trongthanh/2779392)). Additionally, the Git history was rewritten to preserve the links to the original PRs with ``` git filter-repo --message-callback 'return re.sub(br"#(\d{3})", br"dfinity/evm-rpc-canister#\1", message)' ``` so that commit messages like this [one](d41568a) that were pointed to PRs such as `#364` are now pointing to `dfinity/evm-rpc-canister#364`. This broke various things that this PR addresses: 1. Symlinks for license and notice that were pointing to files outside the moved crate. 2. Re-create a Cargo workspace. 3. Add Github CI pipeline.

gregorydemay added 21 commits February 3, 2025 16:42

new crate canjsonrpc

6935680

setup auxiliary files

932ecb0

JSON RPC types

a58d7f3

request builder

af1454d

skeleton to execute request

e7dc79d

cycles charging

0ce804e

retry strategy

7d9763b

added request builder methods

c5d0dec

constructor JsonRpcRequest

5863011

PoC with Tower

09daf7f

copied over cycles cost calculation

84a00a9

charge user as filter

c27f7a7

retry policy if response too large

f7929d5

map request/response to JSON RPC

aedffaf

layered service HTTP -> ICP

cf78f22

dump

dbd89d5

Revert

14627b7

rename canhttp

066016c

basic cycles handling

2236d82

IC client

d2c172f

build client in evm_rpc_canister

996e5c4

gregorydemay changed the title ~~feat: library canjsonrpc~~ feat: library canhttp Feb 10, 2025

gregorydemay added 8 commits February 10, 2025 15:35

Merge branch 'main' into gdemay/XC-287-canjsonrpc

336d970

# Conflicts: # src/memory.rs

use client from canhttp

1a8f6de

clippy

66fb8ae

move cycle accounting to canhttp

431a1bb

default implementation RequestCyclesCostWithCollateralEstimator

54cde76

Put cycles accounting on a separate layer

8f1df2d

docs

5492d68

fix: use cycles to charge for request_cost

9c4b59c

gregorydemay commented Feb 12, 2025

View reviewed changes

gregorydemay and others added 2 commits February 12, 2025 08:48

Apply suggestions from code review

eaba9b1

Co-authored-by: Louis Pahlavi <louis.pahlavi@gmail.com>

Improve doc

54d2789

Co-authored-by: Louis Pahlavi <louis.pahlavi@gmail.com>

lpahlavi previously approved these changes Feb 12, 2025

View reviewed changes

canhttp/src/cycles/mod.rs Show resolved Hide resolved

canhttp/src/cycles/mod.rs Show resolved Hide resolved

canhttp/src/cycles/mod.rs Show resolved Hide resolved

gregorydemay added 5 commits February 13, 2025 09:17

Merge branch 'main' into gdemay/XC-287-canjsonrpc

f709fb5

# Conflicts: # Cargo.toml

remove trait cycles to attach

360ac72

rename

f75eef7

linting

394ea3a

fix CI

f5c3dc6

gregorydemay dismissed lpahlavi’s stale review via f5c3dc6 February 13, 2025 14:48

ninegua approved these changes Feb 13, 2025

View reviewed changes

lpahlavi approved these changes Feb 13, 2025

View reviewed changes

gregorydemay merged commit f2b62c4 into main Feb 13, 2025
7 checks passed

gregorydemay deleted the gdemay/XC-287-canjsonrpc branch February 13, 2025 15:51

gregorydemay mentioned this pull request Feb 14, 2025

feat: observability layer #370

Merged

gregorydemay mentioned this pull request Feb 26, 2025

feat: HTTP conversion layer #374

Merged

gregorydemay mentioned this pull request Mar 4, 2025

feat: JSON RPC conversion layer #375

Merged

gregorydemay mentioned this pull request Mar 7, 2025

feat: retry layer #378

Merged

gregorydemay added a commit that referenced this pull request Mar 11, 2025

feat: retry layer (#378)

ab1c1cd

Follow-up on #370, #364, #374, and #375 to automatically retry requests by doubling its `max_response_bytes` when the response was too big.

This was referenced Nov 19, 2025

chore: release dfinity/canhttp#51

Closed

chore: release dfinity/canhttp#56

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: library `canhttp`#364

feat: library `canhttp`#364
gregorydemay merged 39 commits intomainfrom
gdemay/XC-287-canjsonrpc

gregorydemay commented Feb 3, 2025 •

edited

Loading

Uh oh!

gregorydemay left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gregorydemay commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gregorydemay commented Feb 3, 2025 •

edited

Loading