Check networkTraffic preference and move into compass-connections

Author: kraenhansen

package-lock.json

@@ -69,7 +69,8 @@
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",
-    "redux-thunk": "^2.4.2"
+    "redux-thunk": "^2.4.2",
+    "semver": "^7.6.2"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-compass": "^1.3.8",
@@ -82,6 +83,7 @@
     "@types/mocha": "^9.0.0",
     "@types/react": "^17.0.5",
     "@types/react-dom": "^17.0.10",
+    "@types/semver": "^7.3.9",
     "@types/sinon-chai": "^3.2.5",
     "chai": "^4.3.4",
     "depcheck": "^1.4.1",

packages/compass-connections/package.json

@@ -34,6 +34,10 @@ import { showEndOfLifeMongoDBWarningModal as _showEndOfLifeMongoDBWarningModal }
 import ConnectionString from 'mongodb-connection-string-url';
 import type { ExtraConnectionData as ExtraConnectionDataForTelemetry } from '@mongodb-js/compass-telemetry';
 import { connectable } from '../utils/connection-supports';
+import {
+  getLatestEndOfLifeServerVersion,
+  isEndOfLifeVersion,
+} from '../utils/end-of-life-server';
 
 export type ConnectionsEventMap = {
   connected: (
@@ -1819,25 +1823,28 @@ const connectWithOptions = (
             .isGenuine === false
         ) {
           dispatch(showNonGenuineMongoDBWarningModal(connectionInfo.id));
-        } else {
-          void dataService.instance().then(
-            (instance) => {
-              if (instance.build.isEndOfLife) {
+        } else if (preferences.getPreferences().networkTraffic) {
+          void dataService
+            .instance()
+            .then(async (instance) => {
+              const { version } = instance.build;
+              const latestEndOfLifeServerVersion =
+                await getLatestEndOfLifeServerVersion();
+              if (isEndOfLifeVersion(version, latestEndOfLifeServerVersion)) {
                 dispatch(
                   showEndOfLifeMongoDBWarningModal(
                     connectionInfo.id,
                     instance.build.version
                   )
                 );
               }
-            },
-            (err) => {
+            })
+            .catch((err) => {
               debug(
                 'failed to get instance details to determine if the server version is end-of-life',
                 err
               );
-            }
-          );
+            });
         }
       } catch (err) {
         dispatch(connectionAttemptError(connectionInfo, err));

packages/compass-connections/src/stores/connections-store-redux.ts

@@ -0,0 +1,31 @@
+import { expect } from 'chai';
+import { isEndOfLifeVersion } from './end-of-life-server';
+
+describe('isEndOfLifeVersion', function () {
+  const LATEST_END_OF_LIFE_VERSION = '4.4.x';
+
+  function expectVersions(versions: string[], expected: boolean) {
+    for (const version of versions) {
+      expect(isEndOfLifeVersion(version, LATEST_END_OF_LIFE_VERSION)).to.equal(
+        expected,
+        `Expected ${version} to be ${
+          expected ? 'end of life' : 'not end of life'
+        }`
+      );
+    }
+  }
+
+  it('returns true for v4.4 and below', () => {
+    expectVersions(
+      ['4.4.0', '4.3.0', '4.0', '4.0-beta.0', '1.0.0', '0.0.1', '3.999.0'],
+      true
+    );
+  });
+
+  it('returns true for v4.5 and above', () => {
+    expectVersions(
+      ['4.5.0', '5.0.0', '5.0.25', '6.0.0', '7.0.0', '8.0.0'],
+      false
+    );
+  });
+});

packages/compass-connections/src/utils/end-of-life-server.spec.ts

@@ -1,5 +1,9 @@
+import semverSatisfies from 'semver/functions/satisfies';
+import semverCoerce from 'semver/functions/coerce';
+
 import { createLogger } from '@mongodb-js/compass-logging';
-const { mongoLogId, log } = createLogger('END-OF-LIFE-SERVER');
+
+const { mongoLogId, log, debug } = createLogger('END-OF-LIFE-SERVER');
 
 const FALLBACK_END_OF_LIFE_SERVER_VERSION = '4.4';
 const {
@@ -61,3 +65,19 @@ export async function getLatestEndOfLifeServerVersion(): Promise<string> {
   // Return a cached or in-flight value
   return latestEndOfLifeServerVersion;
 }
+
+export function isEndOfLifeVersion(
+  version: string,
+  latestEndOfLifeServerVersion: string
+) {
+  try {
+    const coercedVersion = semverCoerce(version);
+    return coercedVersion
+      ? semverSatisfies(coercedVersion, `<=${latestEndOfLifeServerVersion}`)
+      : false;
+  } catch (error) {
+    debug('Error comparing versions', { error });
+    // If the version is not a valid semver, we can't reliably determine if it's EOL
+    return false;
+  }
+}

packages/data-service/src/end-of-life-server.ts renamed to packages/compass-connections/src/utils/end-of-life-server.ts

@@ -60,8 +60,7 @@
     "mongodb": "^6.16.0",
     "mongodb-build-info": "^1.7.2",
     "mongodb-connection-string-url": "^3.0.1",
-    "mongodb-ns": "^2.4.2",
-    "semver": "^7.6.2"
+    "mongodb-ns": "^2.4.2"
   },
   "devDependencies": {
     "@mongodb-js/compass-test-server": "^0.3.8",
@@ -72,7 +71,6 @@
     "@mongodb-js/prettier-config-compass": "^1.2.8",
     "@mongodb-js/tsconfig-compass": "^1.2.8",
     "@types/lodash": "^4.14.188",
-    "@types/semver": "^7.3.9",
     "@types/whatwg-url": "^8.2.1",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",

packages/data-service/package.json

@@ -7,8 +7,6 @@ import {
   getDatabasesByRoles,
   getPrivilegesByDatabaseAndCollection,
   getInstance,
-  isEndOfLifeVersion,
-  adaptBuildInfo,
 } from './instance-detail-helper';
 
 import * as fixtures from '../test/fixtures';
@@ -631,70 +629,4 @@ describe('instance-detail-helper', function () {
       ).to.deep.equal(['aws', 'local']);
     });
   });
-
-  describe('isEndOfLifeVersion', function () {
-    const LATEST_END_OF_LIFE_VERSION = '4.4.x';
-
-    function expectVersions(versions: string[], expected: boolean) {
-      for (const version of versions) {
-        expect(
-          isEndOfLifeVersion(version, LATEST_END_OF_LIFE_VERSION)
-        ).to.equal(
-          expected,
-          `Expected ${version} to be ${
-            expected ? 'end of life' : 'not end of life'
-          }`
-        );
-      }
-    }
-
-    it('returns true for v4.4 and below', () => {
-      expectVersions(
-        ['4.4.0', '4.3.0', '4.0', '4.0-beta.0', '1.0.0', '0.0.1', '3.999.0'],
-        true
-      );
-    });
-
-    it('returns true for v4.5 and above', () => {
-      expectVersions(
-        ['4.5.0', '5.0.0', '5.0.25', '6.0.0', '7.0.0', '8.0.0'],
-        false
-      );
-    });
-  });
-
-  describe('adaptBuildInfo', function () {
-    const LATEST_END_OF_LIFE_VERSION = '4.4.0';
-    it('propagate isEndOfLife as expected', function () {
-      expect(
-        adaptBuildInfo({ version: '4.4.0' }, LATEST_END_OF_LIFE_VERSION)
-      ).to.deep.equal({
-        version: '4.4.0',
-        isEndOfLife: true,
-        isEnterprise: false,
-      });
-      // Missing version
-      expect(adaptBuildInfo({}, LATEST_END_OF_LIFE_VERSION)).to.deep.equal({
-        version: '',
-        isEndOfLife: false,
-        isEnterprise: false,
-      });
-      // Malformed version
-      expect(
-        adaptBuildInfo({ version: 'what?' }, LATEST_END_OF_LIFE_VERSION)
-      ).to.deep.equal({
-        version: 'what?',
-        isEndOfLife: false,
-        isEnterprise: false,
-      });
-      // Newer version
-      expect(
-        adaptBuildInfo({ version: '8.0.0' }, LATEST_END_OF_LIFE_VERSION)
-      ).to.deep.equal({
-        version: '8.0.0',
-        isEndOfLife: false,
-        isEnterprise: false,
-      });
-    });
-  });
 });

