Merge pull request rmosolgo#3837 from rmosolgo/repeatable-directives

Support repeatable directives

Author: rmosolgo

Rakefile

@@ -62,7 +62,7 @@ ERR
   end
 
   assert_dependency_version("Ragel", "7.0.0.9", "ragel -v")
-  assert_dependency_version("Racc", "1.5.2", %|ruby -e "require 'racc'; puts Racc::VERSION"|)
+  assert_dependency_version("Racc", "1.6.0", %|ruby -e "require 'racc'; puts Racc::VERSION"|)
 
   `rm -f lib/graphql/language/parser.rb lib/graphql/language/lexer.rb `
   `racc lib/graphql/language/parser.y -o lib/graphql/language/parser.rb`

lib/graphql/language/document_from_schema_definition.rb

@@ -152,6 +152,7 @@ def build_input_object_node(input_object)
       def build_directive_node(directive)
         GraphQL::Language::Nodes::DirectiveDefinition.new(
           name: directive.graphql_name,
+          repeatable: directive.repeatable?,
           arguments: build_argument_nodes(warden.arguments(directive)),
           locations: build_directive_location_nodes(directive.locations),
           description: directive.description,

lib/graphql/language/lexer.rb

@@ -27,6 +27,7 @@
   ENUM =          'enum';
   INPUT =         'input';
   DIRECTIVE =     'directive';
+  REPEATABLE =    'repeatable';
   LCURLY =        '{';
   RCURLY =        '}';
   LPAREN =        '(';
@@ -85,6 +86,7 @@
     ENUM          => { emit(:ENUM, ts, te, meta) };
     INPUT         => { emit(:INPUT, ts, te, meta) };
     DIRECTIVE     => { emit(:DIRECTIVE, ts, te, meta) };
+    REPEATABLE    => { emit(:REPEATABLE, ts, te, meta, "repeatable") };
     RCURLY        => { emit(:RCURLY, ts, te, meta, "}") };
     LCURLY        => { emit(:LCURLY, ts, te, meta, "{") };
     RPAREN        => { emit(:RPAREN, ts, te, meta, ")") };

lib/graphql/language/lexer.rl

@@ -318,7 +318,7 @@ class DirectiveLocation < NameOnlyNode
       class DirectiveDefinition < AbstractNode
         include DefinitionNode
         attr_reader :description
-        scalar_methods :name
+        scalar_methods :name, :repeatable
         children_methods(
           locations: Nodes::DirectiveLocation,
           arguments: Nodes::Argument,

lib/graphql/language/nodes.rb

@@ -147,6 +147,7 @@ rule
   name_without_on:
       IDENTIFIER
     | FRAGMENT
+    | REPEATABLE
     | TRUE
     | FALSE
     | operation_type
@@ -155,6 +156,7 @@ rule
   enum_name: /* any identifier, but not "true", "false" or "null" */
       IDENTIFIER
     | FRAGMENT
+    | REPEATABLE
     | ON
     | operation_type
     | schema_keyword
@@ -422,10 +424,14 @@ rule
       }
 
   directive_definition:
-      description_opt DIRECTIVE DIR_SIGN name arguments_definitions_opt ON directive_locations {
-        result = make_node(:DirectiveDefinition, name: val[3], arguments: val[4], locations: val[6], description: val[0] || get_description(val[1]), definition_line: val[1].line, position_source: val[0] || val[1])
+      description_opt DIRECTIVE DIR_SIGN name arguments_definitions_opt directive_repeatable_opt ON directive_locations {
+        result = make_node(:DirectiveDefinition, name: val[3], arguments: val[4], locations: val[7], repeatable: !!val[5], description: val[0] || get_description(val[1]), definition_line: val[1].line, position_source: val[0] || val[1])
       }
 
+  directive_repeatable_opt:
+    /* nothing */
+    | REPEATABLE
+
   directive_locations:
       name                          { result = [make_node(:DirectiveLocation, name: val[0].to_s, position_source: val[0])] }
     | directive_locations PIPE name { val[0] << make_node(:DirectiveLocation, name: val[2].to_s, position_source: val[2]) }

lib/graphql/language/parser.rb

@@ -252,6 +252,10 @@ def print_directive_definition(directive)
           out << print_arguments(directive.arguments)
         end
 
+        if directive.repeatable
+          out << " repeatable"
+        end
+
         out << " on #{directive.locations.map(&:name).join(' | ')}"
       end
 

lib/graphql/language/parser.y

@@ -377,6 +377,7 @@ def build_directive(directive_definition, type_resolver)
           Class.new(GraphQL::Schema::Directive) do
             graphql_name(directive_definition.name)
             description(directive_definition.description)
+            repeatable(directive_definition.repeatable)
             locations(*directive_definition.locations.map { |location| location.name.to_sym })
             ast_node(directive_definition)
             builder.build_arguments(self, directive_definition.arguments, type_resolver)

lib/graphql/language/printer.rb

@@ -101,6 +101,14 @@ def on_fragment?
         def on_operation?
           locations.include?(QUERY) && locations.include?(MUTATION) && locations.include?(SUBSCRIPTION)
         end
+
+        def repeatable?
+          !!@repeatable
+        end
+
+        def repeatable(new_value)
+          @repeatable = new_value
+        end
       end
 
       # @return [GraphQL::Schema::Field, GraphQL::Schema::Argument, Class, Module]

lib/graphql/schema/build_from_definition.rb

@@ -110,7 +110,7 @@ def on_field(node, parent)
         end
 
         def on_directive(node, parent)
-          directive_defn = @schema.directives[node.name]
+          directive_defn = @context.schema_directives[node.name]
           @directive_definitions.push(directive_defn)
           super
           @directive_definitions.pop

lib/graphql/schema/directive.rb

@@ -59,7 +59,7 @@ def parent_definition(parent)
             end
           end
         when GraphQL::Language::Nodes::Directive
-          context.schema.directives[parent.name]
+          context.schema_directives[parent.name]
         when GraphQL::Language::Nodes::Field
           context.field_definition
         else

lib/graphql/static_validation/base_visitor.rb

@@ -5,7 +5,7 @@ module DirectivesAreInValidLocations
       include GraphQL::Language
 
       def on_directive(node, parent)
-        validate_location(node, parent, context.schema.directives)
+        validate_location(node, parent, context.schema_directives)
         super
       end
 

lib/graphql/static_validation/rules/arguments_are_defined.rb

@@ -8,7 +8,7 @@ def on_field(node, _parent)
       end
 
       def on_directive(node, _parent)
-        directive_defn = context.schema.directives[node.name]
+        directive_defn = context.schema_directives[node.name]
         assert_required_args(node, directive_defn)
         super
       end

lib/graphql/static_validation/rules/directives_are_in_valid_locations.rb

@@ -40,7 +40,7 @@ def validate_directive_location(node)
               nodes: [used_directives[directive_name], ast_directive],
               directive: directive_name,
             ))
