detect cyclic @inline fragments

Reviewed By: josephsavona

Differential Revision: D35046903

fbshipit-source-id: e768787582330ce7fe3981241b7da209fc4d711f

compiler/crates/relay-compiler/tests/compile_relay_artifacts/fixtures/circular-inline-fragment.invalid.expected

@@ -0,0 +1,88 @@
+==================================== INPUT ====================================
+# expected-to-throw
+
+fragment circularInlineFragmentF1 on User @inline {
+  ...circularInlineFragmentF2
+}
+
+fragment circularInlineFragmentF2 on User @inline {
+  ...circularInlineFragmentF3
+}
+
+fragment circularInlineFragmentF3 on User @inline {
+  ...circularInlineFragmentF1
+}
+==================================== ERROR ====================================
+✖︎ Found a circular reference from fragment 'circularInlineFragmentF1'.
+
+  circular-inline-fragment.invalid.graphql:12:6
+   11 │ fragment circularInlineFragmentF3 on User @inline {
+   12 │   ...circularInlineFragmentF1
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+   13 │ }
+
+  ℹ︎ spreading circularInlineFragmentF2
+
+  circular-inline-fragment.invalid.graphql:4:6
+    3 │ fragment circularInlineFragmentF1 on User @inline {
+    4 │   ...circularInlineFragmentF2
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+    5 │ }
+
+  ℹ︎ spreading circularInlineFragmentF3
+
+  circular-inline-fragment.invalid.graphql:8:6
+    7 │ fragment circularInlineFragmentF2 on User @inline {
+    8 │   ...circularInlineFragmentF3
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+    9 │ }
+
+
+✖︎ Found a circular reference from fragment 'circularInlineFragmentF2'.
+
+  circular-inline-fragment.invalid.graphql:4:6
+    3 │ fragment circularInlineFragmentF1 on User @inline {
+    4 │   ...circularInlineFragmentF2
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+    5 │ }
+
+  ℹ︎ spreading circularInlineFragmentF3
+
+  circular-inline-fragment.invalid.graphql:8:6
+    7 │ fragment circularInlineFragmentF2 on User @inline {
+    8 │   ...circularInlineFragmentF3
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+    9 │ }
+
+  ℹ︎ spreading circularInlineFragmentF1
+
+  circular-inline-fragment.invalid.graphql:12:6
+   11 │ fragment circularInlineFragmentF3 on User @inline {
+   12 │   ...circularInlineFragmentF1
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+   13 │ }
+
+
+✖︎ Found a circular reference from fragment 'circularInlineFragmentF3'.
+
+  circular-inline-fragment.invalid.graphql:8:6
+    7 │ fragment circularInlineFragmentF2 on User @inline {
+    8 │   ...circularInlineFragmentF3
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+    9 │ }
+
+  ℹ︎ spreading circularInlineFragmentF1
+
+  circular-inline-fragment.invalid.graphql:12:6
+   11 │ fragment circularInlineFragmentF3 on User @inline {
+   12 │   ...circularInlineFragmentF1
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+   13 │ }
+
+  ℹ︎ spreading circularInlineFragmentF2
+
+  circular-inline-fragment.invalid.graphql:4:6
+    3 │ fragment circularInlineFragmentF1 on User @inline {
+    4 │   ...circularInlineFragmentF2
+      │      ^^^^^^^^^^^^^^^^^^^^^^^^
+    5 │ }

compiler/crates/relay-compiler/tests/compile_relay_artifacts/fixtures/circular-inline-fragment.invalid.graphql

@@ -0,0 +1,13 @@
+# expected-to-throw
+
+fragment circularInlineFragmentF1 on User @inline {
+  ...circularInlineFragmentF2
+}
+
+fragment circularInlineFragmentF2 on User @inline {
+  ...circularInlineFragmentF3
+}
+
+fragment circularInlineFragmentF3 on User @inline {
+  ...circularInlineFragmentF1
+}

compiler/crates/relay-compiler/tests/compile_relay_artifacts_test.rs

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @generated SignedSource<<1d6f350f3c9c690369bd4c7ee6c434df>>
+ * @generated SignedSource<<e41886c3abe3d2ccd18f08212a954a32>>
  */
 
 mod compile_relay_artifacts;
