#RI-4447 - update bulk actions telemetry (#2105)

* #RI-4447 - update bulk actions telemetry

Author: AmirAllayarovSofteq

redisinsight/api/src/__mocks__/analytics.ts

@@ -1,3 +1,14 @@
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { BulkActionsAnalyticsService } from 'src/modules/bulk-actions/bulk-actions-analytics.service';
+
+const mockEmitter = new EventEmitter2();
+
+class AnalyticsService extends BulkActionsAnalyticsService {
+  constructor(protected eventEmitter: EventEmitter2) {
+    super(eventEmitter);
+  }
+}
+
 export const mockInstancesAnalyticsService = () => ({
   sendInstanceListReceivedEvent: jest.fn(),
   sendInstanceAddedEvent: jest.fn(),
@@ -29,6 +40,8 @@ export const mockSettingsAnalyticsService = () => ({
   sendSettingsUpdatedEvent: jest.fn(),
 });
 
+export const mockBulActionsAnalyticsService = new AnalyticsService(mockEmitter);
+
 export const mockPubSubAnalyticsService = () => ({
   sendMessagePublishedEvent: jest.fn(),
   sendChannelSubscribeEvent: jest.fn(),

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

@@ -64,6 +64,8 @@ export enum TelemetryEvents {
   // Bulk Actions
   BulkActionsStarted = 'BULK_ACTIONS_STARTED',
   BulkActionsStopped = 'BULK_ACTIONS_STOPPED',
+  BulkActionsSucceed = 'BULK_ACTIONS_SUCCEED',
+  BulkActionsFailed = 'BULK_ACTIONS_FAILED',
 }
 
 export enum CommandType {

redisinsight/api/src/modules/bulk-actions/bulk-actions-analytics.service.ts

@@ -1,7 +1,8 @@
-import { Injectable } from '@nestjs/common';
+import { HttpException, Injectable } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { TelemetryEvents } from 'src/constants';
 import { TelemetryBaseService } from 'src/modules/analytics/telemetry.base.service';
+import { getRangeForNumber, BULK_ACTIONS_BREAKPOINTS } from 'src/utils';
 import { CommandExecutionStatus } from 'src/modules/cli/dto/cli.dto';
 import { RedisError, ReplyError } from 'src/models';
 import { IBulkActionOverview } from 'src/modules/bulk-actions/interfaces/bulk-action-overview.interface';
@@ -20,6 +21,8 @@ export class BulkActionsAnalyticsService extends TelemetryBaseService {
     super(eventEmitter);
     this.events.set(TelemetryEvents.BulkActionsStarted, this.sendActionStarted.bind(this));
     this.events.set(TelemetryEvents.BulkActionsStopped, this.sendActionStopped.bind(this));
+    this.events.set(TelemetryEvents.BulkActionsSucceed, this.sendActionSucceed.bind(this));
+    this.events.set(TelemetryEvents.BulkActionsFailed, this.sendActionFailed.bind(this));
   }
 
   sendActionStarted(overview: IBulkActionOverview): void {
@@ -36,7 +39,9 @@ export class BulkActionsAnalyticsService extends TelemetryBaseService {
           },
           progress: {
             scanned: overview.progress?.scanned,
+            scannedRange: getRangeForNumber(overview.progress?.scanned, BULK_ACTIONS_BREAKPOINTS),
             total: overview.progress?.total,
+            totalRange: getRangeForNumber(overview.progress?.total, BULK_ACTIONS_BREAKPOINTS),
           },
         },
       );
@@ -59,12 +64,17 @@ export class BulkActionsAnalyticsService extends TelemetryBaseService {
           },
           progress: {
             scanned: overview.progress?.scanned,
+            scannedRange: getRangeForNumber(overview.progress?.scanned, BULK_ACTIONS_BREAKPOINTS),
             total: overview.progress?.total,
+            totalRange: getRangeForNumber(overview.progress?.total, BULK_ACTIONS_BREAKPOINTS),
           },
           summary: {
             processed: overview.summary?.processed,
+            processedRange: getRangeForNumber(overview.summary?.processed, BULK_ACTIONS_BREAKPOINTS),
             succeed: overview.summary?.succeed,
+            succeedRange: getRangeForNumber(overview.summary?.succeed, BULK_ACTIONS_BREAKPOINTS),
             failed: overview.summary.failed,
+            failedRange: getRangeForNumber(overview.summary.failed, BULK_ACTIONS_BREAKPOINTS),
           },
         },
       );
@@ -73,6 +83,54 @@ export class BulkActionsAnalyticsService extends TelemetryBaseService {
     }
   }
 
+  sendActionSucceed(overview: IBulkActionOverview): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.BulkActionsSucceed,
+        {
+          databaseId: overview.databaseId,
+          type: overview.type,
+          duration: overview.duration,
+          filter: {
+            match: overview.filter?.match === '*' ? '*' : 'PATTERN',
+            type: overview.filter?.type,
+          },
+          progress: {
+            scanned: overview.progress?.scanned,
+            scannedRange: getRangeForNumber(overview.progress?.scanned, BULK_ACTIONS_BREAKPOINTS),
+            total: overview.progress?.total,
+            totalRange: getRangeForNumber(overview.progress?.total, BULK_ACTIONS_BREAKPOINTS),
+          },
+          summary: {
+            processed: overview.summary?.processed,
+            processedRange: getRangeForNumber(overview.summary?.processed, BULK_ACTIONS_BREAKPOINTS),
+            succeed: overview.summary?.succeed,
+            succeedRange: getRangeForNumber(overview.summary?.succeed, BULK_ACTIONS_BREAKPOINTS),
+            failed: overview.summary.failed,
+            failedRange: getRangeForNumber(overview.summary.failed, BULK_ACTIONS_BREAKPOINTS),
+          },
+        },
+      );
+    } catch (e) {
+      // continue regardless of error
+    }
+  }
+
+  sendActionFailed(overview: IBulkActionOverview, error: HttpException | Error): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.BulkActionsFailed,
+        {
+          databaseId: overview.databaseId,
+          type: overview.type,
+          error,
+        },
+      );
+    } catch (e) {
+      // continue regardless of error
+    }
+  }
+
   getEventsEmitters(): Map<TelemetryEvents, Function> {
     return this.events;
   }

