graphql_cody 1.13.0

data/lib/graphql/schema/resolver.rb

@@ -0,0 +1,397 @@
+# frozen_string_literal: true
+require "graphql/schema/resolver/has_payload_type"
+
+module GraphQL
+  class Schema
+    # A class-based container for field configuration and resolution logic. It supports:
+    #
+    # - Arguments, via `.argument(...)` helper, which will be applied to the field.
+    # - Return type, via `.type(..., null: ...)`, which will be applied to the field.
+    # - Description, via `.description(...)`, which will be applied to the field
+    # - Resolution, via `#resolve(**args)` method, which will be called to resolve the field.
+    # - `#object` and `#context` accessors for use during `#resolve`.
+    #
+    # Resolvers can be attached with the `resolver:` option in a `field(...)` call.
+    #
+    # A resolver's configuration may be overridden with other keywords in the `field(...)` call.
+    #
+    # See the {.field_options} to see how a Resolver becomes a set of field configuration options.
+    #
+    # @see {GraphQL::Schema::Mutation} for a concrete subclass of `Resolver`.
+    # @see {GraphQL::Function} `Resolver` is a replacement for `GraphQL::Function`
+    class Resolver
+      include Schema::Member::GraphQLTypeNames
+      # Really we only need description from here, but:
+      extend Schema::Member::BaseDSLMethods
+      extend GraphQL::Schema::Member::HasArguments
+      extend GraphQL::Schema::Member::HasValidators
+      include Schema::Member::HasPath
+      extend Schema::Member::HasPath
+
+      # @param object [Object] The application object that this field is being resolved on
+      # @param context [GraphQL::Query::Context]
+      # @param field [GraphQL::Schema::Field]
+      def initialize(object:, context:, field:)
+        @object = object
+        @context = context
+        @field = field
+        # Since this hash is constantly rebuilt, cache it for this call
+        @arguments_by_keyword = {}
+        self.class.arguments(context).each do |name, arg|
+          @arguments_by_keyword[arg.keyword] = arg
+        end
+        @prepared_arguments = nil
+      end
+
+      # @return [Object] The application object this field is being resolved on
+      attr_reader :object
+
+      # @return [GraphQL::Query::Context]
+      attr_reader :context
+
+      # @return [GraphQL::Dataloader]
+      def dataloader
+        context.dataloader
+      end
+
+      # @return [GraphQL::Schema::Field]
+      attr_reader :field
+
+      def arguments
+        @prepared_arguments || raise("Arguments have not been prepared yet, still waiting for #load_arguments to resolve. (Call `.arguments` later in the code.)")
+      end
+
+      # This method is _actually_ called by the runtime,
+      # it does some preparation and then eventually calls
+      # the user-defined `#resolve` method.
+      # @api private
+      def resolve_with_support(**args)
+        # First call the ready? hook which may raise
+        ready_val = if args.any?
+          ready?(**args)
+        else
+          ready?
+        end
+        context.schema.after_lazy(ready_val) do |is_ready, ready_early_return|
+          if ready_early_return
+            if is_ready != false
+              raise "Unexpected result from #ready? (expected `true`, `false` or `[false, {...}]`): [#{authorized_result.inspect}, #{ready_early_return.inspect}]"
+            else
+              ready_early_return
+            end
+          elsif is_ready
+            # Then call each prepare hook, which may return a different value
+            # for that argument, or may return a lazy object
+            load_arguments_val = load_arguments(args)
+            context.schema.after_lazy(load_arguments_val) do |loaded_args|
+              @prepared_arguments = loaded_args
+              Schema::Validator.validate!(self.class.validators, object, context, loaded_args, as: @field)
+              # Then call `authorized?`, which may raise or may return a lazy object
+              authorized_val = if loaded_args.any?
+                authorized?(**loaded_args)
+              else
+                authorized?
+              end
+              context.schema.after_lazy(authorized_val) do |(authorized_result, early_return)|
+                # If the `authorized?` returned two values, `false, early_return`,
+                # then use the early return value instead of continuing
+                if early_return
+                  if authorized_result == false
+                    early_return
+                  else
+                    raise "Unexpected result from #authorized? (expected `true`, `false` or `[false, {...}]`): [#{authorized_result.inspect}, #{early_return.inspect}]"
+                  end
+                elsif authorized_result
+                  # Finally, all the hooks have passed, so resolve it
+                  if loaded_args.any?
+                    public_send(self.class.resolve_method, **loaded_args)
+                  else
+                    public_send(self.class.resolve_method)
+                  end
+                else
+                  raise GraphQL::UnauthorizedFieldError.new(context: context, object: object, type: field.owner, field: field)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      # Do the work. Everything happens here.
+      # @return [Object] An object corresponding to the return type
+      def resolve(**args)
+        raise GraphQL::RequiredImplementationMissingError, "#{self.class.name}#resolve should execute the field's logic"
+      end
+
+      # Called before arguments are prepared.
+      # Implement this hook to make checks before doing any work.
+      #
+      # If it returns a lazy object (like a promise), it will be synced by GraphQL
+      # (but the resulting value won't be used).
+      #
+      # @param args [Hash] The input arguments, if there are any
+      # @raise [GraphQL::ExecutionError] To add an error to the response
+      # @raise [GraphQL::UnauthorizedError] To signal an authorization failure
+      # @return [Boolean, early_return_data] If `false`, execution will stop (and `early_return_data` will be returned instead, if present.)
+      def ready?(**args)
+        true
+      end
+
+      # Called after arguments are loaded, but before resolving.
+      #
+      # Override it to check everything before calling the mutation.
+      # @param inputs [Hash] The input arguments
+      # @raise [GraphQL::ExecutionError] To add an error to the response
+      # @raise [GraphQL::UnauthorizedError] To signal an authorization failure
+      # @return [Boolean, early_return_data] If `false`, execution will stop (and `early_return_data` will be returned instead, if present.)
+      def authorized?(**inputs)
+        self.class.arguments(context).each_value do |argument|
+          arg_keyword = argument.keyword
+          if inputs.key?(arg_keyword) && !(arg_value = inputs[arg_keyword]).nil? && (arg_value != argument.default_value)
+            arg_auth, err = argument.authorized?(self, arg_value, context)
+            if !arg_auth
+              return arg_auth, err
+            else
+              true
+            end
+          else
+            true
+          end
+        end
+      end
+
+      # Called when an object loaded by `loads:` fails the `.authorized?` check for its resolved GraphQL object type.
+      #
+      # By default, the error is re-raised and passed along to {{Schema.unauthorized_object}}.
+      #
+      # Any value returned here will be used _instead of_ of the loaded object.
+      # @param err [GraphQL::UnauthorizedError]
+      def unauthorized_object(err)
+        raise err
+      end
+
+      private
+
+      def load_arguments(args)
+        prepared_args = {}
+        prepare_lazies = []
+
+        args.each do |key, value|
+          arg_defn = @arguments_by_keyword[key]
+          if arg_defn
+            prepped_value = prepared_args[key] = arg_defn.load_and_authorize_value(self, value, context)
+            if context.schema.lazy?(prepped_value)
+              prepare_lazies << context.schema.after_lazy(prepped_value) do |finished_prepped_value|
+                prepared_args[key] = finished_prepped_value
+              end
+            end
+          else
+            # these are `extras:`
+            prepared_args[key] = value
+          end
+        end
+
+        # Avoid returning a lazy if none are needed
+        if prepare_lazies.any?
+          GraphQL::Execution::Lazy.all(prepare_lazies).then { prepared_args }
+        else
+          prepared_args
+        end
+      end
+
+      def get_argument(name, context = GraphQL::Query::NullContext)
+        self.class.get_argument(name, context)
+      end
+
+      class << self
+        # Default `:resolve` set below.
+        # @return [Symbol] The method to call on instances of this object to resolve the field
+        def resolve_method(new_method = nil)
+          if new_method
+            @resolve_method = new_method
+          end
+          @resolve_method || (superclass.respond_to?(:resolve_method) ? superclass.resolve_method : :resolve)
+        end
+
+        # Additional info injected into {#resolve}
+        # @see {GraphQL::Schema::Field#extras}
+        def extras(new_extras = nil)
+          if new_extras
+            @own_extras = new_extras
+          end
+          own_extras = @own_extras || []
+          own_extras + (superclass.respond_to?(:extras) ? superclass.extras : [])
+        end
+
+        # If `true` (default), then the return type for this resolver will be nullable.
+        # If `false`, then the return type is non-null.
+        #
+        # @see #type which sets the return type of this field and accepts a `null:` option
+        # @param allow_null [Boolean] Whether or not the response can be null
+        def null(allow_null = nil)
+          if !allow_null.nil?
+            @null = allow_null
+          end
+
+          @null.nil? ? (superclass.respond_to?(:null) ? superclass.null : true) : @null
+        end
+
+        # Call this method to get the return type of the field,
+        # or use it as a configuration method to assign a return type
+        # instead of generating one.
+        # TODO unify with {#null}
+        # @param new_type [Class, Array<Class>, nil] If a type definition class is provided, it will be used as the return type of the field
+        # @param null [true, false] Whether or not the field may return `nil`
+        # @return [Class] The type which this field returns.
+        def type(new_type = nil, null: nil)
+          if new_type
+            if null.nil?
+              raise ArgumentError, "required argument `null:` is missing"
+            end
+            @type_expr = new_type
+            @null = null
+          else
+            if @type_expr
+              GraphQL::Schema::Member::BuildType.parse_type(@type_expr, null: @null)
+            elsif superclass.respond_to?(:type)
+              superclass.type
+            else
+              nil
+            end
+          end
+        end
+
+        # Specifies the complexity of the field. Defaults to `1`
+        # @return [Integer, Proc]
+        def complexity(new_complexity = nil)
+          if new_complexity
+            @complexity = new_complexity
+          end
+          @complexity || (superclass.respond_to?(:complexity) ? superclass.complexity : 1)
+        end
+
+        def broadcastable(new_broadcastable)
+          @broadcastable = new_broadcastable
+        end
+
+        # @return [Boolean, nil]
+        def broadcastable?
+          if defined?(@broadcastable)
+            @broadcastable
+          else
+            (superclass.respond_to?(:broadcastable?) ? superclass.broadcastable? : nil)
+          end
+        end
+
+        # Get or set the `max_page_size:` which will be configured for fields using this resolver
+        # (`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
+            @max_page_size = new_max_page_size
+          elsif defined?(@max_page_size)
+            @max_page_size
+          elsif superclass.respond_to?(:max_page_size)
+            superclass.max_page_size
+          else
+            nil
+          end
+        end
+
+        # @return [Boolean] `true` if this resolver or a superclass has an assigned `max_page_size`
+        def has_max_page_size?
+          defined?(@max_page_size) || (superclass.respond_to?(:has_max_page_size?) && superclass.has_max_page_size?)
+        end
+
+        def field_options
+
+          all_args = {}
+          all_argument_definitions.each do |arg|
+            if (prev_entry = all_args[arg.graphql_name])
+              if prev_entry.is_a?(Array)
+                prev_entry << arg
+              else
+                all_args[arg.graphql_name] = [prev_entry, arg]
+              end
+            else
+              all_args[arg.graphql_name] = arg
+            end
+          end
+
+          field_opts = {
+            type: type_expr,
+            description: description,
+            extras: extras,
+            resolver_method: :resolve_with_support,
+            resolver_class: self,
+            arguments: all_args,
+            null: null,
+            complexity: complexity,
+            broadcastable: broadcastable?,
+          }
+
+          # If there aren't any, then the returned array is `[].freeze`,
+          # but passing that along breaks some user code.
+          if (exts = extensions).any?
+            field_opts[:extensions] = exts
+          end
+
+          if has_max_page_size?
+            field_opts[:max_page_size] = max_page_size
+          end
+
+          field_opts
+        end
+
+        # A non-normalized type configuration, without `null` applied
+        def type_expr
+          @type_expr || (superclass.respond_to?(:type_expr) ? superclass.type_expr : nil)
+        end
+
+        # Add an argument to this field's signature, but
+        # also add some preparation hook methods which will be used for this argument
+        # @see {GraphQL::Schema::Argument#initialize} for the signature
+        def argument(*args, **kwargs, &block)
+          # Use `from_resolver: true` to short-circuit the InputObject's own `loads:` implementation
+          # so that we can support `#load_{x}` methods below.
+          super(*args, from_resolver: true, **kwargs)
+        end
+
+        # Registers new extension
+        # @param extension [Class] Extension class
+        # @param options [Hash] Optional extension options
+        def extension(extension, **options)
+          @own_extensions ||= []
+          @own_extensions << {extension => options}
+        end
+
+        # @api private
+        def extensions
+          own_exts = @own_extensions
+          # Jump through some hoops to avoid creating arrays when we don't actually need them
+          if superclass.respond_to?(:extensions)
+            s_exts = superclass.extensions
+            if own_exts
+              if s_exts.any?
+                own_exts + s_exts
+              else
+                own_exts
+              end
+            else
+              s_exts
+            end
+          else
+            own_exts || EMPTY_ARRAY
+          end
+        end
+
+        private
+
+        def own_extensions
+          @own_extensions
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/scalar.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Scalar < GraphQL::Schema::Member
+      extend GraphQL::Schema::Member::AcceptsDefinition
+      extend GraphQL::Schema::Member::ValidatesInput
+
+      class << self
+        def coerce_input(val, ctx)
+          val
+        end
+
+        def coerce_result(val, ctx)
+          val
+        end
+
+        def to_graphql
+          type_defn = GraphQL::ScalarType.new
+          type_defn.name = graphql_name
+          type_defn.description = description
+          type_defn.coerce_result = method(:coerce_result)
+          type_defn.coerce_input = method(:coerce_input)
+          type_defn.metadata[:type_class] = self
+          type_defn.default_scalar = default_scalar
+          type_defn.ast_node = ast_node
+          type_defn
+        end
+
+        def kind
+          GraphQL::TypeKinds::SCALAR
+        end
+
+        def default_scalar(is_default = nil)
+          if !is_default.nil?
+            @default_scalar = is_default
+          end
+          @default_scalar
+        end
+
+        def default_scalar?
+          @default_scalar ||= false
+        end
+
+        def validate_non_null_input(value, ctx)
+          result = Query::InputValidationResult.new
+          coerced_result = begin
+            ctx.query.with_error_handling do
+              coerce_input(value, ctx)
+            end
+          rescue GraphQL::CoercionError => err
+            err
+          end
+
+          if coerced_result.nil?
+            str_value = if value == Float::INFINITY
+              ""
+            else
+              " #{GraphQL::Language.serialize(value)}"
+            end
+            result.add_problem("Could not coerce value#{str_value} to #{graphql_name}")
+          elsif coerced_result.is_a?(GraphQL::CoercionError)
+            result.add_problem(coerced_result.message, message: coerced_result.message, extensions: coerced_result.extensions)
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/subscription.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # This class can be extended to create fields on your subscription root.
+    #
+    # It provides hooks for the different parts of the subscription lifecycle:
+    #
+    # - `#authorized?`: called before initial subscription and subsequent updates
+    # - `#subscribe`: called for the initial subscription
+    # - `#update`: called for subsequent update
+    #
+    # Also, `#unsubscribe` terminates the subscription.
+    class Subscription < GraphQL::Schema::Resolver
+      extend GraphQL::Schema::Resolver::HasPayloadType
+      extend GraphQL::Schema::Member::HasFields
+      NO_UPDATE = :no_update
+      # The generated payload type is required; If there's no payload,
+      # propagate null.
+      null false
+
+      def initialize(object:, context:, field:)
+        super
+        # Figure out whether this is an update or an initial subscription
+        @mode = context.query.subscription_update? ? :update : :subscribe
+      end
+
+      def resolve_with_support(**args)
+        result = nil
+        unsubscribed = true
+        catch :graphql_subscription_unsubscribed do
+          result = super
+          unsubscribed = false
+        end
+
+
+        if unsubscribed
+          context.skip
+        else
+          result
+        end
+      end
+
+      # Implement the {Resolve} API
+      def resolve(**args)
+        # Dispatch based on `@mode`, which will raise a `NoMethodError` if we ever
+        # have an unexpected `@mode`
+        public_send("resolve_#{@mode}", **args)
+      end
+
+      # Wrap the user-defined `#subscribe` hook
+      def resolve_subscribe(**args)
+        ret_val = args.any? ? subscribe(**args) : subscribe
+        if ret_val == :no_response
+          context.skip
+        else
+          ret_val
+        end
+      end
+
+      # The default implementation returns nothing on subscribe.
+      # Override it to return an object or
+      # `:no_response` to (explicitly) return nothing.
+      def subscribe(args = {})
+        :no_response
+      end
+
+      # Wrap the user-provided `#update` hook
+      def resolve_update(**args)
+        ret_val = args.any? ? update(**args) : update
+        if ret_val == NO_UPDATE
+          context.namespace(:subscriptions)[:no_update] = true
+          context.skip
+        else
+          ret_val
+        end
+      end
+
+      # The default implementation returns the root object.
+      # Override it to return {NO_UPDATE} if you want to
+      # skip updates sometimes. Or override it to return a different object.
+      def update(args = {})
+        object
+      end
+
+      # If an argument is flagged with `loads:` and no object is found for it,
+      # remove this subscription (assuming that the object was deleted in the meantime,
+      # or that it became inaccessible).
+      def load_application_object_failed(err)
+        if @mode == :update
+          unsubscribe
+        end
+        super
+      end
+
+      # Call this to halt execution and remove this subscription from the system
+      def unsubscribe
+        context.namespace(:subscriptions)[:unsubscribed] = true
+        throw :graphql_subscription_unsubscribed
+      end
+
+      READING_SCOPE = ::Object.new
+      # Call this method to provide a new subscription_scope; OR
+      # call it without an argument to get the subscription_scope
+      # @param new_scope [Symbol]
+      # @param optional [Boolean] If true, then don't require `scope:` to be provided to updates to this subscription.
+      # @return [Symbol]
+      def self.subscription_scope(new_scope = READING_SCOPE, optional: false)
+        if new_scope != READING_SCOPE
+          @subscription_scope = new_scope
+          @subscription_scope_optional = optional
+        elsif defined?(@subscription_scope)
+          @subscription_scope
+        else
+          find_inherited_value(:subscription_scope)
+        end
+      end
+
+      def self.subscription_scope_optional?
+        if defined?(@subscription_scope_optional)
+          @subscription_scope_optional
+        else
+          find_inherited_value(:subscription_scope_optional, false)
+        end
+      end
+
+      # This is called during initial subscription to get a "name" for this subscription.
+      # Later, when `.trigger` is called, this will be called again to build another "name".
+      # Any subscribers with matching topic will begin the update flow.
+      #
+      # The default implementation creates a string using the field name, subscription scope, and argument keys and values.
+      # In that implementation, only `.trigger` calls with _exact matches_ result in updates to subscribers.
+      #
+      # To implement a filtered stream-type subscription flow, override this method to return a string with field name and subscription scope.
+      # Then, implement {#update} to compare its arguments to the current `object` and return {NO_UPDATE} when an
+      # update should be filtered out.
+      #
+      # @see {#update} for how to skip updates when an event comes with a matching topic.
+      # @param arguments [Hash<String => Object>] The arguments for this topic, in GraphQL-style (camelized strings)
+      # @param field [GraphQL::Schema::Field]
+      # @param scope [Object, nil] A value corresponding to `.trigger(... scope:)` (for updates) or the `subscription_scope` found in `context` (for initial subscriptions).
+      # @return [String] An identifier corresponding to a stream of updates
+      def self.topic_for(arguments:, field:, scope:)
+        Subscriptions::Serialize.dump_recursive([scope, field.graphql_name, arguments])
+      end
+
+      # Overriding Resolver#field_options to include subscription_scope
+      def self.field_options
+        super.merge(
+          subscription_scope: subscription_scope
+        )
+      end
+    end
+  end
+end