graphql 1.9.0 → 2.1.1

data/lib/graphql/language/block_string.rb

@@ -5,7 +5,14 @@ module GraphQL
       # Remove leading and trailing whitespace from a block string.
       # See "Block Strings" in https://github.com/facebook/graphql/blob/master/spec/Section%202%20--%20Language.md
       def self.trim_whitespace(str)
-        lines = str.split("\n")
+        # Early return for the most common cases:
+        if str == ""
+          return "".dup
+        elsif !(has_newline = str.include?("\n")) && !(str.start_with?(" "))
+          return str
+        end
+
+        lines = has_newline ? str.split("\n") : [str]
         common_indent = nil
 
         # find the common whitespace
@@ -14,70 +21,90 @@ module GraphQL
             next
           end
           line_length = line.size
-          line_indent = line[/\A */].size
+          line_indent = if line.match?(/\A  [^ ]/)
+            2
+          elsif line.match?(/\A    [^ ]/)
+            4
+          elsif line.match?(/\A[^ ]/)
+            0
+          else
+            line[/\A */].size
+          end
           if line_indent < line_length && (common_indent.nil? || line_indent < common_indent)
             common_indent = line_indent
           end
         end
 
         # Remove the common whitespace
-        if common_indent
+        if common_indent && common_indent > 0
           lines.each_with_index do |line, idx|
             if idx == 0
               next
             else
-              line[0, common_indent] = ""
+              line.slice!(0, common_indent)
             end
           end
         end
 
         # Remove leading & trailing blank lines
-        while lines.first.empty?
+        while lines.size > 0 && lines[0].empty?
           lines.shift
         end
-        while lines.last.empty?
+        while lines.size > 0 && lines[-1].empty?
           lines.pop
         end
 
         # Rebuild the string
-        lines.join("\n")
+        lines.size > 1 ? lines.join("\n") : (lines.first || "".dup)
       end
 
       def self.print(str, indent: '')
-        lines = str.split("\n")
-
-        block_str = "#{indent}\"\"\"\n".dup
+        line_length = 120 - indent.length
+        block_str = "".dup
+        triple_quotes = "\"\"\"\n"
+        block_str << indent
+        block_str << triple_quotes
 
-        lines.each do |line|
-          if line == ''
-            block_str << "\n"
-          else
-            sublines = break_line(line, 120 - indent.length)
-            sublines.each do |subline|
-              block_str << "#{indent}#{subline}\n"
+        if str.include?("\n")
+          str.split("\n") do |line|
+            if line == ''
+              block_str << "\n"
+            else
+              break_line(line, line_length) do |subline|
+                block_str << indent
+                block_str << subline
+                block_str << "\n"
+              end
             end
           end
+        else
+          break_line(str, line_length) do |subline|
+            block_str << indent
+            block_str << subline
+            block_str << "\n"
+          end
         end
 
-        block_str << "#{indent}\"\"\"\n".dup
+        block_str << indent
+        block_str << triple_quotes
       end
 
       private
 
       def self.break_line(line, length)
-        return [line] if line.length < length + 5
+        return yield(line) if line.length < length + 5
 
         parts = line.split(Regexp.new("((?: |^).{15,#{length - 40}}(?= |$))"))
-        return [line] if parts.length < 4
+        return yield(line) if parts.length < 4
 
-        sublines = [parts.slice!(0, 3).join]
+        yield(parts.slice!(0, 3).join)
 
         parts.each_with_index do |part, i|
           next if i % 2 == 1
-          sublines << "#{part[1..-1]}#{parts[i + 1]}"
+          yield "#{part[1..-1]}#{parts[i + 1]}"
         end
 
-        sublines
+        nil
       end
     end
   end

data/lib/graphql/language/cache.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'graphql/version'
+require 'digest/sha2'
+
+module GraphQL
+  module Language
+    class Cache
+      def initialize(path)
+        @path = path
+      end
+
+      DIGEST = Digest::SHA256.new << GraphQL::VERSION
+      def fetch(filename)
+        hash = DIGEST.dup << filename
+        begin
+          hash << File.mtime(filename).to_i.to_s
+        rescue SystemCallError
+          return yield
+        end
+        cache_path = @path.join(hash.to_s)
+
+        if cache_path.exist?
+          Marshal.load(cache_path.read)
+        else
+          payload = yield
+          tmp_path = "#{cache_path}.#{rand}"
+
+          @path.mkpath
+          File.binwrite(tmp_path, Marshal.dump(payload))
+          File.rename(tmp_path, cache_path.to_s)
+          payload
+        end
+      end
+    end
+  end
+end

