Thread Google Chat messages by topic

gitlab-org/gitlab#27823

Changelog: added

app/models/integrations/hangouts_chat.rb

@@ -47,8 +47,31 @@ def default_fields
     private
 
     def notify(message, opts)
+      url = webhook.dup
+
+      key = parse_thread_key(message)
+      url = Gitlab::Utils.add_url_parameters(url, { threadKey: key }) if key
+
       simple_text = parse_simple_text_message(message)
-      ::HangoutsChat::Sender.new(webhook).simple(simple_text)
+      ::HangoutsChat::Sender.new(url).simple(simple_text)
+    end
+
+    # Returns an appropriate key for threading messages in google chat
+    def parse_thread_key(message)
+      case message
+      when Integrations::ChatMessage::NoteMessage
+        message.target
+      when Integrations::ChatMessage::IssueMessage
+        "issue #{Issue.reference_prefix}#{message.issue_iid}"
+      when Integrations::ChatMessage::MergeMessage
+        "merge request #{MergeRequest.reference_prefix}#{message.merge_request_iid}"
+      when Integrations::ChatMessage::PushMessage
+        "push #{message.project_name}_#{message.ref}"
+      when Integrations::ChatMessage::PipelineMessage
+        "pipeline #{message.pipeline_id}"
+      when Integrations::ChatMessage::WikiPageMessage
+        "wiki_page #{message.wiki_page_url}"
+      end
     end
 
     def parse_simple_text_message(message)

spec/models/integrations/hangouts_chat_spec.rb

@@ -12,4 +12,175 @@
       }
     end
   end
+
+  let(:chat_integration) { described_class.new }
+  let(:webhook_url) { 'https://example.gitlab.com/' }
+  let(:webhook_url_regex) { /\A#{webhook_url}.*/ }
+
+  describe "#execute" do
+    let_it_be(:user) { create(:user) }
+    let_it_be(:project) { create(:project, :repository, :wiki_repo) }
+
+    before do
+      allow(chat_integration).to receive_messages(
+        project: project,
+        project_id: project.id,
+        webhook: webhook_url
+      )
+
+      WebMock.stub_request(:post, webhook_url_regex)
+    end
+
+    context 'with push events' do
+      let(:push_sample_data) do
+        Gitlab::DataBuilder::Push.build_sample(project, user)
+      end
+
+      it "adds thread key for push events" do
+        expect(chat_integration.execute(push_sample_data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /push .*?/ }))
+          .once
+      end
+    end
+
+    context 'with issue events' do
+      let(:issues_sample_data) { create(:issue).to_hook_data(user) }
+
+      it "adds thread key for issue events" do
+        expect(chat_integration.execute(issues_sample_data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /issue .*?/ }))
+          .once
+      end
+    end
+
+    context 'with merge events' do
+      let(:merge_sample_data) { create(:merge_request).to_hook_data(user) }
+
+      it "adds thread key for merge events" do
+        expect(chat_integration.execute(merge_sample_data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /merge request .*?/ }))
+          .once
+      end
+    end
+
+    context 'with wiki page events' do
+      let(:wiki_page_sample_data) do
+        Gitlab::DataBuilder::WikiPage.build(create(:wiki_page, message: 'foo'), user, 'create')
+      end
+
+      it "adds thread key for wiki page events" do
+        expect(chat_integration.execute(wiki_page_sample_data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /wiki_page .*?/ }))
+          .once
+      end
+    end
+
+    context 'with pipeline events' do
+      let(:pipeline) do
+        create(:ci_pipeline, :failed, project: project, sha: project.commit.sha, ref: project.default_branch)
+      end
+
+      let(:pipeline_sample_data) { Gitlab::DataBuilder::Pipeline.build(pipeline) }
+
+      it "adds thread key for pipeline events" do
+        expect(chat_integration.execute(pipeline_sample_data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /pipeline .*?/ }))
+          .once
+      end
+    end
+  end
+
+  describe "Note events" do
+    let_it_be(:user) { create(:user) }
+    let_it_be(:project) { create(:project, :repository, creator: user) }
+
+    before do
+      allow(chat_integration).to receive_messages(
+        project: project,
+        project_id: project.id,
+        webhook: webhook_url
+      )
+
+      WebMock.stub_request(:post, webhook_url_regex)
+    end
+
+    context 'when commit comment event executed' do
+      let(:commit_note) do
+        create(:note_on_commit, author: user,
+                                project: project,
+                                commit_id: project.repository.commit.id,
+                                note: 'a comment on a commit')
+      end
+
+      it "adds thread key" do
+        data = Gitlab::DataBuilder::Note.build(commit_note, user)
+
+        expect(chat_integration.execute(data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /commit .*?/ }))
+          .once
+      end
+    end
+
+    context 'when merge request comment event executed' do
+      let(:merge_request_note) do
+        create(:note_on_merge_request, project: project,
+                                       note: "merge request note")
+      end
+
+      it "adds thread key" do
+        data = Gitlab::DataBuilder::Note.build(merge_request_note, user)
+
+        expect(chat_integration.execute(data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /merge request .*?/ }))
+          .once
+      end
+    end
+
+    context 'when issue comment event executed' do
+      let(:issue_note) do
+        create(:note_on_issue, project: project, note: "issue note")
+      end
+
+      it "adds thread key" do
+        data = Gitlab::DataBuilder::Note.build(issue_note, user)
+
+        expect(chat_integration.execute(data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /issue .*?/ }))
+          .once
+      end
+    end
+
+    context 'when snippet comment event executed' do
+      let(:snippet_note) do
+        create(:note_on_project_snippet, project: project,
+                                         note: "snippet note")
+      end
+
+      it "adds thread key" do
+        data = Gitlab::DataBuilder::Note.build(snippet_note, user)
+
+        expect(chat_integration.execute(data)).to be(true)
+
+        expect(WebMock).to have_requested(:post, webhook_url)
+          .with(query: hash_including({ "threadKey" => /snippet .*?/ }))
+          .once
+      end
+    end
+  end
 end

spec/support/shared_examples/models/chat_integration_shared_examples.rb

@@ -35,6 +35,7 @@
     let(:user) { create(:user) }
     let(:project) { create(:project, :repository) }
     let(:webhook_url) { "https://example.gitlab.com/" }
+    let(:webhook_url_regex) { /\A#{webhook_url}.*/ }
 
     before do
       allow(subject).to receive_messages(
@@ -44,7 +45,7 @@
         webhook: webhook_url
       )
 
-      WebMock.stub_request(:post, webhook_url)
+      WebMock.stub_request(:post, webhook_url_regex)
     end
 
     shared_examples "triggered #{integration_name} integration" do |branches_to_be_notified: nil|
@@ -56,7 +57,7 @@
         result = subject.execute(sample_data)
 
         expect(result).to be(true)
-        expect(WebMock).to have_requested(:post, webhook_url).once.with { |req|
+        expect(WebMock).to have_requested(:post, webhook_url_regex).once.with { |req|
           json_body = Gitlab::Json.parse(req.body).with_indifferent_access
           expect(json_body).to include(payload)
         }
@@ -72,7 +73,7 @@
         result = subject.execute(sample_data)
 
         expect(result).to be_falsy
-        expect(WebMock).not_to have_requested(:post, webhook_url)
+        expect(WebMock).not_to have_requested(:post, webhook_url_regex)
       end
     end