RPC Consistency Proposal #2473

acerone85 · 2024-12-05T12:09:34Z

Linked Issues/PRs

Related issue: #1897
Closes #2605

See https://www.notion.so/fuellabs/RPC-Consistency-Proposal-V2-13b2f2293f31809bbce0d93a4c28d633 for the proposal specs.

This PR implements a variation of the proposal in the link, due to techincal limitations of the HTTP protocol when using graphql subscriptions.

for context: Headers cannot be used, the reason being that subscriptions will return multiple graphql responses in a single HTTP response (and therefore have a single HeaderMap), while we require that each item in the response has its associated CURRENT_FUEL_BLOCK_HEIGHT field. Moreover the Response metadata for subscriptions is returned before the actual response body (as it is standard with HTTP).

in the end graphql has a (very undocumented) way to add an extensions field to responses, at the same level of data/errors field. This does not require to tweak anything at the HTTP level.

We will implement an improvement where the server node will wait for a configurable number of blocks before returning a PRECONDITION FAILED response, in a follow-up PR.

Entrypoint for reviews:

https://github.com/FuelLabs/fuel-core/pull/2473/files#diff-9caf873d3167ab9485e7882d621b5147e98b2478cc6462095b88374e2f914f3aR428 for the graphql handler
https://github.com/FuelLabs/fuel-core/pull/2473/files#diff-9caf873d3167ab9485e7882d621b5147e98b2478cc6462095b88374e2f914f3aR428 for the extension definition

Manual testing

TODO:

Tests

Description

Checklist

~~Breaking changes are clearly marked as such in the PR description and changelog~~
New behavior is reflected in tests
The specification matches the implemented behavior (link update PR if changes are needed)

Before requesting review

I have reviewed the code myself
~~I have created follow-up issues caused by this PR and linked them here~~

After merging, notify other teams

[Add or remove entries as needed]

Rust SDK
Sway compiler
Platform documentation (for out-of-organization contributors, the person merging the PR will do this)
Someone else?

crates/client/src/client.rs

crates/fuel-core/src/graphql_api/worker_service.rs

netrome

Nice stuff! I have some thoughts and comments, but no showstoppers.

crates/client/src/client.rs

crates/fuel-core/src/graphql_api/worker_service.rs

crates/fuel-core/src/graphql_api/api_service.rs

Co-authored-by: Mårten Blankfors <[email protected]>

crates/fuel-core/src/graphql_api/required_fuel_block_height_extension.rs

crates/fuel-core/src/graphql_api/api_service.rs

crates/fuel-core/src/graphql_api/required_fuel_block_height_extension.rs

Torres-ssf · 2024-12-13T17:15:30Z

Hi @acerone85,

Could you kindly confirm if the response header for subscriptions is also intended to include current_fuel_block_height?

acerone85 · 2024-12-14T18:11:56Z

Hi @acerone85,

Could you kindly confirm if the response header for subscriptions is also intended to include current_fuel_block_height?

In the current implementation there is no response header for the current_fuel_block_height. Would it be desirable to have one?

# Conflicts: # CHANGELOG.md

…nto 1897-rpc-consistency-proposal # Conflicts: # CHANGELOG.md

acerone85 · 2025-02-12T13:56:27Z

crates/client/src/reqwest_ext.rs

+/// #
+/// # #[derive(cynic::QueryFragment)]
+/// # #[cynic(
+/// #     schema_path = "../schemas/starwars.schema.graphql",


would be nice to have an example related to how we use the reqwest_ext module, but not a big deal at this point :)

acerone85 · 2025-02-12T13:58:38Z

crates/client/src/reqwest_ext.rs

+#[cfg(not(target_arch = "wasm32"))]
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
+
+#[cfg(target_arch = "wasm32")]
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a>>;


curious to know why the Send trait bound is not available/needed on the wasm32 architecture

TIL: It seems like it's a general assumption that the wasm32-unknown-unknown target is single-threaded https://users.rust-lang.org/t/multithreading-in-wasm-how-did-that-come-out/87518 - although there seem to be work to implement multi-threading in WASM coming up in the future. Interesting.

(and if the target is single-threaded you should not have to require Send anywhere)

acerone85 · 2025-02-12T14:04:52Z

crates/client/src/reqwest_ext.rs

+impl<ResponseData, Errors> CynicReqwestBuilder<ResponseData, Errors> {
+    pub fn new(builder: reqwest::RequestBuilder) -> Self {
+        Self {
+            builder,
+            _marker: std::marker::PhantomData,
+        }
+    }
+}


nit: is impl<ResponseData, Errors> From<reqwest::RequestBuilder>for CynicReqwestBuilder<ResponseData, Errors> more idiomatic?

acerone85 · 2025-02-12T14:16:44Z

crates/client/src/reqwest_ext.rs

+            return Err(response);
+        };
+
+        Ok(deserred)


just wanted to check, we return Ok(_) even if the status is not 2xx?

