rpc: backpressured RPC server (bump jsonrpsee 0.20) by niklasad1 · Pull Request #1313 · paritytech/polkadot-sdk

niklasad1 · 2023-08-30T15:21:11Z

This is a rather big change in jsonrpsee, the major things in this bump are:

Server backpressure (the subscription impls are modified to deal with that)
Allow custom error types / return types (remove jsonrpsee::core::Error and jsonrpee::core::CallError)
Bug fixes (graceful shutdown in particular not used by substrate anyway)
Less dependencies for the clients in particular
Return type requires Clone in method call responses
Moved to tokio channels
Async subscription API (not used in this PR)

Major changes in this PR:

The subscriptions are now bounded and if subscription can't keep up with the server it is dropped
CLI: add parameter to configure the jsonrpc server bounded message buffer (default is 64)
Add our own subscription helper to deal with the unbounded streams in substrate

The most important things in this PR to review is the added helpers functions in substrate/client/rpc/src/utils.rs and the rest is pretty much chore.

Regarding the "bounded buffer limit" it may cause the server to handle the JSON-RPC calls
slower than before.

The message size limit is bounded by "--rpc-response-size" thus "by default 10MB * 64 = 640MB"
but the subscription message size is not covered by this limit and could be capped as well.

Hopefully the last release prior to 1.0, sorry in advance for a big PR

Previous attempt: paritytech/substrate#13992

Resolves #748, resolves #627

nazar-pc · 2023-09-25T15:06:29Z

I'm following PR to see when it lands and I find it annoying how many notifications about force pushes just to fix clippy are happening. Can't you run clippy locally and fix it all at once before pushing to GitHub in the first place?

niklasad1 · 2023-09-25T15:25:19Z

Sorry about that but I'm force pushing to make it easy to backport to a previous polkadot release, I haven't fixed the tests when I rebased/merged it to master. That's why clippy complains ^^

Would be nice if Github could just subscribe you when it's actually PR and not draft 🙏

substrate/client/rpc/src/lib.rs

niklasad1 · 2023-10-30T11:13:48Z

substrate/client/service/src/lib.rs

 		&self,
 		json_query: &str,
