|
| 1 | +import { InjectionToken } from '@angular/core'; |
| 2 | +import { Router } from '@angular/router'; |
| 3 | +import { createServiceFactory, mockProvider } from '@ngneat/spectator/jest'; |
| 4 | +import { of } from 'rxjs'; |
| 5 | +import { TelemetryProviderConfig, UserTelemetryProvider, UserTelemetryRegistrationConfig } from './telemetry'; |
| 6 | +import { UserTelemetryHelperService } from './user-telemetry-helper.service'; |
| 7 | + |
| 8 | +describe('User Telemetry helper service', () => { |
| 9 | + const injectionToken = new InjectionToken('test-token'); |
| 10 | + let telemetryProvider: UserTelemetryProvider; |
| 11 | + let registrationConfig: UserTelemetryRegistrationConfig<TelemetryProviderConfig>; |
| 12 | + |
| 13 | + const createService = createServiceFactory({ |
| 14 | + service: UserTelemetryHelperService, |
| 15 | + providers: [ |
| 16 | + mockProvider(Router, { |
| 17 | + events: of({}) |
| 18 | + }) |
| 19 | + ] |
| 20 | + }); |
| 21 | + |
| 22 | + test('should delegate to telemetry provider after registration', () => { |
| 23 | + registrationConfig = { |
| 24 | + telemetryProvider: injectionToken, |
| 25 | + initConfig: { orgId: 'test-id' }, |
| 26 | + enablePageTracking: true, |
| 27 | + enableEventTracking: true, |
| 28 | + enableErrorTracking: true |
| 29 | + }; |
| 30 | + |
| 31 | + telemetryProvider = { |
| 32 | + initialize: jest.fn(), |
| 33 | + identify: jest.fn(), |
| 34 | + trackEvent: jest.fn(), |
| 35 | + trackPage: jest.fn(), |
| 36 | + trackError: jest.fn(), |
| 37 | + shutdown: jest.fn() |
| 38 | + }; |
| 39 | + |
| 40 | + const spectator = createService({ |
| 41 | + providers: [ |
| 42 | + { |
| 43 | + provide: injectionToken, |
| 44 | + useValue: telemetryProvider |
| 45 | + } |
| 46 | + ] |
| 47 | + }); |
| 48 | + |
| 49 | + spectator.service.register(registrationConfig); |
| 50 | + |
| 51 | + // Initialize |
| 52 | + spectator.service.initialize(); |
| 53 | + expect(telemetryProvider.initialize).toHaveBeenCalledWith({ orgId: 'test-id' }); |
| 54 | + |
| 55 | + // Identify |
| 56 | + spectator.service.identify({ email: 'test@email.com' }); |
| 57 | + expect(telemetryProvider.identify).toHaveBeenCalledWith({ email: 'test@email.com' }); |
| 58 | + |
| 59 | + // TrackEvent |
| 60 | + spectator.service.trackEvent('eventA', { target: 'unknown' }); |
| 61 | + expect(telemetryProvider.trackEvent).toHaveBeenCalledWith('eventA', { target: 'unknown' }); |
| 62 | + |
| 63 | + // TrackPage |
| 64 | + spectator.service.trackPageEvent('/abs', { target: 'unknown' }); |
| 65 | + expect(telemetryProvider.trackPage).toHaveBeenCalledWith('/abs', { target: 'unknown' }); |
| 66 | + |
| 67 | + // TrackError |
| 68 | + spectator.service.trackErrorEvent('console error', { target: 'unknown' }); |
| 69 | + expect(telemetryProvider.trackError).toHaveBeenCalledWith('Error: console error', { target: 'unknown' }); |
| 70 | + }); |
| 71 | + |
| 72 | + test('should not capture events if event tracking is disabled', () => { |
| 73 | + registrationConfig = { |
| 74 | + telemetryProvider: injectionToken, |
| 75 | + initConfig: { orgId: 'test-id' }, |
| 76 | + enablePageTracking: true, |
| 77 | + enableEventTracking: false, |
| 78 | + enableErrorTracking: true |
| 79 | + }; |
| 80 | + |
| 81 | + telemetryProvider = { |
| 82 | + initialize: jest.fn(), |
| 83 | + identify: jest.fn(), |
| 84 | + trackEvent: jest.fn(), |
| 85 | + trackPage: jest.fn(), |
| 86 | + trackError: jest.fn(), |
| 87 | + shutdown: jest.fn() |
| 88 | + }; |
| 89 | + |
| 90 | + const spectator = createService({ |
| 91 | + providers: [ |
| 92 | + { |
| 93 | + provide: injectionToken, |
| 94 | + useValue: telemetryProvider |
| 95 | + } |
| 96 | + ] |
| 97 | + }); |
| 98 | + |
| 99 | + spectator.service.register(registrationConfig); |
| 100 | + |
| 101 | + // Initialize |
| 102 | + spectator.service.initialize(); |
| 103 | + expect(telemetryProvider.initialize).toHaveBeenCalledWith({ orgId: 'test-id' }); |
| 104 | + |
| 105 | + // Identify |
| 106 | + spectator.service.identify({ email: 'test@email.com' }); |
| 107 | + expect(telemetryProvider.identify).toHaveBeenCalledWith({ email: 'test@email.com' }); |
| 108 | + |
| 109 | + // TrackEvent |
| 110 | + spectator.service.trackEvent('eventA', { target: 'unknown' }); |
| 111 | + expect(telemetryProvider.trackEvent).not.toHaveBeenCalled(); |
| 112 | + |
| 113 | + // TrackPage |
| 114 | + spectator.service.trackPageEvent('/abs', { target: 'unknown' }); |
| 115 | + expect(telemetryProvider.trackPage).toHaveBeenCalledWith('/abs', { target: 'unknown' }); |
| 116 | + |
| 117 | + // TrackError |
| 118 | + spectator.service.trackErrorEvent('console error', { target: 'unknown' }); |
| 119 | + expect(telemetryProvider.trackError).toHaveBeenCalledWith('Error: console error', { target: 'unknown' }); |
| 120 | + }); |
| 121 | + |
| 122 | + test('should not capture page events if page event tracking is disabled', () => { |
| 123 | + registrationConfig = { |
| 124 | + telemetryProvider: injectionToken, |
| 125 | + initConfig: { orgId: 'test-id' }, |
| 126 | + enablePageTracking: false, |
| 127 | + enableEventTracking: true, |
| 128 | + enableErrorTracking: true |
| 129 | + }; |
| 130 | + |
| 131 | + telemetryProvider = { |
| 132 | + initialize: jest.fn(), |
| 133 | + identify: jest.fn(), |
| 134 | + trackEvent: jest.fn(), |
| 135 | + trackPage: jest.fn(), |
| 136 | + trackError: jest.fn(), |
| 137 | + shutdown: jest.fn() |
| 138 | + }; |
| 139 | + |
| 140 | + const spectator = createService({ |
| 141 | + providers: [ |
| 142 | + { |
| 143 | + provide: injectionToken, |
| 144 | + useValue: telemetryProvider |
| 145 | + } |
| 146 | + ] |
| 147 | + }); |
| 148 | + |
| 149 | + spectator.service.register(registrationConfig); |
| 150 | + |
| 151 | + // Initialize |
| 152 | + spectator.service.initialize(); |
| 153 | + expect(telemetryProvider.initialize).toHaveBeenCalledWith({ orgId: 'test-id' }); |
| 154 | + |
| 155 | + // Identify |
| 156 | + spectator.service.identify({ email: 'test@email.com' }); |
| 157 | + expect(telemetryProvider.identify).toHaveBeenCalledWith({ email: 'test@email.com' }); |
| 158 | + |
| 159 | + // TrackEvent |
| 160 | + spectator.service.trackEvent('eventA', { target: 'unknown' }); |
| 161 | + expect(telemetryProvider.trackEvent).toHaveBeenCalledWith('eventA', { target: 'unknown' }); |
| 162 | + |
| 163 | + // TrackPage |
| 164 | + spectator.service.trackPageEvent('/abs', { target: 'unknown' }); |
| 165 | + expect(telemetryProvider.trackPage).not.toHaveBeenCalled(); |
| 166 | + |
| 167 | + // TrackError |
| 168 | + spectator.service.trackErrorEvent('console error', { target: 'unknown' }); |
| 169 | + expect(telemetryProvider.trackError).toHaveBeenCalledWith('Error: console error', { target: 'unknown' }); |
| 170 | + }); |
| 171 | + |
| 172 | + test('should not capture error events if eror event tracking is disabled', () => { |
| 173 | + registrationConfig = { |
| 174 | + telemetryProvider: injectionToken, |
| 175 | + initConfig: { orgId: 'test-id' }, |
| 176 | + enablePageTracking: true, |
| 177 | + enableEventTracking: true, |
| 178 | + enableErrorTracking: false |
| 179 | + }; |
| 180 | + |
| 181 | + telemetryProvider = { |
| 182 | + initialize: jest.fn(), |
| 183 | + identify: jest.fn(), |
| 184 | + trackEvent: jest.fn(), |
| 185 | + trackPage: jest.fn(), |
| 186 | + trackError: jest.fn(), |
| 187 | + shutdown: jest.fn() |
| 188 | + }; |
| 189 | + |
| 190 | + const spectator = createService({ |
| 191 | + providers: [ |
| 192 | + { |
| 193 | + provide: injectionToken, |
| 194 | + useValue: telemetryProvider |
| 195 | + } |
| 196 | + ] |
| 197 | + }); |
| 198 | + |
| 199 | + spectator.service.register(registrationConfig); |
| 200 | + |
| 201 | + // Initialize |
| 202 | + spectator.service.initialize(); |
| 203 | + expect(telemetryProvider.initialize).toHaveBeenCalledWith({ orgId: 'test-id' }); |
| 204 | + |
| 205 | + // Identify |
| 206 | + spectator.service.identify({ email: 'test@email.com' }); |
| 207 | + expect(telemetryProvider.identify).toHaveBeenCalledWith({ email: 'test@email.com' }); |
| 208 | + |
| 209 | + // TrackEvent |
| 210 | + spectator.service.trackEvent('eventA', { target: 'unknown' }); |
| 211 | + expect(telemetryProvider.trackEvent).toHaveBeenCalledWith('eventA', { target: 'unknown' }); |
| 212 | + |
| 213 | + // TrackPage |
| 214 | + spectator.service.trackPageEvent('/abs', { target: 'unknown' }); |
| 215 | + expect(telemetryProvider.trackPage).toHaveBeenCalledWith('/abs', { target: 'unknown' }); |
| 216 | + |
| 217 | + // TrackError |
| 218 | + spectator.service.trackPageEvent('console error', { target: 'unknown' }); |
| 219 | + expect(telemetryProvider.trackError).not.toHaveBeenCalled(); |
| 220 | + }); |
| 221 | +}); |
0 commit comments