redisinsight/api/src/modules/bulk-actions/bulk-actions.service.spec.ts

@@ -3,6 +3,7 @@ import * as MockedSocket from 'socket.io-mock';
 import { Test, TestingModule } from '@nestjs/testing';
 import {
   MockType,
+  mockBulActionsAnalyticsService,
 } from 'src/__mocks__';
 import { BulkActionsProvider } from 'src/modules/bulk-actions/providers/bulk-actions.provider';
 import { RedisDataType } from 'src/modules/browser/dto';
@@ -43,6 +44,7 @@ const mockBulkAction = new BulkAction(
   mockCreateBulkActionDto.type,
   mockBulkActionFilter,
   mockSocket1,
+  mockBulActionsAnalyticsService,
 );
 const mockOverview = 'mocked overview...';
 
@@ -72,6 +74,8 @@ describe('BulkActionsService', () => {
           useFactory: () => ({
             sendActionStarted: jest.fn(),
             sendActionStopped: jest.fn(),
+            sendActionSucceed: jest.fn(),
+            sendActionFailed: jest.fn(),
           }),
         },
       ],

redisinsight/api/src/modules/bulk-actions/bulk-import.service.spec.ts

@@ -16,6 +16,7 @@ import { BulkActionsAnalyticsService } from 'src/modules/bulk-actions/bulk-actio
 import * as fs from 'fs-extra';
 import config from 'src/utils/config';
 import { join } from 'path';
+import { wrapHttpError } from 'src/common/utils';
 
 const PATH_CONFIG = config.get('dir_path');
 
@@ -34,6 +35,13 @@ const mockSummary: BulkActionSummary = Object.assign(new BulkActionSummary(), {
   errors: [],
 });
 
