Merge branch 'tulir/matrix-notify-improvements' into 'master'

Update Matrix notification integration

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178475



Merged-by: Bojan Marjanovic <bmarjanovic@gitlab.com>
Approved-by: Bojan Marjanovic <bmarjanovic@gitlab.com>
Reviewed-by: Justin Ho Tuan Duong <hduong@gitlab.com>
Reviewed-by: Bojan Marjanovic <bmarjanovic@gitlab.com>
Co-authored-by: Tulir Asokan <tulir@maunium.net>

app/models/integrations/matrix.rb

@@ -4,12 +4,12 @@ module Integrations
   class Matrix < Integration
     include Base::ChatNotification
 
-    MATRIX_HOSTNAME = "%{hostname}/_matrix/client/v3/rooms/%{roomId}/send/m.room.message/?access_token=%{token}" # gitleaks:allow
+    MATRIX_HOSTNAME = "%{hostname}/_matrix/client/v3/rooms/%{roomId}/send/m.room.message/"
 
     field :hostname,
       section: SECTION_TYPE_CONNECTION,
-      help: 'Custom hostname of the Matrix server. The default value is `https://matrix.org`.',
-      placeholder: 'https://matrix.org',
+      help: 'Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`.',
+      placeholder: 'https://matrix-client.matrix.org',
       exposes_secrets: true,
       required: false
 
@@ -82,11 +82,11 @@ def self.supported_events
     private
 
     def set_webhook
-      hostname = self.hostname.presence || 'https://matrix.org'
+      hostname = self.hostname.presence || 'https://matrix-client.matrix.org'
 
       return unless token.present? && room.present?
 
-      self.webhook = format(MATRIX_HOSTNAME, hostname: hostname, roomId: room, token: token)
+      self.webhook = format(MATRIX_HOSTNAME, hostname: hostname, roomId: room)
     end
 
     def notify(message, _opts)
@@ -94,12 +94,15 @@ def notify(message, _opts)
 
       body = {
         body: message.summary,
-        msgtype: 'm.text',
+        msgtype: 'm.notice',
         format: 'org.matrix.custom.html',
         formatted_body: Banzai.render_and_post_process(message.summary, context)
       }.compact_blank
 
-      header = { 'Content-Type' => 'application/json' }
+      header = {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{token}"
+      }
       url = URI.parse(webhook)
       url.path << (Time.current.to_f * 1000).round.to_s
       response = Gitlab::HTTP.put(url, headers: header, body: Gitlab::Json.dump(body))

spec/models/integrations/matrix_spec.rb

@@ -7,7 +7,7 @@
     let(:payload) do
       {
         body: be_present,
-        msgtype: 'm.text',
+        msgtype: 'm.notice',
         format: 'org.matrix.custom.html',
         formatted_body: be_present
       }
@@ -41,7 +41,7 @@
 
     it 'sets webhook value' do
       expect(integration).to be_valid
-      expect(integration.webhook).to start_with('https://matrix.org/_matrix/client/v3/rooms/!qPKKM111FFKKsfoCVy:matrix')
+      expect(integration.webhook).to start_with("https://matrix-client.matrix.org/_matrix/client/v3/rooms/#{subject.room}")
     end
 
     context 'with custom hostname' do
@@ -58,12 +58,18 @@
 
   describe '#notify' do
     let(:message) { instance_double(Integrations::ChatMessage::PushMessage, summary: '_Test message') }
-    let(:header) { { 'Content-Type' => 'application/json' } }
+    let(:header) do
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{subject.token}"
+      }
+    end
+
     let(:response) { instance_double(HTTParty::Response, success?: true) }
     let(:body) do
       {
         body: '_Test message',
-        msgtype: 'm.text',
+        msgtype: 'm.notice',
         format: 'org.matrix.custom.html',
         formatted_body: Banzai.render_and_post_process('_Test message', context)
       }.compact_blank