Added gift members to total_members helper (TryGhost#27482)

ref https://linear.app/ghost/issue/BER-3478

Updated the `total_members` helper to include `gift` members in the
count

Author: mike182uk

apps/admin-x-framework/src/api/stats.ts

@@ -33,6 +33,7 @@ export type MemberCountHistoryResponseType = {
             paid: number;
             free: number;
             comped: number;
+            gift: number;
         }
     };
 }

apps/admin-x-framework/src/test/msw-utils.ts

@@ -85,7 +85,7 @@ export const fixtures = {
             {date: '2024-01-01', paid: 100, free: 500, comped: 10, paid_subscribed: 5, paid_canceled: 2},
             {date: '2024-01-02', paid: 102, free: 505, comped: 10, paid_subscribed: 3, paid_canceled: 1}
         ],
-        meta: {totals: {paid: 102, free: 505, comped: 10}}
+        meta: {totals: {paid: 102, free: 505, comped: 10, gift: 8}}
     },
 
     mrrHistory: {

apps/admin-x-framework/src/test/responses/member_count_history.json

@@ -45,7 +45,8 @@
         "totals": {
             "paid": 110,
             "free": 530,
-            "comped": 12
+            "comped": 12,
+            "gift": 8
         }
     }
 } 

ghost/core/core/frontend/utils/member-count.js

@@ -6,14 +6,15 @@ const {api} = require('../services/proxy');
  *     free: number;
  *     paid: number;
  *     comped: number;
+ *     gift: number;
  *     total: number;
  * }>}
  */
 async function getMemberStats() {
     let memberStats = this.data || await api.stats.memberCountHistory.query();
-    const {free, paid, comped} = memberStats.meta.totals;
-    let total = free + paid + comped;
-    return {free, paid, comped, total};
+    const {free, paid, comped, gift} = memberStats.meta.totals;
+    let total = free + paid + comped + gift;
+    return {free, paid, comped, gift, total};
 }
 
 /**

ghost/core/core/server/services/stats/members-stats-service.js

@@ -22,11 +22,13 @@ class MembersStatsService {
         const paidEvent = rows.find(c => c.status === 'paid');
         const freeEvent = rows.find(c => c.status === 'free');
         const compedEvent = rows.find(c => c.status === 'comped');
+        const giftEvent = rows.find(c => c.status === 'gift');
 
         return {
             paid: paidEvent ? paidEvent.total : 0,
             free: freeEvent ? freeEvent.total : 0,
-            comped: compedEvent ? compedEvent.total : 0
+            comped: compedEvent ? compedEvent.total : 0,
+            gift: giftEvent ? giftEvent.total : 0
         };
     }
 
@@ -279,6 +281,7 @@ module.exports = MembersStatsService;
  * @property {number} paid Total paid members
  * @property {number} free Total free members
  * @property {number} comped Total comped members
+ * @property {number} gift Total gift members
  */
 
 /**

ghost/core/test/e2e-api/admin/__snapshots__/stats.test.js.snap

@@ -44,6 +44,7 @@ Object {
     "totals": Object {
       "comped": 0,
       "free": 3,
+      "gift": 0,
       "paid": 5,
     },
   },
@@ -64,7 +65,7 @@ exports[`Stats API Can fetch member count history 2: [headers] 1`] = `
 Object {
   "access-control-allow-origin": "http://127.0.0.1:2369",
   "cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
-  "content-length": "149",
+  "content-length": "158",
   "content-type": "application/json; charset=utf-8",
   "content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
   "etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,

ghost/core/test/unit/frontend/utils/member-count.test.js

@@ -35,10 +35,10 @@ const getMemberStatsMock = [
 describe('Member Count', function () {
     it('should return total members', async function () {
         const meta = {data: {
-            meta: {totals: {paid: 1000, free: 500, comped: 500}}
+            meta: {totals: {paid: 1000, free: 500, comped: 500, gift: 100}}
         }};
         const members = await getMemberStats.call(meta);
-        assert.equal(members.total, 2000);
+        assert.equal(members.total, 2100);
     });
 
     it('should return rounded numbers in correct format', function () {

ghost/core/test/unit/server/services/stats/members.test.js

@@ -12,7 +12,7 @@ describe('MembersStatsService', function () {
         /**
          * @type {MembersStatsService.TotalMembersByStatus}
          */
-        const currentCounts = {paid: 0, free: 0, comped: 0};
+        const currentCounts = {paid: 0, free: 0, comped: 0, gift: 0};
         /**
          * @type {MembersStatsService.MemberStatusDelta[]}
          */
@@ -49,6 +49,11 @@ describe('MembersStatsService', function () {
         });
 
         beforeEach(async function () {
+            currentCounts.paid = 0;
+            currentCounts.free = 0;
+            currentCounts.comped = 0;
+            currentCounts.gift = 0;
+
             db = knex({client: 'sqlite3', connection: {filename: ':memory:'}, useNullAsDefault: true});
             membersStatsService = new MembersStatsService({knex: db});
 
@@ -81,8 +86,12 @@ describe('MembersStatsService', function () {
                 id: 'id',
                 status: 'comped'
             }));
+            const giftMembers = Array.from({length: currentCounts.gift}).map(() => ({
+                id: 'id',
+                status: 'gift'
+            }));
 
-            await db('members').insert(paidMembers.concat(freeMembers, compedMembers));
+            await db('members').insert(paidMembers.concat(freeMembers, compedMembers, giftMembers));
 
             /**
              * @typedef {object} StatusEvent
@@ -125,6 +134,7 @@ describe('MembersStatsService', function () {
             currentCounts.paid = 1;
             currentCounts.free = 2;
             currentCounts.comped = 3;
+            currentCounts.gift = 4;
 
             await setupDB();