Merge pull request rmosolgo#3292 from rmosolgo/graphql-deprecation-warn

Add GraphQL::Deprecation.warn

Author: Robert Mosolgo

lib/graphql.rb

@@ -149,7 +149,7 @@ def match?(pattern)
 require "graphql/unauthorized_field_error"
 require "graphql/load_application_object_failed_error"
 require "graphql/dataloader"
-
+require "graphql/deprecation"
 
 module GraphQL
   # Ruby has `deprecate_constant`,

lib/graphql/analysis/analyze_query.rb

@@ -43,7 +43,7 @@ def analyze_multiplex(multiplex, analyzers)
     # @param analyzers [Array<#call>] Objects that respond to `#call(memo, visit_type, irep_node)`
     # @return [Array<Any>] Results from those analyzers
     def analyze_query(query, analyzers, multiplex_states: [])
-      warn "Legacy analysis will be removed in GraphQL-Ruby 2.0, please upgrade to AST Analysis: https://graphql-ruby.org/queries/ast_analysis.html (schema: #{query.schema})"
+      GraphQL::Deprecation.warn "Legacy analysis will be removed in GraphQL-Ruby 2.0, please upgrade to AST Analysis: https://graphql-ruby.org/queries/ast_analysis.html (schema: #{query.schema})"
 
       query.trace("analyze_query", { query: query }) do
         analyzers_to_run = analyzers.select do |analyzer|

lib/graphql/analysis/ast.rb

@@ -15,7 +15,7 @@ module AST
       def use(schema_class)
         if schema_class.analysis_engine == self
           definition_line = caller(2, 1).first
-          warn("GraphQL::Analysis::AST is now the default; remove `use GraphQL::Analysis::AST` from the schema definition (#{definition_line})")
+          GraphQL::Deprecation.warn("GraphQL::Analysis::AST is now the default; remove `use GraphQL::Analysis::AST` from the schema definition (#{definition_line})")
         else
           schema_class.analysis_engine = self
         end

lib/graphql/backwards_compatibility.rb

@@ -22,7 +22,7 @@ def wrap_arity(callable, from:, to:, name:, last: false)
         backtrace = caller(0, 20)
         # Find the first line in the trace that isn't library internals:
         user_line = backtrace.find {|l| l !~ /lib\/graphql/ }
-        warn(message + "\n" + user_line + "\n")
+        GraphQL::Deprecation.warn(message + "\n" + user_line + "\n")
         wrapper = last ? LastArgumentsWrapper : FirstArgumentsWrapper
         wrapper.new(callable, from)
       else

lib/graphql/base_type.rb

@@ -224,7 +224,7 @@ def list?
     private
 
     def warn_deprecated_coerce(alt_method_name)
-      warn("Coercing without a context is deprecated; use `#{alt_method_name}` if you don't want context-awareness")
+      GraphQL::Deprecation.warn("Coercing without a context is deprecated; use `#{alt_method_name}` if you don't want context-awareness")
     end
   end
 end

lib/graphql/compatibility/execution_specification.rb

@@ -32,7 +32,7 @@ module ExecutionSpecification
       # @param execution_strategy [<#new, #execute>] An execution strategy class
       # @return [Class<Minitest::Test>] A test suite for this execution strategy
       def self.build_suite(execution_strategy)
-        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+        GraphQL::Deprecation.warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
         Class.new(Minitest::Test) do
           class << self
             attr_accessor :counter_schema, :specification_schema

lib/graphql/compatibility/lazy_execution_specification.rb

@@ -7,7 +7,7 @@ module LazyExecutionSpecification
       # @param execution_strategy [<#new, #execute>] An execution strategy class
       # @return [Class<Minitest::Test>] A test suite for this execution strategy
       def self.build_suite(execution_strategy)
-        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+        GraphQL::Deprecation.warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
 
         Class.new(Minitest::Test) do
           class << self

lib/graphql/compatibility/query_parser_specification.rb

@@ -11,7 +11,7 @@ module QueryParserSpecification
       # @yieldreturn [GraphQL::Language::Nodes::Document]
       # @return [Class<Minitest::Test>] A test suite for this parse function
       def self.build_suite(&block)
-        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+        GraphQL::Deprecation.warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
 
         Class.new(Minitest::Test) do
           include QueryAssertions

