feat(analytics): initial Habitica-owned solution

test/api/unit/libs/payments/payments.test.js

@@ -3,7 +3,6 @@ import moment from 'moment';
 import * as sender from '../../../../../website/server/libs/email';
 import common from '../../../../../website/common';
 import api from '../../../../../website/server/libs/payments/payments';
-import * as analytics from '../../../../../website/server/libs/analyticsService';
 import * as notifications from '../../../../../website/server/libs/pushNotifications';
 import { model as User } from '../../../../../website/server/models/user';
 import { translate as t } from '../../../../helpers/api-integration/v3';
@@ -13,6 +12,7 @@ import {
 import * as worldState from '../../../../../website/server/libs/worldState';
 import { TransactionModel } from '../../../../../website/server/models/transaction';
 import { REPEATING_EVENTS } from '../../../../../website/common/script/content/constants/events';
+import { SubscriptionEventModel } from '../../../../../website/server/models/analytics/subscriptionEvent';
 
 describe('payments/index', () => {
   let user;
@@ -36,8 +36,6 @@ describe('payments/index', () => {
 
     sandbox.stub(sender, 'sendTxn');
     sandbox.stub(user, 'sendMessage');
-    sandbox.stub(analytics.mockAnalyticsService, 'trackPurchase');
-    sandbox.stub(analytics.mockAnalyticsService, 'track');
     sandbox.stub(notifications, 'sendNotification');
 
     data = {
@@ -97,6 +95,16 @@ describe('payments/index', () => {
         expect(recipient.items.pets['Jackalope-RoyalPurple']).to.eql(5);
       });
 
+      it('tracks subscription events', async () => {
+        await api.createSubscription(data);
+        const subscriptionEvent = await SubscriptionEventModel.findOne({ userId: recipient._id });
+        expect(subscriptionEvent).to.exist;
+        expect(subscriptionEvent).to.have.property('eventType', 'subscribed');
+        expect(subscriptionEvent).to.have.property('userId', recipient._id);
+        expect(subscriptionEvent).to.have.property('planId', 'basic_3mo');
+        expect(subscriptionEvent).to.have.property('paymentMethod', 'Payment Method');
+      });
+
       it('adds extra months to an existing subscription', async () => {
         recipient.purchased.plan = plan;
 
@@ -298,28 +306,6 @@ describe('payments/index', () => {
         expect(notifications.sendNotification).to.be.calledOnce;
       });
 
-      it('tracks subscription purchase as gift', async () => {
-        await api.createSubscription(data);
-
-        expect(analytics.mockAnalyticsService.trackPurchase).to.be.calledOnce;
-        expect(analytics.mockAnalyticsService.trackPurchase).to.be.calledWith({
-          uuid: user._id,
-          groupId: undefined,
-          itemPurchased: 'Subscription',
-          sku: 'payment method-subscription',
-          purchaseType: 'subscribe',
-          paymentMethod: data.paymentMethod,
-          quantity: 1,
-          gift: true,
-          purchaseValue: 15,
-          firstPurchase: true,
-          headers: {
-            'x-client': 'habitica-web',
-            'user-agent': '',
-          },
-        });
-      });
-
       context('No Active Promotion', () => {
         beforeEach(() => {
           sinon.stub(worldState, 'getCurrentEventList').returns([]);
@@ -455,6 +441,16 @@ describe('payments/index', () => {
         expect(user.purchased.plan.dateCreated).to.exist;
       });
 
+      it('tracks subscription events', async () => {
+        await api.createSubscription(data);
+        const subscriptionEvent = await SubscriptionEventModel.findOne({ userId: user._id });
+        expect(subscriptionEvent).to.exist;
+        expect(subscriptionEvent).to.have.property('userId', user._id);
+        expect(subscriptionEvent).to.have.property('ipAddress');
+        expect(subscriptionEvent).to.have.property('planId', 'basic_3mo');
+        expect(subscriptionEvent).to.have.property('paymentMethod', 'Payment Method');
+      });
+
       it('sets plan.dateCreated if it did not previously exist', async () => {
         expect(user.purchased.plan.dateCreated).to.not.exist;
 
@@ -543,29 +539,24 @@ describe('payments/index', () => {
         expect(sender.sendTxn).to.be.calledWith(data.user, 'subscription-begins');
       });
 
-      it('tracks subscription purchase', async () => {
-        await api.createSubscription(data);
-
-        expect(analytics.mockAnalyticsService.trackPurchase).to.be.calledOnce;
-        expect(analytics.mockAnalyticsService.trackPurchase).to.be.calledWith({
-          uuid: user._id,
-          groupId: undefined,
-          itemPurchased: 'Subscription',
-          sku: 'payment method-subscription',
-          purchaseType: 'subscribe',
-          paymentMethod: data.paymentMethod,
-          quantity: 1,
-          gift: false,
-          purchaseValue: 15,
-          firstPurchase: true,
-          headers: {
-            'x-client': 'habitica-web',
-            'user-agent': '',
-          },
-        });
-      });
-
       context('Upgrades subscription', () => {
+        it('tracks subscription events', async () => {
+          data.sub.key = 'basic_earned';
+          expect(user.purchased.plan.planId).to.not.exist;
+
+          await api.createSubscription(data);
+
+          data.sub.key = 'basic_6mo';
+          data.updatedFrom = { key: 'basic_earned' };
+          await api.createSubscription(data);
+
+          const subscriptionEvent = await SubscriptionEventModel.findOne({ userId: user._id, planId: 'basic_6mo' });
+          expect(subscriptionEvent).to.exist;
+          expect(subscriptionEvent).to.have.property('eventType', 'upgraded');
+          expect(subscriptionEvent).to.have.property('userId', user._id);
+          expect(subscriptionEvent).to.have.property('paymentMethod', 'Payment Method');
+        });
+
         it('from basic_earned to basic_6mo', async () => {
           data.sub.key = 'basic_earned';
           expect(user.purchased.plan.planId).to.not.exist;
@@ -608,6 +599,23 @@ describe('payments/index', () => {
       });
 
       context('Downgrades subscription', () => {
+        it('tracks subscription events', async () => {
+          data.sub.key = 'basic_6mo';
+          expect(user.purchased.plan.planId).to.not.exist;
+
+          await api.createSubscription(data);
+
+          data.sub.key = 'basic_earned';
+          data.updatedFrom = { key: 'basic_6mo' };
+          await api.createSubscription(data);
+
+          const subscriptionEvent = await SubscriptionEventModel.findOne({ userId: user._id, planId: 'basic_earned' });
+          expect(subscriptionEvent).to.exist;
+          expect(subscriptionEvent).to.have.property('eventType', 'downgraded');
+          expect(subscriptionEvent).to.have.property('userId', user._id);
+          expect(subscriptionEvent).to.have.property('paymentMethod', 'Payment Method');
+        });
+
         it('from basic_6mo to basic_earned', async () => {
           data.sub.key = 'basic_6mo';
           expect(user.purchased.plan.planId).to.not.exist;
@@ -1136,6 +1144,15 @@ describe('payments/index', () => {
         expect(daysTillTermination).to.be.within(29, 30); // 1 month +/- 1 days
       });
 
+      it('tracks subscription events', async () => {
+        await api.cancelSubscription(data);
+
+        const subscriptionEvent = await SubscriptionEventModel.findOne({ userId: user._id });
+        expect(subscriptionEvent).to.exist;
+        expect(subscriptionEvent).to.have.property('eventType', 'cancelled');
+        expect(subscriptionEvent).to.have.property('userId', user._id);
+      });
+
       it('adds extraMonths to dateTerminated value', async () => {
         user.purchased.plan.extraMonths = 2;