Conversation mailer/improvements (#922)

improves the conversation_mailer.rb by making it more concise and
informative for the recipient. removes duplicating subject line in the
body and provides sender details in the from address

Author: rsmithlal

app/mailers/better_together/conversation_mailer.rb

@@ -11,14 +11,21 @@ def new_message_notification # rubocop:todo Metrics/MethodLength, Metrics/AbcSiz
       @recipient = params[:recipient]
       @sender = @message.sender
 
+      subject = t('better_together.conversation_mailer.new_message_notification.subject')
+      if @conversation.title.present?
+        subject = t('better_together.conversation_mailer.new_message_notification.subject_with_title',
+                    conversation: @conversation.title)
+      end
+
       # Override time zone and locale if necessary
       self.locale = @recipient.locale
       self.time_zone = @recipient.time_zone
 
       mail(to: @recipient.email,
-           subject: t('better_together.conversation_mailer.new_message_notification.subject',
-                      platform: @platform.name,
-                      conversation: @conversation.title))
+           from: t('better_together.conversation_mailer.new_message_notification.from_address',
+                   sender_name: @sender.name,
+                   from_address: default_params[:from]),
+           subject:)
     end
     # rubocop:enable Metrics/AbcSize
   end

app/views/better_together/conversation_mailer/new_message_notification.html.erb

@@ -1,19 +1,11 @@
 <!-- app/views/better_together/conversation_mailer/new_message_notification.html.erb -->
 
-<h2><%= t('.subject', platform: @platform.name, conversation: @conversation.title) %></h2>
-
 <p><%= t('.greeting', recipient_name: @recipient.name) %></p>
 
-<p><%= t('.message_intro', conversation: @conversation.title) %></p>
-
-<blockquote style="border-left: 4px solid #ccc; padding-left: 10px; margin: 10px 0;">
-  <p><strong><%= @sender.name %>:</strong></p>
-  <p><%= @message.content %></p>
-  <P><small class="text-muted"><%= l(@message.created_at, format: :short) %></small></P>
-</blockquote>
+<p><%= t('.message_intro', sender_name: @sender.name) %></p>
 
 <p><%= t('.view_conversation') %></p>
 
 <p><%= link_to conversation_url(@conversation), conversation_url(@conversation) %></p>
 
-<p><%= t('.signature', platform: @platform.name) %></p>
+<p><%= t('.signature_html', platform: @platform.name) %></p>

config/locales/en.yml

@@ -627,13 +627,15 @@ en:
       add: Add Contact
     conversation_mailer:
       new_message_notification:
+        from_address: '%{sender_name} via %{from_address}'
         greeting: Hello %{recipient_name},
-        message_intro: 'You have a new message in the conversation "%{conversation}":'
+        message_intro: 'You have an unread message from %{sender_name}:'
         signature: Signature
         signature_html: |-
           Best regards,<br />
           The %{platform} Team
-        subject: '[%{platform}] New message in conversation "%{conversation}"'
+        subject: 'Your conversation has an unread message'
+        subject_with_title: '[%{conversation}] conversation has an unread message'
         view_conversation: 'You can view and reply to this message by clicking the
           link below:'
     conversations:

config/locales/es.yml

@@ -630,13 +630,15 @@ es:
       add: Agregar Contacto
     conversation_mailer:
       new_message_notification:
+        from_address: '%{sender_name} por %{from_address}'
         greeting: Hola %{recipient_name},
-        message_intro: 'Tienes un nuevo mensaje en la conversación "%{conversation}":'
+        message_intro: 'Tienes un mensaje sin leer de %{sender_name}'
         signature: Signature
         signature_html: |-
           Saludos cordiales,<br />
           El equipo de %{platform}
-        subject: '[%{platform}] Nuevo mensaje en la conversación "%{conversation}"'
+        subject: 'Tu conversación tiene un mensaje sin leer'
+        subject_with_title: '[%{conversation}] tiene un mensaje sin leer'
         view_conversation: 'Puedes ver y responder a este mensaje haciendo clic en
           el enlace a continuación:'
     conversations:

config/locales/fr.yml

@@ -633,12 +633,14 @@ fr:
     conversation_mailer:
       new_message_notification:
         greeting: Bonjour %{recipient_name},
-        message_intro: 'Vous avez un nouveau message dans la conversation "%{conversation}":'
+        from_address: '%{sender_name} via %{from_address}'
+        message_intro: 'Vous avez un message non lu de %{sender_name}'
         signature: Signature
         signature_html: |-
           Cordialement,<br />
           L'équipe de %{platform}
-        subject: '[%{platform}] Nouveau message dans la conversation "%{conversation}"'
+        subject: 'Votre conversation contient un message non lu'
+        subject_with_title: '[%{conversation}] contient un message non lu'
         view_conversation: 'Vous pouvez voir et répondre à ce message en cliquant
           sur le lien ci-dessous :'
     conversations:

docker-compose.yml

@@ -20,6 +20,7 @@ x-app-shared: &app-shared
   depends_on:
     - db
     - redis
+    - elasticsearch
 
 services:
   app: &app

spec/factories/better_together/people.rb

@@ -7,8 +7,8 @@ module BetterTogether
     factory :better_together_person, class: Person, aliases: %i[person inviter invitee creator author] do
       id { Faker::Internet.uuid }
       name { Faker::Name.name }
-      description { Faker::Lorem.paragraphs(number: 3) }
-      identifier { Faker::Internet.unique.username(specifier: 5..10) }
+      description { Faker::Lorem.paragraph(sentence_count: 3) }
+      identifier { Faker::Internet.unique.username(specifier: 8..12) }
 
       community
     end

spec/mailers/better_together/conversation_mailer_spec.rb

@@ -17,15 +17,14 @@ module BetterTogether
       end
 
       it 'renders the headers' do
-        expect(mail.subject).to eq("[#{host_platform.name}] New message in conversation \"#{conversation.title}\"")
-        expect(mail.to).to eq([recipient.email])
-        expect(mail.from).to eq(['[email protected]'])
+        expect(mail.subject).to have_content('conversation has an unread message')
+        expect(mail.to).to include(recipient.email)
+        expect(mail.from).to include('[email protected]')
       end
 
       it 'renders the body' do
         expect(mail.body.encoded).to have_content("Hello #{recipient.person.name}")
-        expect(mail.body.encoded).to have_content("#{sender.person.name}:")
-        expect(mail.body.encoded).to have_content(message.content.to_plain_text)
+        expect(mail.body.encoded).to have_content("You have an unread message from #{sender.person.name}:")
       end
 
       it 'sends a message notification email' do

spec/mailers/previews/better_together/conversation_mailer_preview.rb

@@ -8,9 +8,9 @@ class ConversationMailerPreview < ActionMailer::Preview
 
     # Preview this email at http://localhost:3000/rails/mailers/better_together/conversation_mailer/new_message_notification
     def new_message_notification
-      host_platform || create(:platform)
-      sender = create(:user)
-      recipient = create(:user)
+      host_platform || create(:platform, :host)
+      sender = create(:user, :confirmed)
+      recipient = create(:user, :confirmed)
       conversation = create(:conversation, creator: sender.person)
       message = create(:message, conversation: conversation, sender: sender.person)