Class: Resolvers::BaseResolver

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

Direct Known Subclasses

AbuseReportResolver, Achievements::AchievementsResolver, Achievements::UserAchievementsResolver, Admin::Analytics::UsageTrends::MeasurementsResolver, AlertManagement::AlertResolver, AlertManagement::AlertStatusCountsResolver, AlertManagement::HttpIntegrationsResolver, AlertManagement::IntegrationsResolver, Analytics::CycleAnalytics::BaseCountResolver, Analytics::CycleAnalytics::StagesResolver, Analytics::CycleAnalytics::ValueStreams::StageItemsResolver, Analytics::CycleAnalytics::ValueStreams::StageMetricsResolver, Analytics::CycleAnalytics::ValueStreamsResolver, AppConfig::GitlabInstanceFeatureFlagsResolver, AppConfig::InstanceMetadataResolver, AuditEvents::AuditEventDefinitionsResolver, Authz::AccessTokens::PermissionsResolver, AutocompleteUsersResolver, AwardEmoji::BaseVotesCountResolver, BlameResolver, BlobsResolver, BoardListIssuesResolver, BoardListsResolver, BoardsResolver, BulkLabelsResolver, Ci::AllJobsResolver, Ci::Catalog::ResourceResolver, Ci::Catalog::Resources::VersionsResolver, Ci::Catalog::ResourcesResolver, Ci::ConfigResolver, Ci::InheritedVariablesResolver, Ci::JobAnalyticsResolver, Ci::JobTokenAuthLogsResolver, Ci::JobTokenScopeAllowlistResolver, Ci::JobTokenScopeResolver, Ci::JobsResolver, Ci::PipelineAnalyticsResolver, Ci::PipelineJobArtifactsResolver, Ci::PipelineStagesResolver, Ci::PipelineTriggersResolver, Ci::ProjectPipelineCountsResolver, Ci::ProjectPipelineResolver, Ci::ProjectPipelineSchedulesResolver, Ci::ProjectPipelinesResolver, Ci::RunnerGroupsResolver, Ci::RunnerJobCountResolver, Ci::RunnerJobsResolver, Ci::RunnerManagersResolver, Ci::RunnerOwnerProjectResolver, Ci::RunnerPlatformsResolver, Ci::RunnerProjectsResolver, Ci::RunnerResolver, Ci::RunnerSetupResolver, 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, CustomEmojiResolver, 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, FeatureFlagResolver, GroupEnvironmentScopesResolver, GroupMembers::NotificationEmailResolver, GroupReleasesResolver, GroupResolver, Import::SourceUsersResolver, IncidentManagement::TimelineEventTagsResolver, IncidentManagement::TimelineEventsResolver, Integrations::ExclusionsResolver, Issues::BaseResolver, Kas::AgentConfigurationsResolver, Kas::AgentConnectionsResolver, LabelsResolver, LastCommitResolver, MembersResolver, MergeRequestPipelinesResolver, MergeRequests::IssueRelatedResolver, MergeRequestsCountResolver, MergeRequestsResolver, MilestonesResolver, Ml::ExperimentDetailResolver, Ml::FindExperimentsResolver, Ml::FindModelVersionResolver, Ml::FindModelVersionsResolver, Ml::FindModelsResolver, Ml::ModelDetailResolver, NamespaceProjectsResolver, NamespaceResolver, Namespaces::BaseGroupsResolver, Namespaces::SharedGroupsResolver, Namespaces::WorkItemResolver, NestedGroupsResolver, Noteable::NotesResolver, Notes::SyntheticNoteResolver, Organizations::OrganizationResolver, Organizations::OrganizationUsersResolver, Organizations::OrganizationsResolver, PackageDetailsResolver, PackagePipelinesResolver, PackagesBaseResolver, PagesDeploymentsResolver, PaginatedTreeResolver, ProjectContainerRegistryProtectionRulesResolver, ProjectJobsResolver, ProjectPackagesProtectionRulesResolver, ProjectResolver, Projects::BranchRulesResolver, Projects::CommitReferencesResolver, Projects::DeployKeyResolver, Projects::ForkDetailsResolver, Projects::ForkTargetsResolver, Projects::IsForkedResolver, Projects::JiraProjectsResolver, Projects::PlanLimitsResolver, Projects::ServicesResolver, Projects::SharedProjectsResolver, Projects::SnippetsResolver, Projects::UserContributedProjectsResolver, ProjectsResolver, RecentBoardsResolver, ReleaseMilestonesResolver, ReleaseResolver, ReleasesResolver, Repositories::CommitResolver, Repositories::CommitsResolver, Repositories::RefCommitResolver, RepositoryBranchNamesResolver, SavedReplyResolver, Snippets::BlobsResolver, SnippetsResolver, Terraform::StatesResolver, TimelogResolver, TodoResolver, TodosResolver, TopicsResolver, TreeResolver, UserDiscussionsCountResolver, UserNotesCountResolver, UserResolver, UserStarredProjectsResolver, Users::FrecentGroupsResolver, Users::FrecentProjectsResolver, Users::GroupCountResolver, Users::GroupsResolver, Users::OrganizationsResolver, Users::ParticipantsResolver, Users::PersonalAccessTokensResolver, Users::ProjectCountResolver, Users::RecentlyViewedIssuesResolver, Users::RecentlyViewedItemsResolver, Users::RecentlyViewedMergeRequestsResolver, Users::SnippetsResolver, UsersResolver, WebHooks::EventsResolver, WebHooks::ProjectHooksResolver, Wikis::WikiPageResolver, WorkItemReferencesResolver, WorkItemResolver, WorkItems::DescriptionTemplateContentResolver, WorkItems::DescriptionTemplatesResolver, WorkItems::HierarchyResolver, WorkItems::LinkedItemsResolver, WorkItems::TypesResolver, WorkItems::UserPreferenceResolver, WorkItems::UserWorkItemsResolver, WorkItems::WidgetsResolver, WorkItems::WorkItemDiscussionsResolver, WorkItemsResolver