packages/data-service/src/instance-detail-helper.spec.ts

@@ -14,9 +14,6 @@ import {
 } from 'mongodb-build-info';
 import toNS from 'mongodb-ns';
 
-import semverSatisfies from 'semver/functions/satisfies';
-import semverCoerce from 'semver/functions/coerce';
-
 import type {
   BuildInfo,
   CollectionInfo,
@@ -28,11 +25,9 @@ import type {
 } from './run-command';
 import { runCommand } from './run-command';
 import { debug } from './logger';
-import { getLatestEndOfLifeServerVersion } from './end-of-life-server';
 
 type BuildInfoDetails = {
   isEnterprise: boolean;
-  isEndOfLife: boolean;
   version: string;
 };
 
@@ -127,7 +122,6 @@ export async function getInstance(
     getParameterResult,
     atlasVersionResult,
     isLocalAtlas,
-    latestEndOfLifeServerVersion,
   ] = await Promise.all([
     runCommand(
       adminDb,
@@ -164,14 +158,13 @@ export async function getInstance(
         return await client.db(db).collection(collection).countDocuments(query);
       }
     ),
-    getLatestEndOfLifeServerVersion(),
   ]);
 
   const isAtlas = !!atlasVersionResult.atlasVersion || checkIsAtlas(uri);
 
   return {
     auth: adaptAuthInfo(connectionStatus),
-    build: adaptBuildInfo(buildInfoResult, latestEndOfLifeServerVersion),
+    build: adaptBuildInfo(buildInfoResult),
     host: adaptHostInfo(hostInfoResult),
     genuineMongoDB: buildGenuineMongoDBInfo(uri),
     dataLake: buildDataLakeInfo(buildInfoResult),
@@ -357,33 +350,13 @@ function adaptHostInfo(rawHostInfo: Partial<HostInfo>): HostInfoDetails {
   };
 }
 
-export function isEndOfLifeVersion(
-  version: string,
-  latestEndOfLifeServerVersion: string
-) {
-  try {
-    const coercedVersion = semverCoerce(version);
-    return coercedVersion
-      ? semverSatisfies(coercedVersion, `<=${latestEndOfLifeServerVersion}`)
-      : false;
-  } catch (error) {
-    debug('Error comparing versions', { error });
-    // If the version is not a valid semver, we can't reliably determine if it's EOL
-    return false;
-  }
-}
-
 export function adaptBuildInfo(
-  rawBuildInfo: Partial<BuildInfo>,
-  latestEndOfLifeServerVersion: string
+  rawBuildInfo: Partial<BuildInfo>
 ): BuildInfoDetails {
   return {
     version: rawBuildInfo.version ?? '',
     // Cover both cases of detecting enterprise module, see SERVER-18099.
     isEnterprise: isEnterprise(rawBuildInfo),
-    isEndOfLife: rawBuildInfo.version
-      ? isEndOfLifeVersion(rawBuildInfo.version, latestEndOfLifeServerVersion)
-      : false,
   };
 }