From 27c80f7d56bba6317e6c0c7347d2a6e8dde35fae Mon Sep 17 00:00:00 2001 From: Gao Sun Date: Tue, 20 Dec 2022 14:00:03 +0800 Subject: [PATCH] refactor(core): fix log --- .../core/src/middleware/koa-audit-log-legacy.test.ts | 6 +++--- packages/core/src/middleware/koa-audit-log.test.ts | 10 +++++----- packages/core/src/queries/log.ts | 6 +++--- packages/core/src/routes/log.test.ts | 10 +++++----- packages/core/src/routes/log.ts | 8 ++++---- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/packages/core/src/middleware/koa-audit-log-legacy.test.ts b/packages/core/src/middleware/koa-audit-log-legacy.test.ts index cda3d0226..a8fe23bc4 100644 --- a/packages/core/src/middleware/koa-audit-log-legacy.test.ts +++ b/packages/core/src/middleware/koa-audit-log-legacy.test.ts @@ -58,7 +58,7 @@ describe('koaLog middleware', () => { expect(insertLog).toBeCalledWith({ id: nanoIdMock, - type, + key: type, payload: { ...mockPayload, ...additionalMockPayload, @@ -105,7 +105,7 @@ describe('koaLog middleware', () => { expect(insertLog).toBeCalledWith({ id: nanoIdMock, - type, + key: type, payload: { ...mockPayload, result: LogResult.Error, @@ -139,7 +139,7 @@ describe('koaLog middleware', () => { expect(insertLog).toBeCalledWith({ id: nanoIdMock, - type, + key: type, payload: { ...mockPayload, result: LogResult.Error, diff --git a/packages/core/src/middleware/koa-audit-log.test.ts b/packages/core/src/middleware/koa-audit-log.test.ts index 7e76a6cb9..982c50cd9 100644 --- a/packages/core/src/middleware/koa-audit-log.test.ts +++ b/packages/core/src/middleware/koa-audit-log.test.ts @@ -54,7 +54,7 @@ describe('koaAuditLog middleware', () => { expect(insertLog).toBeCalledWith({ id: nanoIdMock, - type: logKey, + key: logKey, payload: { ...mockPayload, ...additionalMockPayload, @@ -93,12 +93,12 @@ describe('koaAuditLog middleware', () => { expect(insertLog).toHaveBeenCalledWith({ id: nanoIdMock, - type: logKey, + key: logKey, payload: basePayload, }); expect(insertLog).toHaveBeenCalledWith({ id: nanoIdMock, - type: logKey, + key: logKey, payload: { ...basePayload, ...additionalMockPayload, @@ -139,7 +139,7 @@ describe('koaAuditLog middleware', () => { expect(insertLog).toBeCalledWith({ id: nanoIdMock, - type: logKey, + key: logKey, payload: { ...mockPayload, key: logKey, @@ -176,7 +176,7 @@ describe('koaAuditLog middleware', () => { expect(insertLog).toHaveBeenCalledTimes(2); expect(insertLog).toBeCalledWith({ id: nanoIdMock, - type: logKey, + key: logKey, payload: { ...mockPayload, key: logKey, diff --git a/packages/core/src/queries/log.ts b/packages/core/src/queries/log.ts index feb9de78c..fc1cd4235 100644 --- a/packages/core/src/queries/log.ts +++ b/packages/core/src/queries/log.ts @@ -12,15 +12,15 @@ const { table, fields } = convertToIdentifiers(Logs); export const insertLog = buildInsertInto(Logs); export type LogCondition = { - logType?: string; + logKey?: string; applicationId?: string; userId?: string; }; const buildLogConditionSql = (logCondition: LogCondition) => - conditionalSql(logCondition, ({ logType, applicationId, userId }) => { + conditionalSql(logCondition, ({ logKey, applicationId, userId }) => { const subConditions = [ - conditionalSql(logType, (logType) => sql`${fields.key}=${logType}`), + conditionalSql(logKey, (logKey) => sql`${fields.key}=${logKey}`), conditionalSql(userId, (userId) => sql`${fields.payload}->>'userId'=${userId}`), conditionalSql( applicationId, diff --git a/packages/core/src/routes/log.test.ts b/packages/core/src/routes/log.test.ts index ae3d50504..bc3dde89c 100644 --- a/packages/core/src/routes/log.test.ts +++ b/packages/core/src/routes/log.test.ts @@ -4,7 +4,7 @@ import { createRequester } from '#src/utils/test-utils.js'; const { jest } = import.meta; -const mockBody = { type: 'a', payload: {}, createdAt: 123 }; +const mockBody = { key: 'a', payload: {}, createdAt: 123 }; const mockLog = { id: '1', ...mockBody }; const mockLogs = [mockLog, { id: '2', ...mockBody }]; @@ -28,15 +28,15 @@ describe('logRoutes', () => { it('should call countLogs and findLogs with correct parameters', async () => { const userId = 'userIdValue'; const applicationId = 'foo'; - const logType = 'SignInUsernamePassword'; + const logKey = 'SignInUsernamePassword'; const page = 1; const pageSize = 5; await logRequest.get( - `/logs?userId=${userId}&applicationId=${applicationId}&logType=${logType}&page=${page}&page_size=${pageSize}` + `/logs?userId=${userId}&applicationId=${applicationId}&logKey=${logKey}&page=${page}&page_size=${pageSize}` ); - expect(countLogs).toHaveBeenCalledWith({ userId, applicationId, logType }); - expect(findLogs).toHaveBeenCalledWith(5, 0, { userId, applicationId, logType }); + expect(countLogs).toHaveBeenCalledWith({ userId, applicationId, logKey }); + expect(findLogs).toHaveBeenCalledWith(5, 0, { userId, applicationId, logKey }); }); it('should return correct response', async () => { diff --git a/packages/core/src/routes/log.ts b/packages/core/src/routes/log.ts index 53d84fe62..09f0103b9 100644 --- a/packages/core/src/routes/log.ts +++ b/packages/core/src/routes/log.ts @@ -15,19 +15,19 @@ export default function logRoutes(router: T) { query: object({ userId: string().optional(), applicationId: string().optional(), - logType: string().optional(), + logKey: string().optional(), }), }), async (ctx, next) => { const { limit, offset } = ctx.pagination; const { - query: { userId, applicationId, logType }, + query: { userId, applicationId, logKey }, } = ctx.guard; // TODO: @Gao refactor like user search const [{ count }, logs] = await Promise.all([ - countLogs({ logType, applicationId, userId }), - findLogs(limit, offset, { logType, userId, applicationId }), + countLogs({ logKey, applicationId, userId }), + findLogs(limit, offset, { logKey, userId, applicationId }), ]); // Return totalCount to pagination middleware