build: query request logs

src/common/logger/loggerInstance.ts

@@ -67,7 +67,7 @@ export const loggerInstance = winston.createLogger({
   format: combine(
     timestamp({
       format: () => {
-        return dayjs().format('MM/DD/YYYY, h:mm:ss.SSS A');
+        return dayjs().format('MM/DD/YYYY, hh:mm:ss.SSS A');
       },
     }),
     logFormat,

src/common/swagger/ApiOkPaginateQueryResponse.ts

@@ -0,0 +1,31 @@
+import type { Type } from '@nestjs/common';
+import { applyDecorators } from '@nestjs/common';
+import { ApiExtraModels, ApiOkResponse, getSchemaPath } from '@nestjs/swagger';
+
+export const ApiOkPaginateQueryResponse = <T extends Type>(options: {
+  model: T;
+  description?: string;
+}) => {
+  const { model, description } = options;
+  const ref = { $ref: getSchemaPath(model) };
+  return applyDecorators(
+    ApiExtraModels(model),
+    ApiOkResponse({
+      description,
+      schema: {
+        type: 'array',
+        items: {
+          oneOf: [
+            {
+              type: 'array',
+              items: ref,
+            },
+            {
+              type: 'number',
+            },
+          ],
+        },
+      },
+    }),
+  );
+};

src/fastify/hook.ts

@@ -33,7 +33,7 @@ export const createFastifyInstance = (): FastifyInstance => {
 
   fastifyInstance.addHook('onSend', (_request, reply: FastifyReply, _payload, done) => {
     // fix log.middleware.ts can't get response headers
-    reply.raw.setHeader('x-request-id', getRequestId());
+    reply.raw.setHeader('x-request-id', getRequestId() || '');
     reply.header('x-process-time', `${reply.getResponseTime().toFixed(3)}ms`);
     reply.header('x-server-id', HOSTNAME);
     reply.header('x-server-time', DateTimeFormat());

src/post/post.service.ts

@@ -271,7 +271,7 @@ export class PostService extends BaseService {
       createdAt,
       skip,
       content,
-      public: _p,
+      public: isPublic,
       updatedAt,
       poster,
       summary,
@@ -283,7 +283,7 @@ export class PostService extends BaseService {
         title: super.iLike(title),
         createdAt: super.convertDateRangeToBetween(createdAt),
         content: super.iLike(content),
-        public: super.ignoreNilValue(_p),
+        public: isPublic,
         updatedAt: super.convertDateRangeToBetween(updatedAt),
         poster: {
           id: super.ignoreFalsyValue(poster?.id),

src/request-log/dto/query-request-log.dto.ts

@@ -0,0 +1,20 @@
+import { PaginatedBaseQuery } from '@/common/decorator/pagination/PaginationQuery';
+import { RequestLog } from '@/request-log/entities/request-log.entity';
+import { ApiProperty, IntersectionType, OmitType } from '@nestjs/swagger';
+
+export class QueryRequestLogDto extends IntersectionType(
+  PaginatedBaseQuery,
+  OmitType(RequestLog, ['createdAt', 'updatedAt']),
+) {
+  @ApiProperty({
+    description: '创建时间',
+    type: [Date, Date],
+  })
+  createdAt: [Date, Date];
+
+  @ApiProperty({
+    description: '更新时间',
+    type: [Date, Date],
+  })
+  updatedAt: [Date, Date];
+}

src/request-log/request-log.controller.ts

@@ -0,0 +1,34 @@
+import { AdminAuthGuard } from '@/common/decorator/auth-guard.decorator';
+import { BodyPagination } from '@/common/decorator/pagination/pagination.decorator';
+import { LoggerService } from '@/common/logger/logger.service';
+import { ApiOkPaginateQueryResponse } from '@/common/swagger/ApiOkPaginateQueryResponse';
+import { QueryRequestLogDto } from '@/request-log/dto/query-request-log.dto';
+import { RequestLog } from '@/request-log/entities/request-log.entity';
+import { RequestLogService } from '@/request-log/request-log.service';
+import { Controller, Post } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+
+@Controller('request-log-manage')
+@ApiTags('request-log-manage')
+@AdminAuthGuard()
+export class RequestLogController {
+  constructor(
+    private readonly logger: LoggerService,
+    private readonly requestLogService: RequestLogService,
+  ) {
+    this.logger.setContext(RequestLogController.name);
+  }
+
+  @Post('query-logs')
+  @ApiOperation({
+    summary: '分页查询请求日志',
+    operationId: 'queryLogs',
+  })
+  @ApiOkPaginateQueryResponse({
+    model: RequestLog,
+    description: '分页查询请求日志响应',
+  })
+  queryLogs(@BodyPagination() paginateQueryRequestLogDto: QueryRequestLogDto) {
+    return this.requestLogService.queryLogs(paginateQueryRequestLogDto);
+  }
+}

src/request-log/request-log.module.ts

@@ -1,4 +1,5 @@
 import { RequestLog } from '@/request-log/entities/request-log.entity';
+import { RequestLogController } from '@/request-log/request-log.controller';
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { CacheModule } from '@/common/cache/cache.module';
@@ -10,5 +11,6 @@ import { RequestLogService } from '@/request-log/request-log.service';
   imports: [OrmModule, TypeOrmModule.forFeature([RequestLog]), CacheModule, LoggerModule],
   providers: [RequestLogService],
   exports: [RequestLogService],
+  controllers: [RequestLogController],
 })
 export class RequestLogModule {}

src/request-log/request-log.service.ts

@@ -1,16 +1,19 @@
 import { LoggerService } from '@/common/logger/logger.service';
+import type { QueryRequestLogDto } from '@/request-log/dto/query-request-log.dto';
 import type { RequestLogDto } from '@/request-log/dto/request-log.dto';
 import { RequestLog } from '@/request-log/entities/request-log.entity';
+import { BaseService } from '@/service/base/BaseService';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
 
 @Injectable()
-export class RequestLogService {
+export class RequestLogService extends BaseService {
   constructor(
     @InjectRepository(RequestLog) private readonly requestLogDao: Repository<RequestLog>,
     private readonly logger: LoggerService,
   ) {
+    super();
     this.logger.setContext(RequestLogService.name);
   }
 
@@ -29,4 +32,46 @@ export class RequestLogService {
   async log(requestLog: Omit<RequestLog, 'id' | 'createdAt' | 'updatedAt'>) {
     return this.requestLogDao.save(requestLog);
   }
+
+  queryLogs(paginateQueryRequestLogDto: QueryRequestLogDto) {
+    const {
+      id,
+      updatedAt,
+      createdAt,
+      skip,
+      take,
+      requestId,
+      statusCode,
+      path,
+      referer,
+      userAgent,
+      ip,
+      ipInfo,
+      contentLength,
+      method,
+      processTime,
+    } = paginateQueryRequestLogDto;
+    return this.requestLogDao.findAndCount({
+      where: {
+        id: super.ignoreFalsyValue(id),
+        createdAt: super.convertDateRangeToBetween(createdAt),
+        updatedAt: super.convertDateRangeToBetween(updatedAt),
+        requestId: super.ignoreFalsyValue(requestId),
+        statusCode: super.ignoreFalsyValue(statusCode),
+        path: super.iLike(path),
+        referer: super.iLike(referer),
+        userAgent: super.iLike(userAgent),
+        ip,
+        ipInfo: super.iLike(ipInfo),
+        contentLength: super.ignoreEmptyString(contentLength),
+        method: super.ignoreEmptyString(method),
+        processTime: super.iLike(processTime),
+      },
+      take,
+      skip,
+      order: {
+        id: 'DESC',
+      },
+    });
+  }
 }

src/service/base/BaseService.ts

@@ -61,6 +61,10 @@ export class BaseService {
     return isNotNil(value) ? value : undefined;
   }
 
+  protected ignoreEmptyString(value?: string) {
+    return value === '' ? undefined : value;
+  }
+
   protected ignoreEmptyArray<T>(value?: T[]) {
     return value?.length ? In(value) : undefined;
   }

src/user/user.service.ts

@@ -385,6 +385,7 @@ export class UserService extends BaseService {
     const user = await this.queryUserCascadeInfo(id);
     user.lastIp = loginIp;
     user.lastAddress = getIpInfo(loginIp);
+    user.updatedAt = new Date();
     return this.saveUserAndCached(user);
   }
 }