Constant Summary

Constants included from Gitlab::Graphql::Authorize::AuthorizeResource

Gitlab::Graphql::Authorize::AuthorizeResource::ConfigurationError, Gitlab::Graphql::Authorize::AuthorizeResource::RESOURCE_ACCESS_ERROR

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

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

Methods included from Gitlab::Graphql::Authorize::AuthorizeResource

#authorize!, #authorized_find!, #authorized_resource?, #find_object, #raise_resource_not_available_error!

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 



174
175
176
 
# File 'app/graphql/resolvers/base_resolver.rb', line 174

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

.authorized?(object, context) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'app/graphql/resolvers/base_resolver.rb', line 178

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

.before_connection_authorization(&block) ⇒ Object 



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

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

.before_connection_authorization_block ⇒ Object

rubocop: disable Style/TrivialAccessors



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

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.



30
31
32
 
# File 'app/graphql/resolvers/base_resolver.rb', line 30

def self.calculate_ext_conn_complexity
  false
end

.calls_gitaly! ⇒ Object 



19
20
21
 
# File 'app/graphql/resolvers/base_resolver.rb', line 19

def self.calls_gitaly!
  @calls_gitaly = true
end

.calls_gitaly? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'app/graphql/resolvers/base_resolver.rb', line 23

def self.calls_gitaly?
  !!@calls_gitaly
end

.complexity ⇒ Object 



115
116
117
 
# File 'app/graphql/resolvers/base_resolver.rb', line 115

def self.complexity
  0
end

.complexity_multiplier(args) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
 
# File 'app/graphql/resolvers/base_resolver.rb', line 127

def self.complexity_multiplier(args)
  # if the number of iids present in the args is of a sufficiently large
  # size, we want to ensure that the complexity multiplier is applied
  if args[:iid] || (args[:iids].present? && args[:iids].length <= 100)
    0
  elsif args[:iids].present? && args[:iids].length > 100
    0.02
  else
    0.01
  end
end

.last ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'app/graphql/resolvers/base_resolver.rb', line 100

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 



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

def self.requires_argument!
  @requires_argument = true
end

.requires_argument? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.requires_argument?
  !!@requires_argument
end

.resolver_complexity(args, child_complexity:) ⇒ Object 



119
120
121
122
123
124
125
 
# File 'app/graphql/resolvers/base_resolver.rb', line 119

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
94
95
96
97
98
 
# 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)
        value = super

        if value.is_a?(Array)
          [value[0], select_result(value[1])]
        else
          value
        end
      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 



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

def current_user
  context[:current_user]
end

#object ⇒ Object 



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

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



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

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

#select_result(results) ⇒ Object

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



170
171
172
 
# File 'app/graphql/resolvers/base_resolver.rb', line 170

def select_result(results)
  results
end

#single? ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'app/graphql/resolvers/base_resolver.rb', line 161

def single?
  false
end