feat(analytics): initial Habitica-owned solution

test/api/v3/integration/analytics/POST-analytics_track_eventName.test.js

@@ -1,19 +0,0 @@
-import {
-  generateUser,
-  requester,
-} from '../../../../helpers/api-integration/v3';
-import { mockAnalyticsService as analytics } from '../../../../../website/server/libs/analyticsService';
-
-describe('POST /analytics/track/:eventName', () => {
-  it('calls res.analytics', async () => {
-    const user = await generateUser();
-    sandbox.spy(analytics, 'track');
-
-    const requestWithHeaders = requester(user, { 'x-client': 'habitica-web' });
-    await requestWithHeaders.post('/analytics/track/eventName', { data: 'example' }, { 'x-client': 'habitica-web' });
-    expect(analytics.track).to.be.calledOnce;
-    expect(analytics.track).to.be.calledWith('eventName', sandbox.match({ data: 'example' }));
-
-    sandbox.restore();
-  });
-});

test/api/v3/integration/user/POST-user_sleep.test.js

@@ -1,7 +1,6 @@
 import {
   generateUser,
 } from '../../../../helpers/api-integration/v3';
-import { mockAnalyticsService as analytics } from '../../../../../website/server/libs/analyticsService';
 
 describe('POST /user/sleep', () => {
   let user;
@@ -23,15 +22,4 @@ describe('POST /user/sleep', () => {
     await user.sync();
     expect(user.preferences.sleep).to.be.false;
   });
-
-  it('sends sleep status to analytics service', async () => {
-    sandbox.spy(analytics, 'track');
-
-    await user.post('/user/sleep');
-    await user.sync();
-    expect(analytics.track).to.be.calledOnce;
-    expect(analytics.track).to.be.calledWith('sleep', sandbox.match.has('status', user.preferences.sleep));
-
-    sandbox.restore();
-  });
 });

test/api/v3/integration/user/auth/POST-register_local.test.js

@@ -9,6 +9,7 @@ import {
 } from '../../../../../helpers/api-integration/v3';
 import { ApiUser } from '../../../../../helpers/api-integration/api-classes';
 import { encrypt } from '../../../../../../website/server/libs/encryption';
+import { RegistrationEventModel } from '../../../../../../website/server/models/analytics/registrationEvent';
 
 function generateRandomUserName () {
   return (Date.now() + uuid()).substring(0, 20);
@@ -41,6 +42,25 @@ describe('POST /user/auth/local/register', () => {
       expect(user.newUser).to.eql(true);
     });
 
+    it('tracks a registration event', async () => {
+      const username = generateRandomUserName();
+      const email = `${username}@example.com`;
+      const password = 'password';
+
+      const user = await api.post('/user/auth/local/register', {
+        username,
+        email,
+        password,
+        confirmPassword: password,
+      });
+
+      const registrationEvent = await RegistrationEventModel.findOne({ userId: user._id });
+      expect(registrationEvent).to.exist;
+      expect(registrationEvent).to.have.property('userId', user._id);
+      expect(registrationEvent).to.have.property('ipAddress');
+      expect(registrationEvent).to.have.property('authenticationMethod', 'local');
+    });
+
     it('registers a new user and sets verifiedUsername to true', async () => {
       const username = generateRandomUserName();
       const email = `${username}@example.com`;

test/api/v3/integration/user/auth/POST-user_auth_social.test.js

@@ -7,6 +7,7 @@ import {
   getProperty,
 } from '../../../../../helpers/api-integration/v3';
 import apiErrorMessages from '../../../../../../website/common/script/errors/apiErrorMessages';
+import { RegistrationEventModel } from '../../../../../../website/server/models/analytics/registrationEvent';
 
 describe('POST /user/auth/social', () => {
   let api;
@@ -65,6 +66,19 @@ describe('POST /user/auth/social', () => {
       await expect(getProperty('users', response.id, 'profile.name')).to.eventually.equal('a google user');
     });
 
+    it('tracks a registration event', async () => {
+      const socialUser = await api.post(endpoint, {
+        authResponse: { access_token: randomAccessToken }, // eslint-disable-line camelcase
+        network,
+      });
+
+      const registrationEvent = await RegistrationEventModel.findOne({ userId: socialUser.id });
+      expect(registrationEvent).to.exist;
+      expect(registrationEvent).to.have.property('userId', socialUser.id);
+      expect(registrationEvent).to.have.property('ipAddress');
+      expect(registrationEvent).to.have.property('authenticationMethod', 'google');
+    });
+
     it('includes sanitized version of provided username', async () => {
       const response = await api.post(endpoint, {
         authResponse: { access_token: randomAccessToken }, // eslint-disable-line camelcase
@@ -231,6 +245,17 @@ describe('POST /user/auth/social', () => {
       expect(response.newUser).to.be.false;
     });
 
+    it('does not track a registration event for existing users', async () => {
+      const beforeEvents = await RegistrationEventModel.find({ userId: user._id });
+      await user.post(endpoint, {
+        authResponse: { access_token: randomAccessToken }, // eslint-disable-line camelcase
+        network,
+      });
+
+      const registrationEvents = await RegistrationEventModel.find({ userId: user._id });
+      expect(registrationEvents).to.have.lengthOf(beforeEvents.length);
+    });
+
     it('does not log into other account if social auth already exists', async () => {
       const registerResponse = await api.post(endpoint, {
         authResponse: { access_token: randomAccessToken }, // eslint-disable-line camelcase