GraphQL mutations for managing Notes

https://gitlab.com/gitlab-org/gitlab-ce/issues/62826

13 files changed, 302 insertions, 0 deletions

diff --git a/app/graphql/mutations/notes/base.rb b/app/graphql/mutations/notes/base.rb
new file mode 100644
index 00000000000..a7198f5fba6
--- /dev/null
+++ b/app/graphql/mutations/notes/base.rb
@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    class Base < BaseMutation
+      include Gitlab::Graphql::Authorize::AuthorizeResource
+
+      field :note,
+            Types::Notes::NoteType,
+            null: true,
+            description: 'The note after mutation'
+
+      private
+
+      def find_object(id:)
+        GitlabSchema.object_from_id(id)
+      end
+
+      def check_object_is_noteable!(object)
+        unless object.is_a?(Noteable)
+          raise Gitlab::Graphql::Errors::ResourceNotAvailable,
+                'Cannot add notes to this resource'
+        end
+      end
+
+      def check_object_is_note!(object)
+        unless object.is_a?(Note)
+          raise Gitlab::Graphql::Errors::ResourceNotAvailable,
+                'Resource is not a note'
+        end
+      end
+    end
+  end
+end
diff --git a/app/graphql/mutations/notes/create/base.rb b/app/graphql/mutations/notes/create/base.rb
new file mode 100644
index 00000000000..d3a5dae2188
--- /dev/null
+++ b/app/graphql/mutations/notes/create/base.rb
@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    module Create
+      # This is a Base class for the Note creation Mutations and is not
+      # mounted as a GraphQL mutation itself.
+      class Base < Mutations::Notes::Base
+        authorize :create_note
+
+        argument :noteable_id,
+                  GraphQL::ID_TYPE,
+                  required: true,
+                  description: 'The global id of the resource to add a note to'
+
+        argument :body,
+                  GraphQL::STRING_TYPE,
+                  required: true,
+                  description: copy_field_description(Types::Notes::NoteType, :body)
+
+        private
+
+        def resolve(args)
+          noteable = authorized_find!(id: args[:noteable_id])
+
+          check_object_is_noteable!(noteable)
+
+          note = ::Notes::CreateService.new(
+            noteable.project,
+            current_user,
+            create_note_params(noteable, args)
+          ).execute
+
+          {
+            note: (note if note.persisted?),
+            errors: errors_on_object(note)
+          }
+        end
+
+        def create_note_params(noteable, args)
+          {
+            noteable: noteable,
+            note: args[:body]
+          }
+        end
+      end
+    end
+  end
+end
diff --git a/app/graphql/mutations/notes/create/diff_note.rb b/app/graphql/mutations/notes/create/diff_note.rb
new file mode 100644
index 00000000000..9b5f3092006
--- /dev/null
+++ b/app/graphql/mutations/notes/create/diff_note.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    module Create
+      class DiffNote < Base
+        graphql_name 'CreateDiffNote'
+
+        argument :position,
+                  Types::Notes::DiffPositionInputType,
+                  required: true,
+                  description: copy_field_description(Types::Notes::NoteType, :position)
+
+        private
+
+        def create_note_params(noteable, args)
+          super(noteable, args).merge({
+            type: 'DiffNote',
+            position: position(noteable, args)
+          })
+        end
+
+        def position(noteable, args)
+          position = args[:position].to_h
+          position[:position_type] = 'text'
+          position.merge!(position[:paths].to_h)
+
+          Gitlab::Diff::Position.new(position)
+        end
+      end
+    end
+  end
+end
diff --git a/app/graphql/mutations/notes/create/image_diff_note.rb b/app/graphql/mutations/notes/create/image_diff_note.rb
new file mode 100644
index 00000000000..d94fd4d6ff8
--- /dev/null
+++ b/app/graphql/mutations/notes/create/image_diff_note.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    module Create
+      class ImageDiffNote < Base
+        graphql_name 'CreateImageDiffNote'
+
+        argument :position,
+                  Types::Notes::DiffImagePositionInputType,
+                  required: true,
+                  description: copy_field_description(Types::Notes::NoteType, :position)
+
+        private
+
+        def create_note_params(noteable, args)
+          super(noteable, args).merge({
+            type: 'DiffNote',
+            position: position(noteable, args)
+          })
+        end
+
+        def position(noteable, args)
+          position = args[:position].to_h
+          position[:position_type] = 'image'
+          position.merge!(position[:paths].to_h)
+
+          Gitlab::Diff::Position.new(position)
+        end
+      end
+    end
+  end
+end
diff --git a/app/graphql/mutations/notes/create/note.rb b/app/graphql/mutations/notes/create/note.rb
new file mode 100644
index 00000000000..3c571a4538f
--- /dev/null
+++ b/app/graphql/mutations/notes/create/note.rb
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    module Create
+      class Note < Base
+        graphql_name 'CreateNote'
+      end
+    end
+  end
+end
diff --git a/app/graphql/mutations/notes/destroy.rb b/app/graphql/mutations/notes/destroy.rb
new file mode 100644
index 00000000000..a81322bc9b7
--- /dev/null
+++ b/app/graphql/mutations/notes/destroy.rb
@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    class Destroy < Base
+      graphql_name 'DestroyNote'
+
+      authorize :admin_note
+
+      argument :id,
+                GraphQL::ID_TYPE,
+                required: true,
+                description: 'The global id of the note to destroy'
+
+      def resolve(id:)
+        note = authorized_find!(id: id)
+
+        check_object_is_note!(note)
+
+        ::Notes::DestroyService.new(note.project, current_user).execute(note)
+
+        {
+          errors: []
+        }
+      end
+    end
+  end
+end
diff --git a/app/graphql/mutations/notes/update.rb b/app/graphql/mutations/notes/update.rb
new file mode 100644
index 00000000000..ebf57b800c0
--- /dev/null
+++ b/app/graphql/mutations/notes/update.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mutations
+  module Notes
+    class Update < Base
+      graphql_name 'UpdateNote'
+
+      authorize :admin_note
+
+      argument :id,
+                GraphQL::ID_TYPE,
+                required: true,
+                description: 'The global id of the note to update'
+
+      argument :body,
+                GraphQL::STRING_TYPE,
+                required: true,
+                description: copy_field_description(Types::Notes::NoteType, :body)
+
+      def resolve(args)
+        note = authorized_find!(id: args[:id])
+
+        check_object_is_note!(note)
+
+        note = ::Notes::UpdateService.new(
+          note.project,
+          current_user,
+          { note: args[:body] }
+        ).execute(note)
+
+        {
+          note: note.reset,
+          errors: errors_on_object(note)
+        }
+      end
+    end
+  end
+end
diff --git a/app/graphql/types/base_input_object.rb b/app/graphql/types/base_input_object.rb
index aebed035d3b..90a29b0cfb8 100644
--- a/app/graphql/types/base_input_object.rb
+++ b/app/graphql/types/base_input_object.rb
@@ -2,5 +2,6 @@
 
 module Types
   class BaseInputObject < GraphQL::Schema::InputObject
