Merge branch 'zj-format-chat-messages' into 'master'

Format chat messages

Closes #24917 and #25746

See merge request !8528

16 files changed, 442 insertions, 182 deletions

diff --git a/lib/gitlab/chat_commands/base_command.rb b/lib/gitlab/chat_commands/base_command.rb
index 4fe53ce93a9..25da8474e95 100644
--- a/lib/gitlab/chat_commands/base_command.rb
+++ b/lib/gitlab/chat_commands/base_command.rb
@@ -42,10 +42,6 @@ module Gitlab
       def find_by_iid(iid)
         collection.find_by(iid: iid)
       end
-
-      def presenter
-        Gitlab::ChatCommands::Presenter.new
-      end
     end
   end
 end
diff --git a/lib/gitlab/chat_commands/command.rb b/lib/gitlab/chat_commands/command.rb
index 145086755e4..f34ed0f4cf2 100644
--- a/lib/gitlab/chat_commands/command.rb
+++ b/lib/gitlab/chat_commands/command.rb
@@ -3,7 +3,7 @@ module Gitlab
     class Command < BaseCommand
       COMMANDS = [
         Gitlab::ChatCommands::IssueShow,
-        Gitlab::ChatCommands::IssueCreate,
+        Gitlab::ChatCommands::IssueNew,
         Gitlab::ChatCommands::IssueSearch,
         Gitlab::ChatCommands::Deploy,
       ].freeze
@@ -13,51 +13,32 @@ module Gitlab
 
         if command
           if command.allowed?(project, current_user)
-            present command.new(project, current_user, params).execute(match)
+            command.new(project, current_user, params).execute(match)
           else
-            access_denied
+            Gitlab::ChatCommands::Presenters::Access.new.access_denied
           end
         else
-          help(help_messages)
+          Gitlab::ChatCommands::Help.new(project, current_user, params).execute(available_commands, params[:text])
         end
       end
 
       def match_command
         match = nil
-        service = available_commands.find do |klass|
-          match = klass.match(command)
-        end
+        service =
+          available_commands.find do |klass|
+            match = klass.match(params[:text])
+          end
 
         [service, match]
       end
 
       private
 
-      def help_messages
-        available_commands.map(&:help_message)
-      end
-
       def available_commands
         COMMANDS.select do |klass|
           klass.available?(project)
         end
       end
-
-      def command
-        params[:text]
-      end
-
-      def help(messages)
-        presenter.help(messages, params[:command])
-      end
-
-      def access_denied
-        presenter.access_denied
-      end
-
-      def present(resource)
-        presenter.present(resource)
-      end
     end
   end
 end
diff --git a/lib/gitlab/chat_commands/deploy.rb b/lib/gitlab/chat_commands/deploy.rb
index 7127d2f6d04..458d90f84e8 100644
--- a/lib/gitlab/chat_commands/deploy.rb
+++ b/lib/gitlab/chat_commands/deploy.rb
@@ -1,8 +1,6 @@
 module Gitlab
   module ChatCommands
     class Deploy < BaseCommand
-      include Gitlab::Routing.url_helpers
-
       def self.match(text)
         /\Adeploy\s+(?<from>\S+.*)\s+to+\s+(?<to>\S+.*)\z/.match(text)
       end
@@ -24,35 +22,29 @@ module Gitlab
         to = match[:to]
 
         actions = find_actions(from, to)
-        return unless actions.present?
 
-        if actions.one?
-          play!(from, to, actions.first)
+        if actions.none?
+          Gitlab::ChatCommands::Presenters::Deploy.new(nil).no_actions
+        elsif actions.one?
+          action = play!(from, to, actions.first)
+          Gitlab::ChatCommands::Presenters::Deploy.new(action).present(from, to)
         else
-          Result.new(:error, 'Too many actions defined')
+          Gitlab::ChatCommands::Presenters::Deploy.new(actions).too_many_actions
         end
       end
 
       private
 
       def play!(from, to, action)
-        new_action = action.play(current_user)
-
-        Result.new(:success, "Deployment from #{from} to #{to} started. Follow the progress: #{url(new_action)}.")
+        action.play(current_user)
       end
 
       def find_actions(from, to)
         environment = project.environments.find_by(name: from)