-          else
+          elsif !((dir_defn = context.schema_directives[directive_name]) && dir_defn.repeatable?)
             used_directives[directive_name] = ast_directive
           end
         end

lib/graphql/static_validation/rules/required_arguments_are_present.rb

@@ -44,6 +44,10 @@ def validate_literal(ast_value, type)
       def too_many_errors?
         @errors.length >= @max_errors
       end
+
+      def schema_directives
+        @schema_directives ||= schema.directives
+      end
     end
   end
 end

lib/graphql/static_validation/rules/unique_directives_per_location.rb

@@ -108,11 +108,12 @@
 
     it "is parsed for directive definitions" do
       document = subject.parse <<-GRAPHQL
-      "thing description" directive @thing on FIELD
+      "thing description" directive @thing repeatable on FIELD
       GRAPHQL
 
       thing_defn = document.definitions[0]
       assert_equal "thing", thing_defn.name
+      assert_equal true, thing_defn.repeatable
       assert_equal "thing description", thing_defn.description
     end
   end

lib/graphql/static_validation/validation_context.rb

@@ -68,7 +68,7 @@ def assert_schema_and_compare_output(definition)
 
 directive @greeting(pleasant: Boolean = true) on ARGUMENT_DEFINITION | ENUM | FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | UNION
 
-directive @hashed on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
+directive @hashed repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
 
 directive @language(is: String!) on ENUM_VALUE
 
@@ -105,6 +105,10 @@ def assert_schema_and_compare_output(definition)
       parsed_schema.directives.values.each do |dir_class|
         assert dir_class < GraphQL::Schema::Directive
       end
+
+      assert_equal true, parsed_schema.directives["hashed"].repeatable?
+      assert_equal false, parsed_schema.directives["deprecated"].repeatable?
+
       assert_equal 1, hello_type.directives.size
       assert_instance_of parsed_schema.directives["greeting"], hello_type.directives.first
       assert_equal({ pleasant: true }, hello_type.directives.first.arguments.keyword_arguments)

spec/graphql/language/parser_spec.rb

@@ -15,6 +15,7 @@
 
     directive @A on FIELD
     directive @B on FIELD
+    directive @C repeatable on FIELD
   ") }
 
   describe "query with no directives" do
@@ -31,6 +32,20 @@
     end
   end
 
+  describe "query with repeatable directives" do
+    let(:query_string) {"
+      {
+        type {
+          field @C @C @C
+        }
+      }
+    "}
+
+    it "passes rule" do
+      assert_equal [], errors
+    end
+  end
+
   describe "query with unique directives in different locations" do
     let(:query_string) {"
       {