Web client #1738

Twey · 2024-03-01T13:55:57Z

Motivation

The client half of #1609.

Proposal

When compiling with web, replace our existing gRPC client with a Wasm-compatible gRPC-Web–based client using tonic-web-wasm-client.

Since browser objects are neither Send nor Sync, a large part of this work is then to enable non–Send equivalents of various traits for structs containing non–Send objects. linera-core in particular now never assumes that the client struct is Send. linera-service, however, does. In order to enable this, I have used trait-variant to construct, as automatically as possible, local and non-local variants of relevant traits.

Task list:

convert relevant traits to use AFIT and trait-variant
relax the Sendness bound that permeates linera-core and linera-rpc
implement a gRPC-Web client when compiling for the browser
deduplicate the implementations for the Web and non–Web clients
add tests in which the Wasm client connects to the gRPC-Web endpoint implemented in linera-service: export a grpc-web–compatible endpoint #1735

Test Plan

As part of this PR, I shall add tests to be run in a headless browser using wasm-pack test.

Due to #1799 and #1800 these are not currently part of the standard test cargo test test suite, but can be run manually:

$ eval "$(linera net helper)"
$ linera_spawn_and_read_wallet_variables linera net up
$ cd linera-rpc
$ wasm-pack test --chrome --headless --features web -- --include-ignored

The above assumes you are using the provided Nix flake for a development environment; if not, first you will need to install wasm-pack, chromium, and chromedriver through your usual package distribution channels. Tests also pass on Firefox, if you have Firefox installed — substitute --firefox for --chrome above.

Release Plan

Need to bump the major/minor version number in the next release of the crates.

Links

linera-rpc/src/mass_client.rs

linera-rpc/src/simple/client.rs

linera-rpc/src/grpc/transport.rs

…aming

…ransport` module

…ansport options

jvff · 2024-03-22T14:17:10Z

linera-rpc/src/mass_client.rs

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0

 use crate::RpcMessage;
+


Nit: No need for the whitespace here.

Yes indeed, we're generally trying to maximize the normalization opportunities for Rustfmt

The blocks here are ordered by scope (ancestor < crate < workspace < external < std), so there shouldn't be any normalization opportunities between them (different crates will always end up in different blocks). Unfortunately rustfmt doesn't understand anything about the scope of crates, so while it's smart enough to order super and crate dependencies at the top, without the newlines it will mix std and linera-* crates in with third-party dependencies :-\

rustfmt has added preliminary support for this, and since we're already using nightly rustfmt I've created PR #1821 to codify import grouping behaviour — it's not quite what's done here, but at least moves a standard for crate grouping into CI to increase normalization opportunities.

jvff · 2024-03-22T14:17:46Z

linera-rpc/src/simple/client.rs

@@ -3,24 +3,26 @@
 // SPDX-License-Identifier: Apache-2.0

 use super::{codec, transport::TransportProtocol};
+


Nit: same here, following the convention in the rest of the code of just separating imports if they have different visibility modifiers or feature gates.

jvff · 2024-03-22T14:17:55Z

linera-rpc/src/simple/client.rs

 use crate::{
    config::ValidatorPublicNetworkPreConfig, mass_client, HandleCertificateRequest,
    HandleLiteCertificateRequest, RpcMessage,
 };
-use async_trait::async_trait;
-use futures::{sink::SinkExt, stream::StreamExt};
+


Nit: same here

jvff · 2024-03-22T14:18:28Z

linera-rpc/src/simple/client.rs

 use linera_version::VersionInfo;

-use std::time::Duration;
+use async_trait::async_trait;


Nit: if possible, could you also remove the other newlines above and below?

…nd` `NotificationStream`

Twey · 2024-03-22T16:31:06Z

Remaining nits should be addressed by #1821 — so I'm going to go ahead and merge this one for now :)

