Merge branch 'remove_hipchat_gem' into 'master'

Remove hipchat gem, and make HipChat service a no-op

See merge request gitlab-org/gitlab!57434

Gemfile

@@ -238,9 +238,6 @@ gem 'redis-rails', '~> 5.0.2'
 # Discord integration
 gem 'discordrb-webhooks', '~> 3.4', require: false
 
-# HipChat integration
-gem 'hipchat', '~> 1.5.0'
-
 # Jira integration
 gem 'jira-ruby', '~> 2.1.4'
 gem 'atlassian-jwt', '~> 0.2.0'

Gemfile.lock

@@ -593,9 +593,6 @@ GEM
       railties (>= 5.0)
     heapy (0.2.0)
       thor
-    hipchat (1.5.2)
-      httparty
-      mimemagic
     html-pipeline (2.13.2)
       activesupport (>= 2)
       nokogiri (>= 1.4)
@@ -1456,7 +1453,6 @@ DEPENDENCIES
   hashie
   hashie-forbidden_attributes
   health_check (~> 3.0)
-  hipchat (~> 1.5.0)
   html-pipeline (~> 2.13.2)
   html2text
   httparty (~> 0.16.4)

app/models/project_services/hipchat_service.rb

@@ -52,12 +52,8 @@ class HipchatService < Service
   end
 
   def execute(data)
-    return unless supported_events.include?(data[:object_kind])
-
-    message = create_message(data)
-    return unless message.present?
-
-    gate[room].send('GitLab', message, message_options(data)) # rubocop:disable GitlabSecurity/PublicSend
+    # We removed the hipchat gem due to https://gitlab.com/gitlab-org/gitlab/-/issues/325851#note_537143149
+    # HipChat is unusable anyway, so do nothing in this method
   end
 
   def test(data)
@@ -72,71 +68,14 @@ class HipchatService < Service
 
   private
 
-  def gate
-    options = { api_version: api_version.presence || 'v2' }
-    options[:server_url] = server unless server.blank?
-    @gate ||= HipChat::Client.new(token, options)
-  end
-
   def message_options(data = nil)
     { notify: notify.present? && Gitlab::Utils.to_boolean(notify), color: message_color(data) }
   end
 
-  def create_message(data)
-    object_kind = data[:object_kind]
-
-    case object_kind
-    when "push", "tag_push"
-      create_push_message(data)
-    when "issue"
-      create_issue_message(data) unless update?(data)
-    when "merge_request"
-      create_merge_request_message(data) unless update?(data)
-    when "note"
-      create_note_message(data)
-    when "pipeline"
-      create_pipeline_message(data) if should_pipeline_be_notified?(data)
-    end
-  end
-
   def render_line(text)
     markdown(text.lines.first.chomp, pipeline: :single_line) if text
   end
 
-  def create_push_message(push)
-    ref_type = Gitlab::Git.tag_ref?(push[:ref]) ? 'tag' : 'branch'
-    ref = Gitlab::Git.ref_name(push[:ref])
-
-    before = push[:before]
-    after = push[:after]
-
-    message = []
-    message << "#{push[:user_name]} "
-
-    if Gitlab::Git.blank_ref?(before)
-      message << "pushed new #{ref_type} <a href=\""\
-                 "#{project_url}/commits/#{CGI.escape(ref)}\">#{ref}</a>"\
-                 " to #{project_link}\n"
-    elsif Gitlab::Git.blank_ref?(after)
-      message << "removed #{ref_type} <b>#{ref}</b> from <a href=\"#{project.web_url}\">#{project_name}</a> \n"
-    else
-      message << "pushed to #{ref_type} <a href=\""\
-                  "#{project.web_url}/commits/#{CGI.escape(ref)}\">#{ref}</a> "
-      message << "of <a href=\"#{project.web_url}\">#{project.full_name.gsub!(/\s/, '')}</a> "
-      message << "(<a href=\"#{project.web_url}/compare/#{before}...#{after}\">Compare changes</a>)"
-
-      push[:commits].take(MAX_COMMITS).each do |commit|
-        message << "<br /> - #{render_line(commit[:message])} (<a href=\"#{commit[:url]}\">#{commit[:id][0..5]}</a>)"
-      end
-
-      if push[:commits].count > MAX_COMMITS
-        message << "<br />... #{push[:commits].count - MAX_COMMITS} more commits"
-      end
-    end
-
-    message.join
-  end
-
   def markdown(text, options = {})
     return "" unless text
 
