Add a crate to test the in-browser light client. (#4887)

Co-Authored-By: Pierre Krieger <pierre.krieger1708@gmail.com>

substrate/.gitlab-ci.yml

@@ -40,6 +40,9 @@ variables:
   # FIXME set to release
   CARGO_UNLEASH_INSTALL_PARAMS:    "--version 1.0.0-alpha.10"
   CARGO_UNLEASH_PKG_DEF:           "--skip node node-* pallet-template pallet-example pallet-example-* subkey chain-spec-builder sp-arithmetic-fuzzer"
+  CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER: "wasm-bindgen-test-runner"
+  WASM_BINDGEN_TEST_TIMEOUT:                  120
+  CHROMEDRIVER_ARGS:                          "--log-level=INFO --whitelisted-ips=127.0.0.1"
 
 
 .collect-artifacts:                &collect-artifacts
@@ -312,7 +315,6 @@ test-linux-stable-int:
     paths:
       - ${CI_COMMIT_SHORT_SHA}_int_failure.log
 
-
 check-web-wasm:
   stage:                           test
   <<:                              *docker-env
@@ -354,6 +356,15 @@ test-full-crypto-feature:
 
 #### stage:                        build
 
+test-browser-node:
+  stage:                           build
+  <<:                              *docker-env
+  needs:
+    - job:                         check-web-wasm
+      artifacts:                   false
+  script:
+    - cargo +nightly test --target wasm32-unknown-unknown -p node-browser-testing -Z features=itarget
+
 build-linux-substrate:             &build-binary
   stage:                           build
   <<:                              *collect-artifacts

substrate/Cargo.lock

@@ -3372,6 +3372,23 @@ dependencies = [
  "tempfile",
 ]
 
+[[package]]
+name = "node-browser-testing"
+version = "2.0.0"
+dependencies = [
+ "futures 0.3.4",
+ "futures-timer 3.0.2",
+ "jsonrpc-core",
+ "libp2p",
+ "node-cli",
+ "sc-rpc-api",
+ "serde",
+ "serde_json",
+ "wasm-bindgen",
+ "wasm-bindgen-futures",
+ "wasm-bindgen-test",
+]
+
 [[package]]
 name = "node-cli"
 version = "2.0.0-dev"
@@ -9075,6 +9092,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "2cc57ce05287f8376e998cbddfb4c8cb43b84a7ec55cf4551d7c00eef317a47f"
 dependencies = [
  "cfg-if",
+ "serde",
+ "serde_json",
  "wasm-bindgen-macro",
 ]
 
@@ -9134,6 +9153,30 @@ version = "0.2.60"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "daf76fe7d25ac79748a37538b7daeed1c7a6867c92d3245c12c6222e4a20d639"
 
+[[package]]
+name = "wasm-bindgen-test"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "648da3460c6d2aa04b715a936329e2e311180efe650b2127d6267f4193ccac14"
+dependencies = [
+ "console_error_panic_hook",
+ "js-sys",
+ "scoped-tls",
+ "wasm-bindgen",
+ "wasm-bindgen-futures",
+ "wasm-bindgen-test-macro",
+]
+
+[[package]]
+name = "wasm-bindgen-test-macro"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf2f86cd78a2aa7b1fb4bb6ed854eccb7f9263089c79542dca1576a1518a8467"
+dependencies = [
+ "proc-macro2",
+ "quote 1.0.3",
+]
+
 [[package]]
 name = "wasm-gc-api"
 version = "0.1.11"

substrate/Cargo.toml

@@ -4,6 +4,7 @@ members = [
 	"bin/node-template/runtime",
 	"bin/node-template/pallets/template",
 	"bin/node/bench",
+	"bin/node/browser-testing",
 	"bin/node/cli",
 	"bin/node/executor",
 	"bin/node/primitives",

substrate/bin/node/browser-testing/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "node-browser-testing"
+version = "2.0.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+description = "Tests for the in-browser light client."
+edition = "2018"
+license = "GPL-3.0"
+
+[dependencies]
+futures-timer = "3.0.2"
+libp2p = { version = "0.18.0", default-features = false }
+jsonrpc-core = "14.0.5"
+serde = "1.0.106"
+serde_json = "1.0.48"
+wasm-bindgen = { version = "0.2.60", features = ["serde-serialize"] }
+wasm-bindgen-futures = "0.4.10"
+wasm-bindgen-test = "0.3.10"
+futures = "0.3.4"
+
+node-cli = { path = "../cli", default-features = false, features = ["browser"] }
+sc-rpc-api = { path = "../../../client/rpc-api" }

substrate/bin/node/browser-testing/src/lib.rs

@@ -0,0 +1,84 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Substrate is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! # Running
+//! Running this test can be done with
+//! ```text
+//! wasm-pack test --firefox --release --headless bin/node/browser-testing
+//! ```
+//! or (without `wasm-pack`)
+//! ```text
+//! CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER=wasm-bindgen-test-runner WASM_BINDGEN_TEST_TIMEOUT=60 cargo test --target wasm32-unknown-unknown
+//! ```
+//! For debug infomation, such as the informant, run without the `--headless`
+//! flag and open a browser to the url that `wasm-pack test` outputs.
+//! For more infomation see https://rustwasm.github.io/docs/wasm-pack/.
+
+use wasm_bindgen_test::{wasm_bindgen_test, wasm_bindgen_test_configure};
+use wasm_bindgen_futures::JsFuture;
+use wasm_bindgen::JsValue;
+use jsonrpc_core::types::{MethodCall, Success, Version, Params, Id};
+use serde::de::DeserializeOwned;
+use futures_timer::Delay;
+use std::time::Duration;
+use futures::FutureExt;
+
+wasm_bindgen_test_configure!(run_in_browser);
+
+const CHAIN_SPEC: &str = include_str!("../../cli/res/flaming-fir.json");
+
+fn rpc_call(method: &str) -> String {
+    serde_json::to_string(&MethodCall {
+        jsonrpc: Some(Version::V2),
+        method: method.into(),
+        params: Params::None,
+        id: Id::Num(1)
+    }).unwrap()
+}
+
+fn deserialize_rpc_result<T: DeserializeOwned>(js_value: JsValue) -> T {
+    let string = js_value.as_string().unwrap();
+    let value = serde_json::from_str::<Success>(&string).unwrap().result;
+    // We need to convert a `Value::Object` into a proper type.
+    let value_string = serde_json::to_string(&value).unwrap();
+    serde_json::from_str(&value_string).unwrap()
+}
+
+#[wasm_bindgen_test]
+async fn runs() {
+    let mut client = node_cli::start_client(CHAIN_SPEC.into(), "info".into())
+            .await
+            .unwrap();
+
+    let mut test_timeout = Delay::new(Duration::from_secs(45));
+    loop {
+        // Check that timeout hasn't expired.
+        assert!((&mut test_timeout).now_or_never().is_none(), "Test timed out.");
+
+        // Let the node do a bit of work.
+        Delay::new(Duration::from_secs(5)).await;
+
+        let state: sc_rpc_api::system::Health = deserialize_rpc_result(
+            JsFuture::from(client.rpc_send(&rpc_call("system_health")))
+                .await
+                .unwrap()
+        );
+    
+        if state.should_have_peers && state.peers > 0 && state.is_syncing {
+            break;
+        }
+    }
+}

substrate/bin/node/browser-testing/webdriver.json

@@ -0,0 +1,7 @@
+{
+  "goog:chromeOptions": {
+    "args": [
+      "--whitelisted-ips=127.0.0.1"
+    ]
+  }
+}

substrate/bin/node/cli/src/browser.rs

@@ -17,7 +17,6 @@
 use crate::chain_spec::ChainSpec;
 use log::info;
 use wasm_bindgen::prelude::*;
-use sc_service::Configuration;
 use browser_utils::{
 	Client,
 	browser_configuration, set_console_error_panic_hook, init_console_log,