Twey force-pushed the 03-01-Web_client branch 5 times, most recently from 54a87b3 to 0dcda6a Compare March 7, 2024 00:29

Twey force-pushed the 03-01-Web_client branch from 1de3dff to f8fb3cb Compare March 8, 2024 16:25

Twey mentioned this pull request Mar 20, 2024

Add fixture framework capable of passing native fixtures to Wasm code #1799

Open

Twey force-pushed the 03-01-Web_client branch from 3636963 to 141f6bb Compare March 20, 2024 13:10

Twey mentioned this pull request Mar 20, 2024

linera-service: enable gRPC-Web on the right service #1801

Merged

Twey force-pushed the 03-01-Web_client branch from 141f6bb to 3d7bb56 Compare March 20, 2024 14:42

Twey marked this pull request as ready for review March 20, 2024 14:59

Twey force-pushed the 03-01-Web_client branch 4 times, most recently from 4b043a1 to be520e9 Compare March 21, 2024 19:39

jvff reviewed Mar 21, 2024

View reviewed changes

Twey mentioned this pull request Mar 22, 2024

Make the Web RPC client respect node timeouts and retries #1817

Open

Twey force-pushed the 03-01-Web_client branch from 25add9d to 74c5482 Compare March 22, 2024 13:41

Twey added 7 commits March 22, 2024 13:53

linera-rpc: implement WebSocket client, modulo Send-ness

f390f9f

Implement non-Send versions of RPC traits

73d7e4b

linera-rpc: deduplicate implementation by cunning use of import ren…

e95d8d3

…aming

linera-rpc: add transport test

5946c3c

linera-rpc: use cfg-if to simplify implementation of the `grpc::t…

ad275a2

…ransport` module

linera-rpc: note the issue for the Web client not respecting its tr…

6765b7b

…ansport options

linera-rpc: refer to async_trait unqualified

b3c61d7

Twey force-pushed the 03-01-Web_client branch from 74c5482 to b3c61d7 Compare March 22, 2024 14:09

jvff reviewed Mar 22, 2024

View reviewed changes

linera-core: use explicit trait bounds for ValidatorNode with `Se…

f1309d0

…nd` `NotificationStream`

jvff approved these changes Mar 22, 2024

View reviewed changes

Twey merged commit 8ce69b8 into linera-io:main Mar 22, 2024
3 checks passed

Twey mentioned this pull request Apr 2, 2024

Tunnel the RPC protocol over WebSockets when compiling for wasm32-unknown-unknown #1629

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Web client #1738

Web client #1738

Twey commented Mar 1, 2024 •

edited

Loading

jvff Mar 22, 2024

ma2bd Mar 22, 2024

Twey Mar 22, 2024 •

edited

Loading

Twey Mar 22, 2024 •

edited

Loading

jvff Mar 22, 2024

jvff Mar 22, 2024

jvff Mar 22, 2024

Twey commented Mar 22, 2024

		@@ -2,6 +2,7 @@
		// SPDX-License-Identifier: Apache-2.0

		use crate::RpcMessage;

		@@ -3,24 +3,26 @@
		// SPDX-License-Identifier: Apache-2.0

		use super::{codec, transport::TransportProtocol};

Web client #1738

Web client #1738

Conversation

Twey commented Mar 1, 2024 • edited Loading

Motivation

Proposal

Test Plan

Release Plan

Links

jvff Mar 22, 2024

Choose a reason for hiding this comment

ma2bd Mar 22, 2024

Choose a reason for hiding this comment

Twey Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

Twey Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

jvff Mar 22, 2024

Choose a reason for hiding this comment

jvff Mar 22, 2024

Choose a reason for hiding this comment

jvff Mar 22, 2024

Choose a reason for hiding this comment

Twey commented Mar 22, 2024

Twey commented Mar 1, 2024 •

edited

Loading

Twey Mar 22, 2024 •

edited

Loading

Twey Mar 22, 2024 •

edited

Loading