Class: Resolvers::BaseResolver

Inherits:
GraphQL::Schema::Resolver
  • Object
show all
Extended by:
Gitlab::Utils::Override
Includes:
Gitlab::Utils::StrongMemoize
Defined in:
app/graphql/resolvers/base_resolver.rb

Direct Known Subclasses

AbuseReportLabelsResolver, AbuseReportResolver, Achievements::AchievementsResolver, Achievements::UserAchievementsResolver, Admin::Analytics::UsageTrends::MeasurementsResolver, AlertManagement::AlertResolver, AlertManagement::AlertStatusCountsResolver, AlertManagement::HttpIntegrationsResolver, AlertManagement::IntegrationsResolver, Analytics::CycleAnalytics::BaseCountResolver, AuditEvents::AuditEventDefinitionsResolver, AutocompleteUsersResolver, AwardEmoji::BaseVotesCountResolver, BlameResolver, BlobsResolver, BoardListIssuesResolver, BoardListsResolver, BoardsResolver, BranchCommitResolver, BulkLabelsResolver, Ci::AllJobsResolver, Ci::ConfigResolver, Ci::InheritedVariablesResolver, Ci::JobTokenScopeResolver, Ci::JobsResolver, Ci::PipelineJobArtifactsResolver, Ci::PipelineStagesResolver, Ci::PipelineTriggersResolver, Ci::ProjectPipelineCountsResolver, Ci::RunnerGroupsResolver, Ci::RunnerJobCountResolver, Ci::RunnerJobsResolver, Ci::RunnerOwnerProjectResolver, Ci::RunnerPlatformsResolver, Ci::RunnerProjectsResolver, Ci::RunnerResolver, Ci::RunnerSetupResolver, Ci::RunnerStatusResolver, Ci::RunnersResolver, Ci::TemplateResolver, Ci::TestReportSummaryResolver, Ci::TestSuiteResolver, Ci::VariablesResolver, Clusters::AgentActivityEventsResolver, Clusters::AgentTokensResolver, Clusters::Agents::Authorizations::CiAccessResolver, Clusters::Agents::Authorizations::UserAccessResolver, Clusters::AgentsResolver, CodequalityReportsComparerResolver, CommitPipelinesResolver, ContainerRepositoriesResolver, ContainerRepositoryTagsResolver, Crm::ContactStateCountsResolver, Crm::ContactsResolver, Crm::OrganizationStateCountsResolver, Crm::OrganizationsResolver, DataTransfer::GroupDataTransferResolver, DataTransfer::ProjectDataTransferResolver, DeploymentResolver, DeploymentsResolver, DesignManagement::DesignAtVersionResolver, DesignManagement::DesignResolver, DesignManagement::DesignsResolver, DesignManagement::Version::DesignAtVersionResolver, DesignManagement::Version::DesignsAtVersionResolver, DesignManagement::VersionInCollectionResolver, DesignManagement::VersionResolver, DesignManagement::VersionsResolver, EchoResolver, Environments::LastDeploymentResolver, EnvironmentsResolver, ErrorTracking::SentryDetailedErrorResolver, ErrorTracking::SentryErrorCollectionResolver, ErrorTracking::SentryErrorStackTraceResolver, ErrorTracking::SentryErrorsResolver, GroupEnvironmentScopesResolver, GroupMembers::NotificationEmailResolver, GroupReleasesResolver, GroupResolver, GroupsResolver, IncidentManagement::TimelineEventTagsResolver, IncidentManagement::TimelineEventsResolver, Issues::BaseResolver, Kas::AgentConfigurationsResolver, Kas::AgentConnectionsResolver, LabelsResolver, LastCommitResolver, MembersResolver, MergeRequestPipelinesResolver, MergeRequestsCountResolver, MergeRequestsResolver, MetadataResolver, Metrics::Dashboards::AnnotationResolver, MilestonesResolver, NamespaceProjectsResolver, NamespaceResolver, Namespaces::WorkItemResolver, NestedGroupsResolver, Noteable::NotesResolver, Notes::SyntheticNoteResolver, Organizations::GroupsResolver, Organizations::OrganizationResolver, Organizations::OrganizationUsersResolver, PackageDetailsResolver, PackagePipelinesResolver, PackagesBaseResolver, PaginatedTreeResolver, ProjectJobsResolver, ProjectPipelineResolver, ProjectPipelineSchedulesResolver, ProjectPipelineStatisticsResolver, ProjectPipelinesResolver, ProjectResolver, Projects::BranchRulesResolver, Projects::CommitReferencesResolver, Projects::ForkDetailsResolver, Projects::ForkTargetsResolver, Projects::GrafanaIntegrationResolver, Projects::JiraProjectsResolver, Projects::ServicesResolver, Projects::SnippetsResolver, ProjectsResolver, RecentBoardsResolver, ReleaseMilestonesResolver, ReleaseResolver, ReleasesResolver, RepositoryBranchNamesResolver, SavedReplyResolver, Snippets::BlobsResolver, SnippetsResolver, Terraform::StatesResolver, TimelogResolver, TodoResolver, TodosResolver, TopicsResolver, TreeResolver, UserDiscussionsCountResolver, UserNotesCountResolver, UserResolver, UserStarredProjectsResolver, Users::GroupCountResolver, Users::GroupsResolver, Users::ParticipantsResolver, Users::SnippetsResolver, UsersResolver, WorkItemResolver, WorkItems::LinkedItemsResolver, WorkItems::TypesResolver, WorkItems::WorkItemDiscussionsResolver, WorkItemsResolver

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

