Added post_id filter and total to activity feed API

fixes https://github.com/TryGhost/Team/issues/2091 fixes https://github.com/TryGhost/Team/issues/2089 - Added new fixtures to make testing easier for the activity feed - Improved E2E test coverage of activity feed with separate test file - Added data.post_id filter to enable filtering by events related to a given post - Fixed return types in JSDoc of test agents (TypeScript interprets these as `typeof Agent` if we don't add `InstanceType<Agent>`) - Added total pagination metadata to activity feed API (to allow a basic type of pagination using filters)
TryGhost · Oct 18, 2022 · 4c54ed8 · 4c54ed8
1 parent 95cfb48
commit 4c54ed8
Show file tree

Hide file tree

Showing 16 changed files with 1,051 additions and 89 deletions.
diff --git a/ghost/core/core/server/api/endpoints/members.js b/ghost/core/core/server/api/endpoints/members.js
@@ -435,10 +435,7 @@ module.exports = {
             method: 'browse'
         },
         async query(frame) {
-            const events = await membersService.api.events.getEventTimeline(frame.options);
-            return {
-                events
-            };
+            return await membersService.api.events.getEventTimeline(frame.options);
         }
     }
 };
diff --git a/ghost/core/core/server/api/endpoints/utils/serializers/output/members.js b/ghost/core/core/server/api/endpoints/utils/serializers/output/members.js
@@ -76,11 +76,12 @@ function bulkAction(bulkActionResult, _apiConfig, frame) {
 
 /**
  *
- * @returns {{events: any[]}}
+ * @returns {{events: any[], meta: any}}
  */
 function activityFeed(data, _apiConfig, frame) {
     return {
-        events: data.events.map(e => mappers.activityFeedEvents(e, frame))
+        events: data.events.map(e => mappers.activityFeedEvents(e, frame)),
+        meta: data.meta
     };
 }
 

diff --git a/ghost/core/core/server/models/member-click-event.js b/ghost/core/core/server/models/member-click-event.js
@@ -10,7 +10,31 @@ const MemberClickEvent = ghostBookshelf.Model.extend({
 
     member() {
         return this.belongsTo('Member', 'member_id', 'id');
+    },
+
+    filterExpansions: function filterExpansions() {
+        const expansions = [{
+            key: 'post_id',
+            replacement: 'link.post_id'
+        }];
+
+        return expansions;
+    },
+
+    filterRelations() {
+        return {
+            link: {
+                // Mongo-knex doesn't support belongsTo relations
+                tableName: 'redirects',
+                tableNameAs: 'link',
+                type: 'manyToMany',
+                joinTable: 'members_click_events',
+                joinFrom: 'id',
+                joinTo: 'redirect_id'
+            }
+        };
     }
+
 }, {
     async edit() {
         throw new errors.IncorrectUsageError({message: 'Cannot edit MemberClickEvent'});

diff --git a/ghost/core/core/server/models/member-paid-subscription-event.js b/ghost/core/core/server/models/member-paid-subscription-event.js
@@ -25,6 +25,21 @@ const MemberPaidSubscriptionEvent = ghostBookshelf.Model.extend({
                 .groupByRaw('currency, DATE(created_at)')
                 .orderByRaw('DATE(created_at)');
         }
+    },
+
+    filterRelations() {
+        return {
+            subscriptionCreatedEvent: {
+                // Mongo-knex doesn't support belongsTo relations
+                tableName: 'members_subscription_created_events',
+                tableNameAs: 'subscriptionCreatedEvent',
+                type: 'manyToMany',
+                joinTable: 'members_paid_subscription_events',
+                joinFrom: 'id',
+                joinToForeign: 'subscription_id',
+                joinTo: 'subscription_id'
+            }
+        };
     }
 }, {
     permittedOptions(methodName) {