Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,13 @@ describe('SettingsAnalytics', () => {

beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
EventEmitter2,
SettingsAnalytics,
],
providers: [EventEmitter2, SettingsAnalytics],
}).compile();

service = module.get<SettingsAnalytics>(SettingsAnalytics);
eventEmitter = module.get<EventEmitter2>(EventEmitter2);
eventEmitter.emit = jest.fn();
sendEventMethod = jest.spyOn<SettingsAnalytics, any>(
service,
'sendEvent',
);
sendEventMethod = jest.spyOn<SettingsAnalytics, any>(service, 'sendEvent');
});

describe('sendAnalyticsAgreementChange', () => {
Expand Down Expand Up @@ -63,22 +57,21 @@ describe('SettingsAnalytics', () => {
},
);
});
it('should emit ANALYTICS_PERMISSION with state enabled and reason "test-reason"', async () => {
it('should emit ANALYTICS_PERMISSION with state enabled and reason "sso"', async () => {
service.sendAnalyticsAgreementChange(
mockSessionMetadata,
new Map([['analytics', true]]),
undefined,
'test-reason',
'sso',
);

expect(eventEmitter.emit).toHaveBeenCalledWith(
AppAnalyticsEvents.Track,
mockSessionMetadata,
{
event: TelemetryEvents.AnalyticsPermission,
eventData: { reason: 'test-reason', state: 'enabled' },
eventData: { reason: 'sso', state: 'enabled' },
nonTracking: true,

},
);
});
Expand All @@ -104,7 +97,7 @@ describe('SettingsAnalytics', () => {
mockSessionMetadata,
new Map([['analytics', false]]),
new Map([['analytics', false]]),
'test-reason',
'none',
);

expect(eventEmitter.emit).not.toHaveBeenCalledWith(
Expand All @@ -121,15 +114,15 @@ describe('SettingsAnalytics', () => {
mockSessionMetadata,
new Map([['analytics', false]]),
new Map([['analytics', true]]),
'test-reason',
'none',
);

expect(eventEmitter.emit).toHaveBeenCalledWith(
AppAnalyticsEvents.Track,
mockSessionMetadata,
{
event: TelemetryEvents.AnalyticsPermission,
eventData: { state: 'disabled', reason: 'test-reason' },
eventData: { state: 'disabled', reason: 'none' },
nonTracking: true,
},
);
Expand Down
61 changes: 42 additions & 19 deletions redisinsight/api/src/modules/settings/settings.analytics.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
import { Injectable } from '@nestjs/common';
import { EventEmitter2 } from '@nestjs/event-emitter';
import { differenceWith, has, isEqual } from 'lodash';
import { AppAnalyticsEvents, TelemetryEvents, ToggleAnalyticsReasonType } from 'src/constants';
import { getIsPipelineEnable, getRangeForNumber, SCAN_THRESHOLD_BREAKPOINTS } from 'src/utils';
import { AppAnalyticsEvents, TelemetryEvents } from 'src/constants';
import {
getIsPipelineEnable,
getRangeForNumber,
SCAN_THRESHOLD_BREAKPOINTS,
} from 'src/utils';
import { TelemetryBaseService } from 'src/modules/analytics/telemetry.base.service';
import { GetAppSettingsResponse } from 'src/modules/settings/dto/settings.dto';
import { SessionMetadata } from 'src/common/models';
import { ToggleAnalyticsReasonType } from 'src/modules/settings/constants/settings';

@Injectable()
export class SettingsAnalytics extends TelemetryBaseService {
Expand All @@ -20,13 +25,25 @@ export class SettingsAnalytics extends TelemetryBaseService {
): void {
try {
const dif = Object.fromEntries(
differenceWith(Object.entries(newSettings), Object.entries(oldSettings), isEqual),
differenceWith(
Object.entries(newSettings),
Object.entries(oldSettings),
isEqual,
),
);
if (has(dif, 'scanThreshold')) {
this.sendScanThresholdChanged(sessionMetadata, dif.scanThreshold, oldSettings.scanThreshold);
this.sendScanThresholdChanged(
sessionMetadata,
dif.scanThreshold,
oldSettings.scanThreshold,
);
}
if (has(dif, 'batchSize')) {
this.sendWorkbenchPipelineChanged(sessionMetadata, dif.batchSize, oldSettings.batchSize);
this.sendWorkbenchPipelineChanged(
sessionMetadata,
dif.batchSize,
oldSettings.batchSize,
);
}
} catch (e) {
// continue regardless of error
Expand All @@ -44,18 +61,14 @@ export class SettingsAnalytics extends TelemetryBaseService {
const newPermission = newAgreements.get('analytics');
const oldPermission = oldAgreements.get('analytics');
if (oldPermission !== newPermission) {
this.eventEmitter.emit(
AppAnalyticsEvents.Track,
sessionMetadata,
{
event: TelemetryEvents.AnalyticsPermission,
eventData: {
state: newPermission ? 'enabled' : 'disabled',
reason,
},
nonTracking: true,
this.eventEmitter.emit(AppAnalyticsEvents.Track, sessionMetadata, {
event: TelemetryEvents.AnalyticsPermission,
eventData: {
state: newPermission ? 'enabled' : 'disabled',
reason,
},
);
nonTracking: true,
});
}
} catch (e) {
// continue regardless of error
Expand All @@ -72,14 +85,24 @@ export class SettingsAnalytics extends TelemetryBaseService {
TelemetryEvents.SettingsScanThresholdChanged,
{
currentValue,
currentValueRange: getRangeForNumber(currentValue, SCAN_THRESHOLD_BREAKPOINTS),
currentValueRange: getRangeForNumber(
currentValue,
SCAN_THRESHOLD_BREAKPOINTS,
),
previousValue,
previousValueRange: getRangeForNumber(previousValue, SCAN_THRESHOLD_BREAKPOINTS),
previousValueRange: getRangeForNumber(
previousValue,
SCAN_THRESHOLD_BREAKPOINTS,
),
},
);
}

private sendWorkbenchPipelineChanged(sessionMetadata: SessionMetadata, newValue: number, currentValue: number): void {
private sendWorkbenchPipelineChanged(
sessionMetadata: SessionMetadata,
newValue: number,
currentValue: number,
): void {
this.sendEvent(
sessionMetadata,
TelemetryEvents.SettingsWorkbenchPipelineChanged,
Expand Down
Loading
Loading