Merge branch 'release' into develop

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "habitica",
-  "version": "4.166.0",
+  "version": "4.166.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "habitica",
   "description": "A habit tracker app which treats your goals like a Role Playing Game.",
-  "version": "4.166.0",
+  "version": "4.166.2",
   "main": "./website/server/index.js",
   "dependencies": {
     "@babel/core": "^7.12.3",

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

@@ -0,0 +1,28 @@
+import {
+  generateUser,
+  requester,
+  translate as t,
+} from '../../../../helpers/api-integration/v3';
+import { mockAnalyticsService as analytics } from '../../../../../website/server/libs/analyticsService';
+
+describe('POST /analytics/track/:eventName', () => {
+  it('requires authentication', async () => {
+    await expect(requester().post('/analytics/track/event')).to.eventually.be.rejected.and.eql({
+      code: 401,
+      error: 'NotAuthorized',
+      message: t('missingAuthHeaders'),
+    });
+  });
+
+  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/helpers/api-integration/requester.js

@@ -41,6 +41,7 @@ function _requestMaker (user, method, additionalSets = {}) {
       || route.indexOf('/amazon') === 0
       || route.indexOf('/stripe') === 0
       || route.indexOf('/qr-code') === 0
+      || route.indexOf('/analytics') === 0
     ) {
       url += `${route}`;
     } else {

website/client/src/components/achievements/dropCapReached.vue

@@ -232,7 +232,7 @@ export default {
         eventCategory: 'drop-cap-reached',
         eventAction: 'click',
         eventLabel: 'Drop Cap Reached > Modal > Wiki',
-      });
+      }, { trackOnServer: true });
     },
     toLearnMore () {
       Analytics.track({
@@ -240,7 +240,7 @@ export default {
         eventCategory: 'drop-cap-reached',
         eventAction: 'click',
         eventLabel: 'Drop Cap Reached > Modal > Subscriptions',
-      });
+      }, { trackOnServer: true });
 
       this.close();
       this.$router.push('/user/settings/subscription');

website/client/src/components/header/notifications/dropCapReached.vue

@@ -36,7 +36,7 @@ export default {
         eventCategory: 'drop-cap-reached',
         eventAction: 'click',
         eventLabel: 'Drop Cap Reached > Notification Click',
-      });
+      }, { trackOnServer: true });
     },
   },
 };

website/client/src/components/header/userDropdown.vue

@@ -183,7 +183,7 @@ export default {
         eventCategory: 'button',
         eventAction: 'click',
         eventLabel: 'User Dropdown > Subscriptions',
-      });
+      }, { trackOnServer: true });
 
       this.$router.push({ name: 'subscription' });
     },

website/client/src/libs/analytics.js

@@ -82,14 +82,21 @@ export function setUser () {
   window.ga('set', { userId: user._id });
 }
 
-export function track (properties) {
+export function track (properties, options = {}) {
   // Use nextTick to avoid blocking the UI
   Vue.nextTick(() => {
     if (_doesNotHaveRequiredFields(properties)) return;
     if (_doesNotHaveAllowedHitType(properties)) return;
 
-    amplitude.getInstance().logEvent(properties.eventAction, properties);
-    window.ga('send', properties);
+    const trackOnServer = options && options.trackOnServer === true;
+    if (trackOnServer === true) {
+      // Track an event on the server
+      const store = getStore();
+      store.dispatch('analytics:trackEvent', properties);
+    } else {
+      amplitude.getInstance().logEvent(properties.eventAction, properties);
+      window.ga('send', properties);
+    }
   });
 }
 

website/client/src/store/actions/analytics.js

@@ -0,0 +1,7 @@
+import axios from 'axios';
+
+export async function trackEvent (store, params) {
+  const url = `/analytics/track/${params.eventAction}`;
+
+  await axios.post(url, params);
+}

website/client/src/store/actions/index.js

@@ -17,6 +17,7 @@ import * as shops from './shops';
 import * as snackbars from './snackbars';
 import * as worldState from './worldState';
 import * as news from './news';
+import * as analytics from './analytics';
 
 // Actions should be named as 'actionName' and can be accessed as 'namespace:actionName'
 // Example: fetch in user.js -> 'user:fetch'
@@ -39,6 +40,7 @@ const actions = flattenAndNamespace({
   snackbars,
   worldState,
   news,
+  analytics,
 });
 
 export default actions;

website/client/vue.config.js

@@ -148,6 +148,10 @@ module.exports = {
         target: DEV_BASE_URL,
         changeOrigin: true,
       },
+      '^/analytics': {
+        target: DEV_BASE_URL,
+        changeOrigin: true,
+      },
     },
   },
 };

website/server/controllers/top-level/analytics.js

@@ -0,0 +1,47 @@
+import {
+  NotAuthorized,
+} from '../../libs/errors';
+import {
+  authWithHeaders,
+} from '../../middlewares/auth';
+
+const api = {};
+
+/**
+ * @apiIgnore Analytics are considered part of the private API
+ * @api {post} /analytics/track/:eventName Track a generic analytics event
+ * @apiName AnalyticsTrack
+ * @apiGroup Analytics
+ *
+ * @apiSuccess {Object} data An empty object
+ * */
+api.trackEvent = {
+  method: 'POST',
+  url: '/analytics/track/:eventName',
+  // we authenticate these requests to make sure they actually came from a real user
+  middlewares: [authWithHeaders()],
+  async handler (req, res) {
+    // As of now only web can track events using this route
+    if (req.headers['x-client'] !== 'habitica-web') {
+      throw new NotAuthorized('Only habitica.com is allowed to track analytics events.');
+    }
+
+    const { user } = res.locals;
+    const eventProperties = req.body;
+
+    res.analytics.track(req.params.eventName, {
+      uuid: user._id,
+      headers: req.headers,
+      category: 'behaviour',
+      gaLabel: 'local',
+      // hitType: 'event', sent from the client
+      ...eventProperties,
+    });
+
+    // not using res.respond
+    // because we don't want to send back notifications and other user-related data
+    res.status(200).send({});
+  },
+};
+
+export default api;