+const mockEmptySummary: BulkActionSummary = Object.assign(new BulkActionSummary(), {
+  processed: 0,
+  succeed: 0,
+  failed: 0,
+  errors: [],
+});
+
 const mockSummaryWithErrors = Object.assign(new BulkActionSummary(), {
   processed: 100,
   succeed: 99,
@@ -52,6 +60,17 @@ const mockImportResult: IBulkActionOverview = {
   duration: 100,
 };
 
+const mockEmptyImportResult: IBulkActionOverview = {
+  id: 'empty',
+  databaseId: mockClientMetadata.databaseId,
+  type: BulkActionType.Import,
+  summary: mockEmptySummary.getOverview(),
+  progress: null,
+  filter: null,
+  status: BulkActionStatus.Completed,
+  duration: 0,
+};
+
 const mockUploadImportFileDto = {
   file: {
     originalname: 'filename',
@@ -88,6 +107,8 @@ describe('BulkImportService', () => {
           useFactory: () => ({
             sendActionStarted: jest.fn(),
             sendActionStopped: jest.fn(),
+            sendActionSucceed: jest.fn(),
+            sendActionFailed: jest.fn(),
           }),
         },
       ],
@@ -135,7 +156,7 @@ describe('BulkImportService', () => {
         ...mockImportResult,
         duration: jasmine.anything(),
       });
-      expect(analytics.sendActionStopped).toHaveBeenCalledWith({
+      expect(analytics.sendActionSucceed).toHaveBeenCalledWith({
         ...mockImportResult,
         duration: jasmine.anything(),
       });
@@ -220,6 +241,10 @@ describe('BulkImportService', () => {
         fail();
       } catch (e) {
         expect(mockIORedisClient.disconnect).not.toHaveBeenCalled();
+        expect(analytics.sendActionFailed).toHaveBeenCalledWith(
+          { ...mockEmptyImportResult },
+          wrapHttpError(e),
+        );
         expect(e).toBeInstanceOf(NotFoundException);
       }
     });

redisinsight/api/src/modules/bulk-actions/bulk-import.service.ts

@@ -1,4 +1,4 @@
-import { join, resolve } from 'path';
+import { join } from 'path';
 import * as fs from 'fs-extra';
 import { BadRequestException, Injectable, Logger } from '@nestjs/common';
 import { Readable } from 'stream';
@@ -115,6 +115,7 @@ export class BulkImportService {
         rl.on('error', (error) => {
           result.summary.errors.push(error);
           result.status = BulkActionStatus.Failed;
+          this.analyticsService.sendActionFailed(result, error);
           res(null);
         });
         rl.on('close', () => {
@@ -133,15 +134,19 @@ export class BulkImportService {
       result.summary.processed += parseErrors;
       result.summary.failed += parseErrors;
 
-      this.analyticsService.sendActionStopped(result);
+      if (result.status === BulkActionStatus.Completed) {
+        this.analyticsService.sendActionSucceed(result);
+      }
 
       client.disconnect();
 
       return result;
     } catch (e) {
       this.logger.error('Unable to process an import file', e);
+      const exception = wrapHttpError(e);
+      this.analyticsService.sendActionFailed(result, exception);
       client?.disconnect();
-      throw wrapHttpError(e);
+      throw exception;
     }
   }
 

redisinsight/api/src/modules/bulk-actions/models/bulk-action.spec.ts

@@ -2,6 +2,7 @@ import IORedis from 'ioredis';
 import { omit } from 'lodash';
 import {
   mockSocket,
+  mockBulActionsAnalyticsService,
 } from 'src/__mocks__';
 import {
   DeleteBulkActionSimpleRunner,
@@ -34,6 +35,23 @@ const mockCreateBulkActionDto = {
   type: BulkActionType.Delete,
 };
 
+const mockOverview = {
+  ...mockCreateBulkActionDto,
+  duration: 0,
+  filter: { match: '*', type: null },
+  progress: {
+    scanned: 0,
+    total: 0,
+  },
+  status: 'completed',
+  summary: {
+    failed: 0,
+    processed: 0,
+    succeed: 0,
+    errors: [],
+  },
+};
+
 let bulkAction;
 let mockRunner;
 let mockSummary;
@@ -85,6 +103,7 @@ describe('AbstractBulkActionSimpleRunner', () => {
       mockCreateBulkActionDto.type,
       mockBulkActionFilter,
       mockSocket,
+      mockBulActionsAnalyticsService,
     );
   });
 
@@ -303,8 +322,12 @@ describe('AbstractBulkActionSimpleRunner', () => {
   });
   describe('sendOverview', () => {
     let sendOverviewSpy;
+    let sendActionSucceedSpy;
+    let sendActionFailedSpy;
 
     beforeEach(() => {
+      sendActionSucceedSpy = jest.spyOn(bulkAction['analyticsService'], 'sendActionSucceed');
+      sendActionFailedSpy = jest.spyOn(bulkAction['analyticsService'], 'sendActionFailed');
       sendOverviewSpy = jest.spyOn(bulkAction, 'sendOverview');
     });
 
@@ -320,6 +343,37 @@ describe('AbstractBulkActionSimpleRunner', () => {
 
       expect(sendOverviewSpy).toHaveBeenCalledTimes(1);
     });
+
+    it('Should call sendActionSucceed', () => {
+      mockSocket.emit.mockReturnValue();
+
+      bulkAction['status'] = BulkActionStatus.Completed;
+
+      bulkAction.sendOverview();
+
+      expect(sendOverviewSpy).toHaveBeenCalledTimes(1);
+      expect(sendActionFailedSpy).not.toHaveBeenCalled();
+      expect(sendActionSucceedSpy).toHaveBeenCalledWith(mockOverview);
+    });
+
+    it('Should call sendActionFailed', () => {
+      mockSocket.emit.mockReturnValue();
+
+      bulkAction['status'] = BulkActionStatus.Failed;
+      bulkAction['error'] = 'some error';
+
+      bulkAction.sendOverview();
+
+      expect(sendOverviewSpy).toHaveBeenCalledTimes(1);
+      expect(sendActionSucceedSpy).not.toHaveBeenCalled();
+      expect(sendActionFailedSpy).toHaveBeenCalledWith(
+        {
+          ...mockOverview,
+          status: 'failed',
+        },
+        'some error',
+      );
+    });
   });
   describe('Other', () => {
     it('getters', () => {