Mark semantic nullability config option as experimental

facebook · Jan 27, 2024 · c84e0b4 · c84e0b4
1 parent 2ce7b7d
commit c84e0b4
Show file tree

Hide file tree

Showing 48 changed files with 55 additions and 51 deletions.
diff --git a/compiler/crates/relay-config/src/typegen_config.rs b/compiler/crates/relay-config/src/typegen_config.rs
@@ -115,13 +115,17 @@ pub struct TypegenConfig {
     #[serde(default)]
     pub typescript_exclude_undefined_from_nullable_union: bool,
 
-    /// If your environment is configured to handles errors out of band, either via
+    /// EXPERIMENTAL: If your environment is configured to handles errors out of band, either via
     /// a network layer which discards responses with errors, or via enabling strict
     /// error handling in the runtime, you can enable this flag to have Relay generate
     /// non-null types for fields which are marked as semantically non-null in
     /// the schema.
+    ///
+    /// Currently semantically non-null fields must be specified in your schema
+    /// using the `@semanticNonNull` directive as specified in:
+    /// https://github.com/apollographql/specs/pull/42
     #[serde(default)]
-    pub emit_semantic_nullability_types: bool,
+    pub experimental_emit_semantic_nullability_types: bool,
 }
 
 #[derive(Default, Debug, Serialize, Deserialize, Clone, Copy)]

diff --git a/compiler/crates/relay-typegen/src/visit.rs b/compiler/crates/relay-typegen/src/visit.rs
@@ -2434,7 +2434,7 @@ fn field_type(field: &Field, typegen_options: &'_ TypegenContext<'_>) -> TypeRef
     if typegen_options
         .project_config
         .typegen_config
