Merge branch 'cablett-nodes-recursion-analyzer' into 'master'

Simplify recursion fixtures and add `nodes` to recursion analyser IGNORED_FIELDS

See merge request gitlab-org/gitlab!24050

lib/gitlab/graphql/query_analyzers/recursion_analyzer.rb

@@ -6,7 +6,7 @@ module Gitlab
   module Graphql
     module QueryAnalyzers
       class RecursionAnalyzer
-        IGNORED_FIELDS = %w(node edges ofType).freeze
+        IGNORED_FIELDS = %w(node edges nodes ofType).freeze
         RECURSION_THRESHOLD = 2
 
         def initial_value(query)

spec/fixtures/api/graphql/recursive-introspection.graphql

@@ -2,51 +2,11 @@ query allSchemaTypes {
   __schema {
     types {
       fields {
-        type{
+        type {
           fields {
             type {
               fields {
-                type {
-                  fields {
-                    type {
-                      fields {
-                        type {
-                          fields {
-                            type {
-                              fields {
-                                type {
-                                  fields {
-                                    type {
-                                      fields {
-                                        type {
-                                          fields {
-                                            type {
-                                              fields {
-                                                type {
-                                                  fields {
-                                                    type {
-                                                      fields {
-                                                        name
-                                                      }
-                                                    }
-                                                  }
-                                                }
-                                              }
-                                            }
-                                          }
-                                        }
-                                      }
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
+                name
               }
             }
           }
@@ -54,4 +14,4 @@ query allSchemaTypes {
       }
     }
   }
-}
\ No newline at end of file
+}

spec/fixtures/api/graphql/recursive-query-edges-node.graphql

+{
+  project(fullPath: "gitlab-org/gitlab") {
+    group {
+      projects {
+        edges {
+          node {
+            group {
+              projects {
+                edges {
+                  node {
+                    group {
+                      description
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

spec/fixtures/api/graphql/recursive-query-nodes.graphql

+{
+  project(fullPath: "gitlab-org/gitlab") {
+    group {
+      projects {
+        nodes {
+          group {
+            projects {
+              nodes {
+                group {
+                  description
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

spec/fixtures/api/graphql/recursive-query.graphql

-{
-  project(fullPath: "gitlab-org/gitlab-ce") {
-    group {
-      projects {
-        edges {
-          node {
-            group {
-              projects {
-                edges {
-                  node {
-                    group {
-                      projects {
-                        edges {
-                          node {
-                            group {
-                              projects {
-                                edges {
-                                  node {
-                                    group {
-                                      projects {
-                                        edges {
-                                          node {
-                                            group {
-                                              description
-                                            }
-                                          }
-                                        }
-                                      }
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}

spec/requests/api/graphql/gitlab_schema_spec.rb

@@ -67,24 +67,45 @@ describe 'GitlabSchema configurations' do
         end
       end
 
-      context 'a deep but simple recursive introspective query' do
-        it 'fails due to recursion' do
-          query = File.read(Rails.root.join('spec/fixtures/api/graphql/recursive-introspection.graphql'))
+      context 'failing queries' do
+        before do
+          allow(GitlabSchema).to receive(:max_query_recursion).and_return 1
+        end
 
-          post_graphql(query, current_user: nil)
+        context 'a recursive introspective query' do
+          it 'fails due to recursion' do
+            query = File.read(Rails.root.join('spec/fixtures/api/graphql/recursive-introspection.graphql'))
 
-          expect_graphql_errors_to_include [/Recursive query/]
+            post_graphql(query, current_user: nil)
+
+            expect_graphql_errors_to_include [/Recursive query/]
+          end
         end
-      end
 
-      context 'a deep recursive non-introspective query' do
-        it 'fails due to recursion, complexity and depth' do
-          allow(GitlabSchema).to receive(:max_query_complexity).and_return 1
-          query = File.read(Rails.root.join('spec/fixtures/api/graphql/recursive-query.graphql'))
+        context 'a recursive non-introspective query' do
+          before do
+            allow(GitlabSchema).to receive(:max_query_complexity).and_return 1
+            allow(GitlabSchema).to receive(:max_query_depth).and_return 1
+            allow(GitlabSchema).to receive(:max_query_complexity).and_return 1
+          end
 
-          post_graphql(query, current_user: nil)
+          shared_examples 'fails due to recursion, complexity and depth' do |fixture_file|
+            it 'fails due to recursion, complexity and depth' do
+              query = File.read(Rails.root.join(fixture_file))
+
+              post_graphql(query, current_user: nil)
+
+              expect_graphql_errors_to_include [/Recursive query/, /exceeds max complexity/, /exceeds max depth/]
+            end
+          end
 
-          expect_graphql_errors_to_include [/Recursive query/, /exceeds max complexity/, /exceeds max depth/]
+          context 'using `nodes` notation' do
+            it_behaves_like 'fails due to recursion, complexity and depth', 'spec/fixtures/api/graphql/recursive-query-nodes.graphql'
+          end
+
+          context 'using `edges -> node` notation' do
+            it_behaves_like 'fails due to recursion, complexity and depth', 'spec/fixtures/api/graphql/recursive-query-edges-node.graphql'
+          end
         end
       end
     end