gitlab-org--gitlab-foss/app/graphql/mutations/base_mutation.rb

73 lines
2.2 KiB
Ruby

# frozen_string_literal: true
module Mutations
class BaseMutation < GraphQL::Schema::RelayClassicMutation
include Gitlab::Graphql::Authorize::AuthorizeResource
prepend Gitlab::Graphql::CopyFieldDescription
ERROR_MESSAGE = 'You cannot perform write operations on a read-only instance'
field_class ::Types::BaseField
argument_class ::Types::BaseArgument
field :errors, [GraphQL::Types::String],
null: false,
description: 'Errors encountered during execution of the mutation.'
def current_user
context[:current_user]
end
def api_user?
context[:is_sessionless_user]
end
# Returns Array of errors on an ActiveRecord object
def errors_on_object(record)
record.errors.full_messages
end
def ready?(**args)
raise_resource_not_available_error! ERROR_MESSAGE if Gitlab::Database.read_only?
missing_args = self.class.arguments.values
.reject { |arg| arg.accepts?(args.fetch(arg.keyword, :not_given)) }
.map(&:graphql_name)
raise ArgumentError, "Arguments must be provided: #{missing_args.join(", ")}" if missing_args.any?
true
end
def load_application_object(argument, id, context)
::Gitlab::Graphql::Lazy.new { super }
end
def unauthorized_object(error)
# The default behavior is to abort processing and return nil for the
# entire mutation field, but not set any top-level errors. We prefer to
# at least say that something went wrong.
Gitlab::ErrorTracking.track_exception(error)
raise_resource_not_available_error!
end
def self.authorizes_object?
true
end
def self.authorized?(object, context)
auth = ::Gitlab::Graphql::Authorize::ObjectAuthorization.new(:execute_graphql_mutation, :api)
return true if auth.ok?(:global, context[:current_user],
scope_validator: context[:scope_validator])
# in our mutations we raise, rather than returning a null value.
raise_resource_not_available_error!
end
# See: AuthorizeResource#authorized_resource?
def self.authorization
@authorization ||= ::Gitlab::Graphql::Authorize::ObjectAuthorization.new(authorize)
end
end
end