feat: update telemetry log to use email instead of userId; modify related components and services

Author: NarwhalChen

backend/src/dashboard/dto/telemetry-log-input.ts

@@ -15,7 +15,7 @@ export class TelemetryLogFilterInput {
   endpoint?: string;
 
   @Field({ nullable: true })
-  userId?: string;
+  email?: string;
 
   @Field({ nullable: true })
   handler?: string;

backend/src/interceptor/LoggingInterceptor.ts

@@ -10,21 +10,30 @@ import { Observable } from 'rxjs';
 import { tap } from 'rxjs/operators';
 import { GqlExecutionContext } from '@nestjs/graphql';
 import { TelemetryLogService } from './telemetry-log.service';
-import { GetUserIdFromToken } from 'src/decorator/get-auth-token.decorator';
+import { InjectRepository } from '@nestjs/typeorm';
+import { User } from 'src/user/user.model';
+import { Repository } from 'typeorm';
 
 @Injectable()
 export class LoggingInterceptor implements NestInterceptor {
   private readonly logger = new Logger('RequestLogger');
   private startTime: number;
 
-  constructor(private telemetryLogService: TelemetryLogService) {}
+  constructor(
+    private telemetryLogService: TelemetryLogService,
+    @InjectRepository(User)
+    private readonly userRepository: Repository<User>,
+  ) {}
 
-  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+  async intercept(
+    context: ExecutionContext,
+    next: CallHandler,
+  ): Promise<Observable<any>> {
     const contextType = context.getType();
     this.logger.debug(`Intercepting request, Context Type: ${contextType}`);
 
     if (contextType === ('graphql' as ContextType)) {
-      return this.handleGraphQLRequest(context, next);
+      return await this.handleGraphQLRequest(context, next);
     } else if (contextType === 'http') {
       return this.handleRestRequest(context, next);
     } else {
@@ -33,13 +42,18 @@ export class LoggingInterceptor implements NestInterceptor {
     }
   }
 
-  private handleGraphQLRequest(
+  private async handleGraphQLRequest(
     context: ExecutionContext,
     next: CallHandler,
-  ): Observable<any> {
+  ): Promise<Observable<any>> {
     const ctx = GqlExecutionContext.create(context);
     const info = ctx.getInfo();
     const userId = ctx.getContext().req.user?.userId;
+    const user = await this.userRepository.findOne({
+      where: { id: userId },
+      select: { email: true },
+    });
+    const email = user?.email;
     if (!info) {
       this.logger.warn(
         'GraphQL request detected, but ctx.getInfo() is undefined.',
@@ -76,6 +90,7 @@ export class LoggingInterceptor implements NestInterceptor {
             output: JSON.stringify(value),
             timeConsumed,
             userId,
+            email,
             handler: 'GraphQL',
           });
         },

backend/src/interceptor/interceptor.module.ts

@@ -3,9 +3,10 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { TelemetryLog } from './telemetry-log.model';
 import { TelemetryLogService } from './telemetry-log.service';
 import { LoggingInterceptor } from './LoggingInterceptor';
+import { User } from 'src/user/user.model';
 
 @Module({
-  imports: [TypeOrmModule.forFeature([TelemetryLog])],
+  imports: [TypeOrmModule.forFeature([TelemetryLog, User])],
   providers: [TelemetryLogService, LoggingInterceptor],
   exports: [TelemetryLogService, LoggingInterceptor],
 })

backend/src/interceptor/telemetry-log.model.ts

@@ -44,6 +44,10 @@ export class TelemetryLog {
   @Field({ nullable: true })
   userId: string;
 
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  email: string;
+
   @Column({ nullable: true })
   @Field({ nullable: true })
   handler: string;

backend/src/interceptor/telemetry-log.service.ts

@@ -48,9 +48,6 @@ export class TelemetryLogService {
         endpoint: `%${filter.endpoint}%`,
       });
     }
-    if (filter.userId) {
-      query.andWhere('log.userId = :userId', { userId: filter.userId });
-    }
     if (filter.handler) {
       query.andWhere('log.handler LIKE :handler', {
         handler: `%${filter.handler}%`,
@@ -102,8 +99,8 @@ export class TelemetryLogService {
           endpoint: `%${filter.endpoint}%`,
         });
       }
-      if (filter.userId) {
-        query.andWhere('log.userId = :userId', { userId: filter.userId });
+      if (filter.email) {
+        query.andWhere('log.email = :email', { email: filter.email });
       }
       if (filter.handler) {
         query.andWhere('log.handler LIKE :handler', {

dashboard/src/content/management/telemetry/TelemetryLogs.tsx

@@ -31,7 +31,7 @@ interface TelemetryLog {
   input?: string;
   output?: string;
   timeConsumed: number;
-  userId?: string;
+  email?: string;
   handler: string;
 }
 
@@ -40,7 +40,7 @@ interface TelemetryLogFilterInput {
   endDate?: Date;
   requestMethod?: string;
   endpoint?: string;
-  userId?: string;
+  email?: string;
   handler?: string;
   minTimeConsumed?: number;
   maxTimeConsumed?: number;
@@ -125,10 +125,10 @@ const TelemetryLogs = () => {
               onChange={handleFilterChange('handler')}
             />
             <TextField
-              label="User ID"
+              label="Email"
               size="small"
-              value={filter.userId || ''}
-              onChange={handleFilterChange('userId')}
+              value={filter.email || ''}
+              onChange={handleFilterChange('email')}
             />
           </Box>
         )}
@@ -142,7 +142,7 @@ const TelemetryLogs = () => {
                 <TableCell>Endpoint</TableCell>
                 <TableCell>Handler</TableCell>
                 <TableCell>Time (ms)</TableCell>
-                <TableCell>User ID</TableCell>
+                <TableCell>Email</TableCell>
                 <TableCell>Actions</TableCell>
               </TableRow>
             </TableHead>
@@ -163,7 +163,7 @@ const TelemetryLogs = () => {
                     <TableCell>{log.endpoint}</TableCell>
                     <TableCell>{log.handler}</TableCell>
                     <TableCell>{log.timeConsumed}</TableCell>
-                    <TableCell>{log.userId || '-'}</TableCell>
+                    <TableCell>{log.email || '-'}</TableCell>
                     <TableCell>
                       <Tooltip title="View Details">
                         <IconButton

dashboard/src/graphql/request.ts

@@ -478,7 +478,7 @@ export const GET_DASHBOARD_TELEMETRY_LOGS = gql`
       input
       output
       timeConsumed
-      userId
+      email
       handler
     }
   }
@@ -494,7 +494,7 @@ export const GET_DASHBOARD_TELEMETRY_LOG = gql`
       input
       output
       timeConsumed
-      userId
+      email
       handler
     }
   }

frontend/src/graphql/schema.gql

@@ -334,6 +334,7 @@ type SystemRole {
 }
 
 type TelemetryLog {
+  email: String
   endpoint: String!
   handler: String
   id: ID!
@@ -348,6 +349,7 @@ type TelemetryLog {
 }
 
 input TelemetryLogFilterInput {
+  email: String
   endDate: Date
   endpoint: String
   handler: String
@@ -356,7 +358,6 @@ input TelemetryLogFilterInput {
   requestMethod: String
   search: String
   startDate: Date
-  userId: String
 }
 
 input UpdateChatInput {

frontend/src/graphql/type.tsx

@@ -620,6 +620,7 @@ export type SystemRole = {
 
 export type TelemetryLog = {
   __typename: 'TelemetryLog';
+  email?: Maybe<Scalars['String']['output']>;
   endpoint: Scalars['String']['output'];
   handler?: Maybe<Scalars['String']['output']>;
   id: Scalars['ID']['output'];
@@ -634,6 +635,7 @@ export type TelemetryLog = {
 };
 
 export type TelemetryLogFilterInput = {
+  email?: InputMaybe<Scalars['String']['input']>;
   endDate?: InputMaybe<Scalars['Date']['input']>;
   endpoint?: InputMaybe<Scalars['String']['input']>;
   handler?: InputMaybe<Scalars['String']['input']>;
@@ -642,7 +644,6 @@ export type TelemetryLogFilterInput = {
   requestMethod?: InputMaybe<Scalars['String']['input']>;
   search?: InputMaybe<Scalars['String']['input']>;
   startDate?: InputMaybe<Scalars['Date']['input']>;
-  userId?: InputMaybe<Scalars['String']['input']>;
 };
 
 export type UpdateChatInput = {
@@ -1654,6 +1655,7 @@ export type TelemetryLogResolvers<
   ParentType extends
     ResolversParentTypes['TelemetryLog'] = ResolversParentTypes['TelemetryLog'],
 > = ResolversObject<{
+  email?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   endpoint?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   handler?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;