From 45a301277d79eb24a3d191016391589f3ccd49a9 Mon Sep 17 00:00:00 2001
From: Rishabh Garg <zrishabhgarg@gmail.com>
Date: Thu, 22 Sep 2022 20:58:45 +0530
Subject: [PATCH] Updated empty referrer source to null (#15456)

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

- changes empty referrer source to null instead of explicit `Unavailable` in API
- makes it easier for clients/frontend to ignore empty referrers
---
 ghost/stats-service/lib/referrers.js          | 14 +------
 .../stats-service/test/lib/referrers.test.js  | 37 ++++++++++++++++++-
 2 files changed, 38 insertions(+), 13 deletions(-)

diff --git a/ghost/stats-service/lib/referrers.js b/ghost/stats-service/lib/referrers.js
index 014faa2991..345f4896bb 100644
--- a/ghost/stats-service/lib/referrers.js
+++ b/ghost/stats-service/lib/referrers.js
@@ -104,12 +104,7 @@ class ReferrersStatsService {
         const rows = await knex('members_subscription_created_events')
             .select(knex.raw(`DATE(created_at) as date`))
             .select(knex.raw(`COUNT(*) as paid_conversions`))
-            .select(knex.raw(`
-                CASE
-                    WHEN referrer_source IS NULL THEN 'Unavailable'
-                    ELSE referrer_source
-                END
-            as source`))
+            .select(knex.raw(`referrer_source as source`))
             .groupBy('date', 'referrer_source')
             .orderBy('date');
 
@@ -124,12 +119,7 @@ class ReferrersStatsService {
         const rows = await knex('members_created_events')
             .select(knex.raw(`DATE(created_at) as date`))
             .select(knex.raw(`COUNT(*) as signups`))
-            .select(knex.raw(`
-                CASE
-                    WHEN referrer_source IS NULL THEN 'Unavailable'
-                    ELSE referrer_source
-                END
-            as source`))
+            .select(knex.raw(`referrer_source as source`))
             .groupBy('date', 'referrer_source')
             .orderBy('date');
 
diff --git a/ghost/stats-service/test/lib/referrers.test.js b/ghost/stats-service/test/lib/referrers.test.js
index 1e3efbace6..6994dcc8bc 100644
--- a/ghost/stats-service/test/lib/referrers.test.js
+++ b/ghost/stats-service/test/lib/referrers.test.js
@@ -58,6 +58,37 @@ describe('ReferrersStatsService', function () {
                 });
             }
 
+            // Insert null referrer data for signups
+            signupInsert.push(...[
+                {
+                    referrer_source: null,
+                    referrer_medium: null,
+                    referrer_url: null,
+                    created_at: '1970-01-09'
+                },
+                {
+                    referrer_source: null,
+                    referrer_medium: null,
+                    referrer_url: null,
+                    created_at: '1970-01-09'
+                }
+            ]);
+
+            // Insert null referrer data for paid conversions
+            paidInsert.push(...[
+                {
+                    referrer_source: null,
+                    referrer_medium: null,
+                    referrer_url: null,
+                    created_at: '1970-01-09'
+                },
+                {
+                    referrer_source: null,
+                    referrer_medium: null,
+                    referrer_url: null,
+                    created_at: '1970-01-09'
+                }
+            ]);
             await db('members_created_events').insert(signupInsert);
             await db('members_subscription_created_events').insert(paidInsert);
         }
@@ -75,11 +106,12 @@ describe('ReferrersStatsService', function () {
             };
 
             // Is sorted by date
-            assert.deepStrictEqual(results.data.map(result => result.date), ['1970-01-01', '1970-01-02', '1970-01-03', '1970-01-04', '1970-01-05', '1970-01-06', '1970-01-07', '1970-01-08', '1970-01-09']);
+            assert.deepStrictEqual(results.data.map(result => result.date), ['1970-01-01', '1970-01-02', '1970-01-03', '1970-01-04', '1970-01-05', '1970-01-06', '1970-01-07', '1970-01-08', '1970-01-09', '1970-01-09']);
 
             const firstDayCounts = results.data.find(finder('Twitter', '1970-01-01'));
             const secondDayCounts = results.data.find(finder('Ghost Newsletter', '1970-01-02'));
             const thirdDayCounts = results.data.find(finder('Ghost Explore', '1970-01-03'));
+            const nullReferrerCounts = results.data.find(finder(null, '1970-01-09'));
 
             assert(firstDayCounts.signups === 0);
             assert(firstDayCounts.paid_conversions === 1);
@@ -89,6 +121,9 @@ describe('ReferrersStatsService', function () {
 
             assert(thirdDayCounts.signups === 1);
             assert(thirdDayCounts.paid_conversions === 1);
+
+            assert(nullReferrerCounts.signups === 2);
+            assert(nullReferrerCounts.paid_conversions === 2);
         });
     });
 });