refactor: factor common sdam types into commonly accesible file

mbroadst · mbroadst · commit d45d33c6422b · 2019-11-25T10:02:00.000-05:00
diff --git a/lib/core/sdam/common.js b/lib/core/sdam/common.js
@@ -0,0 +1,38 @@
+'use strict';
+
+// shared state names
+const STATE_CLOSING = 'closing';
+const STATE_CLOSED = 'closed';
+const STATE_CONNECTING = 'connecting';
+const STATE_CONNECTED = 'connected';
+
+// An enumeration of topology types we know about
+const TopologyType = {
+  Single: 'Single',
+  ReplicaSetNoPrimary: 'ReplicaSetNoPrimary',
+  ReplicaSetWithPrimary: 'ReplicaSetWithPrimary',
+  Sharded: 'Sharded',
+  Unknown: 'Unknown'
+};
+
+// An enumeration of server types we know about
+const ServerType = {
+  Standalone: 'Standalone',
+  Mongos: 'Mongos',
+  PossiblePrimary: 'PossiblePrimary',
+  RSPrimary: 'RSPrimary',
+  RSSecondary: 'RSSecondary',
+  RSArbiter: 'RSArbiter',
+  RSOther: 'RSOther',
+  RSGhost: 'RSGhost',
+  Unknown: 'Unknown'
+};
+
+module.exports = {
+  STATE_CLOSING,
+  STATE_CLOSED,
+  STATE_CONNECTING,
+  STATE_CONNECTED,
+  TopologyType,
+  ServerType
+};
diff --git a/lib/core/sdam/monitoring.js b/lib/core/sdam/monitoring.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const ServerDescription = require('./server_description').ServerDescription;
+const ServerDescription = require('./server_description');
 const calculateDurationInMs = require('../utils').calculateDurationInMs;
 
 // pulled from `Server` implementation
diff --git a/lib/core/sdam/server.js b/lib/core/sdam/server.js
@@ -7,7 +7,7 @@ const wireProtocol = require('../wireprotocol');
 const BSON = require('../connection/utils').retrieveBSON();
 const createClientInfo = require('../topologies/shared').createClientInfo;
 const Logger = require('../connection/logger');
-const ServerDescription = require('./server_description').ServerDescription;
+const ServerDescription = require('./server_description');
 const ReadPreference = require('../topologies/read_preference');
 const monitorServer = require('./monitoring').monitorServer;
 const MongoParseError = require('../error').MongoParseError;
@@ -16,6 +16,7 @@ const collationNotSupported = require('../utils').collationNotSupported;
 const debugOptions = require('../connection/utils').debugOptions;
 const isSDAMUnrecoverableError = require('../error').isSDAMUnrecoverableError;
 const makeStateMachine = require('../utils').makeStateMachine;
