/
file-sighup-test.js
155 lines (136 loc) · 3.89 KB
/
file-sighup-test.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
const { test } = require('tap');
const path = require('path');
const fs = require('fs');
const sandbox = require('@log4js-node/sandboxed-module');
const osDelay = process.platform === 'win32' ? 400 : 200;
const removeFiles = async (filenames) => {
if (!Array.isArray(filenames)) filenames = [filenames];
const promises = filenames.map((filename) => fs.promises.unlink(filename));
await Promise.allSettled(promises);
};
test('file appender single SIGHUP handler', (t) => {
const initialListeners = process.listenerCount('SIGHUP');
let warning;
const originalListener = process.listeners('warning')[
process.listeners('warning').length - 1
];
const warningListener = (error) => {
if (
error.type === 'SIGHUP' &&
error.name === 'MaxListenersExceededWarning'
) {
warning = error;
return;
}
originalListener(error);
};
process.off('warning', originalListener);
process.on('warning', warningListener);
const config = {
appenders: {},
categories: {
default: { appenders: [], level: 'debug' },
},
};
// create 11 appenders to make nodejs warn for >10 max listeners
const numOfAppenders = 11;
for (let i = 1; i <= numOfAppenders; i++) {
config.appenders[`app${i}`] = {
type: 'file',
filename: path.join(__dirname, `file${i}.log`),
};
config.categories.default.appenders.push(`app${i}`);
}
const log4js = require('../../lib/log4js');
log4js.configure(config);
t.teardown(async () => {
// next event loop so that past warnings will not be printed
setImmediate(() => {
process.off('warning', warningListener);
process.on('warning', originalListener);
});
await new Promise((resolve) => {
log4js.shutdown(resolve);
});
const filenames = Object.values(config.appenders).map(
(appender) => appender.filename
);
await removeFiles(filenames);
});
t.plan(2);
// next event loop to allow event emitter/listener to happen
setImmediate(() => {
t.notOk(warning, 'should not have MaxListenersExceededWarning for SIGHUP');
t.equal(
process.listenerCount('SIGHUP') - initialListeners,
1,
'should be 1 SIGHUP listener'
);
t.end();
});
});
test('file appender SIGHUP', (t) => {
let closeCalled = 0;
let openCalled = 0;
sandbox
.require('../../lib/appenders/file', {
requires: {
streamroller: {
RollingFileStream: class RollingFileStream {
constructor() {
openCalled++;
this.ended = false;
}
on() {
this.dummy = 'easier than turning off lint rule';
}
end(cb) {
this.ended = true;
closeCalled++;
cb();
}
write() {
if (this.ended) {
throw new Error('write after end');
}
return true;
}
},
},
},
})
.configure(
{ type: 'file', filename: 'sighup-test-file' },
{
basicLayout() {
return 'whatever';
},
}
);
process.emit('SIGHUP', 'SIGHUP', 1);
t.plan(2);
setTimeout(() => {
t.equal(openCalled, 2, 'open should be called twice');
t.equal(closeCalled, 1, 'close should be called once');
t.end();
}, osDelay);
});
test('file appender SIGHUP handler leak', (t) => {
const log4js = require('../../lib/log4js');
const initialListeners = process.listenerCount('SIGHUP');
log4js.configure({
appenders: {
file: { type: 'file', filename: 'test.log' },
},
categories: { default: { appenders: ['file'], level: 'info' } },
});
t.teardown(async () => {
await removeFiles('test.log');
});
t.plan(2);
t.equal(process.listenerCount('SIGHUP'), initialListeners + 1);
log4js.shutdown(() => {
t.equal(process.listenerCount('SIGHUP'), initialListeners);
t.end();
});
});