-        return unless environment
+        return [] unless environment
 
         environment.actions_for(to).select(&:starts_environment?)
       end
-
-      def url(subject)
-        polymorphic_url(
-          [subject.project.namespace.becomes(Namespace), subject.project, subject]
-        )
-      end
     end
   end
 end
diff --git a/lib/gitlab/chat_commands/help.rb b/lib/gitlab/chat_commands/help.rb
new file mode 100644
index 00000000000..6c0e4d304a4
--- /dev/null
+++ b/lib/gitlab/chat_commands/help.rb
@@ -0,0 +1,28 @@
+module Gitlab
+  module ChatCommands
+    class Help < BaseCommand
+      # This class has to be used last, as it always matches. It has to match
+      # because other commands were not triggered and we want to show the help
+      # command
+      def self.match(_text)
+        true
+      end
+
+      def self.help_message
+        'help'
+      end
+
+      def self.allowed?(_project, _user)
+        true
+      end
+
+      def execute(commands, text)
+        Gitlab::ChatCommands::Presenters::Help.new(commands).present(trigger, text)
+      end
+
+      def trigger
+        params[:command]
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/issue_create.rb b/lib/gitlab/chat_commands/issue_new.rb
index cefb6775db8..016054ecd46 100644
--- a/lib/gitlab/chat_commands/issue_create.rb
+++ b/lib/gitlab/chat_commands/issue_new.rb
@@ -1,8 +1,8 @@
 module Gitlab
   module ChatCommands
-    class IssueCreate < IssueCommand
+    class IssueNew < IssueCommand
       def self.match(text)
-        # we can not match \n with the dot by passing the m modifier as than 
+        # we can not match \n with the dot by passing the m modifier as than
         # the title and description are not seperated
         /\Aissue\s+(new|create)\s+(?<title>[^\n]*)\n*(?<description>(.|\n)*)/.match(text)
       end
@@ -19,8 +19,24 @@ module Gitlab
         title = match[:title]
         description = match[:description].to_s.rstrip
 
+        issue = create_issue(title: title, description: description)
+
+        if issue.persisted?
+          presenter(issue).present
+        else
+          presenter(issue).display_errors
+        end
+      end
+
+      private
+
+      def create_issue(title:, description:)
         Issues::CreateService.new(project, current_user, title: title, description: description).execute
       end
+
+      def presenter(issue)
+        Gitlab::ChatCommands::Presenters::IssueNew.new(issue)
+      end
     end
   end
 end
diff --git a/lib/gitlab/chat_commands/issue_search.rb b/lib/gitlab/chat_commands/issue_search.rb
index 51bf80c800b..3491b53093e 100644
--- a/lib/gitlab/chat_commands/issue_search.rb
+++ b/lib/gitlab/chat_commands/issue_search.rb
@@ -10,7 +10,13 @@ module Gitlab
       end
 
       def execute(match)
-        collection.search(match[:query]).limit(QUERY_LIMIT)
+        issues = collection.search(match[:query]).limit(QUERY_LIMIT)
+
+        if issues.present?
+          Presenters::IssueSearch.new(issues).present
+        else
+          Presenters::Access.new(issues).not_found
+        end
       end
     end
   end
diff --git a/lib/gitlab/chat_commands/issue_show.rb b/lib/gitlab/chat_commands/issue_show.rb
index 2a45d49cf6b..d6013f4d10c 100644
--- a/lib/gitlab/chat_commands/issue_show.rb
+++ b/lib/gitlab/chat_commands/issue_show.rb
@@ -10,7 +10,13 @@ module Gitlab
       end
 
       def execute(match)
-        find_by_iid(match[:iid])
+        issue = find_by_iid(match[:iid])
+
+        if issue
+          Gitlab::ChatCommands::Presenters::IssueShow.new(issue).present
+        else
+          Gitlab::ChatCommands::Presenters::Access.new.not_found
+        end
       end
     end
   end