+const common = require('./common');
 
 // Used for filtering out fields for logging
 const DEBUG_FIELDS = [
@@ -45,10 +46,10 @@ const DEBUG_FIELDS = [
   'servername'
 ];
 
-const STATE_CLOSING = 'closing';
-const STATE_CLOSED = 'closed';
-const STATE_CONNECTING = 'connecting';
-const STATE_CONNECTED = 'connected';
+const STATE_CLOSING = common.STATE_CLOSING;
+const STATE_CLOSED = common.STATE_CLOSED;
+const STATE_CONNECTING = common.STATE_CONNECTING;
+const STATE_CONNECTED = common.STATE_CONNECTED;
 const stateTransition = makeStateMachine({
   [STATE_CLOSED]: [STATE_CLOSED, STATE_CONNECTING],
   [STATE_CONNECTING]: [STATE_CONNECTING, STATE_CLOSING, STATE_CONNECTED, STATE_CLOSED],
diff --git a/lib/core/sdam/server_description.js b/lib/core/sdam/server_description.js
@@ -2,19 +2,7 @@
 
 const arrayStrictEqual = require('../utils').arrayStrictEqual;
 const tagsStrictEqual = require('../utils').tagsStrictEqual;
-
-// An enumeration of server types we know about
-const ServerType = {
-  Standalone: 'Standalone',
-  Mongos: 'Mongos',
-  PossiblePrimary: 'PossiblePrimary',
-  RSPrimary: 'RSPrimary',
-  RSSecondary: 'RSSecondary',
-  RSArbiter: 'RSArbiter',
-  RSOther: 'RSOther',
-  RSGhost: 'RSGhost',
-  Unknown: 'Unknown'
-};
+const ServerType = require('./common').ServerType;
 
 const WRITABLE_SERVER_TYPES = new Set([
   ServerType.RSPrimary,
@@ -186,7 +174,4 @@ function parseServerType(ismaster) {
   return ServerType.Standalone;
 }
 
-module.exports = {
-  ServerDescription,
-  ServerType
-};
+module.exports = ServerDescription;
diff --git a/lib/core/sdam/server_selectors.js b/lib/core/sdam/server_selectors.js
@@ -1,6 +1,6 @@
 'use strict';
-const ServerType = require('./server_description').ServerType;
-const TopologyType = require('./topology_description').TopologyType;
+const ServerType = require('./common').ServerType;
+const TopologyType = require('./common').TopologyType;
 const ReadPreference = require('../topologies/read_preference');
 const MongoError = require('../error').MongoError;
 
diff --git a/lib/core/sdam/topology.js b/lib/core/sdam/topology.js
@@ -1,9 +1,9 @@
 'use strict';
 const EventEmitter = require('events');
-const ServerDescription = require('./server_description').ServerDescription;
-const ServerType = require('./server_description').ServerType;
-const TopologyDescription = require('./topology_description').TopologyDescription;
-const TopologyType = require('./topology_description').TopologyType;
+const ServerDescription = require('./server_description');
+const ServerType = require('./common').ServerType;
+const TopologyDescription = require('./topology_description');
+const TopologyType = require('./common').TopologyType;
 const monitoring = require('./monitoring');
 const calculateDurationInMs = require('../utils').calculateDurationInMs;
 const MongoTimeoutError = require('../error').MongoTimeoutError;
@@ -27,6 +27,7 @@ const SrvPoller = require('./srv_polling').SrvPoller;
 const getMMAPError = require('../topologies/shared').getMMAPError;
 const makeStateMachine = require('../utils').makeStateMachine;
 const eachAsync = require('../utils').eachAsync;
+const common = require('./common');
 
 // Global state
 let globalTopologyCounter = 0;
@@ -62,10 +63,10 @@ const LOCAL_SERVER_EVENTS = SERVER_RELAY_EVENTS.concat([
   'ended'
 ]);
 
-const STATE_CLOSING = 'closing';
-const STATE_CLOSED = 'closed';
-const STATE_CONNECTING = 'connecting';
-const STATE_CONNECTED = 'connected';
+const STATE_CLOSING = common.STATE_CLOSING;
+const STATE_CLOSED = common.STATE_CLOSED;
+const STATE_CONNECTING = common.STATE_CONNECTING;
+const STATE_CONNECTED = common.STATE_CONNECTED;
 const stateTransition = makeStateMachine({
   [STATE_CLOSED]: [STATE_CLOSED, STATE_CONNECTING],
   [STATE_CONNECTING]: [STATE_CONNECTING, STATE_CLOSING, STATE_CONNECTED, STATE_CLOSED],
diff --git a/lib/core/sdam/topology_description.js b/lib/core/sdam/topology_description.js
@@ -1,23 +1,15 @@
 'use strict';
-const ServerType = require('./server_description').ServerType;
-const ServerDescription = require('./server_description').ServerDescription;
+const ServerType = require('./common').ServerType;
+const ServerDescription = require('./server_description');
 const WIRE_CONSTANTS = require('../wireprotocol/constants');
+const TopologyType = require('./common').TopologyType;
 
 // contstants related to compatability checks
 const MIN_SUPPORTED_SERVER_VERSION = WIRE_CONSTANTS.MIN_SUPPORTED_SERVER_VERSION;
 const MAX_SUPPORTED_SERVER_VERSION = WIRE_CONSTANTS.MAX_SUPPORTED_SERVER_VERSION;
 const MIN_SUPPORTED_WIRE_VERSION = WIRE_CONSTANTS.MIN_SUPPORTED_WIRE_VERSION;
 const MAX_SUPPORTED_WIRE_VERSION = WIRE_CONSTANTS.MAX_SUPPORTED_WIRE_VERSION;
 
-// An enumeration of topology types we know about
-const TopologyType = {
-  Single: 'Single',
-  ReplicaSetNoPrimary: 'ReplicaSetNoPrimary',
-  ReplicaSetWithPrimary: 'ReplicaSetWithPrimary',
-  Sharded: 'Sharded',
-  Unknown: 'Unknown'
-};
-
 // Representation of a deployment of servers
 class TopologyDescription {
   /**
@@ -404,7 +396,4 @@ function checkHasPrimary(serverDescriptions) {
   return TopologyType.ReplicaSetNoPrimary;
 }
 
-module.exports = {
-  TopologyType,
-  TopologyDescription
-};
+module.exports = TopologyDescription;
diff --git a/lib/core/topologies/shared.js b/lib/core/topologies/shared.js
@@ -3,7 +3,7 @@
 const os = require('os');
 const ReadPreference = require('./read_preference');
 const Buffer = require('safe-buffer').Buffer;
-const TopologyType = require('../sdam/topology_description').TopologyType;
+const TopologyType = require('../sdam/common').TopologyType;
 const MongoError = require('../error').MongoError;
 
 const MMAPv1_RETRY_WRITES_ERROR_CODE = 20;
diff --git a/lib/core/wireprotocol/shared.js b/lib/core/wireprotocol/shared.js
@@ -2,8 +2,8 @@
 
 const ReadPreference = require('../topologies/read_preference');
 const MongoError = require('../error').MongoError;
-const ServerType = require('../sdam/server_description').ServerType;
-const TopologyDescription = require('../sdam/topology_description').TopologyDescription;
+const ServerType = require('../sdam/common').ServerType;
+const TopologyDescription = require('../sdam/topology_description');
 
 const MESSAGE_HEADER_SIZE = 16;
 const COMPRESSION_DETAILS_SIZE = 9; // originalOpcode + uncompressedSize, compressorID
diff --git a/test/core/functional/srv_polling_tests.js b/test/core/functional/srv_polling_tests.js
@@ -1,9 +1,8 @@
 'use strict';
 
 const Topology = require('../../../lib/core/sdam/topology');
-const _topologyDescription = require('../../../lib/core/sdam/topology_description');
-const TopologyDescription = _topologyDescription.TopologyDescription;
-const TopologyType = _topologyDescription.TopologyType;
+const TopologyDescription = require('../../../lib/core/sdam/topology_description');
+const TopologyType = require('../../../lib/core/sdam/common').TopologyType;
 const monitoring = require('../../../lib/core/sdam/monitoring');
 const SrvPoller = require('../../../lib/core/sdam/srv_polling').SrvPoller;
 const SrvPollingEvent = require('../../../lib/core/sdam/srv_polling').SrvPollingEvent;
diff --git a/test/core/unit/sdam_spec_tests.js b/test/core/unit/sdam_spec_tests.js
@@ -5,7 +5,7 @@ const chai = require('chai');
 const expect = chai.expect;
 const Topology = require('../../../lib/core/sdam/topology');
 const Server = require('../../../lib/core/sdam/server');
-const ServerDescription = require('../../../lib/core/sdam/server_description').ServerDescription;
+const ServerDescription = require('../../../lib/core/sdam/server_description');
 const monitoring = require('../../../lib/core/sdam/monitoring');
 const parse = require('../../../lib/core/uri_parser');
 chai.use(require('chai-subset'));
diff --git a/test/runner/config.js b/test/runner/config.js
@@ -4,7 +4,7 @@ const qs = require('querystring');
 const util = require('util');
 
 const MongoClient = require('../../lib/mongo_client');
-const TopologyType = require('../../lib/core/sdam/topology_description').TopologyType;
+const TopologyType = require('../../lib/core/sdam/common').TopologyType;
 const core = require('../../lib/core');
 
 class NativeConfiguration {
diff --git a/test/runner/filters/mongodb_topology_filter.js b/test/runner/filters/mongodb_topology_filter.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const topologyType = require('../../../lib/core/topologies/shared').topologyType;
-const TopologyType = require('../../../lib/core/sdam/topology_description').TopologyType;
+const TopologyType = require('../../../lib/core/sdam/common').TopologyType;
 
 /**
  * Filter for the MongoDB toopology required for the test
diff --git a/test/unit/sdam/server_selection/spec_tests.js b/test/unit/sdam/server_selection/spec_tests.js
@@ -8,8 +8,8 @@ const ReadPreference = core.ReadPreference;
 
 // TODO: these should be from `core` when legacy topologies are removed
 const Server = require('../../../../lib/core/sdam/server');
-const ServerType = require('../../../../lib/core/sdam/server_description').ServerType;
-const ServerDescription = require('../../../../lib/core/sdam/server_description').ServerDescription;
+const ServerType = require('../../../../lib/core/sdam/common').ServerType;
+const ServerDescription = require('../../../../lib/core/sdam/server_description');
 const ServerSelectors = require('../../../../lib/core/sdam/server_selectors');
 
 const EJSON = require('mongodb-extjson');
