@depup/mongodb 7.1.0-depup.0

package/src/sdam/server_selection_events.ts

@@ -0,0 +1,142 @@
+import { HostAddress } from '.././utils';
+import {
+  SERVER_SELECTION_FAILED,
+  SERVER_SELECTION_STARTED,
+  SERVER_SELECTION_SUCCEEDED,
+  WAITING_FOR_SUITABLE_SERVER
+} from '../constants';
+import { type ReadPreference } from '../read_preference';
+import { type ServerSelector } from './server_selection';
+import type { TopologyDescription } from './topology_description';
+
+/**
+ * The base export class for all logs published from server selection
+ * @internal
+ * @category Log Type
+ */
+export abstract class ServerSelectionEvent {
+  /** String representation of the selector being used to select the server.
+   *  Defaults to 'custom selector' for application-provided custom selector case.
+   */
+  selector: string | ReadPreference | ServerSelector;
+  /** The name of the operation for which a server is being selected.  */
+  operation: string;
+  /** 	The current topology description.  */
+  topologyDescription: TopologyDescription;
+
+  /** @internal */
+  abstract name:
+    | typeof SERVER_SELECTION_STARTED
+    | typeof SERVER_SELECTION_SUCCEEDED
+    | typeof SERVER_SELECTION_FAILED
+    | typeof WAITING_FOR_SUITABLE_SERVER;
+
+  abstract message: string;
+
+  /** @internal */
+  constructor(
+    selector: string | ReadPreference | ServerSelector,
+    topologyDescription: TopologyDescription,
+    operation: string
+  ) {
+    this.selector = selector;
+    this.operation = operation;
+    this.topologyDescription = topologyDescription;
+  }
+}
+
+/**
+ * An event published when server selection starts
+ * @internal
+ * @category Event
+ */
+export class ServerSelectionStartedEvent extends ServerSelectionEvent {
+  /** @internal */
+  name = SERVER_SELECTION_STARTED;
+  message = 'Server selection started';
+
+  /** @internal */
+  constructor(
+    selector: string | ReadPreference | ServerSelector,
+    topologyDescription: TopologyDescription,
+    operation: string
+  ) {
+    super(selector, topologyDescription, operation);
+  }
+}
+
+/**
+ * An event published when a server selection fails
+ * @internal
+ * @category Event
+ */
+export class ServerSelectionFailedEvent extends ServerSelectionEvent {
+  /** @internal */
+  name = SERVER_SELECTION_FAILED;
+  message = 'Server selection failed';
+  /** Representation of the error the driver will throw regarding server selection failing. */
+  failure: Error;
+
+  /** @internal */
+  constructor(
+    selector: string | ReadPreference | ServerSelector,
+    topologyDescription: TopologyDescription,
+    error: Error,
+    operation: string
+  ) {
+    super(selector, topologyDescription, operation);
+    this.failure = error;
+  }
+}
+
+/**
+ * An event published when server selection succeeds
+ * @internal
+ * @category Event
+ */
+export class ServerSelectionSucceededEvent extends ServerSelectionEvent {
+  /** @internal */
+  name = SERVER_SELECTION_SUCCEEDED;
+  message = 'Server selection succeeded';
+  /** 	The hostname, IP address, or Unix domain socket path for the selected server. */
+  serverHost: string;
+  /** The port for the selected server. Optional; not present for Unix domain sockets. When the user does not specify a port and the default (27017) is used, the driver SHOULD include it here. */
+  serverPort: number | undefined;
+
+  /** @internal */
+  constructor(
+    selector: string | ReadPreference | ServerSelector,
+    topologyDescription: TopologyDescription,
+    address: string,
+    operation: string
+  ) {
+    super(selector, topologyDescription, operation);
+    const { host, port } = HostAddress.fromString(address).toHostPort();
+    this.serverHost = host;
+    this.serverPort = port;
+  }
+}
+
+/**
+ * An event published when server selection is waiting for a suitable server to become available
+ * @internal
+ * @category Event
+ */
+export class WaitingForSuitableServerEvent extends ServerSelectionEvent {
+  /** @internal */
+  name = WAITING_FOR_SUITABLE_SERVER;
+  message = 'Waiting for suitable server to become available';
+  /** The remaining time left until server selection will time out. */
+  remainingTimeMS: number;
+
+  /** @internal */
+  constructor(
+    selector: string | ReadPreference | ServerSelector,
+    topologyDescription: TopologyDescription,
+    remainingTimeMS: number,
+    operation: string
+  ) {
+    super(selector, topologyDescription, operation);
+    this.remainingTimeMS = remainingTimeMS;
+  }
+}

package/src/sdam/srv_polling.ts

@@ -0,0 +1,146 @@
+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 {
+    if (!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);
+  }
+}