Implement supergraph config schema command (#2418)

This takes Dylan's work from #2139 and makes it work with the latest
work in Rover

Essentially this allows us to take the work done in
`apollo-federation-types` and expose it for others to consume in other
IDEs etc.

Author: jonathanrainer

Cargo.lock

@@ -69,7 +69,7 @@ apollo-parser = "0.8"
 apollo-encoder = "0.8"
 
 # https://github.com/apollographql/federation-rs
-apollo-federation-types = "0.15.2"
+apollo-federation-types = { version = "0.15.2", features = ["json_schema"] }
 
 apollo-language-server = { version = "0.4.0", default-features = false, features = ["tokio"] }
 
@@ -86,7 +86,7 @@ base64 = "0.22"
 billboard = "0.2"
 buildstructor = "0.6.0"
 bytes = "1.8.0"
-cargo_metadata = "0.19"
+cargo_metadata = "0.18"
 calm_io = "0.1"
 camino = { version = "1", features = ["serde1"] }
 clap = "4"
@@ -100,7 +100,7 @@ directories-next = "2.0"
 flate2 = "1"
 futures = "0.3"
 git-url-parse = "0.4.5"
-git2 = { version = "0.20", default-features = false }
+git2 = { version = "0.19", default-features = false }
 graphql_client = "0.14"
 heck = "0.5"
 humantime = "2.1.0"
@@ -110,7 +110,7 @@ http-body-util = "0.1.2"
 httpmock = "0.7"
 hyper = "1.0"
 indoc = "2"
-itertools = "0.14.0"
+itertools = "0.13.0"
 lazycell = "1"
 lazy_static = "1.4"
 notify = { version = "8" }
@@ -122,6 +122,7 @@ pretty_assertions = "1"
 regex = "1"
 reqwest = { version = "0.12", default-features = false }
 rstest = "0.24.0"
+schemars = "0.8.21"
 semver = "1"
 serial_test = "3"
 serde = "1.0"
@@ -132,8 +133,8 @@ shell-candy = "0.4"
 speculoos = "0.11.0"
 strip-ansi-escapes = "0.2"
 strsim = "0.11"
-strum = "0.27"
-strum_macros = "0.27"
+strum = "0.26"
+strum_macros = "0.26"
 sha2 = "0.10"
 shellexpand = "3.1"
 termcolor = "1.3"
@@ -197,6 +198,7 @@ rover-graphql = { workspace = true }
 rover-http = { workspace = true }
 rover-std = { workspace = true }
 rover-studio = { workspace = true }
+schemars = { workspace = true }
 semver = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
@@ -233,12 +235,13 @@ git2 = { workspace = true, features = ["https"] }
 graphql-schema-diff = "=0.2.0"
 httpmock = { workspace = true }
 indoc = { workspace = true }
+jsonschema = "0.29.0"
 mime = "=0.3.17"
 mockall = "=0.13.1"
 portpicker = "=0.1.1"
 predicates = { workspace = true }
-rand = "=0.9.0"
-rand_regex = "=0.18.0"
+rand = "=0.8.5"
+rand_regex = "=0.17.0"
 reqwest = { workspace = true, features = ["native-tls-vendored"] }
 rstest = { workspace = true }
 serial_test = { workspace = true }

Cargo.toml

@@ -229,3 +229,23 @@ We recommend updating to the latest version of Rover as soon as possible. If you
 |---|---|
 |<= v0.2.x|<= v0.38.x|
 |>= v0.3.x|>= v0.39.x|
+
+## Configuration awareness in your text editor
+
+### `supergraph config schema`
+
+You can use Rover to generate a JSON schema for config validation in your text editor. This schema helps you format the YAML file correctly and also provides content assist.
+
+Generate the schema with the following command:
+
+```bash
+rover supergraph config schema
+```
+
+After you generate the schema, configure your text editor. Here are the instructions for some commonly used editors:
+
+- [Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings)
+- [Emacs](https://emacs-lsp.github.io/lsp-mode/page/lsp-yaml)
+- [IntelliJ](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas)
+- [Sublime](https://github.com/sublimelsp/LSP-yaml)
+- [Vim](https://github.com/Quramy/vison)

docs/source/commands/supergraphs.mdx

@@ -1,17 +1,12 @@
-use std::{
-    collections::BTreeMap,
-    fmt::Write,
-    io::{self, IsTerminal},
-};
+use std::collections::BTreeMap;
+use std::fmt::Write;
+use std::io::{self, IsTerminal};
 
 use calm_io::{stderr, stderrln};
 use camino::Utf8PathBuf;
 use comfy_table::Attribute::Bold;
 use comfy_table::Cell;
 use comfy_table::CellAlignment::Center;
-use serde_json::{json, Value};
-use termimad::{crossterm::style::Attribute::Underlined, MadSkin};
-
 use rover_client::operations::contract::describe::ContractDescribeResponse;
 use rover_client::operations::contract::publish::ContractPublishResponse;
 use rover_client::operations::graph::publish::GraphPublishResponse;
@@ -25,11 +20,13 @@ use rover_client::shared::{
 };
 use rover_client::RoverClientError;
 use rover_std::Style;
+use serde_json::{json, Value};
+use termimad::crossterm::style::Attribute::Underlined;
+use termimad::MadSkin;
 
 use crate::command::supergraph::compose::CompositionOutput;
 use crate::command::template::queries::list_templates_for_language::ListTemplatesForLanguageTemplates;
-use crate::options::JsonVersion;
-use crate::options::ProjectLanguage;
+use crate::options::{JsonVersion, ProjectLanguage};
 use crate::utils::table;
 use crate::RoverError;
 
@@ -56,6 +53,7 @@ pub enum RoverOutput {
     DocsList(BTreeMap<&'static str, &'static str>),
     FetchResponse(FetchResponse),
     SupergraphSchema(String),
+    JsonSchema(String),
     CompositionResult(CompositionOutput),
     SubgraphList(SubgraphListResponse),
     CheckWorkflowResponse(CheckWorkflowResponse),
@@ -284,6 +282,7 @@ impl RoverOutput {
                 }
             }
             RoverOutput::SupergraphSchema(csdl) => Some((csdl).to_string()),
+            RoverOutput::JsonSchema(schema) => Some(schema.clone()),
             RoverOutput::CompositionResult(composition_output) => {
                 let warn_prefix = Style::HintPrefix.paint("HINT:");
 
@@ -498,6 +497,7 @@ impl RoverOutput {
             }
             RoverOutput::FetchResponse(fetch_response) => json!(fetch_response),
             RoverOutput::SupergraphSchema(csdl) => json!({ "core_schema": csdl }),
+            RoverOutput::JsonSchema(schema) => Value::String(schema.clone()),
             RoverOutput::CompositionResult(composition_output) => {
                 if let Some(federation_version) = &composition_output.federation_version {
                     json!({
@@ -681,28 +681,20 @@ mod tests {
     use apollo_federation_types::rover::{BuildError, BuildErrors};
     use assert_json_diff::assert_json_eq;
     use chrono::{DateTime, Local, Utc};
-
     use console::strip_ansi_codes;
-    use rover_client::{
-        operations::{
-            graph::publish::{ChangeSummary, FieldChanges, TypeChanges},
-            persisted_queries::publish::PersistedQueriesOperationCounts,
-            subgraph::{
-                delete::SubgraphDeleteResponse,
-                list::{SubgraphInfo, SubgraphUpdatedAt},
-            },
-        },
-        shared::{
-            ChangeSeverity, CheckTaskStatus, CheckWorkflowResponse, CustomCheckResponse,
-            Diagnostic, LintCheckResponse, OperationCheckResponse, ProposalsCheckResponse,
-            ProposalsCheckSeverityLevel, ProposalsCoverage, RelatedProposal, SchemaChange, Sdl,
-            SdlType, Violation,
-        },
+    use rover_client::operations::graph::publish::{ChangeSummary, FieldChanges, TypeChanges};
+    use rover_client::operations::persisted_queries::publish::PersistedQueriesOperationCounts;
+    use rover_client::operations::subgraph::delete::SubgraphDeleteResponse;
+    use rover_client::operations::subgraph::list::{SubgraphInfo, SubgraphUpdatedAt};
+    use rover_client::shared::{
+        ChangeSeverity, CheckTaskStatus, CheckWorkflowResponse, CustomCheckResponse, Diagnostic,
+        LintCheckResponse, OperationCheckResponse, ProposalsCheckResponse,
+        ProposalsCheckSeverityLevel, ProposalsCoverage, RelatedProposal, SchemaChange, Sdl,
+        SdlType, Violation,
     };
 
-    use crate::options::JsonOutput;
-
     use super::*;
+    use crate::options::JsonOutput;
 
     #[test]
     fn docs_list_json() {

src/command/output.rs

@@ -0,0 +1,26 @@
+mod schema;
+
+use clap::Parser;
+use serde::Serialize;
+
+use crate::{RoverOutput, RoverResult};
+
+#[derive(Debug, Serialize, Parser)]
+pub struct Config {
+    #[clap(subcommand)]
+    command: Command,
+}
+
+#[derive(Debug, Serialize, Parser)]
+pub enum Command {
+    /// Print the Schema associated with the `supergraph.yaml` file for use in editors
+    Schema(schema::Schema),
+}
+
+impl Config {
+    pub fn run(&self) -> RoverResult<RoverOutput> {
+        match &self.command {
+            Command::Schema(command) => command.run(),
+        }
+    }
+}

src/command/supergraph/config/mod.rs

@@ -0,0 +1,18 @@
+use apollo_federation_types::config::SupergraphConfig;
+use clap::Parser;
+use schemars::schema_for;
+use serde::Serialize;
+
+use crate::{RoverOutput, RoverResult};
+
+#[derive(Debug, Serialize, Parser)]
+pub struct Schema {}
+
+impl Schema {
+    pub fn run(&self) -> RoverResult<RoverOutput> {
+        let schema = schema_for!(SupergraphConfig);
+        Ok(RoverOutput::JsonSchema(
+            serde_json::to_string_pretty(&schema).unwrap(),
+        ))
+    }
+}

src/command/supergraph/config/schema.rs

@@ -6,6 +6,7 @@ use crate::utils::client::StudioClientConfig;
 use crate::{RoverOutput, RoverResult};
 
 pub(crate) mod compose;
+mod config;
 mod fetch;
 
 #[derive(Debug, Serialize, Parser)]
@@ -19,6 +20,9 @@ pub enum Command {
     /// Locally compose supergraph SDL from a set of subgraph schemas
     Compose(compose::Compose),
 
+    /// Supergraph Config Schema commands
+    Config(config::Config),
+
     /// Fetch supergraph SDL from the graph registry
     Fetch(fetch::Fetch),
 }
@@ -37,6 +41,7 @@ impl Supergraph {
                     .run(override_install_path, client_config, output_file)
                     .await
             }
+            Command::Config(command) => command.run(),
         }
     }
 }

src/command/supergraph/mod.rs

@@ -0,0 +1,28 @@
+use std::process::Command;
+
+use assert_cmd::cargo::CommandCargoExt;
+use rstest::rstest;
+use tracing::error;
+use tracing_test::traced_test;
+
+#[rstest]
+#[ignore]
+#[tokio::test(flavor = "multi_thread")]
+#[traced_test]
+async fn e2e_test_rover_supergraph_config_schema() {
+    let mut cmd = Command::cargo_bin("rover").expect("Could not find necessary binary");
+    cmd.args(["supergraph", "config", "schema"]);
+
+    let output = cmd.output().expect("Could not run command");
+    if !output.status.success() {
+        error!("{}", String::from_utf8(output.stderr).unwrap());
+        panic!("Command did not complete successfully");
+    }
+
+    let output = String::from_utf8(output.stdout).unwrap();
+    let json_schema = serde_json::from_str(&output).unwrap();
+    if !jsonschema::meta::is_valid(&json_schema) {
+        error!("{}", output);
+        panic!("Could not validate JSON Schema, incorrect schema printed above");
+    }
+}

tests/e2e/supergraph/config.rs

@@ -1,2 +1,3 @@
 mod compose;
+mod config;
 mod fetch;

tests/e2e/supergraph/mod.rs

@@ -0,0 +1,28 @@
+use std::process::Command;
+
+use assert_cmd::cargo::CommandCargoExt;
+use rstest::rstest;
+use tracing::error;
+use tracing_test::traced_test;
+
+#[rstest]
+#[ignore]
+#[tokio::test(flavor = "multi_thread")]
+#[traced_test]
+async fn e2e_test_rover_supergraph_print_json_schema() {
+    let mut cmd = Command::cargo_bin("rover").expect("Could not find necessary binary");
+    cmd.args(["supergraph", "print-json-schema"]);
+
+    let output = cmd.output().expect("Could not run command");
+    if !output.status.success() {
+        error!("{}", String::from_utf8(output.stderr).unwrap());
+        panic!("Command did not complete successfully");
+    }
+
+    let output = String::from_utf8(output.stdout).unwrap();
+    let json_schema = serde_json::from_str(&output).unwrap();
+    if !jsonschema::meta::is_valid(&json_schema) {
+        error!("{}", output);
+        panic!("Could not validate JSON Schema, incorrect schema printed above");
+    }
+}