Class: API::Entities::Project

Inherits:
ProjectDetails show all
Includes:
Helpers::RelatedResourcesHelpers
Defined in:
lib/api/entities/project.rb

Direct Known Subclasses

ProjectWithAccess

Class Method Summary collapse

Methods included from Helpers::RelatedResourcesHelpers

#expose_path, #expose_url, #issues_available?, #mrs_available?, #project_feature_string_access_level

Methods inherited from ProjectDetails

repositories_for_preload

Methods inherited from BasicProjectDetails

postload_relation

Methods included from ProjectsRelationBuilder

#execute_batch_counting, #preload_groups, #preload_member_roles, #preload_relation, #preload_repository_cache, #prepare_relation, #projects_for_group_preload, #repositories_for_preload

Class Method Details

.execute_batch_counting(projects_relation) ⇒ Object

rubocop: enable CodeReuse/ActiveRecord



206
207
208
209
210
211
212
 
# File 'lib/api/entities/project.rb', line 206

def self.execute_batch_counting(projects_relation)
  # Call the count methods on every project, so the BatchLoader would load them all at
  # once when the entities are rendered
  projects_relation.each(&:open_issues_count)

  super
end

.preload_relation(projects_relation, options = {}) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/api/entities/project.rb', line 188

def self.preload_relation(projects_relation, options = {})
  # Preloading topics, should be done with using only `:topics`,
  # as `:topics` are defined as: `has_many :topics, through: :project_topics`
  # N+1 is solved then by using `subject.topics.map(&:name)`
  # MR describing the solution: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/20555
  super(projects_relation).preload(group: :namespace_settings)
                          .preload(:ci_cd_settings)
                          .preload(:project_setting)
                          .preload(:container_expiration_policy)
                          .preload(:auto_devops)
                          .preload(:project_repository)
                          .preload(:service_desk_setting)
                          .preload(project_group_links: { group: :route },
                            fork_network: :root_project,
                            fork_network_member: :forked_from_project)
end

.preload_resource(project) ⇒ Object

rubocop: disable CodeReuse/ActiveRecord



184
185
186
 
# File 'lib/api/entities/project.rb', line 184

def self.preload_resource(project)
  ActiveRecord::Associations::Preloader.new(records: [project], associations: { project_group_links: { group: :route } }).call
end