extended, extensions, included, method_added, override, prepended, queue_verification, verify!

Class Method Details

.as_single ⇒ Object 



51
52
53
 
# File 'app/graphql/resolvers/base_resolver.rb', line 51

def self.as_single
  @as_single ||= []
end

.authorization ⇒ Object 



168
169
170
 
# File 'app/graphql/resolvers/base_resolver.rb', line 168

def self.authorization
  @authorization ||= ::Gitlab::Graphql::Authorize::ObjectAuthorization.new(try(:required_permissions))
end

.authorized?(object, context) ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
 
# File 'app/graphql/resolvers/base_resolver.rb', line 172

def self.authorized?(object, context)
  authorization.ok?(object, context[:current_user])
end

.before_connection_authorization(&block) ⇒ Object 



133
134
135
 
# File 'app/graphql/resolvers/base_resolver.rb', line 133

def self.before_connection_authorization(&block)
  @before_connection_authorization_block = block
end

.before_connection_authorization_block ⇒ Object

rubocop: disable Style/TrivialAccessors



138
139
140
 
# File 'app/graphql/resolvers/base_resolver.rb', line 138

def self.before_connection_authorization_block
  @before_connection_authorization_block
end

.calculate_ext_conn_complexity ⇒ Object

This is a flag to allow us to use ‘complexity_multiplier` to compute complexity for connection fields(see BaseField#connection_complexity_multiplier) in resolvers that do external connection pagination, thus disabling the default `connection` option(see self.field_options method above).



21
22
23
 
# File 'app/graphql/resolvers/base_resolver.rb', line 21

def self.calculate_ext_conn_complexity
  false
end

.calls_gitaly! ⇒ Object 



14
15
16
 
# File 'app/graphql/resolvers/base_resolver.rb', line 14

def self.calls_gitaly!
  @calls_gitaly = true
end

.complexity ⇒ Object 



110
111
112
 
# File 'app/graphql/resolvers/base_resolver.rb', line 110

def self.complexity
  0
end

.complexity_multiplier(args) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
 
# File 'app/graphql/resolvers/base_resolver.rb', line 122

def self.complexity_multiplier(args)
  # When fetching many items, additional complexity is added to the field
  # depending on how many items is fetched. For each item we add 1% of the
  # original complexity - this means that loading 100 items (our default
  # max_page_size limit) doubles the original complexity.
  #
  # Complexity is not increased when searching by specific ID(s), because
  # complexity difference is minimal in this case.
  [args[:iid], args[:iids]].any? ? 0 : 0.01
end

.field_options ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'app/graphql/resolvers/base_resolver.rb', line 25

def self.field_options
  extra_options = {
    requires_argument: @requires_argument,
    calls_gitaly: @calls_gitaly
  }.compact

  super.merge(extra_options)
end

.last ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'app/graphql/resolvers/base_resolver.rb', line 95

def self.last
  parent = self
  @last ||= Class.new(single) do
    type parent.singular_type, null: true

    def select_result(results)
      results&.last
    end

    define_singleton_method :to_s do
      "#{parent}.last"
    end
  end
end

.requires_argument! ⇒ Object 



10
11
12
 
# File 'app/graphql/resolvers/base_resolver.rb', line 10

def self.requires_argument!
  @requires_argument = true
end

.resolver_complexity(args, child_complexity:) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'app/graphql/resolvers/base_resolver.rb', line 114

def self.resolver_complexity(args, child_complexity:)
  complexity = 1
  complexity += 1 if args[:sort]
  complexity += 5 if args[:search]

  complexity
end

.single ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'app/graphql/resolvers/base_resolver.rb', line 59

def self.single
  @single ||= begin
    parent = self
    klass = Class.new(self) do
      type parent.singular_type, null: true

      def ready?(**args)
        ready, early_return = super
        [ready, select_result(early_return)]
      end

      def resolve(**args)
        select_result(super)
      end

      def single?
        true
      end

      def select_result(results)
        results&.first
      end

      define_singleton_method :to_s do
        "#{parent}.single"
      end
    end

    single_definition_blocks.each do |definition|
      klass.instance_exec(&definition)
    end

    klass
  end
end

.single_definition_blocks ⇒ Object 



55
56
57
 
# File 'app/graphql/resolvers/base_resolver.rb', line 55

def self.single_definition_blocks
  ancestors.flat_map { |klass| klass.try(:as_single) || [] }
end

.singular_type ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'app/graphql/resolvers/base_resolver.rb', line 34

def self.singular_type
  return unless type

  unwrapped = type.unwrap

  %i[node_type relay_node_type of_type itself].reduce(nil) do |t, m|
    t || unwrapped.try(m)
  end
end

.when_single(&block) ⇒ Object 



44
45
46
47
48
49
 
# File 'app/graphql/resolvers/base_resolver.rb', line 44

def self.when_single(&block)
  as_single << block

  # Have we been called after defining the single version of this resolver?
  @single.instance_exec(&block) if @single.present?
end

Instance Method Details

#current_user ⇒ Object 



159
160
161
 
# File 'app/graphql/resolvers/base_resolver.rb', line 159

def current_user
  context[:current_user]
end

#object ⇒ Object 



148
149
150
151
152
153
 
# File 'app/graphql/resolvers/base_resolver.rb', line 148

def object
  super.tap do |obj|
    # If the field this resolver is used in is wrapped in a presenter, unwrap its subject
    break obj.__subject__ if obj.is_a?(Gitlab::View::Presenter::Base)
  end
end

#offset_pagination(relation) ⇒ Object

rubocop: enable Style/TrivialAccessors



143
144
145
 
# File 'app/graphql/resolvers/base_resolver.rb', line 143

def offset_pagination(relation)
  ::Gitlab::Graphql::Pagination::OffsetPaginatedRelation.new(relation)
end

#select_result(results) ⇒ Object

Overridden in sub-classes (see .single, .last)



164
165
166
 
# File 'app/graphql/resolvers/base_resolver.rb', line 164

def select_result(results)
  results
end

#single? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'app/graphql/resolvers/base_resolver.rb', line 155

def single?
  false
end