Add feature flag for fragment arguments (#4648)

Summary:
Adds a new `enable_fragment_argument_transform` feature flag that allows to enable the existing parsing and transform of fragment variable definitions and fragment spread arguments.

Pull Request resolved: #4648

Reviewed By: josephsavona

Differential Revision: D54872375

Pulled By: captbaritone

fbshipit-source-id: 405182b131c984a2a64dbc3ca40a325624714833

Author: tobias-tengler

compiler/crates/common/src/feature_flags.rs

@@ -99,6 +99,11 @@ pub struct FeatureFlags {
     /// excludes resolver metadata from reader ast
     #[serde(default)]
     pub disable_resolver_reader_ast: bool,
+
+    /// Add support for parsing and transforming variable definitions on fragment
+    /// definitions and arguments on fragment spreads.
+    #[serde(default)]
+    pub enable_fragment_argument_transform: bool,
 }
 
 #[derive(Debug, Deserialize, Clone, Serialize, Default)]

compiler/crates/graphql-syntax/src/lib.rs

@@ -59,6 +59,17 @@ pub fn parse_executable(
     parse_executable_with_error_recovery(source, source_location).into()
 }
 
+/// Parses a GraphQL document that's restricted to executable
+/// definitions with custom feature flags passed as `features`.
+pub fn parse_executable_with_features(
+    source: &str,
+    source_location: SourceLocationKey,
+    features: ParserFeatures,
+) -> DiagnosticsResult<ExecutableDocument> {
+    parse_executable_with_error_recovery_and_parser_features(source, source_location, features)
+        .into()
+}
+
 /// Parses a GraphQL document that's restricted to executable definitions,
 /// with error recovery.
 pub fn parse_executable_with_error_recovery(
@@ -81,17 +92,6 @@ pub fn parse_executable_with_error_recovery_and_parser_features(
     parser.parse_executable_document()
 }
 
-/// Parses a GraphQL document that's restricted to executable
-/// definitions with custom feature flags passed as `features`.
-pub fn parse_executable_with_features(
-    source: &str,
-    source_location: SourceLocationKey,
-    features: ParserFeatures,
-) -> DiagnosticsResult<ExecutableDocument> {
-    parse_executable_with_error_recovery_and_parser_features(source, source_location, features)
-        .into()
-}
-
 /// Parses a GraphQL document that's restricted to type system definitions
 /// including schema definition, type definitions and type system extensions.
 pub fn parse_schema_document(

compiler/crates/graphql-syntax/src/parser.rs

@@ -22,15 +22,15 @@ use crate::syntax_error::SyntaxError;
 
 type ParseResult<T> = Result<T, ()>;
 
-#[derive(Default, PartialEq)]
+#[derive(Default, Clone, Copy, PartialEq)]
 pub enum FragmentArgumentSyntaxKind {
     #[default]
     None,
     OnlyFragmentVariableDefinitions,
     SpreadArgumentsAndFragmentVariableDefinitions,
 }
 
-#[derive(Default)]
+#[derive(Default, Clone, Copy)]
 pub struct ParserFeatures {
     /// Whether and how to enable the experimental fragment variables definitions syntax
     pub fragment_argument_capability: FragmentArgumentSyntaxKind,

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

@@ -303,6 +303,7 @@ async fn build_projects<TPerfLogger: PerfLogger + 'static>(
         GraphQLAsts::from_graphql_sources_map(
             &compiler_state.graphql_sources,
             &dirty_artifact_sources,
+            &config,
         )
     })?;
 

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

@@ -9,6 +9,7 @@ use std::collections::hash_map::Entry;
 use std::collections::HashSet;
 use std::path::Path;
 use std::path::PathBuf;
+use std::sync::Arc;
 
 use common::Diagnostic;
 use common::SourceLocationKey;
@@ -18,13 +19,16 @@ use graphql_ir::ExecutableDefinitionName;
 use graphql_ir::FragmentDefinitionName;
 use graphql_ir::OperationDefinitionName;
 use graphql_syntax::ExecutableDefinition;
+use relay_config::ProjectConfig;
 use relay_config::ProjectName;
 
 use crate::artifact_map::ArtifactSourceKey;
 use crate::compiler_state::GraphQLSources;
+use crate::config::Config;
 use crate::errors::Error;
 use crate::errors::Result;
 use crate::file_source::LocatedGraphQLSource;
+use crate::utils::get_parser_features;
 
 #[derive(Debug)]
 pub struct GraphQLAsts {
@@ -50,10 +54,13 @@ impl GraphQLAsts {
     pub fn from_graphql_sources_map(
         graphql_sources_map: &FnvHashMap<ProjectName, GraphQLSources>,
         dirty_artifact_sources: &FnvHashMap<ProjectName, Vec<ArtifactSourceKey>>,
+        config: &Arc<Config>,
     ) -> Result<FnvHashMap<ProjectName, GraphQLAsts>> {
         graphql_sources_map
             .iter()
             .map(|(&project_name, sources)| {
+                let project_config = &config.projects[&project_name];
+
                 let asts = GraphQLAsts::from_graphql_sources(
                     sources,
                     dirty_artifact_sources
@@ -73,6 +80,7 @@ impl GraphQLAsts {
                                 })
                                 .collect()
                         }),
+                    project_config,
                 )?;
                 Ok((project_name, asts))
             })
@@ -85,7 +93,10 @@ impl GraphQLAsts {
     pub fn from_graphql_sources(
         graphql_sources: &GraphQLSources,
         dirty_definitions: Option<Vec<&ExecutableDefinitionName>>,
+        project_config: &ProjectConfig,
     ) -> Result<Self> {
+        let parser_features = get_parser_features(project_config);
+
         let mut syntax_errors = Vec::new();
 
         let mut asts: FnvHashMap<PathBuf, Vec<ExecutableDefinition>> = Default::default();
@@ -108,9 +119,10 @@ impl GraphQLAsts {
             {
                 let source_location =
                     SourceLocationKey::embedded(&file_name.to_string_lossy(), *index);
-                match graphql_syntax::parse_executable(
+                match graphql_syntax::parse_executable_with_features(
                     &graphql_source.text_source().text,
                     source_location,
+                    parser_features,
                 ) {
                     Ok(document) => {
                         for def in &document.definitions {
@@ -145,9 +157,10 @@ impl GraphQLAsts {
                     // TODO: parse name instead of the whole graphql text
                     let source_location =
                         SourceLocationKey::embedded(&file_name.to_string_lossy(), *index);
-                    if let Ok(document) = graphql_syntax::parse_executable(
+                    if let Ok(document) = graphql_syntax::parse_executable_with_features(
                         &graphql_source.text_source().text,
                         source_location,
+                        parser_features,
                     ) {
                         for def in document.definitions {
                             match def {
@@ -210,9 +223,10 @@ impl GraphQLAsts {
             {
                 let source_location =
                     SourceLocationKey::embedded(&file_name.to_string_lossy(), *index);
-                match graphql_syntax::parse_executable(
+                match graphql_syntax::parse_executable_with_features(
                     &graphql_source.text_source().text,
                     source_location,
+                    parser_features,
                 ) {
                     Ok(document) => {
                         definitions_for_file.extend(document.definitions);

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

@@ -23,6 +23,7 @@ mod operation_persister;
 mod red_to_green;
 pub mod saved_state;
 pub mod status_reporter;
+mod utils;
 
 pub use artifact_map::ArtifactSourceKey;
 pub use build_project::add_to_mercurial;
@@ -72,3 +73,4 @@ pub use graphql_asts::GraphQLAsts;
 pub use operation_persister::LocalPersister;
 pub use operation_persister::RemotePersister;
 pub use relay_config::ProjectName;
+pub use utils::get_parser_features;

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

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+use graphql_syntax::FragmentArgumentSyntaxKind;
+use graphql_syntax::ParserFeatures;
+use relay_config::ProjectConfig;
+
+pub fn get_parser_features(project_config: &ProjectConfig) -> ParserFeatures {
+    ParserFeatures {
+        fragment_argument_capability: if project_config
+            .feature_flags
+            .enable_fragment_argument_transform
+        {
+            FragmentArgumentSyntaxKind::SpreadArgumentsAndFragmentVariableDefinitions
+        } else {
+            FragmentArgumentSyntaxKind::None
+        },
+    }
+}

compiler/crates/relay-compiler/tests/compile_relay_artifacts/mod.rs

@@ -124,6 +124,7 @@ pub async fn transform_fixture(fixture: &Fixture<'_>) -> Result<String, String>
         allow_required_in_mutation_response: FeatureFlag::Disabled,
         allow_resolvers_in_mutation_response: FeatureFlag::Disabled,
         disable_resolver_reader_ast: false,
+        enable_fragment_argument_transform: false,
     };
 
     let default_project_config = ProjectConfig {

compiler/crates/relay-compiler/tests/compile_relay_artifacts_with_custom_id/mod.rs

@@ -103,6 +103,7 @@ pub async fn transform_fixture(fixture: &Fixture<'_>) -> Result<String, String>
         allow_required_in_mutation_response: FeatureFlag::Disabled,
         allow_resolvers_in_mutation_response: FeatureFlag::Disabled,
         disable_resolver_reader_ast: false,
+        enable_fragment_argument_transform: false,
     };
 
     let default_schema_config = SchemaConfig::default();