From 99dfe1d5afa52eceb41773e05eb5ffaf22e58c76 Mon Sep 17 00:00:00 2001
From: Tejaswini Chile <tejaswini@chatwoot.com>
Date: Wed, 26 Apr 2023 20:23:46 +0530
Subject: [PATCH] feat: Enable template variables in channel greeting messages
 (#6971)

---
 app/drops/account_drop.rb                     |  3 ++
 app/helpers/email_helper.rb                   | 22 +++++++++++++
 .../inbox/components/WeeklyAvailability.vue   | 32 +++++++++++++++++--
 .../shared/components/GreetingsEditor.vue     |  1 +
 app/models/concerns/liquidable.rb             |  5 +--
 app/services/action_service.rb                |  3 ++
 .../automation_rules/action_service_spec.rb   | 12 +++++++
 .../template/greeting_spec.rb                 | 21 ++++++++++++
 .../template/out_of_office_spec.rb            | 17 ++++++++++
 9 files changed, 112 insertions(+), 4 deletions(-)

diff --git a/app/drops/account_drop.rb b/app/drops/account_drop.rb
index 2e3a2530f..d784475db 100644
--- a/app/drops/account_drop.rb
+++ b/app/drops/account_drop.rb
@@ -1,2 +1,5 @@
 class AccountDrop < BaseDrop
+  def name
+    @obj.try(:name)
+  end
 end
diff --git a/app/helpers/email_helper.rb b/app/helpers/email_helper.rb
index 46689ba00..05b6a53e3 100644
--- a/app/helpers/email_helper.rb
+++ b/app/helpers/email_helper.rb
@@ -10,4 +10,26 @@ module EmailHelper
   def normalize_email_with_plus_addressing(email)
     "#{email.split('@').first.split('+').first}@#{email.split('@').last}".downcase
   end
+
+  def parse_email_variables(conversation, email)
+    case email
+    when modified_liquid_content(email)
+      template = Liquid::Template.parse(modified_liquid_content(email))
+      template.render(message_drops(conversation))
+    when URI::MailTo::EMAIL_REGEXP
+      email
+    end
+  end
+
+  def modified_liquid_content(email)
+    # This regex is used to match the code blocks in the content
+    # We don't want to process liquid in code blocks
+    email.gsub(/`(.*?)`/m, '{% raw %}`\\1`{% endraw %}')
+  end
+
+  def message_drops(conversation)
+    {
+      'contact' => ContactDrop.new(conversation.contact)
+    }
+  end
 end
diff --git a/app/javascript/dashboard/routes/dashboard/settings/inbox/components/WeeklyAvailability.vue b/app/javascript/dashboard/routes/dashboard/settings/inbox/components/WeeklyAvailability.vue
index ecad7814b..5eee329b4 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/inbox/components/WeeklyAvailability.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/inbox/components/WeeklyAvailability.vue
@@ -17,7 +17,16 @@
         <div v-if="isBusinessHoursEnabled" class="business-hours-wrap">
           <label class="unavailable-input-wrap">
             {{ $t('INBOX_MGMT.BUSINESS_HOURS.UNAVAILABLE_MESSAGE_LABEL') }}
-            <textarea v-model="unavailableMessage" type="text" />
+            <label v-if="isRichEditorEnabled" class="richtext">
+              <woot-message-editor
+                v-model="unavailableMessage"
+                :enable-variables="true"
+                :is-format-mode="true"
+                class="input"
+                :min-height="4"
+              />
+            </label>
+            <textarea v-else v-model="unavailableMessage" type="text" />
           </label>
           <div class="timezone-input-wrap">
             <label>
@@ -61,7 +70,9 @@
 <script>
 import { mapGetters } from 'vuex';
 import alertMixin from 'shared/mixins/alertMixin';
+import inboxMixin from 'shared/mixins/inboxMixin';
 import SettingsSection from 'dashboard/components/SettingsSection';
+import WootMessageEditor from 'dashboard/components/widgets/WootWriter/Editor';
 import BusinessDay from './BusinessDay';
 import {
   timeSlotParse,
@@ -79,8 +90,9 @@ export default {
   components: {
     SettingsSection,
     BusinessDay,
+    WootMessageEditor,
   },
-  mixins: [alertMixin],
+  mixins: [alertMixin, inboxMixin],
   props: {
     inbox: {
       type: Object,
@@ -115,6 +127,15 @@ export default {
     timeZones() {
       return [...timeZoneOptions()];
     },
+    isRichEditorEnabled() {
+      if (
+        this.isATwilioChannel ||
+        this.isATwitterInbox ||
+        this.isAFacebookInbox
+      )
+        return false;
+      return true;
+    },
   },
   watch: {
     inbox() {
@@ -190,4 +211,11 @@ export default {
 .business-hours-wrap {
   margin-bottom: var(--space-medium);
 }
+
+.richtext {
+  padding: 0 var(--space-normal);
+  border-radius: var(--border-radius-normal);
+  border: 1px solid var(--color-border);
+  margin: 0 0 var(--space-normal);
+}
 </style>
diff --git a/app/javascript/shared/components/GreetingsEditor.vue b/app/javascript/shared/components/GreetingsEditor.vue
index 2e9130886..4d3920fd0 100644
--- a/app/javascript/shared/components/GreetingsEditor.vue
+++ b/app/javascript/shared/components/GreetingsEditor.vue
@@ -4,6 +4,7 @@
       <woot-message-editor
         v-model="greetingsMessage"
         :is-format-mode="true"
+        :enable-variables="true"
         class="input"
         :placeholder="placeholder"
         :min-height="4"
diff --git a/app/models/concerns/liquidable.rb b/app/models/concerns/liquidable.rb
index e3d6cb64d..6734dfeae 100644
--- a/app/models/concerns/liquidable.rb
+++ b/app/models/concerns/liquidable.rb
@@ -13,12 +13,13 @@ module Liquidable
       'contact' => ContactDrop.new(conversation.contact),
       'agent' => UserDrop.new(sender),
       'conversation' => ConversationDrop.new(conversation),
-      'inbox' => InboxDrop.new(inbox)
+      'inbox' => InboxDrop.new(inbox),
+      'account' => AccountDrop.new(conversation.account)
     }
   end
 
   def liquid_processable_message?
-    content.present? && message_type == 'outgoing'
+    content.present? && (message_type == 'outgoing' || message_type == 'template')
   end
 
   def process_liquid_in_content
diff --git a/app/services/action_service.rb b/app/services/action_service.rb
index 6e8a3b8ca..ecaa9ce9e 100644
--- a/app/services/action_service.rb
+++ b/app/services/action_service.rb
@@ -1,4 +1,6 @@
 class ActionService
+  include EmailHelper
+
   def initialize(conversation)
     @conversation = conversation.reload
   end
@@ -59,6 +61,7 @@ class ActionService
     emails = emails[0].gsub(/\s+/, '').split(',')
 
     emails.each do |email|
+      email = parse_email_variables(@conversation, email)
       ConversationReplyMailer.with(account: @conversation.account).conversation_transcript(@conversation, email)&.deliver_later
     end
   end
diff --git a/spec/services/automation_rules/action_service_spec.rb b/spec/services/automation_rules/action_service_spec.rb
index c95789399..0f0d09943 100644
--- a/spec/services/automation_rules/action_service_spec.rb
+++ b/spec/services/automation_rules/action_service_spec.rb
@@ -91,6 +91,7 @@ RSpec.describe AutomationRules::ActionService do
     describe '#perform with send_email_transcript action' do
       before do
         rule.actions << { action_name: 'send_email_transcript', action_params: ['contact@example.com, agent@example.com,agent1@example.com'] }
+        rule.save
       end
 
       it 'will send email to transcript to action params emails' do
@@ -102,6 +103,17 @@ RSpec.describe AutomationRules::ActionService do
 
         described_class.new(rule, account, conversation).perform
       end
+
+      it 'will send email to transcript to contacts' do
+        rule.actions = [{ action_name: 'send_email_transcript', action_params: ['{{contact.email}}'] }]
+        rule.save
+
+        mailer = double
+        allow(ConversationReplyMailer).to receive(:with).and_return(mailer)
+        allow(mailer).to receive(:conversation_transcript).with(conversation, conversation.contact.email)
+
+        described_class.new(rule.reload, account, conversation).perform
+      end
     end
   end
 end
diff --git a/spec/services/message_templates/template/greeting_spec.rb b/spec/services/message_templates/template/greeting_spec.rb
index 7d1f45d8c..3d7645e3a 100644
--- a/spec/services/message_templates/template/greeting_spec.rb
+++ b/spec/services/message_templates/template/greeting_spec.rb
@@ -8,5 +8,26 @@ describe ::MessageTemplates::Template::Greeting do
       described_class.new(conversation: conversation).perform
       expect(conversation.messages.count).to eq(1)
     end
+
+    it 'creates the greeting messages with template variable' do
+      conversation.inbox.update!(greeting_message: 'Hey, {{contact.name}} welcome to our board.')
+      described_class.new(conversation: conversation).perform
+      expect(conversation.messages.count).to eq(1)
+      expect(conversation.messages.last.content).to eq("Hey, #{conversation.contact.name} welcome to our board.")
+    end
+
+    it 'creates the greeting messages with more than one variable strings' do
+      conversation.inbox.update!(greeting_message: 'Hey, {{contact.name}} welcome to our board. - from {{account.name}}')
+      described_class.new(conversation: conversation).perform
+      expect(conversation.messages.count).to eq(1)
+      expect(conversation.messages.last.content).to eq("Hey, #{conversation.contact.name} welcome to our board. - from #{conversation.account.name}")
+    end
+
+    it 'creates the greeting messages' do
+      conversation.inbox.update!(greeting_message: 'Hello welcome to our board.')
+      described_class.new(conversation: conversation).perform
+      expect(conversation.messages.count).to eq(1)
+      expect(conversation.messages.last.content).to eq('Hello welcome to our board.')
+    end
   end
 end
diff --git a/spec/services/message_templates/template/out_of_office_spec.rb b/spec/services/message_templates/template/out_of_office_spec.rb
index ee2050a70..5fb0dbf79 100644
--- a/spec/services/message_templates/template/out_of_office_spec.rb
+++ b/spec/services/message_templates/template/out_of_office_spec.rb
@@ -9,5 +9,22 @@ describe ::MessageTemplates::Template::OutOfOffice do
       expect(conversation.messages.template.count).to eq(1)
       expect(conversation.messages.template.first.content).to eq(conversation.inbox.out_of_office_message)
     end
+
+    it 'creates the out of office messages with template variable' do
+      conversation.inbox.update!(out_of_office_message: 'Hey, {{contact.name}} we are unavailable at the moment.')
+      described_class.new(conversation: conversation).perform
+      expect(conversation.messages.count).to eq(1)
+      expect(conversation.messages.last.content).to eq("Hey, #{conversation.contact.name} we are unavailable at the moment.")
+    end
+
+    it 'creates the out of office messages with more than one variable strings' do
+      conversation.inbox.update!(out_of_office_message:
+        'Hey, {{contact.name}} we are unavailable at the moment. - from {{account.name}}')
+      described_class.new(conversation: conversation).perform
+      expect(conversation.messages.count).to eq(1)
+      expect(conversation.messages.last.content).to eq(
+        "Hey, #{conversation.contact.name} we are unavailable at the moment. - from #{conversation.account.name}"
+      )
+    end
   end
 end