All files / src/sdam srv_polling.ts

100% Statements 57/57
95.45% Branches 21/22
100% Functions 13/13
100% Lines 56/56

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 147135x 135x   135x 135x 135x           135x     17x       23x                                   135x                     135x     231x 231x   231x 8x     223x 223x 223x 223x 223x   223x 223x   223x       32x       78x       66x 66x         166x 58x 58x 58x           74x 4x     74x 4x         8x 8x 8x       8x 8x       32x     32x 32x   4x 4x     28x 4x     24x 24x 38x 38x 22x   16x       24x 12x 12x     12x      
import * as dns from 'dns';
import { clearTimeout, setTimeout } from 'timers';
 
import { MongoRuntimeError } from '../error';
import { TypedEventEmitter } from '../mongo_types';
import { checkParentDomainMatch, HostAddress, noop, squashError } from '../utils';
 
/**
 * @internal
 * @category Event
 */
export class SrvPollingEvent {
  srvRecords: dns.SrvRecord[];
  constructor(srvRecords: dns.SrvRecord[]) {
    this.srvRecords = srvRecords;
  }
 
  hostnames(): Set<string> {
    return new Set(this.srvRecords.map(r => HostAddress.fromSrvRecord(r).toString()));
  }
}
 
/** @internal */
export interface SrvPollerOptions {
  srvServiceName: string;
  srvMaxHosts: number;
  srvHost: string;
  heartbeatFrequencyMS: number;
}
 
/** @internal */
export type SrvPollerEvents = {
  srvRecordDiscovery(event: SrvPollingEvent): void;
};
 
/** @internal */
export class SrvPoller extends TypedEventEmitter<SrvPollerEvents> {
  srvHost: string;
  rescanSrvIntervalMS: number;
  heartbeatFrequencyMS: number;
  haMode: boolean;
  generation: number;
  srvMaxHosts: number;
  srvServiceName: string;
  _timeout?: NodeJS.Timeout;
 
  /** @event */
  static readonly SRV_RECORD_DISCOVERY = 'srvRecordDiscovery' as const;
 
  constructor(options: SrvPollerOptions) {
    super();
    this.on('error', noop);
 
    if (!options || !options.srvHost) {
      throw new MongoRuntimeError('Options for SrvPoller must exist and include srvHost');
    }
 
    this.srvHost = options.srvHost;
    this.srvMaxHosts = options.srvMaxHosts ?? 0;
    this.srvServiceName = options.srvServiceName ?? 'mongodb';
    this.rescanSrvIntervalMS = 60000;
    this.heartbeatFrequencyMS = options.heartbeatFrequencyMS ?? 10000;
 
    this.haMode = false;
    this.generation = 0;
 
    this._timeout = undefined;
  }
 
  get srvAddress(): string {
    return `_${this.srvServiceName}._tcp.${this.srvHost}`;
  }
 
  get intervalMS(): number {
    return this.haMode ? this.heartbeatFrequencyMS : this.rescanSrvIntervalMS;
  }
 
  start(): void {
    Eif (!this._timeout) {
      this.schedule();
    }
  }
 
  stop(): void {
    if (this._timeout) {
      clearTimeout(this._timeout);
      this.generation += 1;
      this._timeout = undefined;
    }
  }
 
  // TODO(NODE-4994): implement new logging logic for SrvPoller failures
  schedule(): void {
    if (this._timeout) {
      clearTimeout(this._timeout);
    }
 
    this._timeout = setTimeout(() => {
      this._poll().then(undefined, squashError);
    }, this.intervalMS);
  }
 
  success(srvRecords: dns.SrvRecord[]): void {
    this.haMode = false;
    this.schedule();
    this.emit(SrvPoller.SRV_RECORD_DISCOVERY, new SrvPollingEvent(srvRecords));
  }
 
  failure(): void {
    this.haMode = true;
    this.schedule();
  }
 
  async _poll(): Promise<void> {
    const generation = this.generation;
    let srvRecords;
 
    try {
      srvRecords = await dns.promises.resolveSrv(this.srvAddress);
    } catch {
      this.failure();
      return;
    }
 
    if (generation !== this.generation) {
      return;
    }
 
    const finalAddresses: dns.SrvRecord[] = [];
    for (const record of srvRecords) {
      try {
        checkParentDomainMatch(record.name, this.srvHost);
        finalAddresses.push(record);
      } catch (error) {
        squashError(error);
      }
    }
 
    if (!finalAddresses.length) {
      this.failure();
      return;
    }
 
    this.success(finalAddresses);
  }
}