From 61afa94a4e39f7c7bc9451b01a565491463679bb Mon Sep 17 00:00:00 2001
From: Rishabh Garg <rish@ghost.org>
Date: Wed, 29 Mar 2023 00:36:05 +0530
Subject: [PATCH] Fixed plaintext for mentions email report (#16517)

closes https://github.com/TryGhost/Team/issues/2754

Updates plaintext version for mentions email report to include all unique mentions in a nice list format.
---
 .../services/mentions-email-report/service.js |  7 +++++-
 .../lib/email-templates/mention-report.txt.js | 10 +++++++-
 .../staff-service/test/staff-service.test.js  | 23 +++++++++++++++++++
 3 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/ghost/core/core/server/services/mentions-email-report/service.js b/ghost/core/core/server/services/mentions-email-report/service.js
index 698cc944a7..6db297b79d 100644
--- a/ghost/core/core/server/services/mentions-email-report/service.js
+++ b/ghost/core/core/server/services/mentions-email-report/service.js
@@ -81,8 +81,13 @@ module.exports = {
              * @returns {Promise<string>}
              */
             async renderText(report, recipient) {
+                // Filter out mentions with duplicate source url from the report
+                const uniqueMentions = report.mentions.filter((mention, index, self) => {
+                    return self.findIndex(m => m.sourceUrl.href === mention.sourceUrl.href) === index;
+                });
+
                 return staffService.api.emails.renderText('mention-report', {
-                    report: report,
+                    mentions: uniqueMentions,
                     recipient: recipient
                 });
             }
diff --git a/ghost/staff-service/lib/email-templates/mention-report.txt.js b/ghost/staff-service/lib/email-templates/mention-report.txt.js
index 042bb0666d..c67946b3ef 100644
--- a/ghost/staff-service/lib/email-templates/mention-report.txt.js
+++ b/ghost/staff-service/lib/email-templates/mention-report.txt.js
@@ -1,7 +1,15 @@
 module.exports = function (data) {
+    const {mentions} = data;
+    // Create a list of new mentions with a link to the source
+    const mentionsList = mentions.map((mention) => {
+        return `- ${mention.sourceSiteTitle} (${mention.sourceUrl})`;
+    }).join('\n');
+
     // Be careful when you indent the email, because whitespaces are visible in emails!
     return `
-    You have been mentioned by ${data.sourceUrl}.
+You have been mentioned recently. Here's where:
+
+${mentionsList}
 
 ---
 
diff --git a/ghost/staff-service/test/staff-service.test.js b/ghost/staff-service/test/staff-service.test.js
index c4c7f674ff..93b0798e98 100644
--- a/ghost/staff-service/test/staff-service.test.js
+++ b/ghost/staff-service/test/staff-service.test.js
@@ -908,5 +908,28 @@ describe('StaffService', function () {
                 mailStub.called.should.be.false();
             });
         });
+
+        describe('renderText for webmentions', function () {
+            it('renders plaintext report for mentions', async function () {
+                const textTemplate = await service.emails.renderText('mention-report', {
+                    toEmail: 'jamie@example.com',
+                    siteDomain: 'ghost.org',
+                    staffUrl: 'https://admin.example.com/blog/ghost/#/settings/staff/jane.',
+                    mentions: [
+                        {
+                            sourceSiteTitle: 'Webmentions',
+                            sourceUrl: 'https://webmention.io/'
+                        },
+                        {
+                            sourceSiteTitle: 'Ghost Demo',
+                            sourceUrl: 'https://demo.ghost.io/'
+                        }
+                    ]
+                });
+                textTemplate.should.match(/- Webmentions \(https:\/\/webmention.io\/\)/);
+                textTemplate.should.match(/Ghost Demo \(https:\/\/demo.ghost.io\/\)/);
+                textTemplate.should.match(/Sent to jamie@example.com from ghost.org/);
+            });
+        });
     });
 });