Merge pull request #4434 from rmosolgo/consolidate-empty-objects

rmosolgo · web-flow · commit d3145055b97e · 2023-04-11T11:42:59.000-04:00
Consolidate empty value constants
diff --git a/lib/graphql.rb b/lib/graphql.rb
@@ -69,6 +69,10 @@ def self.scan_with_ruby(graphql_string)
 
   NOT_CONFIGURED = Object.new
   private_constant :NOT_CONFIGURED
+  module EmptyObjects
+    EMPTY_HASH = {}.freeze
+    EMPTY_ARRAY = [].freeze
+  end
 end
 
 # Order matters for these:
diff --git a/lib/graphql/execution/interpreter.rb b/lib/graphql/execution/interpreter.rb
@@ -14,7 +14,7 @@ class Interpreter
       class << self
         # Used internally to signal that the query shouldn't be executed
         # @api private
-        NO_OPERATION = {}.freeze
+        NO_OPERATION = GraphQL::EmptyObjects::EMPTY_HASH
 
         # @param schema [GraphQL::Schema]
         # @param queries [Array<GraphQL::Query, Hash>]
diff --git a/lib/graphql/execution/interpreter/arguments.rb b/lib/graphql/execution/interpreter/arguments.rb
@@ -80,7 +80,7 @@ def merge_extras(extra_args)
           )
         end
 
-        NO_ARGS = {}.freeze
+        NO_ARGS = GraphQL::EmptyObjects::EMPTY_HASH
         EMPTY = self.new(argument_values: nil, keyword_arguments: NO_ARGS).freeze
       end
     end
diff --git a/lib/graphql/execution/interpreter/arguments_cache.rb b/lib/graphql/execution/interpreter/arguments_cache.rb
@@ -55,9 +55,8 @@ def dataload_for(ast_node, argument_owner, parent_object, &block)
 
         private
 
-        NO_ARGUMENTS = {}.freeze
-
-        NO_VALUE_GIVEN = Object.new
+        NO_ARGUMENTS = GraphQL::EmptyObjects::EMPTY_HASH
+        NO_VALUE_GIVEN = NOT_CONFIGURED
 
         def self.prepare_args_hash(query, ast_arg_or_hash_or_value)
           case ast_arg_or_hash_or_value