@@ -155,109 +94,10 @@ class HipchatService < Service
     sanitized_html.truncate(200, separator: ' ', omission: '...')
   end
 
-  def create_issue_message(data)
-    user_name = data[:user][:name]
-
-    obj_attr = data[:object_attributes]
-    obj_attr = HashWithIndifferentAccess.new(obj_attr)
-    title = render_line(obj_attr[:title])
-    state = Issue.available_states.key(obj_attr[:state_id])
-    issue_iid = obj_attr[:iid]
-    issue_url = obj_attr[:url]
-    description = obj_attr[:description]
-
-    issue_link = "<a href=\"#{issue_url}\">issue ##{issue_iid}</a>"
-
-    message = ["#{user_name} #{state} #{issue_link} in #{project_link}: <b>#{title}</b>"]
-    message << "<pre>#{markdown(description)}</pre>"
-
-    message.join
-  end
-
-  def create_merge_request_message(data)
-    user_name = data[:user][:name]
-
-    obj_attr = data[:object_attributes]
-    obj_attr = HashWithIndifferentAccess.new(obj_attr)
-    merge_request_id = obj_attr[:iid]
-    state = obj_attr[:state]
-    description = obj_attr[:description]
-    title = render_line(obj_attr[:title])
-
-    merge_request_url = "#{project_url}/-/merge_requests/#{merge_request_id}"
-    merge_request_link = "<a href=\"#{merge_request_url}\">merge request !#{merge_request_id}</a>"
-    message = ["#{user_name} #{state} #{merge_request_link} in " \
-      "#{project_link}: <b>#{title}</b>"]
-
-    message << "<pre>#{markdown(description)}</pre>"
-    message.join
-  end
-
   def format_title(title)
     "<b>#{render_line(title)}</b>"
   end
 
-  def create_note_message(data)
-    data = HashWithIndifferentAccess.new(data)
-    user_name = data[:user][:name]
-
-    obj_attr = HashWithIndifferentAccess.new(data[:object_attributes])
-    note = obj_attr[:note]
-    note_url = obj_attr[:url]
-    noteable_type = obj_attr[:noteable_type]
-    commit_id = nil
-
-    case noteable_type
-    when "Commit"
-      commit_attr = HashWithIndifferentAccess.new(data[:commit])
-      commit_id = commit_attr[:id]
-      subject_desc = commit_id
-      subject_desc = Commit.truncate_sha(subject_desc)
-      subject_type = "commit"
-      title = format_title(commit_attr[:message])
-    when "Issue"
-      subj_attr = HashWithIndifferentAccess.new(data[:issue])
-      subject_id = subj_attr[:iid]
-      subject_desc = "##{subject_id}"
-      subject_type = "issue"
-      title = format_title(subj_attr[:title])
-    when "MergeRequest"
-      subj_attr = HashWithIndifferentAccess.new(data[:merge_request])
-      subject_id = subj_attr[:iid]
-      subject_desc = "!#{subject_id}"
-      subject_type = "merge request"
-      title = format_title(subj_attr[:title])
-    when "Snippet"
-      subj_attr = HashWithIndifferentAccess.new(data[:snippet])
-      subject_id = subj_attr[:id]
-      subject_desc = "##{subject_id}"
-      subject_type = "snippet"
-      title = format_title(subj_attr[:title])
-    end
-
-    subject_html = "<a href=\"#{note_url}\">#{subject_type} #{subject_desc}</a>"
-    message = ["#{user_name} commented on #{subject_html} in #{project_link}: "]
-    message << title
-
-    message << "<pre>#{markdown(note, ref: commit_id)}</pre>"
-    message.join
-  end
-
-  def create_pipeline_message(data)
-    pipeline_attributes = data[:object_attributes]
-    pipeline_id = pipeline_attributes[:id]
-    ref_type = pipeline_attributes[:tag] ? 'tag' : 'branch'
-    ref = pipeline_attributes[:ref]
-    user_name = (data[:user] && data[:user][:name]) || 'API'
-    status = pipeline_attributes[:status]
-    duration = pipeline_attributes[:duration]
-
-    branch_link = "<a href=\"#{project_url}/-/commits/#{CGI.escape(ref)}\">#{ref}</a>"
-    pipeline_url = "<a href=\"#{project_url}/-/pipelines/#{pipeline_id}\">##{pipeline_id}</a>"
-
-    "#{project_link}: Pipeline #{pipeline_url} of #{branch_link} #{ref_type} by #{user_name} #{humanized_status(status)} in #{duration} second(s)"
-  end
-
   def message_color(data)
     pipeline_status_color(data) || color || 'yellow'
   end
