#RI-4865 - Send frontend events in batches

Author: egor-zalenski

redisinsight/api/src/constants/app-events.ts

@@ -1,6 +1,7 @@
 export enum AppAnalyticsEvents {
   Initialize = 'analytics.initialize',
   Track = 'analytics.track',
+  Page = 'analytics.page',
 }
 
 export enum AppRedisInstanceEvents {

redisinsight/api/src/modules/analytics/analytics.controller.ts

@@ -0,0 +1,47 @@
+import {
+  Body,
+  Controller, Post, UsePipes, ValidationPipe,
+} from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator';
+import { SendEventDto } from 'src/modules/analytics/dto/analytics.dto';
+import { AnalyticsService } from 'src/modules/analytics/analytics.service';
+
+@ApiTags('Analytics')
+@Controller('analytics')
+@UsePipes(new ValidationPipe({ transform: true }))
+export class AnalyticsController {
+  constructor(private service: AnalyticsService) {}
+
+  @Post('send-event')
+  @ApiEndpoint({
+    description: 'Send telemetry event',
+    statusCode: 204,
+    responses: [
+      {
+        status: 204,
+      },
+    ],
+  })
+  async sendEvent(
+    @Body() dto: SendEventDto,
+  ): Promise<void> {
+    return this.service.sendEvent(dto);
+  }
+
+  @Post('send-page')
+  @ApiEndpoint({
+    description: 'Send telemetry page',
+    statusCode: 204,
+    responses: [
+      {
+        status: 204,
+      },
+    ],
+  })
+  async sendPage(
+    @Body() dto: SendEventDto,
+  ): Promise<void> {
+    return this.service.sendPage(dto);
+  }
+}

redisinsight/api/src/modules/analytics/analytics.module.ts

@@ -1,9 +1,13 @@
 import { Module } from '@nestjs/common';
 import { AnalyticsService } from 'src/modules/analytics/analytics.service';
+import { AnalyticsController } from './analytics.controller';
 
 @Module({
   providers: [
     AnalyticsService,
   ],
+  controllers: [
+    AnalyticsController,
+  ],
 })
 export class AnalyticsModule {}

redisinsight/api/src/modules/analytics/analytics.service.spec.ts

@@ -14,11 +14,13 @@ import {
 } from './analytics.service';
 
 let mockAnalyticsTrack;
+let mockAnalyticsPage;
 jest.mock(
   'analytics-node',
   () => jest.fn()
     .mockImplementation(() => ({
       track: mockAnalyticsTrack,
+      page: mockAnalyticsPage,
     })),
 );
 
@@ -134,4 +136,71 @@ describe('AnalyticsService', () => {
       });
     });
   });
+
+  describe('sendPage', () => {
+    beforeEach(() => {
+      mockAnalyticsPage = jest.fn();
+      service.initialize({
+        anonymousId: mockAnonymousId,
+        sessionId,
+        appType: AppType.Electron,
+        controlNumber: mockControlNumber,
+        controlGroup: mockControlGroup,
+        appVersion: mockAppVersion,
+      });
+    });
+    it('should send page with anonymousId if permission are granted', async () => {
+      settingsService.getAppSettings.mockResolvedValue(mockAppSettings);
+
+      await service.sendPage({
+        event: TelemetryEvents.ApplicationStarted,
+        eventData: {},
+        nonTracking: false,
+      });
+
+      expect(mockAnalyticsPage).toHaveBeenCalledWith({
+        anonymousId: mockAnonymousId,
+        integrations: { Amplitude: { session_id: sessionId } },
+        name: TelemetryEvents.ApplicationStarted,
+        properties: {
+          buildType: AppType.Electron,
+          controlNumber: mockControlNumber,
+          controlGroup: mockControlGroup,
+          appVersion: mockAppVersion,
+        },
+      });
+    });
+    it('should not send page if permission are not granted', async () => {
+      settingsService.getAppSettings.mockResolvedValue(mockAppSettingsWithoutPermissions);
+
+      await service.sendPage({
+        event: 'SOME_EVENT',
+        eventData: {},
+        nonTracking: false,
+      });
+
+      expect(mockAnalyticsPage).not.toHaveBeenCalled();
+    });
+    it('should send page for non tracking events event if permission are not granted', async () => {
+      settingsService.getAppSettings.mockResolvedValue(mockAppSettingsWithoutPermissions);
+
+      await service.sendPage({
+        event: TelemetryEvents.ApplicationStarted,
+        eventData: {},
+        nonTracking: true,
+      });
+
+      expect(mockAnalyticsPage).toHaveBeenCalledWith({
+        anonymousId: mockAnonymousId,
+        integrations: { Amplitude: { session_id: sessionId } },
+        name: TelemetryEvents.ApplicationStarted,
+        properties: {
+          buildType: AppType.Electron,
+          controlNumber: mockControlNumber,
+          controlGroup: mockControlGroup,
+          appVersion: mockAppVersion,
+        },
+      });
+    });
+  });
 });