data/lib/graphql/language/definition_slice.rb

@@ -7,23 +7,34 @@ module GraphQL
       def slice(document, name)
         definitions = {}
         document.definitions.each { |d| definitions[d.name] = d }
-        names = find_definition_dependencies(definitions, name)
+        names = Set.new
+        DependencyVisitor.find_definition_dependencies(definitions, name, names)
         definitions = document.definitions.select { |d| names.include?(d.name) }
         Nodes::Document.new(definitions: definitions)
       end
 
       private
 
-      def find_definition_dependencies(definitions, name)
-        names = Set.new([name])
-        visitor = Visitor.new(definitions[name])
-        visitor[Nodes::FragmentSpread] << ->(node, parent) {
-          if fragment = definitions[node.name]
-            names.merge(find_definition_dependencies(definitions, fragment.name))
+      class DependencyVisitor < GraphQL::Language::StaticVisitor
+        def initialize(doc, definitions, names)
+          @names = names
+          @definitions = definitions
+          super(doc)
+        end
+
+        def on_fragment_spread(node, parent)
+          if fragment = @definitions[node.name]
+            self.class.find_definition_dependencies(@definitions, fragment.name, @names)
           end
-        }
-        visitor.visit
-        names
+          super
+        end
+
+        def self.find_definition_dependencies(definitions, name, names)
+          names.add(name)
+          visitor = self.new(definitions[name], definitions, names)
+          visitor.visit
+          nil
+        end
       end
     end
   end

data/lib/graphql/language/document_from_schema_definition.rb

@@ -14,7 +14,7 @@ module GraphQL
     # @param include_built_in_directives [Boolean] Whether or not to include built in directives in the AST
     class DocumentFromSchemaDefinition
       def initialize(
-        schema, context: nil, only: nil, except: nil, include_introspection_types: false,
+        schema, context: nil, include_introspection_types: false,
         include_built_in_directives: false, include_built_in_scalars: false, always_include_schema: false
       )
         @schema = schema
@@ -22,12 +22,17 @@ module GraphQL
         @include_introspection_types = include_introspection_types
         @include_built_in_scalars = include_built_in_scalars
         @include_built_in_directives = include_built_in_directives
+        @include_one_of = false
 
