add telemetry events for default data upload

Author: arthosofteq

redisinsight/api/src/__mocks__/bulk-actions.ts

@@ -92,4 +92,5 @@ export const mockBulkActionsAnalytics = () => ({
   sendActionStopped: jest.fn(),
   sendActionSucceed: jest.fn(),
   sendActionFailed: jest.fn(),
+  sendImportSamplesUploaded: jest.fn(),
 });

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

@@ -78,6 +78,7 @@ export enum TelemetryEvents {
   BulkActionsStopped = 'BULK_ACTIONS_STOPPED',
   BulkActionsSucceed = 'BULK_ACTIONS_SUCCEED',
   BulkActionsFailed = 'BULK_ACTIONS_FAILED',
+  ImportSamplesUploaded = 'IMPORT_SAMPLES_UPLOADED',
 
   // Feature
   FeatureFlagConfigUpdated = 'FEATURE_FLAG_CONFIG_UPDATED',

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

@@ -223,4 +223,48 @@ describe('BulkActionsAnalytics', () => {
       expect(sendFailedEventSpy).not.toHaveBeenCalled();
     });
   });
+
+  describe('sendImportSamplesUploaded', () => {
+    it('should emit event when action succeed (without progress)', () => {
+      service.sendImportSamplesUploaded(mockBulkActionOverview);
+
+      expect(sendEventSpy).toHaveBeenCalledWith(
+        TelemetryEvents.ImportSamplesUploaded,
+        {
+          databaseId: mockBulkActionOverview.databaseId,
+          action: mockBulkActionOverview.type,
+          duration: mockBulkActionOverview.duration,
+          summary: {
+            processed: mockBulkActionOverview.summary.processed,
+            processedRange: '0 - 5 000',
+            succeed: mockBulkActionOverview.summary.succeed,
+            succeedRange: '0 - 5 000',
+            failed: mockBulkActionOverview.summary.failed,
+            failedRange: '0 - 5 000',
+          },
+        },
+      );
+    });
+    it('should emit event when action succeed without filter and summary', () => {
+      service.sendImportSamplesUploaded({
+        ...mockBulkActionOverview,
+        filter: undefined,
+        summary: undefined,
+      });
+
+      expect(sendEventSpy).toHaveBeenCalledWith(
+        TelemetryEvents.ImportSamplesUploaded,
+        {
+          databaseId: mockBulkActionOverview.databaseId,
+          action: mockBulkActionOverview.type,
+          duration: mockBulkActionOverview.duration,
+          summary: {},
+        },
+      );
+    });
+    it('should not emit event in case of an error and should not fail', () => {
+      service.sendImportSamplesUploaded(undefined);
+      expect(sendEventSpy).not.toHaveBeenCalled();
+    });
+  });
 });

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

@@ -105,4 +105,27 @@ export class BulkActionsAnalytics extends TelemetryBaseService {
       // continue regardless of error
     }
   }
+
+  sendImportSamplesUploaded(overview: IBulkActionOverview): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.ImportSamplesUploaded,
+        {
+          databaseId: overview.databaseId,
+          action: overview.type,
+          duration: overview.duration,
+          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
+    }
+  }
 }

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

@@ -212,7 +212,11 @@ export class BulkImportService {
         commandsStream.append('\r\n');
       });
 
-      return this.import(clientMetadata, commandsStream);
+      const result = await this.import(clientMetadata, commandsStream);
+
+      this.analytics.sendImportSamplesUploaded(result);
+
+      return result;
     } catch (e) {
       this.logger.error('Unable to process an import file path from tutorial', e);
       throw new InternalServerErrorException(ERROR_MESSAGES.COMMON_DEFAULT_IMPORT_ERROR);