diff --git a/lib/gitlab/chat_commands/presenter.rb b/lib/gitlab/chat_commands/presenter.rb
deleted file mode 100644
index 8930a21f406..00000000000
--- a/lib/gitlab/chat_commands/presenter.rb
+++ /dev/null
@@ -1,131 +0,0 @@
-module Gitlab
-  module ChatCommands
-    class Presenter
-      include Gitlab::Routing
-
-      def authorize_chat_name(url)
-        message = if url
-                    ":wave: Hi there! Before I do anything for you, please [connect your GitLab account](#{url})."
-                  else
-                    ":sweat_smile: Couldn't identify you, nor can I autorize you!"
-                  end
-
-        ephemeral_response(message)
-      end
-
-      def help(commands, trigger)
-        if commands.none?
-          ephemeral_response("No commands configured")
-        else
-          commands.map! { |command| "#{trigger} #{command}" }
-          message = header_with_list("Available commands", commands)
-
-          ephemeral_response(message)
-        end
-      end
-
-      def present(subject)
-        return not_found unless subject
-
-        if subject.is_a?(Gitlab::ChatCommands::Result)
-          show_result(subject)
-        elsif subject.respond_to?(:count)
-          if subject.none?
-            not_found
-          elsif subject.one?
-            single_resource(subject.first)
-          else
-            multiple_resources(subject)
-          end
-        else
-          single_resource(subject)
-        end
-      end
-
-      def access_denied
-        ephemeral_response("Whoops! That action is not allowed. This incident will be [reported](https://xkcd.com/838/).")
-      end
-
-      private
-
-      def show_result(result)
-        case result.type
-        when :success
-          in_channel_response(result.message)
-        else
-          ephemeral_response(result.message)
-        end
-      end
-
-      def not_found
-        ephemeral_response("404 not found! GitLab couldn't find what you were looking for! :boom:")
-      end
-
-      def single_resource(resource)
-        return error(resource) if resource.errors.any? || !resource.persisted?
-
-        message = "#{title(resource)}:"
-        message << "\n\n#{resource.description}" if resource.try(:description)
-
-        in_channel_response(message)
-      end
-
-      def multiple_resources(resources)
-        titles = resources.map { |resource| title(resource) }
-
-        message = header_with_list("Multiple results were found:", titles)
-
-        ephemeral_response(message)
-      end
-
-      def error(resource)
-        message = header_with_list("The action was not successful, because:", resource.errors.messages)
-
-        ephemeral_response(message)
-      end
-
-      def title(resource)
-        reference = resource.try(:to_reference) || resource.try(:id)
-        title = resource.try(:title) || resource.try(:name)
-
-        "[#{reference} #{title}](#{url(resource)})"
-      end
-
-      def header_with_list(header, items)
-        message = [header]
-
-        items.each do |item|
-          message << "- #{item}"
-        end
-
-        message.join("\n")
-      end
-
-      def url(resource)
-        url_for(
-          [
-            resource.project.namespace.becomes(Namespace),
-            resource.project,
-            resource
-          ]
-        )
-      end
-
-      def ephemeral_response(message)
-        {
-          response_type: :ephemeral,
-          text: message,
-          status: 200
-        }
-      end
-
-      def in_channel_response(message)
-        {
-          response_type: :in_channel,
-          text: message,
-          status: 200
-        }
-      end
-    end
-  end
-end
diff --git a/lib/gitlab/chat_commands/presenters/access.rb b/lib/gitlab/chat_commands/presenters/access.rb
new file mode 100644
index 00000000000..92f4fa17f78
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/access.rb
@@ -0,0 +1,40 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class Access < Presenters::Base
+        def access_denied
+          ephemeral_response(text: "Whoops! This action is not allowed. This incident will be [reported](https://xkcd.com/838/).")
+        end
+
+        def not_found
+          ephemeral_response(text: "404 not found! GitLab couldn't find what you were looking for! :boom:")
+        end
+
+        def authorize
+          message =
+            if @resource
+              ":wave: Hi there! Before I do anything for you, please [connect your GitLab account](#{@resource})."
+            else
+              ":sweat_smile: Couldn't identify you, nor can I autorize you!"
+            end
+
+          ephemeral_response(text: message)
+        end
+
+        def unknown_command(commands)
+          ephemeral_response(text: help_message(trigger))
+        end
+
+        private
+
+        def help_message(trigger)
+          header_with_list("Command not found, these are the commands you can use", full_commands(trigger))
+        end
+
+        def full_commands(trigger)
+          @resource.map { |command| "#{trigger} #{command.help_message}" }
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/base.rb b/lib/gitlab/chat_commands/presenters/base.rb
new file mode 100644
index 00000000000..2700a5a2ad5
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/base.rb
@@ -0,0 +1,77 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class Base
+        include Gitlab::Routing.url_helpers
+
+        def initialize(resource = nil)
+          @resource = resource
+        end
+
+        def display_errors
+          message = header_with_list("The action was not successful, because:", @resource.errors.full_messages)
+
+          ephemeral_response(text: message)
+        end
+
+        private
+
+        def header_with_list(header, items)
+          message = [header]
+
+          items.each do |item|
+            message << "- #{item}"
+          end
+
+          message.join("\n")
+        end
+
+        def ephemeral_response(message)
+          response = {
+            response_type: :ephemeral,
+            status: 200
+          }.merge(message)
+
+          format_response(response)
+        end
+
+        def in_channel_response(message)
+          response = {
+            response_type: :in_channel,
+            status: 200
+          }.merge(message)
+
+          format_response(response)
+        end
+
+        def format_response(response)
+          response[:text] = format(response[:text]) if response.has_key?(:text)
+
+          if response.has_key?(:attachments)
+            response[:attachments].each do |attachment|
+              attachment[:pretext] = format(attachment[:pretext]) if attachment[:pretext]
+              attachment[:text] = format(attachment[:text]) if attachment[:text]
+            end
+          end
+
+          response
+        end
+
+        # Convert Markdown to slacks format
+        def format(string)
+          Slack::Notifier::LinkFormatter.format(string)
+        end
+
+        def resource_url
+          url_for(
+            [
+              @resource.project.namespace.becomes(Namespace),
+              @resource.project,
+              @resource
+            ]
+          )
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/deploy.rb b/lib/gitlab/chat_commands/presenters/deploy.rb
new file mode 100644
index 00000000000..863d0bf99ca
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/deploy.rb
@@ -0,0 +1,21 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class Deploy < Presenters::Base
+        def present(from, to)
+          message = "Deployment started from #{from} to #{to}. [Follow its progress](#{resource_url})."
+
+          in_channel_response(text: message)
+        end
+
+        def no_actions
+          ephemeral_response(text: "No action found to be executed")
+        end
+
+        def too_many_actions
+          ephemeral_response(text: "Too many actions defined")
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/help.rb b/lib/gitlab/chat_commands/presenters/help.rb
new file mode 100644
index 00000000000..cd47b7f4c6a
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/help.rb
@@ -0,0 +1,27 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class Help < Presenters::Base
+        def present(trigger, text)
+          ephemeral_response(text: help_message(trigger, text))
+        end
+
+        private
+
+        def help_message(trigger, text)
+          return "No commands available :thinking_face:" unless @resource.present?
+
+          if text.start_with?('help')
+            header_with_list("Available commands", full_commands(trigger))
+          else
+            header_with_list("Unknown command, these commands are available", full_commands(trigger)) 
+          end
+        end
+
+        def full_commands(trigger)
+          @resource.map { |command| "#{trigger} #{command.help_message}" }
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/issuable.rb b/lib/gitlab/chat_commands/presenters/issuable.rb
new file mode 100644
index 00000000000..dfb1c8f6616
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/issuable.rb
@@ -0,0 +1,43 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      module Issuable
+        def color(issuable)
+          issuable.open? ? '#38ae67' : '#d22852'
+        end
+
+        def status_text(issuable)
+          issuable.open? ? 'Open' : 'Closed'
+        end
+
+        def project
+          @resource.project
+        end
+
+        def author
+          @resource.author
+        end
+
+        def fields
+          [
+            {
+              title: "Assignee",
+              value: @resource.assignee ? @resource.assignee.name : "_None_",
+              short: true
+            },
+            {
+              title: "Milestone",
+              value: @resource.milestone ? @resource.milestone.title : "_None_",
+              short: true
+            },
+            {
+              title: "Labels",
+              value: @resource.labels.any? ? @resource.label_names : "_None_",
+              short: true
+            }
+          ]
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/issue_new.rb b/lib/gitlab/chat_commands/presenters/issue_new.rb
new file mode 100644
index 00000000000..a1a3add56c9
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/issue_new.rb
@@ -0,0 +1,50 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class IssueNew < Presenters::Base
+        include Presenters::Issuable
+
+        def present
+          in_channel_response(new_issue)
+        end
+
+        private
+
+        def new_issue 
+          {
+            attachments: [
+              {
+                title:        "#{@resource.title} · #{@resource.to_reference}",
+                title_link:   resource_url,
+                author_name:  author.name,
+                author_icon:  author.avatar_url,
+                fallback:     "New issue #{@resource.to_reference}: #{@resource.title}",
+                pretext:      pretext,
+                color:        color(@resource),
+                fields:       fields,
+                mrkdwn_in: [
+                  :title,
+                  :pretext,
+                  :text,
+                  :fields
+                ]
+              }
+            ]
+          }
+        end
+
+        def pretext
+          "I created an issue on #{author_profile_link}'s behalf: **#{@resource.to_reference}** in #{project_link}"
+        end
+
+        def project_link
+          "[#{project.name_with_namespace}](#{projects_url(project)})"
+        end
+
+        def author_profile_link
+          "[#{author.to_reference}](#{url_for(author)})"
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/issue_search.rb b/lib/gitlab/chat_commands/presenters/issue_search.rb
new file mode 100644
index 00000000000..3478359b91d
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/issue_search.rb
@@ -0,0 +1,47 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class IssueSearch < Presenters::Base
+        include Presenters::Issuable
+
+        def present
+          text = if @resource.count >= 5
+                   "Here are the first 5 issues I found:"
+                 elsif @resource.one?
+                   "Here is the only issue I found:"
+                 else
+                   "Here are the #{@resource.count} issues I found:"
+                 end
+
+          ephemeral_response(text: text, attachments: attachments)
+        end
+
+        private
+
+        def attachments
+          @resource.map do |issue|
+            url = "[#{issue.to_reference}](#{url_for([namespace, project, issue])})"
+
+            {
+              color: color(issue),
+              fallback: "#{issue.to_reference} #{issue.title}",
+              text: "#{url} · #{issue.title} (#{status_text(issue)})",
+
+              mrkdwn_in: [
+                :text
+              ]
+            }
+          end
+        end
+
+        def project
+          @project ||= @resource.first.project
+        end
+
+        def namespace
+          @namespace ||= project.namespace.becomes(Namespace)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/chat_commands/presenters/issue_show.rb b/lib/gitlab/chat_commands/presenters/issue_show.rb
new file mode 100644
index 00000000000..fe5847ccd15
--- /dev/null
+++ b/lib/gitlab/chat_commands/presenters/issue_show.rb
@@ -0,0 +1,61 @@
+module Gitlab
+  module ChatCommands
+    module Presenters
+      class IssueShow < Presenters::Base
+        include Presenters::Issuable
+
+        def present
+          if @resource.confidential?
+            ephemeral_response(show_issue)
+          else
+            in_channel_response(show_issue)
+          end
+        end
+
+        private
+
+        def show_issue
+          {
+            attachments: [
+              {
+                title:        "#{@resource.title} · #{@resource.to_reference}",
+                title_link:   resource_url,
+                author_name:  author.name,
+                author_icon:  author.avatar_url,
+                fallback:     "Issue #{@resource.to_reference}: #{@resource.title}",
+                pretext:      pretext,
+                text:         text,
+                color:        color(@resource),
+                fields:       fields,
+                mrkdwn_in: [
+                  :pretext,
+                  :text,
+                  :fields
+                ]
+              }
+            ]
+          }
+        end
+
+        def text
+          message = "**#{status_text(@resource)}**"
+
+          if @resource.upvotes.zero? && @resource.downvotes.zero? && @resource.user_notes_count.zero?
+            return message
+          end
+
+          message << " · "
+          message << ":+1: #{@resource.upvotes} " unless @resource.upvotes.zero?
+          message << ":-1: #{@resource.downvotes} " unless @resource.downvotes.zero?
+          message << ":speech_balloon: #{@resource.user_notes_count}" unless @resource.user_notes_count.zero?
+
+          message
+        end
+
+        def pretext
+          "Issue *#{@resource.to_reference}* from #{project.name_with_namespace}"
+        end
+      end
+    end
+  end
+end