fix(be): differ failed command executions telemetry by their type (workbench/search)

re #RI-7496

Author: valkirilov

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

@@ -61,6 +61,7 @@ export enum TelemetryEvents {
 
   // Events for search tool
   SearchCommandExecuted = 'SEARCH_COMMAND_EXECUTED',
+  SearchCommandErrorReceived = 'SEARCH_COMMAND_ERROR_RECEIVED',
 
   // Custom tutorials
   WorkbenchEnablementAreaImportSucceeded = 'WORKBENCH_ENABLEMENT_AREA_IMPORT_SUCCEEDED',

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

@@ -393,6 +393,33 @@ describe('WorkbenchAnalytics', () => {
         },
       );
     });
+    it('should emit SearchCommandError event', async () => {
+      await service.sendCommandExecutedEvent(
+        mockSessionMetadata,
+        instanceId,
+        CommandExecutionType.Search,
+        {
+          response: 'Error',
+          error: redisReplyError,
+          status: CommandExecutionStatus.Fail,
+        },
+        { command: 'set', data: 'Some data' },
+      );
+
+      expect(sendEventMethod).toHaveBeenCalledWith(
+        mockSessionMetadata,
+        TelemetryEvents.SearchCommandErrorReceived,
+        {
+          databaseId: instanceId,
+          error: ReplyError.name,
+          command: 'set',
+          commandType: CommandType.Core,
+          moduleName: 'n/a',
+          capability: 'string',
+          data: 'Some data',
+        },
+      );
+    });
   });
   describe('sendCommandDeletedEvent', () => {
     it('should emit WorkbenchCommandDeleted event', () => {

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

@@ -78,7 +78,6 @@ export class WorkbenchAnalytics extends CommandTelemetryBaseService {
     additionalData: object = {},
   ): Promise<void> {
     const { status } = result;
-
     try {
       if (status === CommandExecutionStatus.Success) {
         this.sendEvent(
@@ -94,10 +93,16 @@ export class WorkbenchAnalytics extends CommandTelemetryBaseService {
         );
       }
       if (status === CommandExecutionStatus.Fail) {
-        this.sendCommandErrorEvent(sessionMetadata, databaseId, result.error, {
-          ...(await this.getCommandAdditionalInfo(additionalData['command'])),
-          ...additionalData,
-        });
+        this.sendCommandErrorEvent(
+          sessionMetadata,
+          databaseId,
+          result.error,
+          commandExecutionType,
+          {
+            ...(await this.getCommandAdditionalInfo(additionalData['command'])),
+            ...additionalData,
+          },
+        );
       }
     } catch (e) {
       // continue regardless of error
@@ -119,30 +124,27 @@ export class WorkbenchAnalytics extends CommandTelemetryBaseService {
     sessionMetadata: SessionMetadata,
     databaseId: string,
     error: any,
+    commandExecutionType: CommandExecutionType,
     additionalData: object = {},
   ): void {
     try {
+      const event =
+        commandExecutionType === CommandExecutionType.Search
+          ? TelemetryEvents.SearchCommandErrorReceived
+          : TelemetryEvents.WorkbenchCommandErrorReceived;
+
       if (error instanceof HttpException) {
-        this.sendFailedEvent(
-          sessionMetadata,
-          TelemetryEvents.WorkbenchCommandErrorReceived,
-          error,
-          {
-            databaseId,
-            ...additionalData,
-          },
-        );
+        this.sendFailedEvent(sessionMetadata, event, error, {
+          databaseId,
+          ...additionalData,
+        });
       } else {
-        this.sendEvent(
-          sessionMetadata,
-          TelemetryEvents.WorkbenchCommandErrorReceived,
-          {
-            databaseId,
-            error: error.name,
-            command: error?.command?.name,
-            ...additionalData,
-          },
-        );
+        this.sendEvent(sessionMetadata, event, {
+          databaseId,
+          error: error.name,
+          command: error?.command?.name,
+          ...additionalData,
+        });
       }
     } catch (e) {
       // continue regardless of error