changes to custom event type in analytics to return array of custom event types instead of one

Author: charliejlin

packages/analytics-service/src/modules/analytics/analytics.controller.ts

@@ -35,7 +35,7 @@ export class AnalyticsController
 
   async getCustomEventTypes(
     request: AnalyticsProto.CustomEventTypeRequest,
-  ): Promise<AnalyticsProto.CustomEventTypeResponse> {
+  ): Promise<AnalyticsProto.GetAllCustomEventTypeResponse> {
     return await this.analyticsService.getCustomEventTypes(request);
   }
 

packages/analytics-service/src/modules/analytics/analytics.service.ts

@@ -320,7 +320,7 @@ export class AnalyticsService implements OnModuleInit {
 
   async getCustomEventTypes(
     request: AnalyticsProto.CustomEventTypeRequest,
-  ): Promise<AnalyticsProto.CustomEventTypeResponse> {
+  ): Promise<AnalyticsProto.GetAllCustomEventTypeResponse> {
     // TODO: environments
     const viewer = await this.getAnalyticsViewer(
       this.EventEnvironment.DEVELOPMENT,
@@ -339,23 +339,18 @@ export class AnalyticsService implements OnModuleInit {
 
     if (!response || response.length === 0) {
       return {
-        id: '',
-        category: '',
-        subcategory: '',
-        properties: [],
-        projectId: '',
+        eventTypes: [],
       };
     }
 
-    // TODO: This should not return only the first type
-    // Return the first custom event type for now
-    const eventType = response[0];
     return {
-      id: eventType._id || '',
-      category: eventType.category,
-      subcategory: eventType.subcategory,
-      properties: eventType.properties,
-      projectId: eventType.projectId,
+      eventTypes: response.map((eventType) => ({
+        id: eventType._id,
+        category: eventType.category,
+        subcategory: eventType.subcategory,
+        properties: [...eventType.properties],
+        projectId: eventType.projectId,
+      })),
     };
   }
 

packages/api-gateway/src/models/analytics.dto.ts

@@ -454,6 +454,24 @@ export class CustomEventTypeResponse {
   }
 }
 
+export class GetAllCustomEventTypeResponse {
+  @ApiProperty({
+    type: [CustomEventTypeResponse],
+    description: 'All custom event types',
+  })
+  eventTypes: CustomEventTypeResponse[];
+
+  constructor(response: AnalyticsProto.GetAllCustomEventTypeResponse) {
+    if (!response || !response.eventTypes) {
+      return;
+    }
+
+    this.eventTypes = response.eventTypes.map(
+      (eventType) => new CustomEventTypeResponse(eventType),
+    );
+  }
+}
+
 export class CustomGraphType {
   @ApiProperty({ type: 'string', description: 'Graph ID' })
   id: string;

packages/api-gateway/src/modules/analytics/analytics.controller.ts

@@ -38,7 +38,6 @@ import {
   VisitEventResponse,
   InputEventResponse,
   CustomEventResponse,
-  CustomEventTypeResponse,
   CustomGraphTypeResponse,
   GetClickEventsResponse,
   GetVisitEventsResponse,
@@ -48,6 +47,7 @@ import {
   GetAllVisitEventsResponse,
   GetAllInputEventsResponse,
   GetAllCustomEventsResponse,
+  GetAllCustomEventTypeResponse,
 } from 'src/models/analytics.dto';
 
 const { ANALYTICS_SERVICE_NAME } = AnalyticsProto;
@@ -183,15 +183,15 @@ export class AnalyticsController implements OnModuleInit {
   @ApiOperation({ summary: 'Get custom event types for a project' })
   @ApiOkResponse({
     description: 'Custom event types retrieved successfully',
-    type: CustomEventTypeResponse,
+    type: GetAllCustomEventTypeResponse,
   })
   @ApiUnauthorizedResponse({ description: 'Unauthorized' })
   @ApiBadRequestResponse({ description: 'Bad Request' })
   @ApiQuery({ name: 'projectName', type: String, description: 'Project name' })
   async getCustomEventTypes(
     @ApiKey() apiKey: AuthCommonProto.ApiKey,
     @Query() query: GetCustomEventTypesQuery,
-  ): Promise<CustomEventTypeResponse> {
+  ): Promise<GetAllCustomEventTypeResponse> {
     await validateOrReject(query);
 
     const response = await lastValueFrom(
@@ -202,7 +202,7 @@ export class AnalyticsController implements OnModuleInit {
       }),
     );
 
-    return new CustomEventTypeResponse(response);
+    return new GetAllCustomEventTypeResponse(response);
   }
 
   @Get('custom-graph-types')

packages/proto/definitions/analytics.proto

@@ -10,7 +10,7 @@ service AnalyticsService {
     rpc logCustomEvent(CustomEventRequest) returns (CustomEventResponse);
 
     // AnalyticsViewer methods
-    rpc getCustomEventTypes(CustomEventTypeRequest) returns (CustomEventTypeResponse);
+    rpc getCustomEventTypes(CustomEventTypeRequest) returns (GetAllCustomEventTypeResponse);
     rpc getCustomGraphTypesById(CustomGraphTypeRequest) returns (CustomGraphTypeResponse);
     rpc getClickEventsPaginated(GetClickEventsRequest) returns (GetClickEventsResponse);
     rpc getAllClickEvents(GetAllClickEventsRequest) returns (GetAllClickEventsResponse);
@@ -245,6 +245,10 @@ message CustomEventTypeResponse {
     string project_id = 5;
 }
 
+message GetAllCustomEventTypeResponse {
+    repeated CustomEventTypeResponse eventTypes = 1;
+}
+
 message CustomGraphTypeResponse {
     repeated CustomGraphType graphs = 1;
 }