-        @warden = GraphQL::Schema::Warden.new(
-          GraphQL::Filter.new(only: only, except: except),
+        schema_context = schema.context_class.new(query: nil, object: nil, schema: schema, values: context)
+
+
+        @warden = @schema.warden_class.new(
           schema: @schema,
-          context: context,
+          context: schema_context,
         )
+
+        schema_context.warden = @warden
       end
 
       def document
@@ -37,89 +42,89 @@ module GraphQL
       end
 
       def build_schema_node
-        GraphQL::Language::Nodes::SchemaDefinition.new(
-          query: warden.root_type_for_operation("query"),
-          mutation: warden.root_type_for_operation("mutation"),
-          subscription: warden.root_type_for_operation("subscription"),
-          # This only supports directives from parsing,
-          # use a custom printer to add to this list.
-          directives: @schema.ast_node ? @schema.ast_node.directives : [],
-        )
+        if !schema_respects_root_name_conventions?(@schema)
+          GraphQL::Language::Nodes::SchemaDefinition.new(
+            query: (q = warden.root_type_for_operation("query")) && q.graphql_name,
+            mutation: (m = warden.root_type_for_operation("mutation")) && m.graphql_name,
+            subscription: (s = warden.root_type_for_operation("subscription")) && s.graphql_name,
+            directives: definition_directives(@schema, :schema_directives)
+          )
+        else
+          # A plain `schema ...` _must_ include root type definitions.
+          # If the only difference is directives, then you have to use `extend schema`
+          GraphQL::Language::Nodes::SchemaExtension.new(directives: definition_directives(@schema, :schema_directives))
+        end
       end
 
       def build_object_type_node(object_type)
+        ints = warden.interfaces(object_type)
+        if ints.any?
+          ints.sort_by!(&:graphql_name)
+          ints.map! { |iface| build_type_name_node(iface) }
+        end
+
         GraphQL::Language::Nodes::ObjectTypeDefinition.new(
-          name: object_type.name,
-          interfaces: warden.interfaces(object_type).sort_by(&:name).map { |iface| build_type_name_node(iface) },
+          name: object_type.graphql_name,
+          interfaces: ints,
           fields: build_field_nodes(warden.fields(object_type)),
           description: object_type.description,
+          directives: directives(object_type),
         )
       end
 
       def build_field_node(field)
-        field_node = GraphQL::Language::Nodes::FieldDefinition.new(
-          name: field.name,
+        GraphQL::Language::Nodes::FieldDefinition.new(
+          name: field.graphql_name,
           arguments: build_argument_nodes(warden.arguments(field)),
           type: build_type_name_node(field.type),
           description: field.description,
+          directives: directives(field),
         )
-
-        if field.deprecation_reason
-          field_node = field_node.merge_directive(
-            name: GraphQL::Directive::DeprecatedDirective.name,
-            arguments: [GraphQL::Language::Nodes::Argument.new(name: "reason", value: field.deprecation_reason)]
-          )
-        end
-
-        field_node
       end
 
       def build_union_type_node(union_type)
         GraphQL::Language::Nodes::UnionTypeDefinition.new(
-          name: union_type.name,
+          name: union_type.graphql_name,
           description: union_type.description,
-          types: warden.possible_types(union_type).sort_by(&:name).map { |type| build_type_name_node(type) }
+          types: warden.possible_types(union_type).sort_by(&:graphql_name).map { |type| build_type_name_node(type) },
+          directives: directives(union_type),
         )
       end
 
       def build_interface_type_node(interface_type)
         GraphQL::Language::Nodes::InterfaceTypeDefinition.new(
-          name: interface_type.name,
+          name: interface_type.graphql_name,
+          interfaces: warden.interfaces(interface_type).sort_by(&:graphql_name).map { |type| build_type_name_node(type) },
           description: interface_type.description,
-          fields: build_field_nodes(warden.fields(interface_type))
+          fields: build_field_nodes(warden.fields(interface_type)),
+          directives: directives(interface_type),
         )
       end
 
       def build_enum_type_node(enum_type)
         GraphQL::Language::Nodes::EnumTypeDefinition.new(
-          name: enum_type.name,
-          values: warden.enum_values(enum_type).sort_by(&:name).map do |enum_value|
+          name: enum_type.graphql_name,
+          values: warden.enum_values(enum_type).sort_by(&:graphql_name).map do |enum_value|
             build_enum_value_node(enum_value)
           end,
           description: enum_type.description,
+          directives: directives(enum_type),
         )
       end
 
       def build_enum_value_node(enum_value)
-        enum_value_node = GraphQL::Language::Nodes::EnumValueDefinition.new(
-          name: enum_value.name,
+        GraphQL::Language::Nodes::EnumValueDefinition.new(
+          name: enum_value.graphql_name,
           description: enum_value.description,
+          directives: directives(enum_value),
         )
-
-        if enum_value.deprecation_reason
-          enum_value_node = enum_value_node.merge_directive(
-            name: GraphQL::Directive::DeprecatedDirective.name,
-            arguments: [GraphQL::Language::Nodes::Argument.new(name: "reason", value: enum_value.deprecation_reason)]
-          )
-        end
-
-        enum_value_node
       end
 
       def build_scalar_type_node(scalar_type)
         GraphQL::Language::Nodes::ScalarTypeDefinition.new(
-          name: scalar_type.name,
+          name: scalar_type.graphql_name,
           description: scalar_type.description,
+          directives: directives(scalar_type),
         )
       end
 
@@ -131,10 +136,11 @@ module GraphQL
         end
 
         argument_node = GraphQL::Language::Nodes::InputValueDefinition.new(
-          name: argument.name,
+          name: argument.graphql_name,
           description: argument.description,
           type: build_type_name_node(argument.type),
           default_value: default_value,
+          directives: directives(argument),
         )
 
         argument_node
@@ -142,15 +148,17 @@ module GraphQL
 
       def build_input_object_node(input_object)
         GraphQL::Language::Nodes::InputObjectTypeDefinition.new(
-          name: input_object.name,
+          name: input_object.graphql_name,
           fields: build_argument_nodes(warden.arguments(input_object)),
           description: input_object.description,
+          directives: directives(input_object),
         )
       end
 
       def build_directive_node(directive)
         GraphQL::Language::Nodes::DirectiveDefinition.new(
-          name: directive.name,
+          name: directive.graphql_name,
+          repeatable: directive.repeatable?,
           arguments: build_argument_nodes(warden.arguments(directive)),
           locations: build_directive_location_nodes(directive.locations),
           description: directive.description,
@@ -158,7 +166,7 @@ module GraphQL
       end
 
       def build_directive_location_nodes(locations)
-        locations.map { |location| build_directive_location_node(location) }
+        locations.sort.map { |location| build_directive_location_node(location) }
       end
 
       def build_directive_location_node(location)
@@ -168,17 +176,18 @@ module GraphQL
       end
 
       def build_type_name_node(type)
-        case type
-        when GraphQL::ListType
+        case type.kind.name
+        when "LIST"
           GraphQL::Language::Nodes::ListType.new(
             of_type: build_type_name_node(type.of_type)
           )
-        when GraphQL::NonNullType
+        when "NON_NULL"
           GraphQL::Language::Nodes::NonNullType.new(
             of_type: build_type_name_node(type.of_type)
           )
         else
-          GraphQL::Language::Nodes::TypeName.new(name: type.name)
+          @cached_type_name_nodes ||= {}
+          @cached_type_name_nodes[type.graphql_name] ||= GraphQL::Language::Nodes::TypeName.new(name: type.graphql_name)
         end
       end
 
@@ -187,43 +196,47 @@ module GraphQL
           return GraphQL::Language::Nodes::NullValue.new(name: "null")
         end
 
-        case type
-        when GraphQL::ScalarType
+        case type.kind.name
+        when "SCALAR"
           type.coerce_isolated_result(default_value)
-        when EnumType
+        when "ENUM"
           GraphQL::Language::Nodes::Enum.new(name: type.coerce_isolated_result(default_value))
-        when InputObjectType
+        when "INPUT_OBJECT"
           GraphQL::Language::Nodes::InputObject.new(
             arguments: default_value.to_h.map do |arg_name, arg_value|
-              arg_type = type.input_fields.fetch(arg_name.to_s).type
+              args = @warden.arguments(type)
+              arg = args.find { |a| a.keyword.to_s == arg_name.to_s }
+              if arg.nil?
+                raise ArgumentError, "No argument definition on #{type.graphql_name} for argument: #{arg_name.inspect} (expected one of: #{args.map(&:keyword)})"
+              end
               GraphQL::Language::Nodes::Argument.new(
-                name: arg_name,
-                value: build_default_value(arg_value, arg_type)
+                name: arg.graphql_name.to_s,
+                value: build_default_value(arg_value, arg.type)
               )
             end
           )
-        when NonNullType
+        when "NON_NULL"
           build_default_value(default_value, type.of_type)
-        when ListType
+        when "LIST"
           default_value.to_a.map { |v| build_default_value(v, type.of_type) }
         else
-          raise NotImplementedError, "Unexpected default value type #{type.inspect}"
+          raise GraphQL::RequiredImplementationMissingError, "Unexpected default value type #{type.inspect}"
         end
       end
 
       def build_type_definition_node(type)
-        case type
-        when GraphQL::ObjectType
+        case type.kind.name
+        when "OBJECT"
           build_object_type_node(type)
-        when GraphQL::UnionType
+        when "UNION"
           build_union_type_node(type)
-        when GraphQL::InterfaceType
+        when "INTERFACE"
           build_interface_type_node(type)
-        when GraphQL::ScalarType
+        when "SCALAR"
           build_scalar_type_node(type)
-        when GraphQL::EnumType
+        when "ENUM"
           build_enum_type_node(type)
-        when GraphQL::InputObjectType
+        when "INPUT_OBJECT"
           build_input_object_node(type)
         else
           raise TypeError
@@ -231,26 +244,40 @@ module GraphQL
       end
 
       def build_argument_nodes(arguments)
-        arguments
-          .map { |arg| build_argument_node(arg) }
-          .sort_by(&:name)
+        if arguments.any?
+          nodes = arguments.map { |arg| build_argument_node(arg) }
+          nodes.sort_by!(&:name)
+          nodes
+        else
+          arguments
+        end
       end
 
       def build_directive_nodes(directives)
-        if !include_built_in_directives
-          directives = directives.reject { |directive| directive.default_directive? }
-        end
-
         directives
           .map { |directive| build_directive_node(directive) }
           .sort_by(&:name)
       end
 
       def build_definition_nodes
-        definitions = []
-        definitions << build_schema_node if include_schema_node?
-        definitions += build_directive_nodes(warden.directives)
-        definitions += build_type_definition_nodes(warden.types)
+        dirs_to_build = warden.directives
+        if !include_built_in_directives
+          dirs_to_build = dirs_to_build.reject { |directive| directive.default_directive? }
+        end
+        definitions = build_directive_nodes(dirs_to_build)
+
+        type_nodes = build_type_definition_nodes(warden.reachable_types)
+
+        if @include_one_of
+          # This may have been set to true when iterating over all types
+          definitions.concat(build_directive_nodes([GraphQL::Schema::Directive::OneOf]))
+        end
+
+        definitions.concat(type_nodes)
+        if include_schema_node?
+          definitions.unshift(build_schema_node)
+        end
+
         definitions
       end
 
@@ -260,7 +287,7 @@ module GraphQL
         end
 
         if !include_built_in_scalars
-          types = types.reject { |type| type.default_scalar? }
+          types = types.reject { |type| type.kind.scalar? && type.default_scalar? }
         end
 
         types
@@ -269,21 +296,60 @@ module GraphQL
       end
 
       def build_field_nodes(fields)
-        fields
-          .map { |field| build_field_node(field) }
-          .sort_by(&:name)
+        f_nodes = fields.map { |field| build_field_node(field) }
+        f_nodes.sort_by!(&:name)
+        f_nodes
       end
 
       private
 
       def include_schema_node?
-        always_include_schema || !schema_respects_root_name_conventions?(schema)
+        always_include_schema ||
+          !schema_respects_root_name_conventions?(schema) ||
+          !schema.schema_directives.empty?
       end
 
       def schema_respects_root_name_conventions?(schema)
-        (schema.query.nil? || schema.query.name == 'Query') &&
-        (schema.mutation.nil? || schema.mutation.name == 'Mutation') &&
-        (schema.subscription.nil? || schema.subscription.name == 'Subscription')
+        (schema.query.nil? || schema.query.graphql_name == 'Query') &&
+        (schema.mutation.nil? || schema.mutation.graphql_name == 'Mutation') &&
+        (schema.subscription.nil? || schema.subscription.graphql_name == 'Subscription')
+      end
+
+      def directives(member)
+        definition_directives(member, :directives)
+      end
+
+      def definition_directives(member, directives_method)
+        dirs = if !member.respond_to?(directives_method) || member.directives.empty?
+          EmptyObjects::EMPTY_ARRAY
+        else
+          member.public_send(directives_method).map do |dir|
+            args = []
+            dir.arguments.argument_values.each_value do |arg_value| # rubocop:disable Development/ContextIsPassedCop -- directive instance method
+              arg_defn = arg_value.definition
+              if arg_defn.default_value? && arg_value.value == arg_defn.default_value
+                next
+              else
+                value_node = build_default_value(arg_value.value, arg_value.definition.type)
+                args << GraphQL::Language::Nodes::Argument.new(
+                  name: arg_value.definition.name,
+                  value: value_node,
+                )
+              end
+            end
+
+            # If this schema uses this built-in directive definition,
+            # include it in the print-out since it's not part of the spec yet.
+            @include_one_of ||= dir.class == GraphQL::Schema::Directive::OneOf
+
+            GraphQL::Language::Nodes::Directive.new(
+              name: dir.class.graphql_name,
+              arguments: args
+            )
+          end
+        end
+
+        dirs
       end
 
       attr_reader :schema, :warden, :always_include_schema,