debian-mirror-gitlab/lib/api/discussions.rb

277 lines
12 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2018-03-27 19:54:05 +05:30
module API
2021-01-03 14:25:43 +05:30
class Discussions < ::API::Base
2018-03-27 19:54:05 +05:30
include PaginationParams
helpers ::API::Helpers::NotesHelpers
2019-10-12 21:52:04 +05:30
helpers ::RendersNotes
2018-03-27 19:54:05 +05:30
before { authenticate! }
2022-01-26 12:08:38 +05:30
urgency :low, [
'/projects/:id/merge_requests/:noteable_id/discussions',
'/projects/:id/merge_requests/:noteable_id/discussions/:discussion_id',
'/projects/:id/merge_requests/:noteable_id/discussions/:discussion_id/notes',
'/projects/:id/merge_requests/:noteable_id/discussions/:discussion_id/notes/:note_id'
]
2021-01-29 00:20:46 +05:30
Helpers::DiscussionsHelpers.feature_category_per_noteable_type.each do |noteable_type, feature_category|
2018-03-27 19:54:05 +05:30
parent_type = noteable_type.parent_class.to_s.underscore
noteables_str = noteable_type.to_s.underscore.pluralize
2023-01-13 00:05:48 +05:30
notable_name = noteable_type.to_s.underscore.humanize.downcase
notable_id_type = noteable_type == Commit ? String : Integer
2018-10-15 14:42:47 +05:30
noteables_path = noteable_type == Commit ? "repository/#{noteables_str}" : noteables_str
2018-03-27 19:54:05 +05:30
params do
requires :id, type: String, desc: "The ID of a #{parent_type}"
end
2019-02-15 15:39:39 +05:30
resource parent_type.pluralize.to_sym, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2023-01-13 00:05:48 +05:30
desc "Get a list of #{notable_name} discussions" do
2018-03-27 19:54:05 +05:30
success Entities::Discussion
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
use :pagination
end
2019-10-12 21:52:04 +05:30
2021-01-29 00:20:46 +05:30
get ":id/#{noteables_path}/:noteable_id/discussions", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
2020-04-22 19:07:51 +05:30
discussion_ids = paginate(noteable.discussion_ids_relation)
notes = readable_discussion_notes(noteable, discussion_ids)
2018-03-27 19:54:05 +05:30
2020-04-22 19:07:51 +05:30
present Discussion.build_collection(notes, noteable), with: Entities::Discussion
2018-03-27 19:54:05 +05:30
end
2023-01-13 00:05:48 +05:30
desc "Get a single #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Discussion
end
params do
requires :discussion_id, type: String, desc: 'The ID of a discussion'
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
end
2021-01-29 00:20:46 +05:30
get ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
notes = readable_discussion_notes(noteable, params[:discussion_id])
2018-10-15 14:42:47 +05:30
if notes.empty?
break not_found!("Discussion")
2018-03-27 19:54:05 +05:30
end
discussion = Discussion.build(notes, noteable)
present discussion, with: Entities::Discussion
end
2023-01-13 00:05:48 +05:30
desc "Create a new #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Discussion
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
requires :body, type: String, desc: 'The content of a note'
optional :created_at, type: String, desc: 'The creation date of the note'
2023-01-13 00:05:48 +05:30
if [Commit, MergeRequest].include?(noteable_type)
optional :position, type: Hash do
requires :base_sha, type: String, desc: 'Base commit SHA in the source branch'
requires :start_sha, type: String, desc: 'SHA referencing commit in target branch'
requires :head_sha, type: String, desc: 'SHA referencing HEAD of this merge request'
requires :position_type, type: String, desc: 'Type of the position reference', values: %w(text image)
optional :new_path, type: String, desc: 'File path after change'
optional :new_line, type: Integer, desc: 'Line number after change'
optional :old_path, type: String, desc: 'File path before change'
optional :old_line, type: Integer, desc: 'Line number before change'
optional :width, type: Integer, desc: 'Width of the image'
optional :height, type: Integer, desc: 'Height of the image'
optional :x, type: Integer, desc: 'X coordinate in the image'
optional :y, type: Integer, desc: 'Y coordinate in the image'
if noteable_type == MergeRequest
optional :line_range, type: Hash, desc: 'Multi-line start and end' do
optional :start, type: Hash do
optional :line_code, type: String, desc: 'Start line code for multi-line note'
optional :type, type: String, desc: 'Start line type for multi-line note'
optional :old_line, type: String, desc: 'Start old_line line number'
optional :new_line, type: String, desc: 'Start new_line line number'
end
optional :end, type: Hash do
optional :line_code, type: String, desc: 'End line code for multi-line note'
optional :type, type: String, desc: 'End line type for multi-line note'
optional :old_line, type: String, desc: 'End old_line line number'
optional :new_line, type: String, desc: 'End new_line line number'
end
end
2020-07-28 23:09:34 +05:30
end
2020-04-22 19:07:51 +05:30
end
2018-10-15 14:42:47 +05:30
end
2018-03-27 19:54:05 +05:30
end
2021-01-29 00:20:46 +05:30
post ":id/#{noteables_path}/:noteable_id/discussions", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-10-15 14:42:47 +05:30
type = params[:position] ? 'DiffNote' : 'DiscussionNote'
id_key = noteable.is_a?(Commit) ? :commit_id : :noteable_id
2018-03-27 19:54:05 +05:30
opts = {
note: params[:body],
created_at: params[:created_at],
2018-10-15 14:42:47 +05:30
type: type,
2018-03-27 19:54:05 +05:30
noteable_type: noteables_str.classify,
2018-10-15 14:42:47 +05:30
position: params[:position],
id_key => noteable.id
2018-03-27 19:54:05 +05:30
}
2021-02-22 17:27:13 +05:30
opts[:commit_id] = params[:commit_id] if noteable.is_a?(MergeRequest) && type == 'DiffNote'
2018-03-27 19:54:05 +05:30
note = create_note(noteable, opts)
if note.valid?
present note.discussion, with: Entities::Discussion
else
bad_request!("Note #{note.errors.messages}")
end
end
2023-01-13 00:05:48 +05:30
desc "Get comments in a single #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Discussion
end
params do
requires :discussion_id, type: String, desc: 'The ID of a discussion'
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
end
2021-01-29 00:20:46 +05:30
get ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id/notes", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
notes = readable_discussion_notes(noteable, params[:discussion_id])
2018-10-15 14:42:47 +05:30
if notes.empty?
break not_found!("Notes")
2018-03-27 19:54:05 +05:30
end
present notes, with: Entities::Note
end
2023-01-13 00:05:48 +05:30
desc "Add a comment to a #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Note
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
requires :discussion_id, type: String, desc: 'The ID of a discussion'
requires :body, type: String, desc: 'The content of a note'
optional :created_at, type: String, desc: 'The creation date of the note'
end
2021-01-29 00:20:46 +05:30
post ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id/notes", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
notes = readable_discussion_notes(noteable, params[:discussion_id])
2019-07-31 22:56:46 +05:30
first_note = notes.first
2018-03-27 19:54:05 +05:30
2018-10-15 14:42:47 +05:30
break not_found!("Discussion") if notes.empty?
2019-07-31 22:56:46 +05:30
unless first_note.part_of_discussion? || first_note.to_discussion.can_convert_to_discussion?
break bad_request!("Discussion can not be replied to.")
end
2018-03-27 19:54:05 +05:30
opts = {
note: params[:body],
type: 'DiscussionNote',
in_reply_to_discussion_id: params[:discussion_id],
created_at: params[:created_at]
}
note = create_note(noteable, opts)
if note.valid?
present note, with: Entities::Note
else
bad_request!("Note #{note.errors.messages}")
end
end
2023-01-13 00:05:48 +05:30
desc "Get a comment in a #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Note
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
requires :discussion_id, type: String, desc: 'The ID of a discussion'
requires :note_id, type: Integer, desc: 'The ID of a note'
end
2021-01-29 00:20:46 +05:30
get ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id/notes/:note_id", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
get_note(noteable, params[:note_id])
end
2023-01-13 00:05:48 +05:30
desc "Edit a comment in a #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Note
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
requires :discussion_id, type: String, desc: 'The ID of a discussion'
requires :note_id, type: Integer, desc: 'The ID of a note'
2018-10-15 14:42:47 +05:30
optional :body, type: String, desc: 'The content of a note'
optional :resolved, type: Boolean, desc: 'Mark note resolved/unresolved'
exactly_one_of :body, :resolved
2018-03-27 19:54:05 +05:30
end
2021-01-29 00:20:46 +05:30
put ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id/notes/:note_id", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
2018-10-15 14:42:47 +05:30
if params[:resolved].nil?
update_note(noteable, params[:note_id])
else
resolve_note(noteable, params[:note_id], params[:resolved])
end
2018-03-27 19:54:05 +05:30
end
2023-01-13 00:05:48 +05:30
desc "Delete a comment in a #{notable_name} discussion" do
2018-03-27 19:54:05 +05:30
success Entities::Note
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-03-27 19:54:05 +05:30
requires :discussion_id, type: String, desc: 'The ID of a discussion'
requires :note_id, type: Integer, desc: 'The ID of a note'
end
2021-01-29 00:20:46 +05:30
delete ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id/notes/:note_id", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-03-27 19:54:05 +05:30
delete_note(noteable, params[:note_id])
end
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
if Noteable.resolvable_types.include?(noteable_type.to_s)
2023-01-13 00:05:48 +05:30
desc "Resolve/unresolve an existing #{notable_name} discussion" do
2018-10-15 14:42:47 +05:30
success Entities::Discussion
end
params do
2023-01-13 00:05:48 +05:30
requires :noteable_id, type: notable_id_type, desc: "The ID of the #{notable_name}"
2018-10-15 14:42:47 +05:30
requires :discussion_id, type: String, desc: 'The ID of a discussion'
requires :resolved, type: Boolean, desc: 'Mark discussion resolved/unresolved'
end
2021-01-29 00:20:46 +05:30
put ":id/#{noteables_path}/:noteable_id/discussions/:discussion_id", feature_category: feature_category do
2020-03-13 15:44:24 +05:30
noteable = find_noteable(noteable_type, params[:noteable_id])
2018-10-15 14:42:47 +05:30
resolve_discussion(noteable, params[:discussion_id], params[:resolved])
end
end
2018-03-27 19:54:05 +05:30
end
end
helpers do
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2020-04-22 19:07:51 +05:30
def readable_discussion_notes(noteable, discussion_ids)
2018-03-27 19:54:05 +05:30
notes = noteable.notes
2021-12-11 22:18:48 +05:30
.with_discussion_ids(discussion_ids)
2023-03-17 16:20:25 +05:30
.inc_relations_for_view(noteable)
2018-03-27 19:54:05 +05:30
.includes(:noteable)
.fresh
2019-10-12 21:52:04 +05:30
# Without RendersActions#prepare_notes_for_rendering,
2022-04-04 11:22:00 +05:30
# Note#system_note_visible_for? will attempt to render
2019-10-12 21:52:04 +05:30
# Markdown references mentioned in the note to see whether they
# should be redacted. For notes that reference a commit, this
# would also incur a Gitaly call to verify the commit exists.
#
# With prepare_notes_for_rendering, we can avoid Gitaly calls
# because notes are redacted if they point to projects that
# cannot be accessed by the user.
notes = prepare_notes_for_rendering(notes)
2020-04-08 14:13:33 +05:30
notes.select { |n| n.readable_by?(current_user) }
2018-03-27 19:54:05 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2018-03-27 19:54:05 +05:30
end
end
end