@@ -309,5 +149,3 @@ class HipchatService < Service
     end
   end
 end
-
-HipchatService.prepend_if_ee('EE::HipchatService')

changelogs/unreleased/remove_hipchat_gem.yml

+---
+title: Make HipChat project service do nothing
+merge_request: 57434
+author:
+type: removed

config/initializers/hipchat_client_patch.rb

-# frozen_string_literal: true
-# This monkey patches the HTTParty used in https://github.com/hipchat/hipchat-rb.
-module HipChat
-  class Client
-    connection_adapter ::Gitlab::HTTPConnectionAdapter
-  end
-
-  class Room
-    connection_adapter ::Gitlab::HTTPConnectionAdapter
-  end
-
-  class User
-    connection_adapter ::Gitlab::HTTPConnectionAdapter
-  end
-end

doc/user/project/integrations/hipchat.md

@@ -4,7 +4,12 @@ group: Ecosystem
 info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
 ---
 
-# Atlassian HipChat **(FREE)**
+# Atlassian HipChat (Deprecated) **(FREE)**
+
+As of [GitLab
+13.11](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57434), the
+HipChat integration will not send any notifications to HipChat. This
+integration is also deprecated.
 
 GitLab provides a way to send HipChat notifications upon a number of events,
 such as when a user pushes code, creates a branch or tag, adds a comment, and

ee/app/models/ee/hipchat_service.rb

-# frozen_string_literal: true
-
-module EE
-  module HipchatService
-    extend ::Gitlab::Utils::Override
-
-    override :create_merge_request_message
-    def create_merge_request_message(data)
-      data = data.deep_symbolize_keys
-      obj_attr = data[:object_attributes]
-
-      # This allows us to correct the `:state` field without having to inject
-      # this code in the middle of `create_merge_request_message`.
-      obj_attr[:state] = 'approved' if obj_attr[:action] == 'approved'
-
-      super(data)
-    end
-  end
-end

ee/spec/models/project_services/hipchat_service_spec.rb

-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe HipchatService do
-  let(:hipchat) { described_class.new }
-  let(:user)    { create(:user) }
-  let(:project) { create(:project, :repository) }
-  let(:api_url) { 'https://hipchat.example.com/v2/room/123456/notification?auth_token=verySecret' }
-  let(:project_name) { project.full_name.gsub(/\s/, '') }
-  let(:token) { 'verySecret' }
-  let(:server_url) { 'https://hipchat.example.com'}
-  let(:merge_request) { create(:merge_request, description: '**please** fix', title: 'Awesome merge request', target_project: project, source_project: project) }
-  let(:merge_service) { MergeRequests::CreateService.new(project, user) }
-  let(:approved_merge_sample_data) { merge_service.hook_data(merge_request, 'approved') }
-
-  before do
-    allow(hipchat).to receive_messages(
-      project_id: project.id,
-      project: project,
-      room: 123456,
-      server: server_url,
-      token: token
-    )
-    WebMock.stub_request(:post, api_url)
-  end
-
-  it 'creates a message for approved merge requests' do
-    message = hipchat.send(:create_merge_request_message, approved_merge_sample_data)
-
-    obj_attr = approved_merge_sample_data[:object_attributes]
-    expect(message).to eq("#{user.name} approved " \
-                          "<a href=\"#{obj_attr[:url]}\">merge request !#{obj_attr['iid']}</a> in " \
-                          "<a href=\"#{project.web_url}\">#{project_name}</a>: " \
-                          '<b>Awesome merge request</b>' \
-                          '<pre><strong>please</strong> fix</pre>')
-  end
-end