-	) -> Result<(String, mpsc::UnboundedReceiver<String>), JsonRpseeError> {
+	) -> Result<(String, tokio::sync::mpsc::Receiver<String>), JsonRpseeError> {


breaking change: bounded channel now

Not sure whether this should be regarded as a breaking change in node release, probably not as it's a custom API.

niklasad1 · 2023-10-30T11:16:05Z

substrate/client/rpc-servers/Cargo.toml

 prometheus-endpoint = { package = "substrate-prometheus-endpoint", path = "../../utils/prometheus" }
 tower-http = { version = "0.4.0", features = ["cors"] }
-tower = "0.4.13"
+tower = { version = "0.4.13", features = ["util"] }


"feature = util" needed for the option_layer API.

This is a rather big change in jsonrpsee, the major things in this bump are: - Server backpressure (the subscription impls are modified to deal with that) - Allow custom error types / return types (remove jsonrpsee::core::Error and jsonrpee::core::CallError) - Bug fixes (graceful shutdown in particular not used by substrate anyway) - Less dependencies for the clients in particular - Return type requires Clone in method call responses - Moved to tokio channels - Async subscription API (not used in this PR) Major changes in this PR: - The subscriptions are now bounded and if subscription can't keep up with the server it is dropped - CLI: add parameter to configure the jsonrpc server bounded message buffer (default is 64) - Add our own subscription helper to deal with the unbounded streams in substrate The most important things in this PR to review is the added helpers functions in `substrate/client/rpc/src/utils.rs` and the rest is pretty much chore. Regarding the "bounded buffer limit" it may cause the server to handle the JSON-RPC calls slower than before. The message size limit is bounded by "--rpc-response-size" thus "by default 10MB * 64 = 640MB" but the subscription message size is not covered by this limit and could be capped as well. Hopefully the last release prior to 1.0, sorry in advance for a big PR Previous attempt: paritytech/substrate#13992 Resolves paritytech#748, resolves paritytech#627

* Setup deps * Remove Koi from account migration test * paritytech/polkadot-sdk#1495 * Bump * paritytech/polkadot-sdk#1524 * !! paritytech/polkadot-sdk#1363 * paritytech/polkadot-sdk#1492 * paritytech/polkadot-sdk#1911 * paritytech/polkadot-sdk#1900 Signed-off-by: Xavier Lau <[email protected]> * paritytech/polkadot-sdk#1661 * paritytech/polkadot-sdk#2144 * paritytech/polkadot-sdk#2048 * paritytech/polkadot-sdk#1672 * paritytech/polkadot-sdk#2303 * paritytech/polkadot-sdk#1256 * Remove identity and vesting * Fixes * paritytech/polkadot-sdk#2657 * paritytech/polkadot-sdk#1313 * paritytech/polkadot-sdk#2331 * paritytech/polkadot-sdk#2409 part.1 * paritytech/polkadot-sdk#2767 * paritytech/polkadot-sdk#2521 Signed-off-by: Xavier Lau <[email protected]> * paritytech/polkadot-sdk#1222 * paritytech/polkadot-sdk#1234 part.1 * Satisfy compiler * XCM V4 part.1 * paritytech/polkadot-sdk#1246 * Remove pallet-democracy part.1 * paritytech/polkadot-sdk#2142 * paritytech/polkadot-sdk#2428 * paritytech/polkadot-sdk#3228 * XCM V4 part.2 * Bump * Build all runtimes * Build node * Remove pallet-democracy Signed-off-by: Xavier Lau <[email protected]> * Format * Fix pallet tests * Fix precompile tests * Format * Fixes * Async, remove council, common pallet config * Fix `ethtx-forward` test case (#1519) * Fix ethtx-forward tests * Format * Fix following the review * Fixes * Fixes * Use default impl * Benchmark helper * Bench part.1 * Bench part.2 * Bench part.3 * Fix all tests * Typo * Feat * Fix EVM tracing build * Reuse upstream `proof_size_base_cost()` (#1521) * Format issue * Fixes * Fix CI --------- Signed-off-by: Xavier Lau <[email protected]> Co-authored-by: Bear Wang <[email protected]>

- Upgrade Polkadot-sdk to v.1.7.0. - Update weights to reflect the new version. Notable Changes: - [Allow custom error types in Jsonrpsee](paritytech/polkadot-sdk#1313) For more details, please refer to: [Release Notes](https://github.com/paritytech/polkadot-sdk/releases/tag/polkadot-v1.7.0) issue-1870

- Upgrade Polkadot-sdk to v.1.7.0. - Update weights to reflect the new version. Notable Changes: - [Allow custom error types in Jsonrpsee](paritytech/polkadot-sdk#1313) For more details, please refer to: [Release Notes](https://github.com/paritytech/polkadot-sdk/releases/tag/polkadot-v1.7.0) #1870

* Setup deps * Remove Koi from account migration test * paritytech/polkadot-sdk#1495 * Bump * paritytech/polkadot-sdk#1524 * !! paritytech/polkadot-sdk#1363 * paritytech/polkadot-sdk#1492 * paritytech/polkadot-sdk#1911 * paritytech/polkadot-sdk#1900 Signed-off-by: Xavier Lau <[email protected]> * paritytech/polkadot-sdk#1661 * paritytech/polkadot-sdk#2144 * paritytech/polkadot-sdk#2048 * paritytech/polkadot-sdk#1672 * paritytech/polkadot-sdk#2303 * paritytech/polkadot-sdk#1256 * Remove identity and vesting * Fixes * paritytech/polkadot-sdk#2657 * paritytech/polkadot-sdk#1313 * paritytech/polkadot-sdk#2331 * paritytech/polkadot-sdk#2409 part.1 * paritytech/polkadot-sdk#2767 * paritytech/polkadot-sdk#2521 Signed-off-by: Xavier Lau <[email protected]> * paritytech/polkadot-sdk#1222 * paritytech/polkadot-sdk#1234 part.1 * Satisfy compiler * XCM V4 part.1 * paritytech/polkadot-sdk#1246 * Remove pallet-democracy part.1 * paritytech/polkadot-sdk#2142 * paritytech/polkadot-sdk#2428 * paritytech/polkadot-sdk#3228 * XCM V4 part.2 * Bump * Build all runtimes * Build node * Remove pallet-democracy Signed-off-by: Xavier Lau <[email protected]> * Format * Fix pallet tests * Fix precompile tests * Format * Fixes * Async, remove council, common pallet config * Fix `ethtx-forward` test case (#1519) * Fix ethtx-forward tests * Format * Fix following the review * Fixes * Fixes * Use default impl * Benchmark helper * Bench part.1 * Bench part.2 * Bench part.3 * Fix all tests * Typo * Feat * Fix EVM tracing build * Reuse upstream `proof_size_base_cost()` (#1521) * Format issue * Fixes * Fix CI --------- Signed-off-by: Xavier Lau <[email protected]> Co-authored-by: Bear Wang <[email protected]>

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 3 times, most recently from 590b12b to ad4d23e Compare August 30, 2023 17:35

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 6 times, most recently from 52b35cf to ec7b24c Compare September 23, 2023 18:23

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 3 times, most recently from 53af167 to a92968d Compare September 25, 2023 14:55

jsdw reviewed Sep 25, 2023

View reviewed changes

substrate/client/rpc/src/lib.rs Outdated Show resolved Hide resolved

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 2 times, most recently from 095d44e to 59a74ad Compare September 28, 2023 11:09

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 3 times, most recently from 3896a14 to 0bcd8b0 Compare October 14, 2023 09:25

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 2 times, most recently from 0f253e5 to c0acd5d Compare October 25, 2023 17:33

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch 2 times, most recently from c9a43f6 to d5d2d9b Compare October 30, 2023 09:49

niklasad1 added the T0-node This PR/Issue is related to the topic “node”. label Oct 30, 2023

jsonrpsee v0.20.3

fb263ce

niklasad1 force-pushed the na-jsonrpsee-v0.20 branch from d5d2d9b to fb263ce Compare October 30, 2023 10:54

niklasad1 changed the title ~~WIP: jsonrpsee v0.20~~ rpc: backpressured RPC server (bump jsonrpsee 0.20) Oct 30, 2023

niklasad1 commented Oct 30, 2023

View reviewed changes

niklasad1 added 2 commits January 23, 2024 07:44

Merge remote-tracking branch 'origin/master' into na-jsonrpsee-v0.20

91a735c

grumbles: add comment for tokio::MAX_PERMITS

b67e888

niklasad1 added this pull request to the merge queue Jan 23, 2024

Merged via the queue into master with commit e16ef08 Jan 23, 2024

niklasad1 deleted the na-jsonrpsee-v0.20 branch January 23, 2024 09:36

niklasad1 mentioned this pull request Jan 26, 2024

[RPC-Spec-V2] chainHead_unstable_follow shouldn't use pipe_from_stream #3078

Closed

This was referenced Mar 1, 2024

Upgrade polkadot-sdk to version 1.7.0 moonbeam-foundation/moonbeam#2688

Closed

Upgrade polkadot-sdk to version 1.7.2 moonbeam-foundation/moonbeam#2700

Merged

github-actions bot mentioned this pull request Mar 13, 2024

Update polkadot-sdk from v1.3.0 to v1.7.2 moonbeam-foundation/moonbeam#2703

Closed

salman01zp mentioned this pull request Mar 20, 2024

[BUG] CI Fails to compile because of missing trait implementation in the node RPC tangle-network/tangle#565

Closed

nazar-pc mentioned this pull request Apr 5, 2024

Update Substrate to 1.8.0 autonomys/subspace#2667

Merged

1 task

aurexav added a commit to darwinia-network/darwinia that referenced this pull request Jun 24, 2024

paritytech/polkadot-sdk#1313

afe4ba3

enddynayn mentioned this pull request Jul 10, 2024

chore(upgrade): v1.6.0 to v1.7.0 frequency-chain/frequency#2066

Merged

enddynayn mentioned this pull request Jul 12, 2024

[Chore]: Configure Updated Backpressure Feature frequency-chain/frequency#2072

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rpc: backpressured RPC server (bump jsonrpsee 0.20)#1313

rpc: backpressured RPC server (bump jsonrpsee 0.20)#1313
niklasad1 merged 28 commits intomasterfrom
na-jsonrpsee-v0.20

niklasad1 commented Aug 30, 2023 •

edited

Loading

Uh oh!

nazar-pc commented Sep 25, 2023

Uh oh!

niklasad1 commented Sep 25, 2023 •

edited

Loading

Uh oh!

Uh oh!

niklasad1 Oct 30, 2023 •

edited

Loading

Uh oh!

niklasad1 Oct 30, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

niklasad1 commented Aug 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nazar-pc commented Sep 25, 2023

Uh oh!

niklasad1 commented Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

niklasad1 Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niklasad1 Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

niklasad1 commented Aug 30, 2023 •

edited

Loading

niklasad1 commented Sep 25, 2023 •

edited

Loading

niklasad1 Oct 30, 2023 •

edited

Loading

niklasad1 Oct 30, 2023 •

edited

Loading