(I think it makes sense if we reserve the Error status for actual connection/deserialization errors, but wanted to check)

acerone85 · 2025-02-12T14:20:41Z

crates/client/src/reqwest_ext.rs

+#[derive(Debug, Clone, serde::Deserialize)]
+pub struct ExtensionsResponse {
+    pub required_fuel_block_height: Option<BlockHeight>,
+    pub current_fuel_block_height: Option<BlockHeight>,


nit: I think we require that this field is set in all graphql responses

acerone85 · 2025-02-12T14:23:01Z

crates/client/src/reqwest_ext.rs

+
+#[derive(Debug, Clone, serde::Deserialize)]
+pub struct ExtensionsResponse {
+    pub required_fuel_block_height: Option<BlockHeight>,


we don't set this field in the response in the graphql extension. But happy to add it if needed

acerone85 · 2025-02-12T15:39:56Z

crates/client/src/client.rs

+    ) -> &mut Self {
+        match &mut self.require_height {
+            ConsistencyPolicy::Auto { height } => {
+                *height.lock().expect("Mutex poisoned") = new_height;


should we use parking_lot Mutex, or use directly a AtomicU32 and avoid a Mutex altogether?

Why do we need locks for this at all? We have a mutable reference to self here already.

So I see that we need some type of interior mutability since the query function takes an immutable self receiver. However, I think it would be cleaner to change the signature of the query function to take a mutable self receiver.

Since that's a breaking change, how about we leave this as-is for now but create a follow-up to simplify this which we can include in the next breaking release?

netrome

The code seems correct to me, but I'm pretty annoyed by the Option<Arc<Mutex>> and would love to get rid of it as soon as possible. I understand that we might need some sort of interior mutability to preserve backwards compatibility in the client though.

netrome · 2025-02-12T19:33:43Z

crates/client/src/client.rs

+    ) -> &mut Self {
+        match &mut self.require_height {
+            ConsistencyPolicy::Auto { height } => {
+                *height.lock().expect("Mutex poisoned") = new_height;


Why do we need locks for this at all? We have a mutable reference to self here already.

netrome · 2025-02-12T19:39:47Z

crates/client/src/client.rs

+    fn decode_response<R, E>(
+        response: FuelGraphQlResponse<R, E>,
+        inner_required_height: Option<Arc<Mutex<Option<BlockHeight>>>>,
+    ) -> io::Result<R>


While this is okay, I think it would be cleaner to separate the height extraction to a separate extract_required_height function.

netrome · 2025-02-12T19:42:36Z

crates/client/src/client.rs

+    ) -> &mut Self {
+        match &mut self.require_height {
+            ConsistencyPolicy::Auto { height } => {
+                *height.lock().expect("Mutex poisoned") = new_height;


So I see that we need some type of interior mutability since the query function takes an immutable self receiver. However, I think it would be cleaner to change the signature of the query function to take a mutable self receiver.

Since that's a breaking change, how about we leave this as-is for now but create a follow-up to simplify this which we can include in the next breaking release?

netrome · 2025-02-12T19:46:50Z

crates/client/src/reqwest_ext.rs

+#[cfg(not(target_arch = "wasm32"))]
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
+
+#[cfg(target_arch = "wasm32")]
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a>>;


TIL: It seems like it's a general assumption that the wasm32-unknown-unknown target is single-threaded https://users.rust-lang.org/t/multithreading-in-wasm-how-did-that-come-out/87518 - although there seem to be work to implement multi-threading in WASM coming up in the future. Interesting.

netrome · 2025-02-12T19:47:38Z

crates/client/src/reqwest_ext.rs

+#[cfg(not(target_arch = "wasm32"))]
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
+
+#[cfg(target_arch = "wasm32")]
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a>>;


(and if the target is single-threaded you should not have to require Send anywhere)

acerone85 added 2 commits December 5, 2024 11:30

Start structuring middleware

a8f5f41

Use a static atomic to keep track of the current block height

778dd7c

acerone85 requested a review from Voxelot December 5, 2024 12:09

acerone85 requested review from xgreenx, Dentosal and MitchTurner as code owners December 5, 2024 12:09

acerone85 linked an issue Dec 5, 2024 that may be closed by this pull request

RPC Consistency Proposal #1897

Closed

acerone85 requested a review from a team December 5, 2024 12:09

acerone85 added 2 commits December 5, 2024 12:13

Add changelog entry

d1b1c33

Add tests and fix middleware

b77506c

acerone85 self-assigned this Dec 5, 2024

acerone85 commented Dec 5, 2024

View reviewed changes

crates/client/src/client.rs Outdated Show resolved Hide resolved

acerone85 commented Dec 5, 2024

View reviewed changes

crates/fuel-core/src/graphql_api/worker_service.rs Outdated Show resolved Hide resolved

netrome previously approved these changes Dec 5, 2024

View reviewed changes

Update crates/fuel-core/src/graphql_api/api_service.rs

b764cd4

Co-authored-by: Mårten Blankfors <[email protected]>

acerone85 dismissed netrome’s stale review via b764cd4 December 6, 2024 13:34

acerone85 and others added 6 commits December 6, 2024 14:18

Set headers in fuel client

d9091e6

AxumRequest/AxumResponse -> http::Request/http::Response

90c411f

Fix compilation

625bf8f

Extension instead of Axum middleware

085d173

Merge branch 'master' into 1897-rpc-consistency-proposal

a98ef9b

Add response header

c95f09a

acerone85 commented Dec 12, 2024

View reviewed changes

crates/fuel-core/src/graphql_api/required_fuel_block_height_extension.rs Show resolved Hide resolved

acerone85 commented Dec 12, 2024

View reviewed changes

crates/fuel-core/src/graphql_api/api_service.rs Outdated Show resolved Hide resolved

acerone85 commented Dec 12, 2024

View reviewed changes

crates/fuel-core/src/graphql_api/required_fuel_block_height_extension.rs Outdated Show resolved Hide resolved

acerone85 commented Dec 12, 2024

View reviewed changes

crates/fuel-core/src/graphql_api/required_fuel_block_height_extension.rs Outdated Show resolved Hide resolved

acerone85 commented Dec 12, 2024

View reviewed changes

crates/fuel-core/src/graphql_api/required_fuel_block_height_extension.rs Outdated Show resolved Hide resolved

Better handling of response

6099651

acerone85 and others added 3 commits February 4, 2025 15:03

Update changelog

2972279

Merge branch 'refs/heads/master' into 1897-rpc-consistency-proposal

1219775

# Conflicts: # CHANGELOG.md

Merge branch 'master' into 1897-rpc-consistency-proposal

cf656bf

acerone85 force-pushed the 1897-rpc-consistency-proposal branch from 1219775 to cf656bf Compare February 11, 2025 11:47

acerone85 and others added 6 commits February 11, 2025 12:15

Test precondition failed from extensions field

e630285

Remove newline

2435cfe

Merge branch 'master' into 1897-rpc-consistency-proposal

385eda2

Merge remote-tracking branch 'origin/1897-rpc-consistency-proposal' i…

703bc24

…nto 1897-rpc-consistency-proposal # Conflicts: # CHANGELOG.md

Fixed CHANGELOG.md

511431f

Implement required block height support on the fuel-core-client side

48d508d

xgreenx previously approved these changes Feb 11, 2025

View reviewed changes

xgreenx and others added 2 commits February 11, 2025 18:39

Merge branch 'master' into 1897-rpc-consistency-proposal

461fbe7

Make CI happy

af2484a

xgreenx dismissed their stale review via af2484a February 12, 2025 00:04

xgreenx added 2 commits February 11, 2025 20:32

Added more tests

44cffec

Use random determenistic port of compatibility tests

5cb1639

xgreenx approved these changes Feb 12, 2025

View reviewed changes

Merge branch 'master' into 1897-rpc-consistency-proposal

eb25459

acerone85 commented Feb 12, 2025

View reviewed changes

netrome approved these changes Feb 12, 2025

View reviewed changes

Merge branch 'master' into 1897-rpc-consistency-proposal

0f6f319

acerone85 enabled auto-merge (squash) February 12, 2025 20:18

acerone85 merged commit f73a12e into master Feb 12, 2025
33 checks passed

acerone85 deleted the 1897-rpc-consistency-proposal branch February 12, 2025 20:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RPC Consistency Proposal #2473

RPC Consistency Proposal #2473

acerone85 commented Dec 5, 2024 •

edited by xgreenx

Loading

netrome left a comment

Torres-ssf commented Dec 13, 2024

acerone85 commented Dec 14, 2024

acerone85 Feb 12, 2025

acerone85 Feb 12, 2025

netrome Feb 12, 2025

netrome Feb 12, 2025

acerone85 Feb 12, 2025

acerone85 Feb 12, 2025

acerone85 Feb 12, 2025

acerone85 Feb 12, 2025

acerone85 Feb 12, 2025

acerone85 Feb 12, 2025

netrome Feb 12, 2025

netrome Feb 12, 2025

netrome left a comment

netrome Feb 12, 2025

netrome Feb 12, 2025

netrome Feb 12, 2025

netrome Feb 12, 2025

netrome Feb 12, 2025

RPC Consistency Proposal #2473

RPC Consistency Proposal #2473

Conversation

acerone85 commented Dec 5, 2024 • edited by xgreenx Loading

Linked Issues/PRs

Manual testing

TODO:

Description

Checklist

Before requesting review

After merging, notify other teams

netrome left a comment

Choose a reason for hiding this comment

Torres-ssf commented Dec 13, 2024

acerone85 commented Dec 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netrome left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acerone85 commented Dec 5, 2024 •

edited by xgreenx

Loading