@@ -152,6 +152,13 @@ fn auto_filled_argument_on_match() {
     test_fixture(transform_fixture, "auto-filled-argument-on-match.graphql", "compile_relay_artifacts/fixtures/auto-filled-argument-on-match.expected", input, expected);
 }
 
+#[test]
+fn circular_inline_fragment_invalid() {
+    let input = include_str!("compile_relay_artifacts/fixtures/circular-inline-fragment.invalid.graphql");
+    let expected = include_str!("compile_relay_artifacts/fixtures/circular-inline-fragment.invalid.expected");
+    test_fixture(transform_fixture, "circular-inline-fragment.invalid.graphql", "compile_relay_artifacts/fixtures/circular-inline-fragment.invalid.expected", input, expected);
+}
+
 #[test]
 fn circular_no_inline_fragment() {
     let input = include_str!("compile_relay_artifacts/fixtures/circular-no-inline-fragment.graphql");

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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-use common::{Diagnostic, DiagnosticsResult, NamedItem};
+use common::{Diagnostic, DiagnosticsResult, NamedItem, WithLocation};
 use graphql_ir::{
     associated_data_impl, FragmentSpread, InlineFragment, Program, Selection, Transformed,
     Transformer,
@@ -34,13 +34,15 @@ pub const INLINE_DIRECTIVE_NAME: Lazy<StringKey> = Lazy::new(|| "inline".intern(
 struct InlineDataFragmentsTransform<'s> {
     program: &'s Program,
     errors: Vec<Diagnostic>,
+    parent_inline_fragments: Vec<WithLocation<StringKey>>,
 }
 
 impl<'s> InlineDataFragmentsTransform<'s> {
     fn new(program: &'s Program) -> Self {
         Self {
             program,
-            errors: vec![],
+            errors: Vec::new(),
+            parent_inline_fragments: Vec::new(),
         }
     }
 }
@@ -63,8 +65,7 @@ impl<'s> Transformer for InlineDataFragmentsTransform<'s> {
             .fragment(spread.fragment.item)
             .unwrap_or_else(|| panic!("was expecting to find fragment `{}`", spread.fragment.item));
 
-        let inline_directive = fragment.directives.named(*INLINE_DIRECTIVE_NAME);
-        if inline_directive.is_none() {
+        if fragment.directives.named(*INLINE_DIRECTIVE_NAME).is_none() {
             next_fragment_spread
         } else {
             if !fragment.variable_definitions.is_empty()
@@ -107,7 +108,29 @@ impl<'s> Transformer for InlineDataFragmentsTransform<'s> {
                 }
             };
 
+            if self
+                .parent_inline_fragments
+                .iter()
+                .any(|name| name.item == fragment.name.item)
+            {
+                let mut cyclic_fragments = self.parent_inline_fragments.iter();
+                let first = cyclic_fragments.next().unwrap();
+                let mut diagnostic = Diagnostic::error(
+                    ValidationMessage::CircularFragmentReference {
+                        fragment_name: first.item,
+                    },
+                    first.location,
+                );
+                for spread in cyclic_fragments {
+                    diagnostic =
+                        diagnostic.annotate(format!("spreading {}", spread.item), spread.location);
+                }
+                self.errors.push(diagnostic);
+                return Transformed::Keep;
+            }
+            self.parent_inline_fragments.push(spread.fragment);
             let transformed_fragment = self.default_transform_fragment(fragment);
+            self.parent_inline_fragments.pop();
 
             let (name, selections) = match transformed_fragment {
                 Transformed::Keep => (fragment.name.item, fragment.selections.clone()),
@@ -143,6 +166,9 @@ impl<'s> Transformer for InlineDataFragmentsTransform<'s> {
 
 #[derive(Error, Debug)]
 enum ValidationMessage {
+    #[error("Found a circular reference from fragment '{fragment_name}'.")]
+    CircularFragmentReference { fragment_name: StringKey },
+
     #[error("Variables are not yet supported inside @inline fragments.")]
     InlineDataFragmentArgumentsNotSupported,