Skip to content

Commit 117e6bb

Browse files
seth-riedelseth-riedel
committed
CR-277: Add tests
1 parent 4c534b7 commit 117e6bb

File tree

2 files changed

+199
-19
lines changed

2 files changed

+199
-19
lines changed

‎redisinsight/api/src/common/logger/app-logger.spec.ts‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
import { plainToClass } from 'class-transformer';
2+
import { cloneDeep } from 'lodash';
3+
import { WinstonModule } from 'nest-winston';
4+
import { AppLogger } from 'src/common/logger/app-logger';
5+
import {
6+
ClientContext,
7+
ClientMetadata,
8+
SessionMetadata,
9+
} from 'src/common/models';
10+
11+
const loggerConfig = {};
12+
const mockWinstonLogger = {
13+
log: jest.fn(),
14+
verbose: jest.fn(),
15+
debug: jest.fn(),
16+
warn: jest.fn(),
17+
error: jest.fn(),
18+
fatal: jest.fn(),
19+
};
20+
const logLevels = Object.keys(mockWinstonLogger);
21+
22+
jest.spyOn(WinstonModule, 'createLogger').mockReturnValue(mockWinstonLogger);
23+
24+
const getSessionMetadata = () => plainToClass(SessionMetadata, {
25+
userId: '123',
26+
sessionId: 'test-session-id',
27+
});
28+
29+
const getClientMetadata = () => plainToClass(ClientMetadata, {
30+
sessionMetadata: getSessionMetadata(),
31+
databaseId: 'db-123',
32+
context: ClientContext.Browser,
33+
uniqueId: 'unique-id',
34+
db: 1,
35+
});
36+
37+
describe('AppLogger', () => {
38+
let logger: AppLogger;
39+
40+
beforeEach(() => {
41+
logger = new AppLogger(loggerConfig);
42+
jest.clearAllMocks();
43+
});
44+
45+
test.each(logLevels)(
46+
'should get context from last optional param if it is a string - logger.%s',
47+
(level) => {
48+
logger[level]('Test message', 'optional arg', 'Test context');
49+
50+
expect(mockWinstonLogger[level]).toHaveBeenCalledTimes(1);
51+
expect(mockWinstonLogger[level]).toHaveBeenCalledWith({
52+
message: 'Test message',
53+
context: 'Test context',
54+
data: ['optional arg'],
55+
error: undefined,
56+
});
57+
},
58+
);
59+
60+
test.each(logLevels)(
61+
'should find and separate the first error object if exists - logger.%s',
62+
(level) => {
63+
const error1 = new Error('Test error 1');
64+
const error2 = new Error('Test error 2');
65+
logger[level]('Test message', error1, error2);
66+
67+
expect(mockWinstonLogger[level]).toHaveBeenCalledTimes(1);
68+
expect(mockWinstonLogger[level]).toHaveBeenCalledWith({
69+
message: 'Test message',
70+
context: null,
71+
data: [error2],
72+
error: {
73+
message: error1.message,
74+
response: undefined,
75+
stack: error1.stack,
76+
},
77+
});
78+
},
79+
);
80+
81+
test.each(logLevels)(
82+
'should get error response and include it if exists - logger.%s',
83+
(level) => {
84+
const error1 = new Error('Test error 1');
85+
(error1 as Error & { response: unknown }).response = {
86+
status: 500,
87+
data: 'Internal server error',
88+
};
89+
logger[level]('Test message', error1);
90+
91+
expect(mockWinstonLogger[level]).toHaveBeenCalledTimes(1);
92+
expect(mockWinstonLogger[level]).toHaveBeenCalledWith({
93+
message: 'Test message',
94+
context: null,
95+
data: undefined,
96+
error: {
97+
message: error1.message,
98+
response: {
99+
status: 500,
100+
data: 'Internal server error',
101+
},
102+
stack: error1.stack,
103+
},
104+
});
105+
},
106+
);
107+
108+
test.each(logLevels)(
109+
'should parse client metadata from optional params - logger.%s',
110+
(level) => {
111+
const clientMetadata = getClientMetadata();
112+
logger[level](
113+
'Test message',
114+
clientMetadata,
115+
{ foo: 'bar' },
116+
'Test context',
117+
);
118+
119+
expect(mockWinstonLogger[level]).toHaveBeenCalledTimes(1);
120+
expect(mockWinstonLogger[level]).toHaveBeenCalledWith({
121+
message: 'Test message',
122+
context: 'Test context',
123+
clientMetadata: {
124+
...clientMetadata,
125+
sessionMetadata: undefined,
126+
},
127+
sessionMetadata: clientMetadata.sessionMetadata,
128+
data: [{ foo: 'bar' }],
129+
error: undefined,
130+
});
131+
},
132+
);
133+
134+
test.each(logLevels)(
135+
'should parse session metadata from optional params - logger.%s',
136+
(level) => {
137+
const sessionMetadata = getSessionMetadata();
138+
logger[level](
139+
'Test message',
140+
sessionMetadata,
141+
{ foo: 'bar' },
142+
'Test context',
143+
);
144+
145+
expect(mockWinstonLogger[level]).toHaveBeenCalledTimes(1);
146+
expect(mockWinstonLogger[level]).toHaveBeenCalledWith({
147+
message: 'Test message',
148+
context: 'Test context',
149+
sessionMetadata,
150+
data: [{ foo: 'bar' }],
151+
error: undefined,
152+
});
153+
},
154+
);
155+
156+
test.each(logLevels)(
157+
'should not mutate original arguments - logger.%s',
158+
(level) => {
159+
const clientMetadata = getClientMetadata();
160+
161+
const error = new Error('test 123');
162+
const optionalParams = [
163+
clientMetadata,
164+
error,
165+
{ foo: 'bar' },
166+
'Test context',
167+
];
168+
const optionalParamsOriginal = cloneDeep(optionalParams);
169+
170+
logger[level]('Test message', ...optionalParams);
171+
172+
expect(mockWinstonLogger[level]).toHaveBeenCalledTimes(1);
173+
expect(mockWinstonLogger[level]).toHaveBeenCalledWith({
174+
message: 'Test message',
175+
context: 'Test context',
176+
clientMetadata: {
177+
...clientMetadata,
178+
sessionMetadata: undefined,
179+
},
180+
sessionMetadata: clientMetadata.sessionMetadata,
181+
data: [{ foo: 'bar' }],
182+
error: {
183+
message: error.message,
184+
stack: error.stack,
185+
response: undefined,
186+
},
187+
});
188+
expect(optionalParams).toEqual(optionalParamsOriginal);
189+
},
190+
);
191+
});

