graphql 1.9.17 → 2.0.21

data/lib/graphql/language/document_from_schema_definition.rb

@@ -22,12 +22,20 @@ 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
 
+        filter = GraphQL::Filter.new(only: only, except: except, silence_deprecation_warning: true)
+        if @schema.respond_to?(:visible?)
+          filter = filter.merge(only: @schema.method(:visible?))
+        end
+
+        schema_context = schema.context_class.new(query: nil, object: nil, schema: schema, values: context)
         @warden = GraphQL::Schema::Warden.new(
-          GraphQL::Filter.new(only: only, except: except),
+          filter,
           schema: @schema,
-          context: context,
+          context: schema_context,
         )
+        schema_context.warden = @warden
       end
 
       def document
@@ -37,89 +45,83 @@ 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 : [],
-        )
+        schema_options = {
+          # `@schema.directives` is covered by `build_definition_nodes`
+          directives: definition_directives(@schema, :schema_directives),
+        }
+        if !schema_respects_root_name_conventions?(@schema)
+          schema_options.merge!({
+            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,
+          })
+        end
+        GraphQL::Language::Nodes::SchemaDefinition.new(schema_options)
       end
 
       def build_object_type_node(object_type)
         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: warden.interfaces(object_type).sort_by(&:graphql_name).map { |iface| build_type_name_node(iface) },
           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 +133,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 +145,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 +163,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 +173,17 @@ 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)
+          GraphQL::Language::Nodes::TypeName.new(name: type.graphql_name)
         end
       end
 
@@ -187,24 +192,28 @@ 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 GraphQL::RequiredImplementationMissingError, "Unexpected default value type #{type.inspect}"
@@ -212,18 +221,18 @@ module GraphQL
       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
@@ -237,20 +246,30 @@ module GraphQL
       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
+        dir_nodes = 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
+          dir_nodes.concat(build_directive_nodes([GraphQL::Schema::Directive::OneOf]))
+        end
+
+        definitions = [*dir_nodes, *type_nodes]
+        if include_schema_node?
+          definitions.unshift(build_schema_node)
+        end
+
         definitions
       end
 
@@ -260,7 +279,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
@@ -277,13 +296,52 @@ module GraphQL
       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?
+          []
+        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,