(#78) Network Viewer - Add versioning mechanism to JSON-RPC responses

rust/demo-app/move/Move.lock

@@ -3,7 +3,7 @@
 [move]
 version = 0
 manifest_digest = "C7E0EBC4DD41B277F44A5FA805716E002069FC359A3BE24E541A14E868DA561C"
-deps_digest = "112928C94A84031C09CD9B9D1D44B149B73FC0EEA5FA8D8B2D7CA4D91936335A"
+deps_digest = "F8BBB0CCB2491CA29A3DF03D6F92277A4F3574266507ACD77214D37ECA3F3082"
 
 dependencies = [
  { name = "Sui" },

rust/suibase/.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.'cfg(all())'] 
+rustflags = ["--cfg", "uuid_unstable"]

rust/suibase/rustfmt.toml → rust/suibase/.rustfmt.toml

@@ -1,2 +1,5 @@
 edition = "2021"
 use_field_init_shorthand = true
+tab_spaces = 4
+max_width = 100
+hard_tabs = false

rust/suibase/Cargo.toml

@@ -44,6 +44,9 @@ tower-http = { version = "0.3.4", features = [
  "propagate-header",
 ] }
 
+uuid = { version = "1.4.1", features = ["v4","v7","fast-rng"] }
+uuid7 = { version= "0.7.0", features = [ "uuid" ] }
+
 anyhow = { version = "1.0.71", features = ["backtrace"] }
 thiserror = "1.0"
 

rust/suibase/crates/suibase-daemon/Cargo.toml

@@ -19,6 +19,7 @@ mime = "0.3.16"
 
 memchr = "2.5.0"
 
+
 tokio.workspace = true
 tokio-graceful-shutdown.workspace = true
 
@@ -27,6 +28,8 @@ notify = { version = "6.0", default-features = false, features = [
  "macos_kqueue",
 ] }
 
+uuid.workspace = true
+uuid7.workspace = true
 anyhow.workspace = true
 
 clap.workspace = true

rust/suibase/crates/suibase-daemon/src/api/api_server.rs

@@ -88,7 +88,7 @@ impl JSONRPCServer {
  }
 
  async fn run_server(self, _subsys: &SubsystemHandle) -> Result<()> {
- // Refrence:
+ // Reference:
  // https://github.com/paritytech/jsonrpsee/blob/master/examples/examples/cors_server.rs
  let cors = CorsLayer::new()
  // Allow `POST` when accessing the resource

rust/suibase/crates/suibase-daemon/src/api/json_rpc_api.rs

@@ -1,3 +1,4 @@
+use hyper::header;
 // Defines the JSON-RPC API.
 //
 // Intended Design (WIP)
@@ -11,13 +12,46 @@
 // emit a message toward the AdminController describing the action needed. The AdminController perform the
 // modification and provides the response with a returning tokio OneShot channel.
 //
+// All *successful" JSON responses have a required "header" section.
+//
 use jsonrpsee::core::RpcResult;
 use jsonrpsee_proc_macros::rpc;
 
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use serde_with::serde_as;
 
+#[serde_as]
+#[derive(Clone, Default, Debug, JsonSchema, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct Header {
+ // Header fields
+ // =============
+ // - method:
+ // A string echoing the method of the request.
+ //
+ // - key:
+ // A string echoing one of the "key" parameter of the request (e.g. the workdir requested).
+ // This field is optional and its interpretation depends on the method.
+ //
+ // - data_uuid:
+ // A sortable hex 64 bytes (UUID v7). Increments with every data modification.
+ //
+ // - server_uuid:
+ // A hex 64 bytes that changes every time the server detects that
+ // a data_uuid is unexpectedly lower than the previous one (e.g. system
+ // time went backward) or the PID of the process changes. This is to
+ // complement data_version for added reliability.
+ //
+ pub method: String,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub server_uuid: Option<String>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub data_uuid: Option<String>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub key: Option<String>,
+}
+
 #[serde_as]
 #[derive(Clone, Default, Debug, JsonSchema, Serialize, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
@@ -75,6 +109,8 @@ impl LinksSummary {
 #[derive(Clone, Debug, JsonSchema, Serialize, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
 pub struct LinksResponse {
+ pub header: Header,
+
  pub status: String, // This is a single word combined "Multi-Link status". Either "OK" or "DOWN".
 
  pub info: String, // More details about the status (e.g. '50% degraded', 'all servers down', etc...)
@@ -100,6 +136,7 @@ pub struct LinksResponse {
 impl LinksResponse {
  pub fn new() -> Self {
  Self {
+ header: Header::default(),
  status: "DISABLED".to_string(),
  info: "INITIALIZING".to_string(),
  summary: None,
@@ -114,12 +151,14 @@ impl LinksResponse {
 #[derive(Clone, Debug, JsonSchema, Serialize, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
 pub struct InfoResponse {
+ pub header: Header,
  pub info: String, // "Success" or info on failure.
 }
 
 impl InfoResponse {
  pub fn new() -> Self {
  Self {
+ header: Header::default(),
  info: "Unknown Error".to_string(),
  }
  }