-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
connection.test.ts
276 lines (227 loc) · 8.41 KB
/
connection.test.ts
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
import { expect } from 'chai';
import { EventEmitter } from 'events';
import { Socket } from 'net';
import * as sinon from 'sinon';
import { setTimeout } from 'timers';
import { connect } from '../../../src/cmap/connect';
import { Connection, hasSessionSupport } from '../../../src/cmap/connection';
import { MessageStream } from '../../../src/cmap/message_stream';
import { MongoNetworkTimeoutError } from '../../../src/error';
import { isHello, ns } from '../../../src/utils';
import * as mock from '../../tools/mongodb-mock/index';
import { getSymbolFrom } from '../../tools/utils';
import { createTimerSandbox } from '../timer_sandbox';
const connectionOptionsDefaults = {
id: 0,
generation: 0,
monitorCommands: false,
tls: false,
metadata: undefined,
loadBalanced: false
};
describe('new Connection()', function () {
let server;
after(() => mock.cleanup());
before(() => mock.createServer().then(s => (server = s)));
it('should support fire-and-forget messages', function (done) {
server.setMessageHandler(request => {
const doc = request.document;
if (isHello(doc)) {
request.reply(mock.HELLO);
}
// blackhole all other requests
});
const options = {
...connectionOptionsDefaults,
connectionType: Connection,
hostAddress: server.hostAddress()
};
connect(options, (err, conn) => {
expect(err).to.not.exist;
expect(conn).to.exist;
conn.command(ns('$admin.cmd'), { ping: 1 }, { noResponse: true }, (err, result) => {
expect(err).to.not.exist;
expect(result).to.not.exist;
done();
});
});
});
it('should destroy streams which time out', function (done) {
server.setMessageHandler(request => {
const doc = request.document;
if (isHello(doc)) {
request.reply(mock.HELLO);
}
// blackhole all other requests
});
const options = {
...connectionOptionsDefaults,
connectionType: Connection,
hostAddress: server.hostAddress()
};
connect(options, (err, conn) => {
expect(err).to.not.exist;
expect(conn).to.exist;
conn.command(ns('$admin.cmd'), { ping: 1 }, { socketTimeoutMS: 50 }, (err, result) => {
expect(err).to.be.instanceOf(MongoNetworkTimeoutError);
expect(result).to.not.exist;
expect(conn).property('stream').property('destroyed', true);
done();
});
});
});
it('should throw a network error with kBeforeHandshake set to false on timeout after handshake', function (done) {
server.setMessageHandler(request => {
const doc = request.document;
if (isHello(doc)) {
request.reply(mock.HELLO);
}
// respond to no other requests to trigger timeout event
});
const options = {
hostAddress: server.hostAddress(),
...connectionOptionsDefaults
};
connect(options, (err, conn) => {
expect(err).to.be.a('undefined');
expect(conn).to.be.instanceOf(Connection);
expect(conn).to.have.property('hello').that.is.a('object');
conn.command(ns('$admin.cmd'), { ping: 1 }, { socketTimeoutMS: 50 }, err => {
const beforeHandshakeSymbol = getSymbolFrom(err, 'beforeHandshake', false);
expect(beforeHandshakeSymbol).to.be.a('symbol');
expect(err).to.have.property(beforeHandshakeSymbol, false);
done();
});
});
});
it('should throw a network error with kBeforeHandshake set to true on timeout before handshake', function (done) {
server.setMessageHandler(() => {
// respond to no requests to trigger timeout event
});
const options = {
...connectionOptionsDefaults,
hostAddress: server.hostAddress(),
socketTimeoutMS: 50
};
connect(options, (err, conn) => {
expect(conn).to.be.a('undefined');
const beforeHandshakeSymbol = getSymbolFrom(err, 'beforeHandshake');
expect(err).to.have.property(beforeHandshakeSymbol, true);
done();
});
});
describe('onTimeout()', () => {
let connection: sinon.SinonSpiedInstance<Connection>;
let clock: sinon.SinonFakeTimers;
let timerSandbox: sinon.SinonFakeTimers;
let driverSocket: sinon.SinonSpiedInstance<FakeSocket>;
let messageStream: MessageStream;
let kDelayedTimeoutId: symbol;
let NodeJSTimeoutClass: any;
/** The absolute minimum socket API needed by Connection as of writing this test */
class FakeSocket extends EventEmitter {
address() {
// is never called
}
pipe() {
// does not need to do anything
}
destroy() {
// is called, has no side effects
}
get remoteAddress() {
return 'iLoveJavaScript';
}
get remotePort() {
return 123;
}
}
beforeEach(() => {
timerSandbox = createTimerSandbox();
clock = sinon.useFakeTimers();
NodeJSTimeoutClass = setTimeout(() => null, 1).constructor;
driverSocket = sinon.spy(new FakeSocket());
// @ts-expect-error: driverSocket does not fully satisfy the stream type, but that's okay
connection = sinon.spy(new Connection(driverSocket, connectionOptionsDefaults));
const messageStreamSymbol = getSymbolFrom(connection, 'messageStream');
kDelayedTimeoutId = getSymbolFrom(connection, 'delayedTimeoutId');
messageStream = connection[messageStreamSymbol];
});
afterEach(() => {
timerSandbox.restore();
clock.restore();
});
it('should delay timeout errors by one tick', async () => {
expect(connection).to.have.property(kDelayedTimeoutId, null);
driverSocket.emit('timeout');
expect(connection.onTimeout).to.have.been.calledOnce;
expect(connection).to.have.property(kDelayedTimeoutId).that.is.instanceOf(NodeJSTimeoutClass);
expect(connection).to.have.property('closed', false);
expect(driverSocket.destroy).to.not.have.been.called;
clock.tick(1);
expect(driverSocket.destroy).to.have.been.calledOnce;
expect(connection).to.have.property('closed', true);
});
it('should clear timeout errors if more data is available', () => {
expect(connection).to.have.property(kDelayedTimeoutId, null);
driverSocket.emit('timeout');
expect(connection.onTimeout).to.have.been.calledOnce;
expect(connection).to.have.property(kDelayedTimeoutId).that.is.instanceOf(NodeJSTimeoutClass);
// emit a message before the clock ticks even once
// onMessage ignores unknown 'responseTo' value
messageStream.emit('message', { responseTo: null });
// New message before clock ticks 1 will clear the timeout
expect(connection).to.have.property(kDelayedTimeoutId, null);
// ticking the clock should do nothing, there is no timeout anymore
clock.tick(1);
expect(driverSocket.destroy).to.not.have.been.called;
expect(connection).to.have.property('closed', false);
expect(connection).to.have.property(kDelayedTimeoutId, null);
});
});
describe('.hasSessionSupport', function () {
let connection;
const stream = new Socket();
context('when logicalSessionTimeoutMinutes is present', function () {
beforeEach(function () {
const options = {
...connectionOptionsDefaults,
hostAddress: server.hostAddress(),
logicalSessionTimeoutMinutes: 5
};
connection = new Connection(stream, options);
});
it('returns true', function () {
expect(hasSessionSupport(connection)).to.be.true;
});
});
context('when logicalSessionTimeoutMinutes is not present', function () {
context('when in load balancing mode', function () {
beforeEach(function () {
const options = {
...connectionOptionsDefaults,
hostAddress: server.hostAddress(),
loadBalanced: true
};
connection = new Connection(stream, options);
});
it('returns true', function () {
expect(hasSessionSupport(connection)).to.be.true;
});
});
context('when not in load balancing mode', function () {
beforeEach(function () {
const options = {
...connectionOptionsDefaults,
hostAddress: server.hostAddress(),
loadBalanced: false
};
connection = new Connection(stream, options);
});
it('returns false', function () {
expect(hasSessionSupport(connection)).to.be.false;
});
});
});
});
});