feat: local atlas detection support COMPASS-7213 (#25)

Co-authored-by: Anna Henningsen <[email protected]>

Author: mabaasit

README.md

@@ -44,6 +44,9 @@ Returns a boolean.
 ### isAtlas(uri)
 Returns a boolean.
 
+### isLocalAtlas(count: (db: string, coll: string, query: Document) => Promise\<number\>)
+Returns a Promise\<boolean\>.
+
 ### isAtlasStream(uri)
 Returns a boolean.
 

index.d.ts

@@ -5,6 +5,8 @@ export declare function getDataLake(buildInfo: any): {
 
 export declare function isEnterprise(buildInfo: any): boolean;
 export declare function isAtlas(uri: string): boolean;
+type IsLocalAtlasCountFn = (db: string, ns: string, query: Record<string, any>) => Promise<number>;
+export declare function isLocalAtlas(countFn: IsLocalAtlasCountFn): Promise<boolean>;
 export declare function isAtlasStream(uri: string): boolean;
 export declare function isLocalhost(uri: string): boolean;
 export declare function isDigitalOcean(uri: string): boolean;

index.js

@@ -59,6 +59,12 @@ function isAtlas(uri) {
   return !!getHostnameFromUrl(uri).match(ATLAS_REGEX);
 }
 
+function isLocalAtlas(countFn) {
+  return countFn('admin', 'atlascli', {
+    managedClusterType: 'atlasCliLocalDevCluster'
+  }).then(count => count > 0).catch(() => false);
+}
+
 function isAtlasStream(uri) {
   const host = getHostnameFromUrl(uri);
   return !!(host.match(ATLAS_REGEX) && host.match(ATLAS_STREAM_REGEX));
@@ -103,4 +109,14 @@ function getGenuineMongoDB(uri) {
   };
 }
 
-module.exports = { getDataLake, isEnterprise, isAtlas, isAtlasStream, isLocalhost, isDigitalOcean, getGenuineMongoDB, getBuildEnv };
+module.exports = {
+  getDataLake,
+  isEnterprise,
+  isAtlas,
+  isLocalAtlas,
+  isAtlasStream,
+  isLocalhost,
+  isDigitalOcean,
+  getGenuineMongoDB,
+  getBuildEnv
+};

test/index.spec.js

@@ -1,13 +1,16 @@
 const expect = require('chai').expect;
 const fixtures = require('./fixtures');
-const isAtlas = require('../.').isAtlas;
-const isAtlasStream = require('../.').isAtlasStream;
-const getDataLake = require('../.').getDataLake;
-const isLocalhost = require('../.').isLocalhost;
-const isDigitalOcean = require('../.').isDigitalOcean;
-const getBuildEnv = require('../.').getBuildEnv;
-const isEnterprise = require('../.').isEnterprise;
-const getGenuineMongoDB = require('../.').getGenuineMongoDB;
+const {
+  isAtlas,
+  isAtlasStream,
+  getDataLake,
+  isLocalhost,
+  isLocalAtlas,
+  isDigitalOcean,
+  getBuildEnv,
+  isEnterprise,
+  getGenuineMongoDB,
+} = require('..');
 
 describe('mongodb-build-info', () => {
   context('isDataLake', () => {
@@ -95,6 +98,40 @@ describe('mongodb-build-info', () => {
     });
   });
 
+  context('isLocalAtlas', () => {
+    it('calls counts function with expected args', (done) => {
+      isLocalAtlas((db, coll, query) => {
+        expect(db).to.equal('admin');
+        expect(coll).to.equal('atlascli');
+        expect(query).to.deep.equal({
+          managedClusterType: 'atlasCliLocalDevCluster'
+        });
+        done();
+      });
+    });
+    it('returns false when count resolves to 0', (done) => {
+      isLocalAtlas(() => Promise.resolve(0))
+        .then(res => {
+          expect(res).to.be.false;
+          done();
+        });
+    });
+    it('returns false when count throws', (done) => {
+      isLocalAtlas(() => Promise.reject('No such db'))
+        .then(res => {
+          expect(res).to.be.false;
+          done();
+        });
+    });
+    it('returns true when count resolves to 1', (done) => {
+      isLocalAtlas(() => Promise.resolve(1))
+        .then(res => {
+          expect(res).to.be.true;
+          done();
+        });
+    });
+  });
+
   context('isAtlasStream', () => {
     it('reports on atlas', () => {
       expect(isAtlasStream('mongodb://admin:catscatscats@atlas-stream-64ba1372b2a9f1545031f34d-gkumd.virginia-usa.a.query.mongodb.net/')).to.be.true;