diff --git a/lib/graphql/execution/interpreter/runtime.rb b/lib/graphql/execution/interpreter/runtime.rb
@@ -379,7 +379,7 @@ def gather_selections(owner_object, owner_type, selections, selections_to_run =
           selections_to_run || selections_by_name
         end
 
-        NO_ARGS = {}.freeze
+        NO_ARGS = GraphQL::EmptyObjects::EMPTY_HASH
 
         # @return [void]
         def evaluate_selections(owner_object, owner_type, is_eager_selection, gathered_selections, selections_result, target_result, parent_object) # rubocop:disable Metrics/ParameterLists
diff --git a/lib/graphql/language/nodes.rb b/lib/graphql/language/nodes.rb
@@ -2,7 +2,7 @@
 module GraphQL
   module Language
     module Nodes
-      NONE = [].freeze
+      NONE = GraphQL::EmptyObjects::EMPTY_ARRAY
       # {AbstractNode} is the base class for all nodes in a GraphQL AST.
       #
       # It provides some APIs for working with ASTs:
@@ -51,7 +51,7 @@ def ==(other)
             other.children == self.children
         end
 
-        NO_CHILDREN = [].freeze
+        NO_CHILDREN = GraphQL::EmptyObjects::EMPTY_ARRAY
 
         # @return [Array<GraphQL::Language::Nodes::AbstractNode>] all nodes in the tree below this one
         def children
diff --git a/lib/graphql/pagination/connection.rb b/lib/graphql/pagination/connection.rb
@@ -58,7 +58,7 @@ def after
       # @param arguments [Hash] The arguments to the field that returned the collection wrapped by this connection
       # @param max_page_size [Integer, nil] A configured value to cap the result size. Applied as `first` if neither first or last are given and no `default_page_size` is set.
       # @param default_page_size [Integer, nil] A configured value to determine the result size when neither first or last are given.
-      def initialize(items, parent: nil, field: nil, context: nil, first: nil, after: nil, max_page_size: :not_given, default_page_size: :not_given, last: nil, before: nil, edge_class: nil, arguments: nil)
+      def initialize(items, parent: nil, field: nil, context: nil, first: nil, after: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, last: nil, before: nil, edge_class: nil, arguments: nil)
         @items = items
         @parent = parent
         @context = context
@@ -71,14 +71,14 @@ def initialize(items, parent: nil, field: nil, context: nil, first: nil, after:
         @edge_class = edge_class || self.class::Edge
         # This is only true if the object was _initialized_ with an override
         # or if one is assigned later.
-        @has_max_page_size_override = max_page_size != :not_given
-        @max_page_size = if max_page_size == :not_given
+        @has_max_page_size_override = max_page_size != NOT_CONFIGURED
+        @max_page_size = if max_page_size == NOT_CONFIGURED
           nil
         else
           max_page_size
         end
-        @has_default_page_size_override = default_page_size != :not_given
-        @default_page_size = if default_page_size == :not_given
+        @has_default_page_size_override = default_page_size != NOT_CONFIGURED
+        @default_page_size = if default_page_size == NOT_CONFIGURED
           nil
         else
           default_page_size
diff --git a/lib/graphql/query.rb b/lib/graphql/query.rb
@@ -318,8 +318,8 @@ def warden
     # @param value [Object] Any runtime value
     # @return [GraphQL::ObjectType, nil] The runtime type of `value` from {Schema#resolve_type}
     # @see {#possible_types} to apply filtering from `only` / `except`
-    def resolve_type(abstract_type, value = :__undefined__)
-      if value.is_a?(Symbol) && value == :__undefined__
+    def resolve_type(abstract_type, value = NOT_CONFIGURED)
+      if value.is_a?(Symbol) && value == NOT_CONFIGURED
         # Old method signature
         value = abstract_type
         abstract_type = nil
diff --git a/lib/graphql/query/context.rb b/lib/graphql/query/context.rb
@@ -91,8 +91,8 @@ def initialize(query:, schema: query.schema, values:, object:)
       end
 
       class ScopedContext
-        NO_PATH = [].freeze
-        NO_CONTEXT = {}.freeze
+        NO_PATH = GraphQL::EmptyObjects::EMPTY_ARRAY
+        NO_CONTEXT = GraphQL::EmptyObjects::EMPTY_HASH
 
         def initialize(query_context)
           @query_context = query_context
diff --git a/lib/graphql/schema/argument.rb b/lib/graphql/schema/argument.rb
@@ -7,9 +7,7 @@ class Argument
       include GraphQL::Schema::Member::HasDirectives
       include GraphQL::Schema::Member::HasDeprecationReason
       include GraphQL::Schema::Member::HasValidators
-      include GraphQL::Schema::FindInheritedValue::EmptyObjects
-
-      NO_DEFAULT = :__no_default__
+      include GraphQL::EmptyObjects
 
       # @return [String] the GraphQL name for this argument, camelized unless `camelize: false` is provided
       attr_reader :name
@@ -20,8 +18,8 @@ class Argument
 
       # @param new_prepare [Method, Proc]
       # @return [Symbol] A method or proc to call to transform this value before sending it to field resolution method
-      def prepare(new_prepare = NO_DEFAULT)
-        if new_prepare != NO_DEFAULT
+      def prepare(new_prepare = NOT_CONFIGURED)
+        if new_prepare != NOT_CONFIGURED
           @prepare = new_prepare
         end
         @prepare
@@ -52,7 +50,7 @@ def from_resolver?
       # @param deprecation_reason [String]
       # @param validates [Hash, nil] Options for building validators, if any should be applied
       # @param replace_null_with_default [Boolean] if `true`, incoming values of `null` will be replaced with the configured `default_value`
-      def initialize(arg_name = nil, type_expr = nil, desc = nil, required: true, type: nil, name: nil, loads: nil, description: nil, ast_node: nil, default_value: NO_DEFAULT, as: nil, from_resolver: false, camelize: true, prepare: nil, owner:, validates: nil, directives: nil, deprecation_reason: nil, replace_null_with_default: false, &definition_block)
+      def initialize(arg_name = nil, type_expr = nil, desc = nil, required: true, type: nil, name: nil, loads: nil, description: nil, ast_node: nil, default_value: NOT_CONFIGURED, as: nil, from_resolver: false, camelize: true, prepare: nil, owner:, validates: nil, directives: nil, deprecation_reason: nil, replace_null_with_default: false, &definition_block)
         arg_name ||= name
         @name = -(camelize ? Member::BuildType.camelize(arg_name.to_s) : arg_name.to_s)
         @type_expr = type_expr || type
@@ -104,16 +102,16 @@ def inspect
 
       # @param default_value [Object] The value to use when the client doesn't provide one
       # @return [Object] the value used when the client doesn't provide a value for this argument
-      def default_value(new_default_value = NO_DEFAULT)
-        if new_default_value != NO_DEFAULT
+      def default_value(new_default_value = NOT_CONFIGURED)
+        if new_default_value != NOT_CONFIGURED
           @default_value = new_default_value
         end
         @default_value
       end
 
       # @return [Boolean] True if this argument has a default value
       def default_value?
-        @default_value != NO_DEFAULT
+        @default_value != NOT_CONFIGURED
       end
 
       def replace_null_with_default?
diff --git a/lib/graphql/schema/build_from_definition.rb b/lib/graphql/schema/build_from_definition.rb
@@ -21,6 +21,7 @@ def from_document(schema_superclass, document, default_resolve:, using: {}, rela
 
       # @api private
       module Builder
+        include GraphQL::EmptyObjects
         extend self
 
         def build(schema_superclass, document, default_resolve:, using: {}, relay:)
@@ -374,16 +375,14 @@ def build_default_value(default_value)
           end
         end
 
-        NO_DEFAULT_VALUE = {}.freeze
-
         def build_arguments(type_class, arguments, type_resolver)
           builder = self
 
           arguments.each do |argument_defn|
             default_value_kwargs = if !argument_defn.default_value.nil?
               { default_value: builder.build_default_value(argument_defn.default_value) }
             else
-              NO_DEFAULT_VALUE
+              EMPTY_HASH
             end
 
             type_class.argument(
diff --git a/lib/graphql/schema/enum_value.rb b/lib/graphql/schema/enum_value.rb
@@ -25,19 +25,16 @@ class EnumValue < GraphQL::Schema::Member
       include GraphQL::Schema::Member::HasDirectives
       include GraphQL::Schema::Member::HasDeprecationReason
 
-      UNDEFINED_VALUE = Object.new.freeze
-      private_constant :UNDEFINED_VALUE
-
       attr_reader :graphql_name
 
       # @return [Class] The enum type that owns this value
       attr_reader :owner
 
-      def initialize(graphql_name, desc = nil, owner:, ast_node: nil, directives: nil, description: nil, value: UNDEFINED_VALUE, deprecation_reason: nil, &block)
+      def initialize(graphql_name, desc = nil, owner:, ast_node: nil, directives: nil, description: nil, value: NOT_CONFIGURED, deprecation_reason: nil, &block)
         @graphql_name = graphql_name.to_s
         GraphQL::NameValidator.validate!(@graphql_name)
         @description = desc || description
-        @value = value === UNDEFINED_VALUE ? @graphql_name : value
+        @value = value === NOT_CONFIGURED ? @graphql_name : value
         if deprecation_reason
           self.deprecation_reason = deprecation_reason
         end
diff --git a/lib/graphql/schema/field.rb b/lib/graphql/schema/field.rb
@@ -11,7 +11,7 @@ class Field
       include GraphQL::Schema::Member::HasPath
       include GraphQL::Schema::Member::HasValidators
       extend GraphQL::Schema::FindInheritedValue
-      include GraphQL::Schema::FindInheritedValue::EmptyObjects
+      include GraphQL::EmptyObjects
       include GraphQL::Schema::Member::HasDirectives
       include GraphQL::Schema::Member::HasDeprecationReason
 
@@ -219,7 +219,7 @@ def method_conflict_warning?
       # @param method_conflict_warning [Boolean] If false, skip the warning if this field's method conflicts with a built-in method
       # @param validates [Array<Hash>] Configurations for validating this field
       # @fallback_value [Object] A fallback value if the method is not defined
-      def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CONFIGURED, deprecation_reason: nil, method: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: NOT_CONFIGURED, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: :not_given, &definition_block)
+      def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CONFIGURED, deprecation_reason: nil, method: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: NOT_CONFIGURED, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: NOT_CONFIGURED, &definition_block)
         if name.nil?
           raise ArgumentError, "missing first `name` argument or keyword `name:`"
         end
@@ -685,7 +685,7 @@ def resolve(object, args, query_ctx)
                 if hash_value == false
                   hash_value
                 else
-                  hash_value || (@fallback_value != :not_given ? @fallback_value : nil)
+                  hash_value || (@fallback_value != NOT_CONFIGURED ? @fallback_value : nil)
                 end
               elsif obj.respond_to?(resolver_method)
                 method_to_call = resolver_method
@@ -703,7 +703,7 @@ def resolve(object, args, query_ctx)
                   inner_object[@method_sym]
                 elsif inner_object.key?(@method_str)
                   inner_object[@method_str]
-                elsif @fallback_value != :not_given
+                elsif @fallback_value != NOT_CONFIGURED
                   @fallback_value
                 else
                   nil
@@ -716,7 +716,7 @@ def resolve(object, args, query_ctx)
                 else
                   inner_object.public_send(@method_sym)
                 end
-              elsif @fallback_value != :not_given
+              elsif @fallback_value != NOT_CONFIGURED
                 @fallback_value
               else
                 raise <<-ERR
diff --git a/lib/graphql/schema/field_extension.rb b/lib/graphql/schema/field_extension.rb
@@ -71,14 +71,11 @@ def extras(new_extras = nil)
           elsif inherited_extras
             inherited_extras
           else
-            NO_EXTRAS
+            GraphQL::EmptyObjects::EMPTY_ARRAY
           end
         end
       end
 
-      NO_EXTRAS = [].freeze
-      private_constant :NO_EXTRAS
-
       # Called when this extension is attached to a field.
       # The field definition may be extended during this method.
       # @return [void]
diff --git a/lib/graphql/schema/find_inherited_value.rb b/lib/graphql/schema/find_inherited_value.rb
@@ -2,17 +2,12 @@
 module GraphQL
   class Schema
     module FindInheritedValue
-      module EmptyObjects
-        EMPTY_HASH = {}.freeze
-        EMPTY_ARRAY = [].freeze
-      end
-
       def self.extended(child_cls)
-        child_cls.singleton_class.include(EmptyObjects)
+        child_cls.singleton_class.include(GraphQL::EmptyObjects)
       end
 
       def self.included(child_cls)
-        child_cls.include(EmptyObjects)
+        child_cls.include(GraphQL::EmptyObjects)
       end
 
       private
diff --git a/lib/graphql/schema/member/has_arguments.rb b/lib/graphql/schema/member/has_arguments.rb
@@ -413,7 +413,7 @@ def load_application_object_failed(err)
           end
         end
 
-        NO_ARGUMENTS = {}.freeze
+        NO_ARGUMENTS =  GraphQL::EmptyObjects::EMPTY_HASH
         def own_arguments
           @own_arguments || NO_ARGUMENTS
         end
diff --git a/lib/graphql/schema/member/has_directives.rb b/lib/graphql/schema/member/has_directives.rb
@@ -33,8 +33,6 @@ def remove_directive(dir_class)
           nil
         end
 
-        NO_DIRECTIVES = [].freeze
-
         def directives
           HasDirectives.get_directives(self, @own_directives, :directives)
         end
@@ -55,7 +53,7 @@ def get_directives(schema_member, directives, directives_method)
               inherited_directives = if schema_member.superclass.respond_to?(directives_method)
                 get_directives(schema_member.superclass, schema_member.superclass.public_send(directives_method), directives_method)
               else
-                NO_DIRECTIVES
+                GraphQL::EmptyObjects::EMPTY_ARRAY
               end
               if inherited_directives.any? && directives
                 dirs = []
@@ -67,7 +65,7 @@ def get_directives(schema_member, directives, directives_method)
               elsif inherited_directives.any?
                 inherited_directives
               else
-                NO_DIRECTIVES
+                GraphQL::EmptyObjects::EMPTY_ARRAY
               end
             when Module
               dirs = nil
@@ -82,9 +80,9 @@ def get_directives(schema_member, directives, directives_method)
                 dirs ||= []
                 merge_directives(dirs, directives)
               end
-              dirs || NO_DIRECTIVES
+              dirs || GraphQL::EmptyObjects::EMPTY_ARRAY
             when HasDirectives
-              directives || NO_DIRECTIVES
+              directives || GraphQL::EmptyObjects::EMPTY_ARRAY
             else
               raise "Invariant: how could #{schema_member} not be a Class, Module, or instance of HasDirectives?"
             end
diff --git a/lib/graphql/schema/member/has_validators.rb b/lib/graphql/schema/member/has_validators.rb
@@ -3,7 +3,7 @@ module GraphQL
   class Schema
     class Member
       module HasValidators
-        include Schema::FindInheritedValue::EmptyObjects
+        include GraphQL::EmptyObjects
 
         # Build {GraphQL::Schema::Validator}s based on the given configuration
         # and use them for this schema member
@@ -28,7 +28,7 @@ def inherited(child_cls)
           end
 
           module ClassValidators
-            include Schema::FindInheritedValue::EmptyObjects
+            include GraphQL::EmptyObjects
 
             def validators
               inherited_validators = superclass.validators
diff --git a/lib/graphql/schema/resolver.rb b/lib/graphql/schema/resolver.rb
@@ -311,8 +311,8 @@ def broadcastable?
         # (`nil` means "unlimited max page size".)
         # @param max_page_size [Integer, nil] Set a new value
         # @return [Integer, nil] The `max_page_size` assigned to fields that use this resolver
-        def max_page_size(new_max_page_size = :not_given)
-          if new_max_page_size != :not_given
+        def max_page_size(new_max_page_size = NOT_CONFIGURED)
+          if new_max_page_size != NOT_CONFIGURED
             @max_page_size = new_max_page_size
           elsif defined?(@max_page_size)
             @max_page_size
@@ -332,8 +332,8 @@ def has_max_page_size?
         # (`nil` means "unlimited default page size".)
         # @param default_page_size [Integer, nil] Set a new value
         # @return [Integer, nil] The `default_page_size` assigned to fields that use this resolver
-        def default_page_size(new_default_page_size = :not_given)
-          if new_default_page_size != :not_given
+        def default_page_size(new_default_page_size = NOT_CONFIGURED)
+          if new_default_page_size != NOT_CONFIGURED
             @default_page_size = new_default_page_size
           elsif defined?(@default_page_size)
             @default_page_size
diff --git a/lib/graphql/schema/validator.rb b/lib/graphql/schema/validator.rb
@@ -102,7 +102,7 @@ class << self
 
       self.all_validators = {}
 
-      include Schema::FindInheritedValue::EmptyObjects
+      include GraphQL::EmptyObjects
 
       class ValidationFailedError < GraphQL::ExecutionError
         attr_reader :errors
diff --git a/lib/graphql/static_validation/rules/fields_will_merge.rb b/lib/graphql/static_validation/rules/fields_will_merge.rb

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ def merge_extras(extra_args)`
`80`	`80`	`)`
`81`	`81`	`end`
`82`	`82`
`83`		`- NO_ARGS = {}.freeze`
	`83`	`+ NO_ARGS = GraphQL::EmptyObjects::EMPTY_HASH`
`84`	`84`	`EMPTY = self.new(argument_values: nil, keyword_arguments: NO_ARGS).freeze`
`85`	`85`	`end`
`86`	`86`	`end`