class GraphQL::Schema::Object

Attributes

Returns

GraphQL::Query::Context — the context instance for this query

Returns

Object — the application object this type is wrapping

Public Class Methods

authorized_new(Object object, GraphQL::Query::Context context) → GraphQL::Schema::Object | GraphQL::Execution::Lazy | GraphQL::UnauthorizedError

Source

# File lib/graphql/schema/object.rb, line 90
def authorized_new(object, context)
  context.query.current_trace.begin_authorized(self, object, context)
  begin
    maybe_lazy_auth_val = context.query.current_trace.authorized(query: context.query, type: self, object: object) do
      begin
        authorized?(object, context)
      rescue GraphQL::UnauthorizedError => err
        context.schema.unauthorized_object(err)
      rescue StandardError => err
        context.query.handle_or_reraise(err)
      end
    end
  ensure
    context.query.current_trace.end_authorized(self, object, context, maybe_lazy_auth_val)
  end

  auth_val = if context.schema.lazy?(maybe_lazy_auth_val)
    GraphQL::Execution::Lazy.new do
      context.query.current_trace.begin_authorized(self, object, context)
      context.query.current_trace.authorized_lazy(query: context.query, type: self, object: object) do
        res = context.schema.sync_lazy(maybe_lazy_auth_val)
        context.query.current_trace.end_authorized(self, object, context, res)
        res
      end
    end
  else
    maybe_lazy_auth_val
  end

  context.query.after_lazy(auth_val) do |is_authorized|
    if is_authorized
      self.new(object, context)
    else
      # It failed the authorization check, so go to the schema's authorized object hook
      err = GraphQL::UnauthorizedError.new(object: object, type: self, context: context)
      # If a new value was returned, wrap that instead of the original value
      begin
        new_obj = context.schema.unauthorized_object(err)
        if new_obj
          self.new(new_obj, context)
        else
          nil
        end
      end
    end
  end
end

Make a new instance of this type if the auth check passes, otherwise, raise an error.

Probably only the framework should call this method.

This might return a GraphQL::Execution::Lazy if the user-provided .authorized? hook returns some lazy value (like a Promise).

The reason that the auth check is in this wrapper method instead of .new is because of how it might return a Promise. It would be weird if .new returned a promise; It would be a headache to try to maintain Promise-y state inside a Schema::Object instance. So, hopefully this wrapper method will do the job.

Parameters

object (Object) — The thing wrapped by this object
context (GraphQL::Query::Context)

Returns

GraphQL::Schema::Object, GraphQL::Execution::Lazy

Raises

GraphQL::UnauthorizedError — if the user-provided hook returns false

const_missing (name)

Source

# File lib/graphql/schema/object.rb, line 151
def const_missing(name)
  if name == :InvalidNullError
    custom_err_class = GraphQL::InvalidNullError.subclass_for(self)
    const_set(:InvalidNullError, custom_err_class)
    custom_err_class
  else
    super
  end
end

Set up a type-specific invalid null error to use when this object’s non-null fields wrongly return nil. It should help with debugging and bug tracker integrations.

Calls superclass method

kind ()

Source

# File lib/graphql/schema/object.rb, line 161
def kind
  GraphQL::TypeKinds::OBJECT
end

new (object, context)

Source

# File lib/graphql/schema/object.rb, line 143
def initialize(object, context)
  @object = object
  @context = context
end

scoped_new (object, context)

Source

# File lib/graphql/schema/object.rb, line 138
def scoped_new(object, context)
  self.new(object, context)
end

wrap (object, context)

Source

# File lib/graphql/schema/object.rb, line 58
def wrap(object, context)
  authorized_new(object, context)
end

This is called by the runtime to return an object to call methods on.

wrap_scoped (object, context)

Source

# File lib/graphql/schema/object.rb, line 53
def wrap_scoped(object, context)
  scoped_new(object, context)
end

Public Instance Methods

dataloader() → GraphQL::Dataloader

Source

# File lib/graphql/schema/object.rb, line 38
def dataloader
  context.dataloader
end

Returns

GraphQL::Dataloader

raw_value (obj)

Source

# File lib/graphql/schema/object.rb, line 44
def raw_value(obj)
  GraphQL::Execution::Interpreter::RawValue.new(obj)
end

Call this in a field method to return a value that should be returned to the client without any further handling by GraphQL.