lib/graphql/compatibility/schema_parser_specification.rb

@@ -8,7 +8,7 @@ module SchemaParserSpecification
       # @yieldreturn [GraphQL::Language::Nodes::Document]
       # @return [Class<Minitest::Test>] A test suite for this parse function
       def self.build_suite(&block)
-        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+        GraphQL::Deprecation.warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
 
         Class.new(Minitest::Test) do
           @@parse_fn = block

lib/graphql/define/assign_global_id_field.rb

@@ -4,7 +4,7 @@ module Define
     module AssignGlobalIdField
       def self.call(type_defn, field_name, **field_kwargs)
         resolve = GraphQL::Relay::GlobalIdResolve.new(type: type_defn)
-        GraphQL::Define::AssignObjectField.call(type_defn, field_name, **field_kwargs, type: GraphQL::DEPRECATED_ID_TYPE.to_non_null_type, resolve: resolve)
+        GraphQL::Define::AssignObjectField.call(type_defn, field_name, **field_kwargs, type: GraphQL::Deprecation_ID_TYPE.to_non_null_type, resolve: resolve)
       end
     end
   end

lib/graphql/define/instance_definable.rb

@@ -11,7 +11,7 @@ def define(**kwargs, &block)
           end
 
           if deprecated_caller
-            warn <<-ERR
+            GraphQL::Deprecation.warn <<-ERR
 #{self}.define will be removed in GraphQL-Ruby 2.0; use a class-based definition instead. See https://graphql-ruby.org/schema/class_based_api.html.
   -> called from #{deprecated_caller}
 ERR

lib/graphql/define/type_definer.rb

@@ -7,11 +7,11 @@ module Define
     class TypeDefiner
       include Singleton
       # rubocop:disable Naming/MethodName
-      def Int;      GraphQL::DEPRECATED_INT_TYPE;      end
-      def String;   GraphQL::DEPRECATED_STRING_TYPE;   end
-      def Float;    GraphQL::DEPRECATED_FLOAT_TYPE;    end
-      def Boolean;  GraphQL::DEPRECATED_BOOLEAN_TYPE;  end
-      def ID;       GraphQL::DEPRECATED_ID_TYPE;       end
+      def Int;      GraphQL::Deprecation_INT_TYPE;      end
+      def String;   GraphQL::Deprecation_STRING_TYPE;   end
+      def Float;    GraphQL::Deprecation_FLOAT_TYPE;    end
+      def Boolean;  GraphQL::Deprecation_BOOLEAN_TYPE;  end
+      def ID;       GraphQL::Deprecation_ID_TYPE;       end
       # rubocop:enable Naming/MethodName
 
       # Make a {ListType} which wraps the input type

lib/graphql/deprecated_dsl.rb

@@ -4,13 +4,13 @@ module GraphQL
   #
   # 1. Scoped by file (CRuby only), add to the top of the file:
   #
-  #      using GraphQL::DeprecatedDSL
+  #      using GraphQL::DeprecationDSL
   #
   #   (This is a "refinement", there are also other ways to scope it.)
   #
   # 2. Global application, add before schema definition:
   #
