Merge pull request #794 from rainlanguage/2024-08-26-schema-validator

Subgraph schema validator

Cargo.toml

@@ -16,7 +16,7 @@ anyhow = "1.0.70"
 async-trait = "0.1.77"
 clap = { version = "4.2.5", features = ["cargo", "derive"] }
 once_cell = "1.17.1"
-reqwest = { version = "0.11.17", features = ["json"] }
+reqwest = { version = "0.12.5", features = ["json"] }
 rust-bigint = "1.2.0"
 serde = "1.0.200"
 futures = "0.3.17"
@@ -29,7 +29,7 @@ tracing-subscriber = "0.3.17"
 url = "2.5.0"
 comfy-table = "7.1.0"
 cynic-codegen = { version = "3.4.0", features = ["rkyv"] }
-cynic = "3.4.0"
+cynic = "3.7.3"
 chrono = "0.4.31"
 typeshare = { git = "https://github.com/tomjw64/typeshare", rev = "556b44aafd5304eedf17206800f69834e3820b7c" }
 thiserror = "1.0.56"

crates/cli/src/commands/mod.rs

@@ -2,7 +2,11 @@ mod chart;
 mod order;
 mod order_take;
 mod quote;
+mod subgraph;
 mod vault;
 mod words;
 
-pub use self::{chart::Chart, order::Order, order_take::OrderTake, vault::Vault, words::Words};
+pub use self::{
+    chart::Chart, order::Order, order_take::OrderTake, subgraph::Subgraph, vault::Vault,
+    words::Words,
+};

crates/cli/src/commands/subgraph/mod.rs

@@ -0,0 +1,34 @@
+use crate::execute::Execute;
+use anyhow::Result;
+use clap::Parser;
+use rain_orderbook_subgraph_client::validate::validate_subgraph_schema;
+
+#[derive(Parser)]
+pub enum Subgraph {
+    #[command(about = "Validates a subgraph schema against this apps subgraph schema")]
+    Validate {
+        /// Subgraph url to validate
+        subgraph_url: String,
+    },
+}
+
+impl Execute for Subgraph {
+    async fn execute(&self) -> Result<()> {
+        match self {
+            Subgraph::Validate { subgraph_url } => Ok(validate_subgraph_schema(subgraph_url)
+                .await
+                .map(|v| println!("--- {}valid subgraph ---", if v { "" } else { "in" }))?),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use clap::CommandFactory;
+
+    #[test]
+    fn verify_command() {
+        Subgraph::command().debug_assert();
+    }
+}

crates/cli/src/lib.rs

@@ -1,4 +1,4 @@
-use crate::commands::{Chart, Order, OrderTake, Vault, Words};
+use crate::commands::{Chart, Order, OrderTake, Subgraph, Vault, Words};
 use crate::execute::Execute;
 use anyhow::Result;
 use clap::Subcommand;
@@ -22,6 +22,9 @@ pub enum Orderbook {
     #[command(subcommand)]
     OrderTake(OrderTake),
 
+    #[command(subcommand)]
+    Subgraph(Subgraph),
+
     Chart(Chart),
 
     Quote(Quoter),
@@ -37,6 +40,7 @@ impl Orderbook {
             Orderbook::OrderTake(order_take) => (order_take).execute().await,
             Orderbook::Chart(chart) => chart.execute().await,
             Orderbook::Quote(quote) => quote.execute().await,
+            Orderbook::Subgraph(subgraph) => subgraph.execute().await,
             Orderbook::Words(words) => words.execute().await,
         }
     }

crates/subgraph/Cargo.toml

@@ -18,10 +18,12 @@ serde_json = { workspace = true }
 alloy = { workspace = true }
 rain_orderbook_bindings = { workspace = true }
 chrono = { workspace = true }
+cynic-introspection = "3.7.3"
 
 [dev-dependencies]
 insta = { workspace = true }
-tokio = { workspace = true }
+tokio = { workspace = true, features = ["full"] }
+httpmock = "0.7.0"
 
 [build-dependencies]
 cynic-codegen = { workspace = true }

crates/subgraph/src/lib.rs

@@ -3,6 +3,7 @@ mod orderbook_client;
 mod pagination;
 pub mod types;
 pub mod utils;
+pub mod validate;
 mod vault_balance_changes_query;
 
 #[cynic::schema("orderbook")]