Skip to content

Commit ce13177

Browse files
committed
Update test feedback
1 parent 1b64fbd commit ce13177

File tree

1 file changed

+17
-51
lines changed

1 file changed

+17
-51
lines changed

packages/logger/tests/unit/logBuffer.test.ts

Lines changed: 17 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,16 @@ describe('bufferLog', () => {
3636
};
3737
vi.clearAllMocks();
3838
});
39-
4039
it('outputs a warning when there is an error buffering the log', () => {
40+
// Prepare
4141
const logger = new TestLogger();
4242
logger.enableBuffering();
4343
logger.overrideBufferLogItem();
4444

45+
// Act
4546
logger.debug('This is a debug');
47+
48+
// Assess
4649
expect(console.debug).toBeCalledTimes(1);
4750
expect(console.warn).toBeCalledTimes(1);
4851
});
@@ -61,93 +64,56 @@ describe('flushBuffer', () => {
6164
});
6265

6366
it('outputs buffered logs', () => {
67+
// Prepare
6468
const logger = new TestLogger({ logLevel: 'SILENT' });
6569
logger.enableBuffering();
6670
logger.setbufferLevelThreshold(LogLevelThreshold.CRITICAL);
6771

72+
// Act
6873
logger.debug('This is a debug');
6974
logger.warn('This is a warning');
7075
logger.critical('this is a critical');
7176

77+
// Assess
7278
expect(console.warn).toHaveBeenCalledTimes(0);
7379
expect(console.error).toHaveBeenCalledTimes(0);
7480

81+
// Act
7582
logger.flushBufferWrapper();
7683

84+
// Assess
7785
expect(console.warn).toHaveBeenCalledTimes(1);
7886
expect(console.error).toHaveBeenCalledTimes(1);
7987
});
8088

8189
it('handles an empty buffer', () => {
82-
const logger = new TestLogger({ logLevel: 'SILENT' });
90+
// Prepare
91+
const logger = new TestLogger();
8392
logger.enableBuffering();
8493

94+
// Act
8595
logger.flushBufferWrapper();
8696
});
8797

8898
it('does not output buffered logs when trace id is not set', () => {
99+
// Prepare
89100
process.env._X_AMZN_TRACE_ID = undefined;
90-
91101
const logger = new TestLogger({});
92102
logger.enableBuffering();
93103

104+
// Act
94105
logger.debug('This is a debug');
95106
logger.warn('this is a warning');
96107

108+
// Assess
97109
expect(console.debug).toHaveBeenCalledTimes(0);
98110
expect(console.warn).toHaveBeenCalledTimes(1);
99111

112+
// Act
100113
logger.flushBufferWrapper();
101114

115+
// Assess
102116
expect(console.debug).toHaveBeenCalledTimes(0);
103117
expect(console.warn).toHaveBeenCalledTimes(1);
104118
});
105119
});
106-
107-
describe('shouldBufferLog', () => {
108-
const ENVIRONMENT_VARIABLES = process.env;
109-
110-
beforeEach(() => {
111-
process.env = {
112-
...ENVIRONMENT_VARIABLES,
113-
POWERTOOLS_LOGGER_LOG_EVENT: 'true',
114-
POWERTOOLS_DEV: 'true',
115-
};
116-
vi.clearAllMocks();
117-
});
118-
it('returns false when _X_AMZN_TRACE_ID is not set', () => {
119-
const logger = new TestLogger({});
120-
process.env._X_AMZN_TRACE_ID = undefined;
121-
logger.enableBuffering();
122-
123-
expect(logger.shouldBufferLog(undefined, LogLevelThreshold.TRACE)).toBe(
124-
false
125-
);
126-
});
127-
128-
it('returns false when the buffer is disabled', () => {
129-
const logger = new TestLogger({});
130-
logger.disableBuffering();
131-
132-
const trace = process.env._X_AMZN_TRACE_ID;
133-
134-
expect(logger.shouldBufferLog(trace, LogLevelThreshold.TRACE)).toBe(false);
135-
});
136-
137-
it('returns false when the log level above the bufferLevelThreshold', () => {
138-
const logger = new TestLogger({});
139-
logger.enableBuffering();
140-
141-
const trace = process.env._X_AMZN_TRACE_ID;
142-
143-
expect(logger.shouldBufferLog(trace, LogLevelThreshold.INFO)).toBe(false);
144-
});
145-
146-
it('returns true when the criteria is met', () => {
147-
const logger = new TestLogger({});
148-
logger.enableBuffering();
149-
const trace = process.env._X_AMZN_TRACE_ID;
150-
151-
expect(logger.shouldBufferLog(trace, LogLevelThreshold.TRACE)).toBe(true);
152-
});
153-
});

0 commit comments

Comments
 (0)