redisinsight/api/src/modules/analytics/analytics.service.ts

@@ -75,12 +75,8 @@ export class AnalyticsService {
       // for analytics is granted or not.
       // If permissions not granted anonymousId includes "UNSET" value without any user identifiers.
       const { event, eventData, nonTracking } = payload;
-      const isAnalyticsGranted = !!get(
-        // todo: define how to fetch userId?
-        await this.settingsService.getAppSettings('1'),
-        'agreements.analytics',
-        false,
-      );
+      const isAnalyticsGranted = await this.checkIsAnalyticsGranted();
+
       if (isAnalyticsGranted || nonTracking) {
         this.analytics.track({
           anonymousId: this.anonymousId,
@@ -99,4 +95,45 @@ export class AnalyticsService {
       // continue regardless of error
     }
   }
+
+  @OnEvent(AppAnalyticsEvents.Page)
+  async sendPage(payload: ITelemetryEvent) {
+    try {
+      // The event is reported only if the user's permission is granted.
+      // The anonymousId is also sent along with the event.
+      //
+      // The `nonTracking` argument can be set to True to mark an event that doesn't track the specific
+      // user in any way. When `nonTracking` is True, the event is sent regardless of whether the user's permission
+      // for analytics is granted or not.
+      // If permissions not granted anonymousId includes "UNSET" value without any user identifiers.
+      const { event, eventData, nonTracking } = payload;
+      const isAnalyticsGranted = await this.checkIsAnalyticsGranted();
+
+      if (isAnalyticsGranted || nonTracking) {
+        this.analytics.page({
+          name: event,
+          anonymousId: this.anonymousId,
+          integrations: { Amplitude: { session_id: this.sessionId } },
+          properties: {
+            ...eventData,
+            buildType: this.appType,
+            controlNumber: this.controlNumber,
+            controlGroup: this.controlGroup,
+            appVersion: this.appVersion,
+          },
+        });
+      }
+    } catch (e) {
+      // continue regardless of error
+    }
+  }
+
+  private async checkIsAnalyticsGranted() {
+    return !!get(
+      // todo: define how to fetch userId?
+      await this.settingsService.getAppSettings('1'),
+      'agreements.analytics',
+      false,
+    );
+  }
 }

redisinsight/api/src/modules/analytics/dto/analytics.dto.ts

@@ -0,0 +1,39 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsBoolean,
+  IsDefined,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  ValidateNested,
+} from 'class-validator';
+
+export class SendEventDto {
+  @ApiProperty({
+    description: 'Telemetry event name.',
+    type: String,
+    example: 'APPLICATION_UPDATED',
+  })
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  event: string;
+
+  @ApiPropertyOptional({
+    description: 'Telemetry event data.',
+    type: Object,
+    example: { length: 5 },
+  })
+  @IsOptional()
+  @ValidateNested()
+  eventData: Object = {};
+
+  @ApiPropertyOptional({
+    description: 'Does not track the specific user in any way?',
+    type: Boolean,
+    example: false,
+  })
+  @IsOptional()
+  @IsBoolean()
+  nonTracking: boolean = false;
+}

redisinsight/api/test/api/analytics/POST-analytics-send-event.test.ts

@@ -0,0 +1,49 @@
+import {
+  describe,
+  deps,
+  Joi,
+  generateInvalidDataTestCases,
+  validateInvalidDataTestCase,
+  getMainCheckFn, _,
+} from '../deps';
+const { server, request, constants } = deps;
+
+// endpoint to test
+const endpoint = () =>
+  request(server).post('/analytics/send-event');
+
+// input data schema
+const dataSchema = Joi.object({
+  event: Joi.string().required(),
+  eventData: Joi.object().allow(null),
+}).strict();
+
+const validInputData = {
+  event: constants.TEST_ANALYTICS_EVENT,
+  eventData: constants.TEST_ANALYTICS_EVENT_DATA,
+};
+
+const mainCheckFn = getMainCheckFn(endpoint);
+
+describe('POST /analytics/send-event', () => {
+  describe('Main', () => {
+    describe('Validation', () => {
+      generateInvalidDataTestCases(dataSchema, validInputData).map(
+        validateInvalidDataTestCase(endpoint, dataSchema),
+      );
+    });
+
+    describe('Common', () => {
+      [
+        {
+          name: 'Should send telemetry event',
+          data: {
+            event: constants.TEST_ANALYTICS_EVENT,
+            eventData: constants.TEST_ANALYTICS_EVENT_DATA,
+          },
+          statusCode: 204,
+        },
+      ].map(mainCheckFn);
+    });
+  });
+});

redisinsight/api/test/api/analytics/POST-analytics-send-page.test.ts

@@ -0,0 +1,49 @@
+import {
+  describe,
+  deps,
+  Joi,
+  generateInvalidDataTestCases,
+  validateInvalidDataTestCase,
+  getMainCheckFn, _,
+} from '../deps';
+const { server, request, constants } = deps;
+
+// endpoint to test
+const endpoint = () =>
+  request(server).post('/analytics/send-page');
+
+// input data schema
+const dataSchema = Joi.object({
+  event: Joi.string().required(),
+  eventData: Joi.object().allow(null),
+}).strict();
+
+const validInputData = {
+  event: constants.TEST_ANALYTICS_PAGE,
+  eventData: constants.TEST_ANALYTICS_EVENT_DATA,
+};
+
+const mainCheckFn = getMainCheckFn(endpoint);
+
+describe('POST /analytics/send-page', () => {
+  describe('Main', () => {
+    describe('Validation', () => {
+      generateInvalidDataTestCases(dataSchema, validInputData).map(
+        validateInvalidDataTestCase(endpoint, dataSchema),
+      );
+    });
+
+    describe('Common', () => {
+      [
+        {
+          name: 'Should send telemetry page',
+          data: {
+            event: constants.TEST_ANALYTICS_PAGE,
+            eventData: constants.TEST_ANALYTICS_EVENT_DATA,
+          },
+          statusCode: 204,
+        },
+      ].map(mainCheckFn);
+    });
+  });
+});

redisinsight/api/test/helpers/constants.ts

@@ -2,7 +2,7 @@ import { v4 as uuidv4 } from 'uuid';
 import * as path from 'path';
 import { randomBytes } from 'crypto';
 import { getASCIISafeStringFromBuffer, getBufferFromSafeASCIIString } from "src/utils/cli-helper";
-import { RECOMMENDATION_NAMES } from 'src/constants';
+import { RECOMMENDATION_NAMES, TelemetryEvents } from 'src/constants';
 import { Compressor } from 'src/modules/database/entities/database.entity';
 import { Vote } from 'src/modules/database-recommendation/models';
 
@@ -20,6 +20,7 @@ const APP_DEFAULT_SETTINGS = {
   agreements: null,
 };
 const TEST_LIBRARY_NAME = 'lib';
+const TEST_ANALYTICS_PAGE = 'Settings';
 
 const unprintableBuf = Buffer.concat([
   Buffer.from('acedae', 'hex'),
@@ -590,5 +591,9 @@ export const constants = {
   TEST_TRIGGERED_FUNCTIONS_LIBRARY_NAME: TEST_LIBRARY_NAME,
   TEST_TRIGGERED_FUNCTIONS_CODE: `#!js api_version=1.0 name=${TEST_LIBRARY_NAME}\n redis.registerFunction('foo', ()=>{return 'bar'})`,
   TEST_TRIGGERED_FUNCTIONS_CONFIGURATION: "{}",
+
+  TEST_ANALYTICS_EVENT: TelemetryEvents.RedisInstanceAdded,
+  TEST_ANALYTICS_EVENT_DATA: { length: 5 },
+  TEST_ANALYTICS_PAGE,
   // etc...
 }