‎redisinsight/api/src/common/logger/app-logger.ts‎

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ import { ClientMetadata, SessionMetadata } from 'src/common/models';
55

66
type LogMeta = object;
77

8-
type LogObject = {
9-
[key: string]: unknown;
10-
};
11-
128
type ErrorOrMeta = Error | LogMeta | string | ClientMetadata | SessionMetadata;
139

1410
@Injectable()
@@ -108,21 +104,14 @@ export class AppLogger implements LoggerService {
108104
return {};
109105
}
110106

111-
private parseLoggerArgs(
112-
message: string | LogObject,
113-
optionalParams: ErrorOrMeta[] = [],
114-
) {
107+
private parseLoggerArgs(message: string, optionalParams: ErrorOrMeta[] = []) {
115108
const optionalParamsCopy = cloneDeep(optionalParams);
116-
const messageObj: LogObject = (
117-
typeof message === 'object' ? message : { message }
118-
) as LogObject;
119-
120109
const context = AppLogger.getContext(optionalParamsCopy);
121110
const error = AppLogger.getError(optionalParamsCopy);
122111
const userMetadata = AppLogger.getUserMetadata(optionalParamsCopy);
123112

124113
return {
125-
...messageObj,
114+
message,
126115
context,
127116
error,
128117
...userMetadata,
@@ -133,42 +122,42 @@ export class AppLogger implements LoggerService {
133122
/**
134123
* Write a 'log' level log.
135124
*/
136-
log(message: string | LogObject, ...optionalParams: ErrorOrMeta[]) {
125+
log(message: string, ...optionalParams: ErrorOrMeta[]) {
137126
this.logger.log(this.parseLoggerArgs(message, optionalParams));
138127
}
139128

140129
/**
141130
* Write a 'fatal' level log.
142131
*/
143-
fatal(message: string | LogObject, ...optionalParams: ErrorOrMeta[]) {
132+
fatal(message: string, ...optionalParams: ErrorOrMeta[]) {
144133
this.logger.fatal(this.parseLoggerArgs(message, optionalParams));
145134
}
146135

147136
/**
148137
* Write an 'error' level log.
149138
*/
150-
error(message: string | LogObject, ...optionalParams: ErrorOrMeta[]) {
139+
error(message: string, ...optionalParams: ErrorOrMeta[]) {
151140
this.logger.error(this.parseLoggerArgs(message, optionalParams));
152141
}
153142

154143
/**
155144
* Write a 'warn' level log.
156145
*/
157-
warn(message: string | LogObject, ...optionalParams: ErrorOrMeta[]) {
146+
warn(message: string, ...optionalParams: ErrorOrMeta[]) {
158147
this.logger.warn(this.parseLoggerArgs(message, optionalParams));
159148
}
160149

161150
/**
162151
* Write a 'debug' level log.
163152
*/
164-
debug?(message: string | LogObject, ...optionalParams: ErrorOrMeta[]) {
153+
debug?(message: string, ...optionalParams: ErrorOrMeta[]) {
165154
this.logger.debug(this.parseLoggerArgs(message, optionalParams));
166155
}
167156

168157
/**
169158
* Write a 'verbose' level log.
170159
*/
171-
verbose?(message: string | LogObject, ...optionalParams: ErrorOrMeta[]) {
160+
verbose?(message: string, ...optionalParams: ErrorOrMeta[]) {
172161
this.logger.verbose(this.parseLoggerArgs(message, optionalParams));
173162
}
174163
}

0 commit comments

Comments
 (0)