feat: more events tracking for SaaS (#6234)

app/javascript/dashboard/helper/AnalyticsHelper/specs/events.spec.js

@@ -0,0 +1,26 @@
+import * as AnalyticsEvents from '../events';
+
+describe('Analytics Events', () => {
+  it('should be frozen', () => {
+    Object.entries(AnalyticsEvents).forEach(([, value]) => {
+      expect(Object.isFrozen(value)).toBe(true);
+    });
+  });
+
+  it('event names should be unique across the board', () => {
+    const allValues = Object.values(AnalyticsEvents).reduce(
+      (acc, curr) => acc.concat(Object.values(curr)),
+      []
+    );
+    const uniqueValues = new Set(allValues);
+    expect(allValues.length).toBe(uniqueValues.size);
+  });
+
+  it('should not allow properties to be modified', () => {
+    Object.values(AnalyticsEvents).forEach(eventsObject => {
+      expect(() => {
+        eventsObject.NEW_PROPERTY = 'new value';
+      }).toThrow();
+    });
+  });
+});

app/javascript/dashboard/helper/AnalyticsHelper/specs/helper.spec.js

@@ -0,0 +1,139 @@
+import helperObject, { AnalyticsHelper } from '../';
+
+jest.mock('@june-so/analytics-next', () => ({
+  AnalyticsBrowser: {
+    load: () => [
+      {
+        identify: jest.fn(),
+        track: jest.fn(),
+        page: jest.fn(),
+        group: jest.fn(),
+      },
+    ],
+  },
+}));
+
+describe('helperObject', () => {
+  it('should return an instance of AnalyticsHelper', () => {
+    expect(helperObject).toBeInstanceOf(AnalyticsHelper);
+  });
+});
+
+describe('AnalyticsHelper', () => {
+  let analyticsHelper;
+  beforeEach(() => {
+    analyticsHelper = new AnalyticsHelper({ token: 'test_token' });
+  });
+
+  describe('init', () => {
+    it('should initialize the analytics browser with the correct token', async () => {
+      await analyticsHelper.init();
+      expect(analyticsHelper.analytics).not.toBe(null);
+    });
+
+    it('should not initialize the analytics browser if token is not provided', async () => {
+      analyticsHelper = new AnalyticsHelper();
+      await analyticsHelper.init();
+      expect(analyticsHelper.analytics).toBe(null);
+    });
+  });
+
+  describe('identify', () => {
+    beforeEach(() => {
+      analyticsHelper.analytics = { identify: jest.fn(), group: jest.fn() };
+    });
+
+    it('should call identify on analytics browser with correct arguments', () => {
+      analyticsHelper.identify({
+        id: '123',
+        email: 'test@example.com',
+        name: 'Test User',
+        avatar_url: 'avatar_url',
+        accounts: [{ id: '1', name: 'Account 1' }],
+        account_id: '1',
+      });
+
+      expect(analyticsHelper.analytics.identify).toHaveBeenCalledWith(
+        'test@example.com',
+        {
+          userId: '123',
+          email: 'test@example.com',
+          name: 'Test User',
+          avatar: 'avatar_url',
+        }
+      );
+      expect(analyticsHelper.analytics.group).toHaveBeenCalled();
+    });
+
+    it('should call identify on analytics browser without group', () => {
+      analyticsHelper.identify({
+        id: '123',
+        email: 'test@example.com',
+        name: 'Test User',
+        avatar_url: 'avatar_url',
+        accounts: [{ id: '1', name: 'Account 1' }],
+        account_id: '5',
+      });
+
+      expect(analyticsHelper.analytics.group).not.toHaveBeenCalled();
+    });
+
+    it('should not call analytics.page if analytics is null', () => {
+      analyticsHelper.analytics = null;
+      analyticsHelper.identify({});
+      expect(analyticsHelper.analytics).toBe(null);
+    });
+  });
+
+  describe('track', () => {
+    beforeEach(() => {
+      analyticsHelper.analytics = { track: jest.fn() };
+      analyticsHelper.user = { id: '123' };
+    });
+
+    it('should call track on analytics browser with correct arguments', () => {
+      analyticsHelper.track('Test Event', { prop1: 'value1', prop2: 'value2' });
+      expect(analyticsHelper.analytics.track).toHaveBeenCalledWith({
+        userId: '123',
+        event: 'Test Event',
+        properties: { prop1: 'value1', prop2: 'value2' },
+      });
+    });
+
+    it('should call track on analytics browser with default properties', () => {
+      analyticsHelper.track('Test Event');
+      expect(analyticsHelper.analytics.track).toHaveBeenCalledWith({
+        userId: '123',
+        event: 'Test Event',
+        properties: {},
+      });
+    });
+
+    it('should not call track on analytics browser if analytics is not initialized', () => {
+      analyticsHelper.analytics = null;
+      analyticsHelper.track('Test Event', { prop1: 'value1', prop2: 'value2' });
+      expect(analyticsHelper.analytics).toBe(null);
+    });
+  });
+
+  describe('page', () => {
+    beforeEach(() => {
+      analyticsHelper.analytics = { page: jest.fn() };
+    });
+
+    it('should call the analytics.page method with the correct arguments', () => {
+      const params = {
+        name: 'Test page',
+        url: '/test',
+      };
+      analyticsHelper.page(params);
+      expect(analyticsHelper.analytics.page).toHaveBeenCalledWith(params);
+    });
+
+    it('should not call analytics.page if analytics is null', () => {
+      analyticsHelper.analytics = null;
+      analyticsHelper.page();
+      expect(analyticsHelper.analytics).toBe(null);
+    });
+  });
+});

app/javascript/dashboard/helper/AnalyticsHelper/specs/plugin.spec.js

@@ -0,0 +1,35 @@
+import Vue from 'vue';
+import plugin from '../plugin';
+import analyticsHelper from '../index';
+
+describe('Vue Analytics Plugin', () => {
+  beforeEach(() => {
+    jest.spyOn(analyticsHelper, 'init');
+    jest.spyOn(analyticsHelper, 'track');
+    Vue.use(plugin);
+  });
+
+  afterEach(() => {
+    jest.resetModules();
+    jest.clearAllMocks();
+  });
+
+  it('should call the init method on the analyticsHelper', () => {
+    expect(analyticsHelper.init).toHaveBeenCalled();
+  });
+
+  it('should add the analyticsHelper to the Vue prototype', () => {
+    expect(Vue.prototype.$analytics).toBe(analyticsHelper);
+  });
+
+  it('should add the track method to the Vue prototype', () => {
+    expect(typeof Vue.prototype.$track).toBe('function');
+    Vue.prototype.$track('eventName');
+    expect(analyticsHelper.track).toHaveBeenCalledWith('eventName');
+  });
+
+  it('should call the track method on the analyticsHelper when $track is called', () => {
+    Vue.prototype.$track('eventName');
+    expect(analyticsHelper.track).toHaveBeenCalledWith('eventName');
+  });
+});