From ae967c449cfabad73b93cb55b81626bd85bbccfa Mon Sep 17 00:00:00 2001
From: Thibaut Patel <thibaut@ghost.org>
Date: Tue, 18 Jan 2022 15:53:51 +0100
Subject: [PATCH] Added EmailRecipient events to `getEventTimeline`

refs https://github.com/TryGhost/Team/issues/1277

- Adds 3 new requests to the `email_recipients` table in the `getEventTimeline` method
- This allows to extract new member events from the table: `email_delivered_event`, `email_opened_event`, `email_failed_event`
---
 ghost/members-api/lib/MembersAPI.js         |  5 +-
 ghost/members-api/lib/repositories/event.js | 85 ++++++++++++++++++++-
 2 files changed, 86 insertions(+), 4 deletions(-)

diff --git a/ghost/members-api/lib/MembersAPI.js b/ghost/members-api/lib/MembersAPI.js
index c067660521..6f072d4d36 100644
--- a/ghost/members-api/lib/MembersAPI.js
+++ b/ghost/members-api/lib/MembersAPI.js
@@ -36,6 +36,7 @@ module.exports = function MembersAPI({
         getSubject
     },
     models: {
+        EmailRecipient,
         StripeCustomer,
         StripeCustomerSubscription,
         Member,
@@ -91,11 +92,13 @@ module.exports = function MembersAPI({
     });
 
     const eventRepository = new EventRepository({
+        EmailRecipient,
         MemberSubscribeEvent,
         MemberPaidSubscriptionEvent,
         MemberPaymentEvent,
         MemberStatusEvent,
-        MemberLoginEvent
+        MemberLoginEvent,
+        labsService
     });
 
     const memberBREADService = new MemberBREADService({
diff --git a/ghost/members-api/lib/repositories/event.js b/ghost/members-api/lib/repositories/event.js
index 3fb2f1070a..685ab0a37f 100644
--- a/ghost/members-api/lib/repositories/event.js
+++ b/ghost/members-api/lib/repositories/event.js
@@ -1,16 +1,20 @@
 module.exports = class EventRepository {
     constructor({
+        EmailRecipient,
         MemberSubscribeEvent,
         MemberPaymentEvent,
         MemberStatusEvent,
         MemberLoginEvent,
-        MemberPaidSubscriptionEvent
+        MemberPaidSubscriptionEvent,
+        labsService
     }) {
         this._MemberSubscribeEvent = MemberSubscribeEvent;
         this._MemberPaidSubscriptionEvent = MemberPaidSubscriptionEvent;
         this._MemberPaymentEvent = MemberPaymentEvent;
         this._MemberStatusEvent = MemberStatusEvent;
         this._MemberLoginEvent = MemberLoginEvent;
+        this._EmailRecipient = EmailRecipient;
+        this._labsService = labsService;
     }
 
     async registerPayment(data) {
@@ -106,6 +110,75 @@ module.exports = class EventRepository {
         };
     }
 
+    async getEmailDelieveredEvents(options = {}) {
+        options.filter = 'delivered_at:-null';
+        const {data: models, meta} = await this._EmailRecipient.findPage(
+            options
+        );
+
+        const data = models.map((data) => {
+            return {
+                type: 'email_delivered_event',
+                data: {
+                    member_id: data.get('member_id'),
+                    created_at: data.get('delivered_at'),
+                    email_id: data.get('email_id')
+                }
+            };
+        });
+
+        return {
+            data,
+            meta
+        };
+    }
+
+    async getEmailOpenedEvents(options = {}) {
+        options.filter = 'opened_at:-null';
+        const {data: models, meta} = await this._EmailRecipient.findPage(
+            options
+        );
+
+        const data = models.map((data) => {
+            return {
+                type: 'email_opened_event',
+                data: {
+                    member_id: data.member_id,
+                    created_at: data.opened_at,
+                    email_id: data.email_id
+                }
+            };
+        });
+
+        return {
+            data,
+            meta
+        };
+    }
+
+    async getEmailFailedEvents(options = {}) {
+        options.filter = 'failed_at:-null';
+        const {data: models, meta} = await this._EmailRecipient.findPage(
+            options
+        );
+
+        const data = models.map((data) => {
+            return {
+                type: 'email_failed_event',
+                data: {
+                    member_id: data.member_id,
+                    created_at: data.failed_at,
+                    email_id: data.email_id
+                }
+            };
+        });
+
+        return {
+            data,
+            meta
+        };
+    }
+
     async getEventTimeline(options = {}) {
         if (!options.limit) {
             options.limit = 10;
@@ -113,12 +186,18 @@ module.exports = class EventRepository {
 
         options.order = 'created_at desc';
 
-        const allEventPages = await Promise.all([
+        const pages = [
             this.getNewsletterSubscriptionEvents(options),
             this.getSubscriptionEvents(options),
             this.getLoginEvents(options),
             this.getSignupEvents(options)
-        ]);
+        ];
+        if (this._labsService.isSet('membersActivityFeed') && this._EmailRecipient) {
+            pages.push(this.getEmailDelieveredEvents(options));
+            pages.push(this.getEmailOpenedEvents(options));
+            pages.push(this.getEmailFailedEvents(options));
+        }
+        const allEventPages = await Promise.all(pages);
 
         const allEvents = allEventPages.reduce((allEvents, page) => allEvents.concat(page.data), []);