debian-mirror-gitlab/lib/api/entities/project.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

188 lines
9.6 KiB
Ruby
Raw Normal View History

2020-03-13 15:44:24 +05:30
# frozen_string_literal: true
module API
module Entities
class Project < BasicProjectDetails
include ::API::Helpers::RelatedResourcesHelpers
2021-04-17 20:07:23 +05:30
expose :container_registry_url, as: :container_registry_image_prefix, if: -> (_, _) { Gitlab.config.registry.enabled }
2020-03-13 15:44:24 +05:30
expose :_links do
expose :self do |project|
expose_url(api_v4_projects_path(id: project.id))
end
expose :issues, if: -> (project, options) { issues_available?(project, options) } do |project|
expose_url(api_v4_projects_issues_path(id: project.id))
end
expose :merge_requests, if: -> (project, options) { mrs_available?(project, options) } do |project|
expose_url(api_v4_projects_merge_requests_path(id: project.id))
end
expose :repo_branches do |project|
expose_url(api_v4_projects_repository_branches_path(id: project.id))
end
expose :labels do |project|
expose_url(api_v4_projects_labels_path(id: project.id))
end
expose :events do |project|
expose_url(api_v4_projects_events_path(id: project.id))
end
expose :members do |project|
expose_url(api_v4_projects_members_path(id: project.id))
end
2022-07-16 23:28:13 +05:30
expose :cluster_agents do |project|
expose_url(api_v4_projects_cluster_agents_path(id: project.id))
end
2020-03-13 15:44:24 +05:30
end
2020-10-24 23:57:45 +05:30
expose :packages_enabled
2020-03-13 15:44:24 +05:30
expose :empty_repo?, as: :empty_repo
expose :archived?, as: :archived
expose :visibility
expose :owner, using: Entities::UserBasic, unless: ->(project, options) { project.group }
expose :resolve_outdated_diff_discussions
expose :container_expiration_policy, using: Entities::ContainerExpirationPolicy,
if: -> (project, _) { project.container_expiration_policy }
# Expose old field names with the new permissions methods to keep API compatible
# TODO: remove in API v5, replaced by *_access_level
expose(:issues_enabled) { |project, options| project.feature_available?(:issues, options[:current_user]) }
expose(:merge_requests_enabled) { |project, options| project.feature_available?(:merge_requests, options[:current_user]) }
expose(:wiki_enabled) { |project, options| project.feature_available?(:wiki, options[:current_user]) }
expose(:jobs_enabled) { |project, options| project.feature_available?(:builds, options[:current_user]) }
expose(:snippets_enabled) { |project, options| project.feature_available?(:snippets, options[:current_user]) }
2021-09-30 23:02:18 +05:30
expose(:container_registry_enabled) { |project, options| project.feature_available?(:container_registry, options[:current_user]) }
2020-07-28 23:09:34 +05:30
expose :service_desk_enabled
2021-12-07 22:27:20 +05:30
expose :service_desk_address, if: -> (project, options) do
Ability.allowed?(options[:current_user], :admin_issue, project)
end
2020-03-13 15:44:24 +05:30
expose(:can_create_merge_request_in) do |project, options|
Ability.allowed?(options[:current_user], :create_merge_request_in, project)
end
expose(:issues_access_level) { |project, options| project.project_feature.string_access_level(:issues) }
expose(:repository_access_level) { |project, options| project.project_feature.string_access_level(:repository) }
expose(:merge_requests_access_level) { |project, options| project.project_feature.string_access_level(:merge_requests) }
2020-04-22 19:07:51 +05:30
expose(:forking_access_level) { |project, options| project.project_feature.string_access_level(:forking) }
2020-03-13 15:44:24 +05:30
expose(:wiki_access_level) { |project, options| project.project_feature.string_access_level(:wiki) }
expose(:builds_access_level) { |project, options| project.project_feature.string_access_level(:builds) }
expose(:snippets_access_level) { |project, options| project.project_feature.string_access_level(:snippets) }
expose(:pages_access_level) { |project, options| project.project_feature.string_access_level(:pages) }
2021-02-22 17:27:13 +05:30
expose(:operations_access_level) { |project, options| project.project_feature.string_access_level(:operations) }
expose(:analytics_access_level) { |project, options| project.project_feature.string_access_level(:analytics) }
2021-10-27 15:23:28 +05:30
expose(:container_registry_access_level) { |project, options| project.project_feature.string_access_level(:container_registry) }
2022-05-07 20:08:51 +05:30
expose(:security_and_compliance_access_level) { |project, options| project.project_feature.string_access_level(:security_and_compliance) }
2020-03-13 15:44:24 +05:30
expose :emails_disabled
expose :shared_runners_enabled
expose :lfs_enabled?, as: :lfs_enabled
expose :creator_id
expose :forked_from_project, using: Entities::BasicProjectDetails, if: ->(project, options) do
project.forked? && Ability.allowed?(options[:current_user], :read_project, project.forked_from_project)
end
2022-03-02 08:16:31 +05:30
expose :mr_default_target_self, if: -> (project) { project.forked? }
2022-06-21 17:19:12 +05:30
expose :import_url, if: -> (project, options) { Ability.allowed?(options[:current_user], :admin_project, project) } do |project|
project[:import_url]
end
expose :import_type, if: -> (project, options) { Ability.allowed?(options[:current_user], :admin_project, project) }
2020-03-13 15:44:24 +05:30
expose :import_status
expose :import_error, if: lambda { |_project, options| options[:user_can_admin_project] } do |project|
project.import_state&.last_error
end
expose :open_issues_count, if: lambda { |project, options| project.feature_available?(:issues, options[:current_user]) }
expose :runners_token, if: lambda { |_project, options| options[:user_can_admin_project] }
expose :ci_default_git_depth
2021-01-03 14:25:43 +05:30
expose :ci_forward_deployment_enabled
2021-09-04 01:27:46 +05:30
expose :ci_job_token_scope_enabled
2022-06-21 17:19:12 +05:30
expose :ci_separated_caches
2022-08-13 15:12:31 +05:30
expose :ci_opt_in_jwt
2020-03-13 15:44:24 +05:30
expose :public_builds, as: :public_jobs
expose :build_git_strategy, if: lambda { |project, options| options[:user_can_admin_project] } do |project, options|
project.build_allow_git_fetch ? 'fetch' : 'clone'
end
expose :build_timeout
expose :auto_cancel_pending_pipelines
expose :build_coverage_regex
expose :ci_config_path, if: -> (project, options) { Ability.allowed?(options[:current_user], :download_code, project) }
expose :shared_with_groups do |project, options|
2021-10-29 20:43:33 +05:30
user = options[:current_user]
SharedGroupWithProject.represent(project.visible_group_links(for_user: user), options)
2020-03-13 15:44:24 +05:30
end
expose :only_allow_merge_if_pipeline_succeeds
2020-06-23 00:09:42 +05:30
expose :allow_merge_on_skipped_pipeline
2021-03-08 18:12:59 +05:30
expose :restrict_user_defined_variables
2020-03-13 15:44:24 +05:30
expose :request_access_enabled
expose :only_allow_merge_if_all_discussions_are_resolved
expose :remove_source_branch_after_merge
expose :printing_merge_request_link_enabled
expose :merge_method
2021-09-04 01:27:46 +05:30
expose :squash_option
2022-07-16 23:28:13 +05:30
expose :enforce_auth_checks_on_uploads
2020-03-13 15:44:24 +05:30
expose :suggestion_commit_message
2021-12-11 22:18:48 +05:30
expose :merge_commit_template
2022-01-26 12:08:38 +05:30
expose :squash_commit_template
2020-03-13 15:44:24 +05:30
expose :statistics, using: 'API::Entities::ProjectStatistics', if: -> (project, options) {
options[:statistics] && Ability.allowed?(options[:current_user], :read_statistics, project)
}
expose :auto_devops_enabled?, as: :auto_devops_enabled
expose :auto_devops_deploy_strategy do |project, options|
project.auto_devops.nil? ? 'continuous' : project.auto_devops.deploy_strategy
end
expose :autoclose_referenced_issues
2020-04-08 14:13:33 +05:30
expose :repository_storage, if: ->(project, options) {
Ability.allowed?(options[:current_user], :change_repository_storage, project)
}
2021-09-04 01:27:46 +05:30
expose :keep_latest_artifacts_available?, as: :keep_latest_artifact
2022-03-02 08:16:31 +05:30
expose :runner_token_expiration_interval
2020-03-13 15:44:24 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2021-11-11 11:23:49 +05:30
def self.preload_resource(project)
ActiveRecord::Associations::Preloader.new.preload(project, project_group_links: { group: :route })
end
2020-03-13 15:44:24 +05:30
def self.preload_relation(projects_relation, options = {})
2021-09-04 01:27:46 +05:30
# Preloading topics, should be done with using only `:topics`,
2021-11-18 22:05:49 +05:30
# as `:topics` are defined as: `has_many :topics, through: :project_topics`
2021-09-04 01:27:46 +05:30
# N+1 is solved then by using `subject.topics.map(&:name)`
2020-03-13 15:44:24 +05:30
# MR describing the solution: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/20555
2021-04-29 21:17:54 +05:30
super(projects_relation).preload(group: :namespace_settings)
2020-03-13 15:44:24 +05:30
.preload(:ci_cd_settings)
2020-06-23 00:09:42 +05:30
.preload(:project_setting)
2020-03-13 15:44:24 +05:30
.preload(:container_expiration_policy)
.preload(:auto_devops)
2021-04-29 21:17:54 +05:30
.preload(:service_desk_setting)
2020-03-13 15:44:24 +05:30
.preload(project_group_links: { group: :route },
fork_network: :root_project,
fork_network_member: :forked_from_project,
2021-11-18 22:05:49 +05:30
forked_from_project: [:route, :topics, :group, :project_feature, namespace: [:route, :owner]])
2020-03-13 15:44:24 +05:30
end
# rubocop: enable CodeReuse/ActiveRecord
2021-11-11 11:23:49 +05:30
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)
projects_relation.map(&:forked_from_project).compact.each(&:forks_count)
super
end
def self.repositories_for_preload(projects_relation)
super + projects_relation.map(&:forked_from_project).compact.map(&:repository)
2020-03-13 15:44:24 +05:30
end
end
end
end
2021-06-08 01:23:25 +05:30
API::Entities::Project.prepend_mod_with('API::Entities::Project', with_descendants: true)