Merge pull request #52 from edx/ahtesham/unit-tests-track-events

feat: add segment events unit tests

src/forms/login-popup/tests/LoginPopup.test.jsx

@@ -23,12 +23,6 @@ const mockStore = configureStore();
 // mocking getAllPossibleQueryParams
 jest.mock('../../../data/utils', () => jest.fn());
 
-// Mocking the sendTrackEvent
-jest.mock('@edx/frontend-platform/analytics', () => ({
-  sendTrackEvent: jest.fn(),
-  sendPageEvent: jest.fn(),
-}));
-
 // Mocking the trackForgotPasswordLinkClick function
 jest.mock('../../../tracking/trackers/login', () => ({
   ...jest.requireActual('../../../tracking/trackers/login'),

src/forms/progressive-profiling-popup/index.test.jsx

@@ -17,11 +17,6 @@ import ProgressiveProfilingForm from './index';
 const IntlProgressiveProfilingForm = injectIntl(ProgressiveProfilingForm);
 const mockStore = configureStore();
 
-jest.mock('@edx/frontend-platform/analytics', () => ({
-  sendTrackEvent: jest.fn(),
-  sendPageEvent: jest.fn(),
-}));
-
 jest.mock('@edx/frontend-platform/auth', () => ({
   configure: jest.fn(),
   getAuthenticatedUser: jest.fn({}),

src/forms/registration-popup/components/tests/RegistrationFailureAlert.test.jsx

@@ -16,11 +16,6 @@ import SSOFailureAlert from '../../../common-components/SSOFailureAlert';
 import RegistrationPage from '../../index';
 import RegistrationFailureAlert from '../RegistrationFailureAlert';
 
-jest.mock('@edx/frontend-platform/analytics', () => ({
-  sendTrackEvent: jest.fn(),
-  sendPageEvent: jest.fn(),
-}));
-
 jest.mock('@edx/frontend-platform/i18n', () => ({
   ...jest.requireActual('@edx/frontend-platform/i18n'),
   getLocale: jest.fn(),

src/forms/registration-popup/tests/RegistrationPopup.test.jsx

@@ -15,11 +15,6 @@ import { clearRegistrationBackendError, registerUser, setUserPipelineDataLoaded
 import * as utils from '../data/utils';
 import RegistrationForm from '../index';
 
-jest.mock('@edx/frontend-platform/analytics', () => ({
-  sendTrackEvent: jest.fn(),
-  sendPageEvent: jest.fn(),
-}));
-
 const IntlRegistrationForm = injectIntl(RegistrationForm);
 const mockStore = configureStore();
 

src/forms/reset-password-popup/forgot-password/tests/index.test.jsx

@@ -13,11 +13,6 @@ import { loginErrorClear } from '../../../login-popup/data/reducers';
 import { forgotPassword, forgotPasswordClearStatus } from '../data/reducers';
 import ForgotPasswordPage from '../index';
 
-jest.mock('@edx/frontend-platform/analytics', () => ({
-  sendTrackEvent: jest.fn(),
-  sendPageEvent: jest.fn(),
-}));
-
 const IntlForgotPasswordPage = injectIntl(ForgotPasswordPage);
 const mockStore = configureStore();
 

src/setupTest.js

@@ -8,6 +8,10 @@ class MockLoggingService {
 
   logError = jest.fn();
 }
+jest.mock('@edx/frontend-platform/analytics', () => ({
+  sendTrackEvent: jest.fn(),
+  sendPageEvent: jest.fn(),
+}));
 
 export default function initializeMockLogging() {
   const loggingService = configureLogging(MockLoggingService, {

src/tracking/trackers/progressive-profiling.js

@@ -6,7 +6,7 @@ export const eventNames = {
   loginAndRegistration: 'login_and_registration',
 };
 
-// Event tracker for successful registration
+// Event tracker for Progressive profiling skip button click
 export const trackProgressiveProfilingSkipLinkClickEvent = () => createEventTracker(
   eventNames.ProgressiveProfilingSkipLinkClick,
   {},

src/tracking/trackers/tests/forgot-password.test.jsx

@@ -0,0 +1,37 @@
+import { createEventTracker, createPageEventTracker } from '../../../data/segment/utils';
+import {
+  categories,
+  eventNames,
+  forgotPasswordPageViewedEvent,
+  trackForgotPasswordPageEvent,
+} from '../forgotpassword';
+
+// Mock createEventTracker function
+jest.mock('../../../data/segment/utils', () => ({
+  createEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+  createPageEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+}));
+
+describe('Tracking Functions', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should fire trackForgotPasswordPageEvent', () => {
+    trackForgotPasswordPageEvent();
+
+    expect(createPageEventTracker).toHaveBeenCalledWith(
+      eventNames.loginAndRegistration,
+      'forgot-password',
+    );
+  });
+
+  it('should fire forgotPasswordPageViewedEvent', () => {
+    forgotPasswordPageViewedEvent();
+
+    expect(createEventTracker).toHaveBeenCalledWith(
+      eventNames.forgotPasswordPageViewd,
+      { category: categories.userEngagement },
+    );
+  });
+});

src/tracking/trackers/tests/progressive-profiling.test.jsx

@@ -0,0 +1,36 @@
+import { createEventTracker, createPageEventTracker } from '../../../data/segment/utils';
+import {
+  eventNames,
+  trackProgressiveProfilingPageEvent,
+  trackProgressiveProfilingSkipLinkClickEvent,
+} from '../progressive-profiling';
+
+// Mock createEventTracker function
+jest.mock('../../../data/segment/utils', () => ({
+  createEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+  createPageEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+}));
+
+describe('Tracking Functions', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should fire trackProgressiveProfilingSkipLinkClickEvent', () => {
+    trackProgressiveProfilingSkipLinkClickEvent();
+
+    expect(createEventTracker).toHaveBeenCalledWith(
+      eventNames.ProgressiveProfilingSkipLinkClick,
+      {},
+    );
+  });
+
+  it('should fire trackProgressiveProfilingPageEvent', () => {
+    trackProgressiveProfilingPageEvent();
+
+    expect(createPageEventTracker).toHaveBeenCalledWith(
+      eventNames.loginAndRegistration,
+      'welcome',
+    );
+  });
+});

src/tracking/trackers/tests/register.test.jsx

@@ -0,0 +1,36 @@
+import { createEventTracker, createPageEventTracker } from '../../../data/segment/utils';
+import {
+  eventNames,
+  registrationSuccessEvent,
+  trackRegistrationPageEvent,
+} from '../register';
+
+// Mock createEventTracker function
+jest.mock('../../../data/segment/utils', () => ({
+  createEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+  createPageEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+}));
+
+describe('Tracking Functions', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should fire registrationSuccessEvent', () => {
+    registrationSuccessEvent();
+
+    expect(createEventTracker).toHaveBeenCalledWith(
+      eventNames.RegistrationSuccess,
+      {},
+    );
+  });
+
+  it('should fire trackRegistrationPageEvent', () => {
+    trackRegistrationPageEvent();
+
+    expect(createPageEventTracker).toHaveBeenCalledWith(
+      eventNames.loginAndRegistration,
+      'register',
+    );
+  });
+});

src/tracking/trackers/tests/reset-password.test.jsx

@@ -0,0 +1,26 @@
+import { createPageEventTracker } from '../../../data/segment/utils';
+import {
+  eventNames,
+  trackResettPasswordPageEvent,
+} from '../reset-password';
+
+// Mock createEventTracker function
+jest.mock('../../../data/segment/utils', () => ({
+  createEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+  createPageEventTracker: jest.fn().mockImplementation(() => jest.fn()),
+}));
+
+describe('Tracking Functions', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should fire trackResettPasswordPageEvent', () => {
+    trackResettPasswordPageEvent();
+
+    expect(createPageEventTracker).toHaveBeenCalledWith(
+      eventNames.loginAndRegistration,
+      'reset-password',
+    );
+  });
+});