-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
polling_srv_records_for_mongos_discovery.prose.test.ts
452 lines (385 loc) · 15.8 KB
/
polling_srv_records_for_mongos_discovery.prose.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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
import { expect } from 'chai';
import * as dns from 'dns';
import * as sinon from 'sinon';
import { MongoClient } from '../../../src';
import { TopologyType } from '../../../src/sdam/common';
import { SrvPoller, SrvPollerOptions, SrvPollingEvent } from '../../../src/sdam/srv_polling';
import { Topology, TopologyOptions } from '../../../src/sdam/topology';
import { HostAddress, isHello } from '../../../src/utils';
import * as mock from '../../tools/mongodb-mock/index';
import type { MockServer } from '../../tools/mongodb-mock/src/server';
import { processTick } from '../../tools/utils';
import { createTimerSandbox } from '../timer_sandbox';
/*
The SRV Prose Tests make use of the following REAL DNS records.
CURRENTLY, WE DO NOT USE THESE. We have stubbed the methods to build our own fake data for testing.
We use sinon to replace the results from resolveSrv to test hostname removals and insertions.
The actual spec prose assumes you have a 4 node sharded cluster running on ports:
[27017, 27018, 27019, 27020]
Record TTL Class Address
localhost.test.test.build.10gen.cc. 86400 IN A 127.0.0.1
Record TTL Class Port Target
_mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27017 localhost.test.build.10gen.cc.
_mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27018 localhost.test.build.10gen.cc.
_mongodb._tcp.test3.test.build.10gen.cc. 86400 IN SRV 27017 localhost.test.build.10gen.cc.
_customname._tcp.test22.test.build.10gen.cc. 86400 IN SRV 27017 localhost.test.build.10gen.cc.
*/
const srvRecord = (name, port) => ({ name, port, weight: 0, priority: 0 });
interface ShardedClusterMocks {
mongoses: MockServer[];
readonly srvRecords: dns.SrvRecord[];
}
// TODO(NODE-3773): Make use of the shared driver's DNS records
// TODO(NODE-3773): Implement tests 6-9
describe('Polling Srv Records for Mongos Discovery', () => {
describe('SRV polling prose cases 1-5', () => {
const SRV_HOST = 'darmok.tanagra.com';
const context: Record<string, any> = {};
function srvRecord(mockServer, port?) {
if (typeof mockServer === 'string') {
mockServer = { host: mockServer, port };
}
return {
priority: 0,
weight: 0,
port: mockServer.port,
name: mockServer.host
};
}
function tryDone(done, handle) {
process.nextTick(() => {
try {
handle();
done();
} catch (e) {
done(e);
}
});
}
class FakeSrvPoller extends SrvPoller {
start() {
return;
}
stop() {
return;
}
trigger(srvRecords) {
this.emit('srvRecordDiscovery', new SrvPollingEvent(srvRecords));
}
}
function srvAddresses(records) {
return records.map(r => `${r.name}:${r.port}`);
}
const MONGOS_HELLO = Object.assign({}, mock.HELLO, {
msg: 'isdbgrid'
});
beforeEach(function () {
return Promise.all(Array.from({ length: 4 }).map(() => mock.createServer())).then(servers => {
context.servers = servers;
});
});
afterEach(function () {
return mock.cleanup();
});
afterEach(function (done) {
if (context.topology) {
context.topology.close({}, done);
} else {
done();
}
});
function runSrvPollerTest(recordSets, done) {
context.servers.forEach(server => {
server.setMessageHandler(request => {
const doc = request.document;
if (isHello(doc)) {
request.reply(Object.assign({}, MONGOS_HELLO));
}
});
});
const srvPoller = new FakeSrvPoller({ srvHost: SRV_HOST } as SrvPollerOptions);
const seedlist = recordSets[0].map(record =>
HostAddress.fromString(`${record.name}:${record.port}`)
);
context.topology = new Topology(seedlist, {
srvPoller: srvPoller as SrvPoller,
srvHost: SRV_HOST
} as TopologyOptions);
const topology = context.topology;
topology.connect({}, err => {
if (err) {
return done(err);
}
try {
expect(topology.description).to.have.property('type', TopologyType.Sharded);
const servers = Array.from(topology.description.servers.keys());
expect(servers).to.deep.equal(srvAddresses(recordSets[0]));
topology.once('topologyDescriptionChanged', function () {
tryDone(done, function () {
const servers = Array.from(topology.description.servers.keys());
expect(servers).to.deep.equal(srvAddresses(recordSets[1]));
});
});
process.nextTick(() => srvPoller.trigger(recordSets[1]));
} catch (e) {
done(e);
}
});
}
// The addition of a new DNS record:
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27019 localhost.test.build.10gen.cc.
it('1. Addition of a new DNS record', function (done) {
const recordSets = [
[srvRecord(context.servers[0]), srvRecord(context.servers[1])],
[
srvRecord(context.servers[0]),
srvRecord(context.servers[1]),
srvRecord(context.servers[2])
]
];
runSrvPollerTest(recordSets, done);
});
// The removal of an existing DNS record:
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27018 localhost.test.build.10gen.cc.
it('2. Removal of an existing DNS record', function (done) {
const recordSets = [
[srvRecord(context.servers[0]), srvRecord(context.servers[1])],
[srvRecord(context.servers[0])]
];
runSrvPollerTest(recordSets, done);
});
// The replacement of a DNS record:
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27018 localhost.test.build.10gen.cc.
// replace by:
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27019 localhost.test.build.10gen.cc.
it('3. Replacement of a DNS record', function (done) {
const recordSets = [
[srvRecord(context.servers[0]), srvRecord(context.servers[1])],
[srvRecord(context.servers[0]), srvRecord(context.servers[2])]
];
runSrvPollerTest(recordSets, done);
});
// The replacement of both existing DNS records with one new record:
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27019 localhost.test.build.10gen.cc.
it('4. replacement of both existing DNS records with one new record', function (done) {
const recordSets = [
[srvRecord(context.servers[0]), srvRecord(context.servers[1])],
[srvRecord(context.servers[2])]
];
runSrvPollerTest(recordSets, done);
});
// The replacement of both existing DNS records with two new records:
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27019 localhost.test.build.10gen.cc.
// _mongodb._tcp.test1.test.build.10gen.cc. 86400 IN SRV 27020 localhost.test.build.10gen.cc.
it('5. Replacement of both existing DNS records with two new records', function (done) {
const recordSets = [
[srvRecord(context.servers[0]), srvRecord(context.servers[1])],
[srvRecord(context.servers[2]), srvRecord(context.servers[3])]
];
runSrvPollerTest(recordSets, done);
});
});
describe('SRV polling prose cases 10-13', () => {
const SRV_CONNECTION_STRING = 'mongodb+srv://test.mock.test.build.10gen.cc';
let shardedCluster: ShardedClusterMocks;
let resolveSrvStub: sinon.SinonStub;
let lookupStub: sinon.SinonStub;
let client: MongoClient;
let clock: sinon.SinonFakeTimers;
let timerSandbox: sinon.SinonSandbox;
const initialRecords = Object.freeze([
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2017 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2018 }
]);
beforeEach(() => {
timerSandbox = createTimerSandbox();
clock = sinon.useFakeTimers();
});
afterEach(() => {
if (clock) {
timerSandbox.restore();
clock.restore();
clock = undefined;
}
});
beforeEach(async () => {
const mongoses = [
await mock.createServer(2017),
await mock.createServer(2018),
await mock.createServer(2019),
await mock.createServer(2020)
];
const srvRecords = mongoses.map(s =>
srvRecord('localhost.test.mock.test.build.10gen.cc', s.port)
);
shardedCluster = { mongoses, srvRecords };
for (const mongos of shardedCluster.mongoses) {
mongos.setMessageHandler(request => {
const document = request.document;
if (isHello(document)) {
request.reply({ ...mock.HELLO, msg: 'isdbgrid' });
}
});
}
});
afterEach(async () => {
await mock.cleanup();
});
afterEach(async () => {
if (resolveSrvStub) {
resolveSrvStub.restore();
resolveSrvStub = undefined;
}
if (lookupStub) {
lookupStub.restore();
lookupStub = undefined;
}
if (client) {
await client.close();
client = undefined;
}
});
function makeStubs({
initialRecords = undefined,
replacementRecords = undefined,
srvServiceName = 'mongodb'
}: {
initialRecords?: dns.SrvRecord[];
replacementRecords?: dns.SrvRecord[];
srvServiceName?: string;
}) {
let initialDNSLookup = true;
const mockRecords = shardedCluster.srvRecords;
replacementRecords ??= mockRecords;
initialRecords ??= mockRecords;
// first call is for the driver initial connection
// second call will check the poller
resolveSrvStub = sinon.stub(dns.promises, 'resolveSrv').callsFake(async address => {
expect(address).to.equal(`_${srvServiceName}._tcp.test.mock.test.build.10gen.cc`);
if (initialDNSLookup) {
initialDNSLookup = false;
return initialRecords;
}
return replacementRecords;
});
lookupStub = sinon.stub(dns, 'lookup').callsFake((...args) => {
const hostname = args[0];
const options = typeof args[1] === 'object' ? args[1] : {};
const callback = args[args.length - 1] as (err: null, address: string, family: 4) => void;
if (hostname.includes('test.mock.test.build.10gen.cc')) {
return process.nextTick(callback, null, '127.0.0.1', 4);
}
const { wrappedMethod: lookup } = lookupStub;
lookup(hostname, options, callback);
});
}
it('10 - All DNS records are selected (srvMaxHosts = 0)', async () => {
const replacementRecords = [
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2017, weight: 0, priority: 0 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2019, weight: 0, priority: 0 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2020, weight: 0, priority: 0 }
];
makeStubs({ initialRecords, replacementRecords });
client = new MongoClient(SRV_CONNECTION_STRING, {
tls: false, // Need to turn off the automatic TLS turn on with SRV connection strings
srvMaxHosts: 0,
serverSelectionTimeoutMS: 5000 // This is just to make the test fail in a nice amount of time
});
await client.connect();
const selectedHosts = client.topology.s.seedlist;
expect(selectedHosts).to.have.lengthOf(initialRecords.length);
expect(selectedHosts.map(({ host }) => host)).to.deep.equal(
initialRecords.map(({ name }) => name)
);
clock.tick(2 * client.topology.s.srvPoller.rescanSrvIntervalMS);
await processTick();
const polledServerAddresses = Array.from(client.topology.description.servers.keys());
polledServerAddresses.sort();
expect(polledServerAddresses).to.deep.equal(
replacementRecords.map(({ name, port }) => `${name}:${port}`)
);
});
it('11 - All DNS records are selected (srvMaxHosts >= records)', async () => {
const replacementRecords = [
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2019, weight: 0, priority: 0 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2020, weight: 0, priority: 0 }
];
makeStubs({ initialRecords, replacementRecords });
client = new MongoClient(SRV_CONNECTION_STRING, {
tls: false,
srvMaxHosts: 2,
serverSelectionTimeoutMS: 5000
});
await client.connect();
const selectedHosts = client.topology.s.seedlist;
expect(selectedHosts).to.have.lengthOf(2);
expect(selectedHosts.map(({ host }) => host)).to.deep.equal(
initialRecords.map(({ name }) => name)
);
clock.tick(2 * client.topology.s.srvPoller.rescanSrvIntervalMS);
await processTick();
const polledServerAddresses = Array.from(client.topology.description.servers.keys());
polledServerAddresses.sort();
expect(polledServerAddresses).to.deep.equal(
replacementRecords.map(({ name, port }) => `${name}:${port}`)
);
});
it('12 - New DNS records are randomly selected (srvMaxHosts > 0)', async () => {
const replacementRecords = [
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2017, weight: 0, priority: 0 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2019, weight: 0, priority: 0 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2020, weight: 0, priority: 0 }
];
makeStubs({ initialRecords, replacementRecords });
client = new MongoClient(SRV_CONNECTION_STRING, {
tls: false,
srvMaxHosts: 2,
serverSelectionTimeoutMS: 5000
});
await client.connect();
const selectedHosts = client.topology.s.seedlist;
expect(selectedHosts).to.have.lengthOf(2);
expect(selectedHosts.map(({ host }) => host)).to.deep.equal(
initialRecords.map(({ name }) => name)
);
clock.tick(2 * client.topology.s.srvPoller.rescanSrvIntervalMS);
await processTick();
const polledServerAddresses = Array.from(client.topology.description.servers.keys());
polledServerAddresses.sort();
// Only two addresses, one should remain the original 2017,
// while the other will be one of 2019 or 2020
expect(polledServerAddresses).to.have.lengthOf(2);
expect(polledServerAddresses).to.include('localhost.test.mock.test.build.10gen.cc:2017');
expect(polledServerAddresses).satisfies(
addresses =>
// If you want proof, comment one of these conditions out, and run the test a few times
// you should see it pass and fail at random
addresses.includes('localhost.test.mock.test.build.10gen.cc:2019') ||
addresses.includes('localhost.test.mock.test.build.10gen.cc:2020')
);
});
it('13 - DNS record with custom service name can be found', async () => {
const replacementRecords = [
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2019, weight: 0, priority: 0 },
{ name: 'localhost.test.mock.test.build.10gen.cc', port: 2020, weight: 0, priority: 0 }
];
makeStubs({
initialRecords: [initialRecords[0]],
replacementRecords,
srvServiceName: 'myFancySrvServiceName'
});
client = new MongoClient(SRV_CONNECTION_STRING, {
tls: false,
srvServiceName: 'myFancySrvServiceName',
serverSelectionTimeoutMS: 5000
});
await client.connect();
clock.tick(2 * client.topology.s.srvPoller.rescanSrvIntervalMS);
// No need to await process tick, since we're not checking DNS lookups
const resolveSrvCalls = resolveSrvStub.getCalls();
expect(resolveSrvCalls).to.have.lengthOf(2);
expect(resolveSrvCalls[0].args[0]).includes('myFancySrvServiceName');
expect(resolveSrvCalls[1].args[0]).include('myFancySrvServiceName');
});
});
});