+    prepend Gitlab::Graphql::CopyFieldDescription
   end
 end
diff --git a/app/graphql/types/diff_paths_input_type.rb b/app/graphql/types/diff_paths_input_type.rb
new file mode 100644
index 00000000000..43feddd9827
--- /dev/null
+++ b/app/graphql/types/diff_paths_input_type.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Types
+  # rubocop: disable Graphql/AuthorizeTypes
+  class DiffPathsInputType < BaseInputObject
+    argument :old_path, GraphQL::STRING_TYPE, required: false,
+              description: 'The path of the file on the start sha'
+    argument :new_path, GraphQL::STRING_TYPE, required: false,
+              description: 'The path of the file on the head sha'
+  end
+  # rubocop: enable Graphql/AuthorizeTypes
+end
diff --git a/app/graphql/types/mutation_type.rb b/app/graphql/types/mutation_type.rb
index bc5fb709522..f843d6ad86f 100644
--- a/app/graphql/types/mutation_type.rb
+++ b/app/graphql/types/mutation_type.rb
@@ -10,5 +10,10 @@ module Types
     mount_mutation Mutations::AwardEmojis::Remove
     mount_mutation Mutations::AwardEmojis::Toggle
     mount_mutation Mutations::MergeRequests::SetWip, calls_gitaly: true
+    mount_mutation Mutations::Notes::Create::Note, calls_gitaly: true
+    mount_mutation Mutations::Notes::Create::DiffNote, calls_gitaly: true
+    mount_mutation Mutations::Notes::Create::ImageDiffNote, calls_gitaly: true
+    mount_mutation Mutations::Notes::Update
+    mount_mutation Mutations::Notes::Destroy
   end
 end
diff --git a/app/graphql/types/notes/diff_image_position_input_type.rb b/app/graphql/types/notes/diff_image_position_input_type.rb
new file mode 100644
index 00000000000..23b53b20815
--- /dev/null
+++ b/app/graphql/types/notes/diff_image_position_input_type.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Types
+  module Notes
+    # rubocop: disable Graphql/AuthorizeTypes
+    class DiffImagePositionInputType < DiffPositionBaseInputType
+      graphql_name 'DiffImagePositionInput'
+
+      argument :x, GraphQL::INT_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :x)
+      argument :y, GraphQL::INT_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :y)
+      argument :width, GraphQL::INT_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :width)
+      argument :height, GraphQL::INT_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :height)
+    end
+    # rubocop: enable Graphql/AuthorizeTypes
+  end
+end
diff --git a/app/graphql/types/notes/diff_position_base_input_type.rb b/app/graphql/types/notes/diff_position_base_input_type.rb
new file mode 100644
index 00000000000..a8991a1240a
--- /dev/null
+++ b/app/graphql/types/notes/diff_position_base_input_type.rb
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Types
+  module Notes
+    # rubocop: disable Graphql/AuthorizeTypes
+    class DiffPositionBaseInputType < BaseInputObject
+      argument :head_sha, GraphQL::STRING_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :head_sha)
+      argument :base_sha,  GraphQL::STRING_TYPE, required: false,
+               description: copy_field_description(Types::Notes::DiffPositionType, :base_sha)
+      argument :start_sha, GraphQL::STRING_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :start_sha)
+
+      argument :paths,
+               Types::DiffPathsInputType,
+               required: true,
+               description: 'The paths of the file that was changed. ' \
+                            'Both of the properties of this input are optional, but at least one of them is required'
+    end
+    # rubocop: enable Graphql/AuthorizeTypes
+  end
+end
diff --git a/app/graphql/types/notes/diff_position_input_type.rb b/app/graphql/types/notes/diff_position_input_type.rb
new file mode 100644
index 00000000000..02c91e173cb
--- /dev/null
+++ b/app/graphql/types/notes/diff_position_input_type.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Types
+  module Notes
+    # rubocop: disable Graphql/AuthorizeTypes
+    class DiffPositionInputType < DiffPositionBaseInputType
+      graphql_name 'DiffPositionInput'
+
+      argument :old_line, GraphQL::INT_TYPE, required: false,
+               description: copy_field_description(Types::Notes::DiffPositionType, :old_line)
+      argument :new_line, GraphQL::INT_TYPE, required: true,
+               description: copy_field_description(Types::Notes::DiffPositionType, :new_line)
+    end
+    # rubocop: enable Graphql/AuthorizeTypes
+  end
+end