Automatically Generate JSON Schema

.github/workflows/ci.yml

@@ -143,6 +143,31 @@ jobs:
         run: grep -r --include "*.rs" --files-without-match "@generated" crates | xargs rustfmt --check --config="skip_children=true"
         working-directory: ./compiler/
 
+  build-config-schema:
+    name: Build Relay Compiler Config JSON Schema
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.64.0
+          override: true
+
+      - uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --features vendored --manifest-path compiler/Cargo.toml --bin relay-config-schema --release
+
+      - name: Generate JSON Schema
+        run: |
+          ./compiler/target/release/relay-config-schema > relay-config-schema.json;
+          node scripts/fixJsonSchema.js;
+      - name: Upload JSON Schema
+        uses: actions/upload-artifact@v2
+        with:
+          name: relay-config-schema.json
+          path: ./relay-config-schema.json
+
   build-compiler:
     name: Build Rust Compiler (${{ matrix.target.os }})
     strategy:
@@ -218,7 +243,7 @@ jobs:
     name: Publish to NPM
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.repository == 'facebook/relay'
-    needs: [js-tests, js-lint, typecheck, build-tests, build-compiler]
+    needs: [js-tests, js-lint, typecheck, build-tests, build-compiler, build-config-schema]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
@@ -253,6 +278,11 @@ jobs:
         with:
           name: relay-bin-win-x64
           path: artifacts/win-x64
+      - name: Download artifact relay-config-schema
+        uses: actions/download-artifact@v2
+        with:
+          name: relay-config-schema.json
+          path: artifacts/relay-config-schmea.json
       - name: Mark binaries as executable
         working-directory: artifacts
         run: |

compiler/Cargo.toml

@@ -29,4 +29,5 @@ members = [
     "crates/schema-print",
     "crates/schema-validate",
     "crates/signedsource",
+    "crates/relay-config-schema"
 ]

compiler/crates/common/Cargo.toml

@@ -14,5 +14,6 @@ log = { version = "0.4.17", features = ["kv_unstable", "kv_unstable_std"] }
 lsp-types = "0.93.2"
 md-5 = "0.10"
 rayon = "1.2"
+schemars = {version = "0.8.11", features = ["indexmap1"] }
 serde = { version = "1.0.136", features = ["derive", "rc"] }
 serde_json = { version = "1.0.79", features = ["float_roundtrip", "unbounded_depth"] }

compiler/crates/common/src/feature_flags.rs

@@ -12,12 +12,13 @@ use std::fmt::Result as FmtResult;
 use indexmap::IndexSet;
 use intern::string_key::StringKey;
 use intern::Lookup;
+use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 
-use crate::Rollout;
+use crate::rollout::Rollout;
 
-#[derive(Default, Debug, Serialize, Deserialize, Clone)]
+#[derive(Default, Debug, Serialize, Deserialize, Clone, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct FeatureFlags {
     #[serde(default)]
@@ -77,7 +78,7 @@ pub struct FeatureFlags {
     pub emit_normalization_nodes_for_client_edges: bool,
 }
 
-#[derive(Debug, Deserialize, Clone, Serialize)]
+#[derive(Debug, Deserialize, Clone, Serialize, JsonSchema)]
 #[serde(tag = "kind", rename_all = "lowercase")]
 pub enum FeatureFlag {
     /// Fully disabled: developers may not use this feature

compiler/crates/common/src/named_item.rs

@@ -12,6 +12,7 @@ use intern::impl_lookup;
 use intern::string_key::Intern;
 use intern::string_key::StringKey;
 use intern::Lookup;
+use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 
@@ -45,7 +46,8 @@ pub trait Named {
     Ord,
     PartialEq,
     PartialOrd,
-    Serialize
+    Serialize,
+    JsonSchema
 )]
 pub struct DirectiveName(pub StringKey);
 

compiler/crates/common/src/rollout.rs

@@ -7,13 +7,14 @@
 
 use md5::Digest;
 use md5::Md5;
+use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 
 /// A utility to enable gradual rollout of large codegen changes.
 /// Can be constructed as the Default which passes or a percentage between 0 and
 /// 100.
-#[derive(Default, Debug, Serialize, Deserialize, Clone, Copy)]
+#[derive(Default, Debug, Serialize, Deserialize, Clone, Copy, JsonSchema)]
 pub struct Rollout(Option<u8>);
 
 impl Rollout {

compiler/crates/intern/Cargo.toml

@@ -17,6 +17,7 @@ serde = { version = "1.0.136", features = ["derive", "rc"] }
 serde_bytes = "0.11"
 serde_derive = "1.0"
 smallvec = { version = "1.6.1", features = ["serde", "union"] }
+schemars = {version = "0.8.11" }
 
 [dev-dependencies]
 bincode = "1.3.3"

compiler/crates/intern/src/string_key.rs

@@ -12,6 +12,9 @@ use std::fmt::Formatter;
 use std::str::FromStr;
 
 use indexmap::IndexMap;
+use schemars::schema::InstanceType;
+use schemars::schema::SchemaObject;
+use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Deserializer;
 use serde::Serialize;
@@ -55,6 +58,20 @@ impl StringKey {
     }
 }
 
+impl JsonSchema for StringKey {
+    fn schema_name() -> String {
+        "StringKey".to_owned()
+    }
+
+    fn json_schema(_: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
+        SchemaObject {
+            instance_type: Some(InstanceType::String.into()),
+            ..Default::default()
+        }
+        .into()
+    }
+}
+
 impl Lookup for StringKey {
     fn lookup(self) -> &'static str {
         self.0.as_str()

compiler/crates/relay-compiler/Cargo.toml

@@ -51,6 +51,7 @@ relay-transforms = { path = "../relay-transforms" }
 relay-typegen = { path = "../relay-typegen" }
 schema = { path = "../schema" }
 schema-diff = { path = "../schema-diff" }
+schemars = { version = "0.8.11", features = ["indexmap1"]}
 serde = { version = "1.0.136", features = ["derive", "rc"] }
 serde_bser = "0.3"
 serde_json = { version = "1.0.79", features = ["float_roundtrip", "unbounded_depth"] }

compiler/crates/relay-compiler/src/compiler_state.rs

@@ -33,6 +33,7 @@ use relay_config::SchemaConfig;
 use schema::SDLSchema;
 use schema_diff::definitions::SchemaChange;
 use schema_diff::detect_changes;
+use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 use zstd::stream::read::Decoder as ZstdDecoder;
@@ -58,7 +59,7 @@ use crate::file_source::SourceControlUpdateStatus;
 pub type ProjectName = StringKey;
 
 /// Set of project names.
-#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash, JsonSchema)]
 #[serde(from = "DeserializableProjectSet")]
 pub struct ProjectSet(Vec<ProjectName>);