-  #      GraphQL::DeprecatedDSL.activate
+  #      GraphQL::DeprecationDSL.activate
   #
   module DeprecatedDSL
     TYPE_CLASSES = [
@@ -24,7 +24,7 @@ module DeprecatedDSL
 
     def self.activate
       deprecated_caller = caller(1, 1).first
-      warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` and remove `.activate` from #{deprecated_caller}"
+      GraphQL::Deprecation.warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` and remove `.activate` from #{deprecated_caller}"
       TYPE_CLASSES.each { |c| c.extend(Methods) }
       GraphQL::Schema::List.include(Methods)
       GraphQL::Schema::NonNull.include(Methods)
@@ -33,7 +33,7 @@ def self.activate
     module Methods
       def !
         deprecated_caller = caller(1, 1).first
-        warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` at #{deprecated_caller}"
+        GraphQL::Deprecation.warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` at #{deprecated_caller}"
         to_non_null_type
       end
     end

lib/graphql/deprecation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Deprecation
+    def self.warn(message)
+      if defined?(ActiveSupport::Deprecation)
+        ActiveSupport::Deprecation.warn(message)
+      else
+        Kernel.warn(message)
+      end
+    end
+  end
+end

lib/graphql/execution/errors.rb

@@ -20,7 +20,7 @@ class Errors
       def self.use(schema)
         if schema.plugins.any? { |(plugin, kwargs)| plugin == self }
           definition_line = caller(2, 1).first
-          warn("GraphQL::Execution::Errors is now installed by default, remove `use GraphQL::Execution::Errors` from #{definition_line}")
+          GraphQL::Deprecation.warn("GraphQL::Execution::Errors is now installed by default, remove `use GraphQL::Execution::Errors` from #{definition_line}")
         end
         schema.error_handler = self.new(schema)
       end

lib/graphql/execution/execute.rb

@@ -25,7 +25,7 @@ def self.use(schema_class)
       end
 
       def execute(ast_operation, root_type, query)
-        warn "#{self.class} will be removed in GraphQL-Ruby 2.0, please upgrade to the Interpreter: https://graphql-ruby.org/queries/interpreter.html"
+        GraphQL::Deprecation.warn "#{self.class} will be removed in GraphQL-Ruby 2.0, please upgrade to the Interpreter: https://graphql-ruby.org/queries/interpreter.html"
         result = resolve_root_selection(query)
         lazy_resolve_root_selection(result, **{query: query})
         GraphQL::Execution::Flatten.call(query.context)

lib/graphql/execution/interpreter.rb

@@ -25,7 +25,7 @@ def execute(_operation, _root_type, query)
       def self.use(schema_class)
         if schema_class.interpreter?
           definition_line = caller(2, 1).first
-          warn("GraphQL::Execution::Interpreter is now the default; remove `use GraphQL::Execution::Interpreter` from the schema definition (#{definition_line})")
+          GraphQL::Deprecation.warn("GraphQL::Execution::Interpreter is now the default; remove `use GraphQL::Execution::Interpreter` from the schema definition (#{definition_line})")
         else
           schema_class.query_execution_strategy(self)
           schema_class.mutation_execution_strategy(self)

lib/graphql/execution/multiplex.rb

@@ -156,7 +156,7 @@ def finish_query(data_result, query, multiplex)
 
         # use the old `query_execution_strategy` etc to run this query
         def run_one_legacy(schema, query)
-          warn "Multiplex.run_one_legacy will be removed from GraphQL-Ruby 2.0, upgrade to the Interpreter to avoid this deprecated codepath: https://graphql-ruby.org/queries/interpreter.html"
+          GraphQL::Deprecation.warn "Multiplex.run_one_legacy will be removed from GraphQL-Ruby 2.0, upgrade to the Interpreter to avoid this deprecated codepath: https://graphql-ruby.org/queries/interpreter.html"
 
           query.result_values = if !query.valid?
             all_errors = query.validation_errors + query.analysis_errors + query.context.errors

lib/graphql/function.rb

@@ -3,7 +3,7 @@ module GraphQL
   # @api deprecated
   class Function
     def self.inherited(subclass)
-      warn "GraphQL::Function (used for #{subclass}) will be removed from GraphQL-Ruby 2.0, please upgrade to resolvers: https://graphql-ruby.org/fields/resolvers.html"
+      GraphQL::Deprecation.warn "GraphQL::Function (used for #{subclass}) will be removed from GraphQL-Ruby 2.0, please upgrade to resolvers: https://graphql-ruby.org/fields/resolvers.html"
     end
 
     # @return [Hash<String => GraphQL::Argument>] Arguments, keyed by name

lib/graphql/internal_representation/document.rb

@@ -14,12 +14,12 @@ def initialize
       end
 
       def [](key)
-        warn "#{self.class}#[] is deprecated; use `operation_definitions[]` instead"
+        GraphQL::Deprecation.warn "#{self.class}#[] is deprecated; use `operation_definitions[]` instead"
         operation_definitions[key]
       end
 
       def each(&block)
-        warn "#{self.class}#each is deprecated; use `operation_definitions.each` instead"
+        GraphQL::Deprecation.warn "#{self.class}#each is deprecated; use `operation_definitions.each` instead"
         operation_definitions.each(&block)
       end
     end

lib/graphql/internal_representation/rewrite.rb

@@ -60,7 +60,7 @@ def initialize(*)
 
       # @return [Hash<String, Node>] Roots of this query
       def operations
-        warn "#{self.class}#operations is deprecated; use `document.operation_definitions` instead"
+        GraphQL::Deprecation.warn "#{self.class}#operations is deprecated; use `document.operation_definitions` instead"
         @document.operation_definitions
       end
 

lib/graphql/pagination/connections.rb

@@ -23,7 +23,7 @@ class ImplementationMissingError < GraphQL::Error
 
       def self.use(schema_defn)
         if schema_defn.plugins.any? { |(plugin, args)| plugin == self }
-          warn("#{self} is now the default, remove `use #{self}` from #{caller(2,1).first}")
+          GraphQL::Deprecation.warn("#{self} is now the default, remove `use #{self}` from #{caller(2,1).first}")
         end
         schema_defn.connections = self.new(schema: schema_defn)
       end

lib/graphql/query/arguments.rb

@@ -22,7 +22,7 @@ def self.construct_arguments_class(argument_owner)
               method_names.each do |method_name|
                 # Don't define a helper method if it would override something.
                 if method_defined?(method_name)
-                  warn(
+                  GraphQL::Deprecation.warn(
                     "Unable to define a helper for argument with name '#{method_name}' "\
                     "as this is a reserved name. Add `method_access: false` to stop this warning."
                   )

lib/graphql/query/serial_execution.rb

@@ -16,7 +16,7 @@ class SerialExecution
       # @param query_object [GraphQL::Query] the query object for this execution
       # @return [Hash] a spec-compliant GraphQL result, as a hash
       def execute(ast_operation, root_type, query_object)
-        warn "#{self.class} will be removed in GraphQL-Ruby 2.0, please upgrade to the Interpreter: https://graphql-ruby.org/queries/interpreter.html"
+        GraphQL::Deprecation.warn "#{self.class} will be removed in GraphQL-Ruby 2.0, please upgrade to the Interpreter: https://graphql-ruby.org/queries/interpreter.html"
         operation_resolution.resolve(
           query_object.irep_selection,
           root_type,

lib/graphql/relay/base_connection.rb

@@ -59,11 +59,11 @@ def register_connection_implementation(nodes_class, connection_class)
       # @param parent [Object] The object which this collection belongs to
       # @param context [GraphQL::Query::Context] The context from the field being resolved
       def initialize(nodes, arguments, field: nil, max_page_size: nil, parent: nil, context: nil)
-        warn "GraphQL::Relay::BaseConnection (used for #{self.class}) will be removed from GraphQL-Ruby 2.0, use GraphQL::Pagination::Connections instead: https://graphql-ruby.org/pagination/overview.html"
+        GraphQL::Deprecation.warn "GraphQL::Relay::BaseConnection (used for #{self.class}) will be removed from GraphQL-Ruby 2.0, use GraphQL::Pagination::Connections instead: https://graphql-ruby.org/pagination/overview.html"
 
         deprecated_caller = caller(0, 10).find { |c| !c.include?("lib/graphql") }
         if deprecated_caller
-          warn "  -> called from #{deprecated_caller}"
+          GraphQL::Deprecation.warn "  -> called from #{deprecated_caller}"
         end
 
         @context = context

lib/graphql/relay/connection_instrumentation.rb

@@ -10,10 +10,10 @@ module ConnectionInstrumentation
       def self.default_arguments
         @default_arguments ||= begin
           argument_definitions = [
-              ["first", GraphQL::DEPRECATED_INT_TYPE, "Returns the first _n_ elements from the list."],
-              ["after", GraphQL::DEPRECATED_STRING_TYPE, "Returns the elements in the list that come after the specified cursor."],
-              ["last", GraphQL::DEPRECATED_INT_TYPE, "Returns the last _n_ elements from the list."],
-              ["before", GraphQL::DEPRECATED_STRING_TYPE, "Returns the elements in the list that come before the specified cursor."],
+              ["first", GraphQL::Deprecation_INT_TYPE, "Returns the first _n_ elements from the list."],
+              ["after", GraphQL::Deprecation_STRING_TYPE, "Returns the elements in the list that come after the specified cursor."],
+              ["last", GraphQL::Deprecation_INT_TYPE, "Returns the last _n_ elements from the list."],
+              ["before", GraphQL::Deprecation_STRING_TYPE, "Returns the elements in the list that come before the specified cursor."],
             ]
 
           argument_definitions.reduce({}) do |memo, arg_defn|

lib/graphql/relay/mutation.rb

@@ -30,7 +30,7 @@ class Mutation
       alias :input_fields :arguments
 
       def initialize
-        warn "GraphQL::Relay::Mutation will be removed from GraphQL-Ruby 2.0, use GraphQL::Schema::RelayClassicMutation instead: https://graphql-ruby.org/mutations/mutation_classes"
+        GraphQL::Deprecation.warn "GraphQL::Relay::Mutation will be removed from GraphQL-Ruby 2.0, use GraphQL::Schema::RelayClassicMutation instead: https://graphql-ruby.org/mutations/mutation_classes"
         @fields = {}
         @arguments = {}
         @has_generated_return_type = false

lib/graphql/relay/node.rb

@@ -5,7 +5,7 @@ module Relay
     module Node
       # @return [GraphQL::Field] a field for finding objects by their global ID.
       def self.field(**kwargs, &block)
-        warn "GraphQL::Relay::Node.field will be removed from GraphQL-Ruby 2.0, use GraphQL::Types::Relay::NodeField instead"
+        GraphQL::Deprecation.warn "GraphQL::Relay::Node.field will be removed from GraphQL-Ruby 2.0, use GraphQL::Types::Relay::NodeField instead"
         # We have to define it fresh each time because
         # its name will be modified and its description
         # _may_ be modified.
@@ -19,7 +19,7 @@ def self.field(**kwargs, &block)
       end
 
       def self.plural_field(**kwargs, &block)
-        warn "GraphQL::Relay::Nodes.field will be removed from GraphQL-Ruby 2.0, use GraphQL::Types::Relay::NodesField instead"
+        GraphQL::Deprecation.warn "GraphQL::Relay::Nodes.field will be removed from GraphQL-Ruby 2.0, use GraphQL::Types::Relay::NodesField instead"
         field = GraphQL::Types::Relay::NodesField.graphql_definition
 
         if kwargs.any? || block
@@ -31,7 +31,7 @@ def self.plural_field(**kwargs, &block)
 
       # @return [GraphQL::InterfaceType] The interface which all Relay types must implement
       def self.interface
-        warn "GraphQL::Relay::Node.interface will be removed from GraphQL-Ruby 2.0, use GraphQL::Types::Relay::Node instead"
+        GraphQL::Deprecation.warn "GraphQL::Relay::Node.interface will be removed from GraphQL-Ruby 2.0, use GraphQL::Types::Relay::Node instead"
         @interface ||= GraphQL::Types::Relay::Node.graphql_definition
       end
     end

lib/graphql/relay/type_extensions.rb

@@ -12,7 +12,7 @@ def connection_type
       # Define a custom connection type for this object type
       # @return [GraphQL::ObjectType]
       def define_connection(**kwargs, &block)
-        warn ".connection_type and .define_connection will be removed from GraphQL-Ruby 2.0, use class-based type definitions instead: https://graphql-ruby.org/schema/class_based_api.html"
+        GraphQL::Deprecation.warn ".connection_type and .define_connection will be removed from GraphQL-Ruby 2.0, use class-based type definitions instead: https://graphql-ruby.org/schema/class_based_api.html"
         GraphQL::Relay::ConnectionType.create_type(self, **kwargs, &block)
       end
 
@@ -24,7 +24,7 @@ def edge_type
       # Define a custom edge type for this object type
       # @return [GraphQL::ObjectType]
       def define_edge(**kwargs, &block)
-        warn ".edge_type and .define_edge will be removed from GraphQL-Ruby 2.0, use class-based type definitions instead: https://graphql-ruby.org/schema/class_based_api.html"
+        GraphQL::Deprecation.warn ".edge_type and .define_edge will be removed from GraphQL-Ruby 2.0, use class-based type definitions instead: https://graphql-ruby.org/schema/class_based_api.html"
         GraphQL::Relay::EdgeType.create_type(self, **kwargs, &block)
       end
     end