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, Analytics::CycleAnalytics::StagesResolver, Analytics::CycleAnalytics::ValueStreams::StageItemsResolver, Analytics::CycleAnalytics::ValueStreams::StageMetricsResolver, Analytics::CycleAnalytics::ValueStreamsResolver, AppConfig::GitlabInstanceFeatureFlagsResolver, AppConfig::InstanceMetadataResolver, AuditEvents::AuditEventDefinitionsResolver, 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::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, GroupsResolver, 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::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::GrafanaIntegrationResolver, Projects::IsForkedResolver, Projects::JiraProjectsResolver, Projects::PlanLimitsResolver, Projects::ServicesResolver, Projects::SnippetsResolver, Projects::UserContributedProjectsResolver, ProjectsResolver, RecentBoardsResolver, ReleaseMilestonesResolver, ReleaseResolver, ReleasesResolver, Repositories::CommitResolver, 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::RecentlyViewedIssuesResolver, Users::RecentlyViewedMergeRequestsResolver, Users::SnippetsResolver, UsersResolver, Wikis::WikiPageResolver, WorkItemReferencesResolver, WorkItemResolver, WorkItems::DescriptionTemplateContentResolver, WorkItems::DescriptionTemplatesResolver, WorkItems::HierarchyResolver, WorkItems::LinkedItemsResolver, WorkItems::TypesResolver, WorkItems::UserPreferenceResolver, WorkItems::UserWorkItemsResolver, 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 



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

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

.authorization ⇒ Object 



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

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

.authorized?(object, context) ⇒ Boolean

Returns:

  • (Boolean) 


176
177
178
 
# File 'app/graphql/resolvers/base_resolver.rb', line 176

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

.before_connection_authorization(&block) ⇒ Object 



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

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

.before_connection_authorization_block ⇒ Object

rubocop: disable Style/TrivialAccessors



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

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.



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

def self.calculate_ext_conn_complexity
  false
end

.calls_gitaly! ⇒ Object 



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

def self.calls_gitaly!
  @calls_gitaly = true
end

.calls_gitaly? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.calls_gitaly?
  !!@calls_gitaly
end

.complexity ⇒ Object 



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

def self.complexity
  0
end

.complexity_multiplier(args) ⇒ Object 



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

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

.last ⇒ Object 



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

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

.requires_argument? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.requires_argument?
  !!@requires_argument
end

.resolver_complexity(args, child_complexity:) ⇒ Object 



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

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

  complexity
end

.single ⇒ Object 



58
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
 
# File 'app/graphql/resolvers/base_resolver.rb', line 58

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 



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

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

.singular_type ⇒ Object 



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

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 



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

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 



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

def current_user
  context[:current_user]
end

#object ⇒ Object 



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

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



147
148
149
 
# File 'app/graphql/resolvers/base_resolver.rb', line 147

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

#select_result(results) ⇒ Object

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



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

def select_result(results)
  results
end

#single? ⇒ Boolean

Returns:

  • (Boolean) 


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

def single?
  false
end