-        .emit_semantic_nullability_types
+        .experimental_emit_semantic_nullability_types
     {
         field.semantic_type()
     } else {

diff --git a/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_in_raw_response.expected b/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_in_raw_response.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 query MyQuery @raw_response_type {
   opera {
     composer {

diff --git a/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_in_raw_response.graphql b/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_in_raw_response.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 query MyQuery @raw_response_type {
   opera {
     composer {

diff --git a/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_items_in_matrix.expected b/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_items_in_matrix.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on Screen {
   pixels
 }

diff --git a/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_items_in_matrix.graphql b/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_items_in_matrix.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on Screen {
   pixels
 }

diff --git a/...elay-typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_resolver.expected b/...elay-typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_resolver.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend @waterfall {
     name

diff --git a/...relay-typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_resolver.graphql b/...relay-typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_resolver.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend @waterfall {
     name

diff --git a/...typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_weak_resolver.expected b/...typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_weak_resolver.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   blob {
     data

diff --git a/...-typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_weak_resolver.graphql b/...-typegen/tests/generate_flow/fixtures/semantic_non_null_liked_field_weak_resolver.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   blob {
     data

diff --git a/...crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_linked_field.expected b/...crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_linked_field.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend {
     name

diff --git a/.../crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_linked_field.graphql b/.../crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_linked_field.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend {
     name

diff --git a/.../relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_and_list_item.expected b/.../relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_and_list_item.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...s/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_and_list_item.graphql b/...s/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_and_list_item.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...er/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_item.expected b/...er/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_item.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...ler/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_item.graphql b/...ler/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_list_item.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/compiler/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar.expected b/compiler/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/compiler/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar.graphql b/compiler/crates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...y-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_feature_disabled.expected b/...y-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_feature_disabled.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# Note: No comment here enabling `emit_semantic_nullability_types`
+# Note: No comment here enabling `experimental_emit_semantic_nullability_types`
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...ay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_feature_disabled.graphql b/...ay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_feature_disabled.graphql
@@ -1,4 +1,4 @@
-# Note: No comment here enabling `emit_semantic_nullability_types`
+# Note: No comment here enabling `experimental_emit_semantic_nullability_types`
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_required.expected b/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_required.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name @required(action: LOG)
 }

diff --git a/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_required.graphql b/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_required.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name @required(action: LOG)
 }

diff --git a/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_resolver.expected b/...tes/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_resolver.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_resolver.graphql b/...ates/relay-typegen/tests/generate_flow/fixtures/semantic_non_null_scalar_resolver.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/compiler/crates/relay-typegen/tests/generate_flow/mod.rs b/compiler/crates/relay-typegen/tests/generate_flow/mod.rs
@@ -92,9 +92,9 @@ pub async fn transform_fixture(fixture: &Fixture<'_>) -> Result<String, String>
         typegen_config: TypegenConfig {
             language: TypegenLanguage::Flow,
             custom_scalar_types,
-            emit_semantic_nullability_types: fixture
+            experimental_emit_semantic_nullability_types: fixture
                 .content
-                .contains("# relay:emit_semantic_nullability_types"),
+                .contains("# relay:experimental_emit_semantic_nullability_types"),
             ..Default::default()
         },
         ..Default::default()

diff --git a/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_in_raw_response.expected b/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_in_raw_response.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 query MyQuery @raw_response_type {
   opera {
     composer {

diff --git a/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_in_raw_response.graphql b/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_in_raw_response.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 query MyQuery @raw_response_type {
   opera {
     composer {

diff --git a/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_items_in_matrix.expected b/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_items_in_matrix.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on Screen {
   pixels
 }

diff --git a/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_items_in_matrix.graphql b/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_items_in_matrix.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on Screen {
   pixels
 }

diff --git a/...ypegen/tests/generate_typescript/fixtures/semantic_non_null_liked_field_resolver.expected b/...ypegen/tests/generate_typescript/fixtures/semantic_non_null_liked_field_resolver.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend @waterfall {
     name

diff --git a/...typegen/tests/generate_typescript/fixtures/semantic_non_null_liked_field_resolver.graphql b/...typegen/tests/generate_typescript/fixtures/semantic_non_null_liked_field_resolver.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend @waterfall {
     name

diff --git a/...n/tests/generate_typescript/fixtures/semantic_non_null_liked_field_weak_resolver.expected b/...n/tests/generate_typescript/fixtures/semantic_non_null_liked_field_weak_resolver.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   blob {
     data

diff --git a/...en/tests/generate_typescript/fixtures/semantic_non_null_liked_field_weak_resolver.graphql b/...en/tests/generate_typescript/fixtures/semantic_non_null_liked_field_weak_resolver.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   blob {
     data

diff --git a/.../relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_linked_field.expected b/.../relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_linked_field.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend {
     name

diff --git a/...s/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_linked_field.graphql b/...s/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_linked_field.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   best_friend {
     name

diff --git a/...-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_and_list_item.expected b/...-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_and_list_item.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...y-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_and_list_item.graphql b/...y-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_and_list_item.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...tes/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_item.expected b/...tes/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_item.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...ates/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_item.graphql b/...ates/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_list_item.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   favorite_numbers
 }

diff --git a/...crates/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar.expected b/...crates/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/.../crates/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar.graphql b/.../crates/relay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...gen/tests/generate_typescript/fixtures/semantic_non_null_scalar_feature_disabled.expected b/...gen/tests/generate_typescript/fixtures/semantic_non_null_scalar_feature_disabled.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# Note: No comment here enabling `emit_semantic_nullability_types`
+# Note: No comment here enabling `experimental_emit_semantic_nullability_types`
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...egen/tests/generate_typescript/fixtures/semantic_non_null_scalar_feature_disabled.graphql b/...egen/tests/generate_typescript/fixtures/semantic_non_null_scalar_feature_disabled.graphql
@@ -1,4 +1,4 @@
-# Note: No comment here enabling `emit_semantic_nullability_types`
+# Note: No comment here enabling `experimental_emit_semantic_nullability_types`
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_required.expected b/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_required.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name @required(action: LOG)
 }

diff --git a/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_required.graphql b/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_required.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name @required(action: LOG)
 }

diff --git a/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_resolver.expected b/...lay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_resolver.expected
@@ -1,5 +1,5 @@
 ==================================== INPUT ====================================
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_resolver.graphql b/...elay-typegen/tests/generate_typescript/fixtures/semantic_non_null_scalar_resolver.graphql
@@ -1,4 +1,4 @@
-# relay:emit_semantic_nullability_types
+# relay:experimental_emit_semantic_nullability_types
 fragment MyFragment on ClientUser {
   name
 }

diff --git a/compiler/crates/relay-typegen/tests/generate_typescript/mod.rs b/compiler/crates/relay-typegen/tests/generate_typescript/mod.rs
@@ -72,9 +72,9 @@ pub async fn transform_fixture(fixture: &Fixture<'_>) -> Result<String, String>
             use_import_type_syntax: fixture
                 .content
                 .contains("# typegen_config.use_import_type_syntax = true"),
-            emit_semantic_nullability_types: fixture
+            experimental_emit_semantic_nullability_types: fixture
                 .content
-                .contains("# relay:emit_semantic_nullability_types"),
+                .contains("# relay:experimental_emit_semantic_nullability_types"),
             ..Default::default()
         },
         feature_flags: Arc::new(FeatureFlags {