@mongosh/service-provider-core 1.10.0 → 1.10.2

package/src/connect-info.spec.ts

@@ -1,84 +1,67 @@
-/* eslint camelcase: 0, camelcase: 0 */
 import { expect } from 'chai';
 import getConnectInfo from './connect-info';
 
-describe('getConnectInfo', function() {
+describe('getConnectInfo', function () {
   const BUILD_INFO = {
-    'version': '3.2.0-rc2',
-    'gitVersion': '8a3acb42742182c5e314636041c2df368232bbc5',
-    'modules': [
-      'enterprise'
-    ],
-    'allocator': 'system',
-    'javascriptEngine': 'mozjs',
-    'sysInfo': 'deprecated',
-    'versionArray': [
-      3,
-      2,
-      0,
-      -48
-    ],
-    'openssl': {
-      'running': 'OpenSSL 0.9.8zg 14 July 2015',
-      'compiled': 'OpenSSL 0.9.8y 5 Feb 2013'
+    version: '3.2.0-rc2',
+    gitVersion: '8a3acb42742182c5e314636041c2df368232bbc5',
+    modules: ['enterprise'],
+    allocator: 'system',
+    javascriptEngine: 'mozjs',
+    sysInfo: 'deprecated',
+    versionArray: [3, 2, 0, -48],
+    openssl: {
+      running: 'OpenSSL 0.9.8zg 14 July 2015',
+      compiled: 'OpenSSL 0.9.8y 5 Feb 2013',
     },
-    'buildEnvironment': {
-      'distmod': '',
-      'distarch': 'x86_64',
-      'cc': 'gcc: Apple LLVM version 5.1 (clang-503.0.40) (based on LLVM 3.4svn)',
-      'ccflags': '-fno-omit-frame-pointer -fPIC -fno-strict-aliasing -ggdb -pthread -Wall -Wsign-compare -Wno-unknown-pragmas -Winvalid-pch -Werror -O2 -Wno-unused-function -Wno-unused-private-field -Wno-deprecated-declarations -Wno-tautological-constant-out-of-range-compare -Wno-unused-const-variable -Wno-missing-braces -mmacosx-version-min=10.7 -fno-builtin-memcmp',
-      'cxx': 'g++: Apple LLVM version 5.1 (clang-503.0.40) (based on LLVM 3.4svn)',
-      'cxxflags': '-Wnon-virtual-dtor -Woverloaded-virtual -stdlib=libc++ -std=c++11',
-      'linkflags': '-fPIC -pthread -Wl,-bind_at_load -mmacosx-version-min=10.7 -stdlib=libc++ -fuse-ld=gold',
-      'target_arch': 'x86_64',
-      'target_os': 'osx'
+    buildEnvironment: {
+      distmod: '',
+      distarch: 'x86_64',
+      cc: 'gcc: Apple LLVM version 5.1 (clang-503.0.40) (based on LLVM 3.4svn)',
+      ccflags:
+        '-fno-omit-frame-pointer -fPIC -fno-strict-aliasing -ggdb -pthread -Wall -Wsign-compare -Wno-unknown-pragmas -Winvalid-pch -Werror -O2 -Wno-unused-function -Wno-unused-private-field -Wno-deprecated-declarations -Wno-tautological-constant-out-of-range-compare -Wno-unused-const-variable -Wno-missing-braces -mmacosx-version-min=10.7 -fno-builtin-memcmp',
+      cxx: 'g++: Apple LLVM version 5.1 (clang-503.0.40) (based on LLVM 3.4svn)',
+      cxxflags:
+        '-Wnon-virtual-dtor -Woverloaded-virtual -stdlib=libc++ -std=c++11',
+      linkflags:
+        '-fPIC -pthread -Wl,-bind_at_load -mmacosx-version-min=10.7 -stdlib=libc++ -fuse-ld=gold',
+      target_arch: 'x86_64',
+      target_os: 'osx',
     },
-    'bits': 64,
-    'debug': false,
-    'maxBsonObjectSize': 16777216,
-    'storageEngines': [
+    bits: 64,
+    debug: false,
+    maxBsonObjectSize: 16777216,
+    storageEngines: [
       'devnull',
       'ephemeralForTest',
       'inMemory',
       'mmapv1',
-      'wiredTiger'
+      'wiredTiger',
     ],
-    'ok': 1
-  };
-
-  const CMD_LINE_OPTS = {
-    'argv': [
-      '/opt/mongodb-osx-x86_64-enterprise-3.6.3/bin/mongod',
-      '--dbpath=/Users/user/testdata'
-    ],
-    'parsed': {
-      'storage': {
-        'dbPath': '/Users/user/testdata'
-      }
-    },
-    'ok': 1
+    ok: 1,
   };
 
   const ATLAS_VERSION = {
-    'atlasVersion': '20210330.0.0.1617063608',
-    'gitVersion': '8f7e5bdde713391e8123a463895bb7fb660a5ffd'
+    atlasVersion: '20210330.0.0.1617063608',
+    gitVersion: '8f7e5bdde713391e8123a463895bb7fb660a5ffd',
   };
 
   const TOPOLOGY_WITH_CREDENTIALS = {
-    's': {
-      'credentials': {
-        'mechanism': 'LDAP'
-      }
-    }
+    s: {
+      credentials: {
+        mechanism: 'LDAP',
+      },
+    },
   };
 
   const TOPOLOGY_NO_CREDENTIALS = {
-    's': {}
+    s: {},
   };
 
-  const ATLAS_URI = 'mongodb+srv://admin:catscatscats@cat-data-sets.cats.example.net/admin';
+  const ATLAS_URI =
+    'mongodb+srv://admin:catscatscats@cat-data-sets.cats.example.net/admin';
 
-  it('reports on an enterprise version >=3.2 of mongodb with credentials', function() {
+  it('reports on an enterprise version >=3.2 of mongodb with credentials', function () {
     const output = {
       is_atlas: true,
       is_localhost: false,
@@ -95,18 +78,20 @@ describe('getConnectInfo', function() {
       server_arch: 'x86_64',
       node_version: process.version,
       server_os: 'osx',
-      uri: ATLAS_URI
+      uri: ATLAS_URI,
     };
-    expect(getConnectInfo(
-      ATLAS_URI,
-      '0.0.6',
-      BUILD_INFO,
-      CMD_LINE_OPTS,
-      ATLAS_VERSION,
-      TOPOLOGY_WITH_CREDENTIALS)).to.deep.equal(output);
+    expect(
+      getConnectInfo(
+        ATLAS_URI,
+        '0.0.6',
+        BUILD_INFO,
+        ATLAS_VERSION,
+        TOPOLOGY_WITH_CREDENTIALS
+      )
+    ).to.deep.equal(output);
   });
 
-  it('reports on an enterprise version >=3.2 of mongodb with no credentials', function() {
+  it('reports on an enterprise version >=3.2 of mongodb with no credentials', function () {
     const output = {
       is_atlas: true,
       is_localhost: false,
@@ -123,18 +108,20 @@ describe('getConnectInfo', function() {
       server_arch: 'x86_64',
       node_version: process.version,
       server_os: 'osx',
-      uri: ATLAS_URI
+      uri: ATLAS_URI,
     };
-    expect(getConnectInfo(
-      ATLAS_URI,
-      '0.0.6',
-      BUILD_INFO,
-      CMD_LINE_OPTS,
-      ATLAS_VERSION,
-      TOPOLOGY_NO_CREDENTIALS)).to.deep.equal(output);
+    expect(
+      getConnectInfo(
+        ATLAS_URI,
+        '0.0.6',
+        BUILD_INFO,
+        ATLAS_VERSION,
+        TOPOLOGY_NO_CREDENTIALS
+      )
+    ).to.deep.equal(output);
   });
 
-  it('reports correct information when an empty uri is passed', function() {
+  it('reports correct information when an empty uri is passed', function () {
     const output = {
       is_atlas: false,
       is_localhost: false,
@@ -151,18 +138,14 @@ describe('getConnectInfo', function() {
       server_arch: 'x86_64',
       node_version: process.version,
       server_os: 'osx',
-      uri: ''
+      uri: '',
     };
-    expect(getConnectInfo(
-      '',
-      '0.0.6',
-      BUILD_INFO,
-      CMD_LINE_OPTS,
-      null,
-      TOPOLOGY_WITH_CREDENTIALS)).to.deep.equal(output);
+    expect(
+      getConnectInfo('', '0.0.6', BUILD_INFO, null, TOPOLOGY_WITH_CREDENTIALS)
+    ).to.deep.equal(output);
   });
 
-  it('does not fail when buildInfo is unavailable', function() {
+  it('does not fail when buildInfo is unavailable', function () {
     const output = {
       is_atlas: false,
       is_localhost: false,
@@ -179,14 +162,10 @@ describe('getConnectInfo', function() {
       server_arch: null,
       node_version: process.version,
       server_os: null,
-      uri: ''
+      uri: '',
     };
-    expect(getConnectInfo(
-      '',
-      '0.0.6',
-      null,
-      CMD_LINE_OPTS,
-      null,
-      TOPOLOGY_WITH_CREDENTIALS)).to.deep.equal(output);
+    expect(
+      getConnectInfo('', '0.0.6', null, null, TOPOLOGY_WITH_CREDENTIALS)
+    ).to.deep.equal(output);
   });
 });

package/src/connect-info.ts

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 // ^ segment data is in snake_case: forgive me javascript, for i have sinned.
 
 import getBuildInfo from 'mongodb-build-info';
@@ -22,20 +21,25 @@ export interface ConnectInfo {
   uri: string;
 }
 
-export default function getConnectInfo(uri: string, mongoshVersion: string, buildInfo: any, cmdLineOpts: any, atlasVersion: any, topology: any): ConnectInfo {
+export default function getConnectInfo(
+  uri: string,
+  mongoshVersion: string,
+  buildInfo: any,
+  atlasVersion: any,
+  topology: any
+): ConnectInfo {
   buildInfo ??= {}; // We're currently not getting buildInfo with --apiStrict.
   const { isGenuine: is_genuine, serverName: non_genuine_server_name } =
-    getBuildInfo.getGenuineMongoDB(buildInfo, cmdLineOpts);
+    getBuildInfo.getGenuineMongoDB(uri);
   // Atlas Data Lake has been renamed to Atlas Data Federation
-  const { isDataLake: is_data_federation, dlVersion: dl_version }
-    = getBuildInfo.getDataLake(buildInfo);
+  const { isDataLake: is_data_federation, dlVersion: dl_version } =
+    getBuildInfo.getDataLake(buildInfo);
 
-  // get this information from topology rather than cmdLineOpts, since not all
-  // connections are able to run getCmdLineOpts command
   const auth_type = topology.s.credentials
-    ? topology.s.credentials.mechanism : null;
-  const { serverOs: server_os, serverArch: server_arch }
-    = getBuildInfo.getBuildEnv(buildInfo);
+    ? topology.s.credentials.mechanism
+    : null;
+  const { serverOs: server_os, serverArch: server_arch } =
+    getBuildInfo.getBuildEnv(buildInfo);
 
   return {
     is_atlas: !!atlasVersion?.atlasVersion || getBuildInfo.isAtlas(uri),
@@ -53,6 +57,6 @@ export default function getConnectInfo(uri: string, mongoshVersion: string, buil
     dl_version,
     atlas_version: atlasVersion?.atlasVersion ?? null,
     is_genuine,
-    non_genuine_server_name
+    non_genuine_server_name,
   };
 }

package/src/index.ts

@@ -18,7 +18,7 @@ import {
   calculateObjectSize,
   Double,
   EJSON,
-  BSONRegExp
+  BSONRegExp,
 } from 'bson';
 import { bsonStringifiers } from './printable-bson';
 import ShellAuthOptions from './shell-auth-options';
@@ -27,7 +27,10 @@ export * from './all-fle-types';
 
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
 
-export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions } from './admin';
+export {
+  CreateEncryptedCollectionOptions,
+  CheckMetadataConsistencyOptions,
+} from './admin';
 
 const bson = {
   ObjectId,
@@ -44,7 +47,7 @@ const bson = {
   calculateObjectSize,
   Double,
   EJSON,
-  BSONRegExp
+  BSONRegExp,
 };
 
 export {
@@ -56,5 +59,5 @@ export {
   ServiceProviderCore,
   bson,
   bsonStringifiers,
-  ConnectInfo
+  ConnectInfo,
 };

package/src/map-reduce-options.ts

@@ -1,4 +1,9 @@
-import type { CommandOperationOptions, Document, ObjectId, Sort } from 'mongodb';
+import type {
+  CommandOperationOptions,
+  Document,
+  ObjectId,
+  Sort,
+} from 'mongodb';
 
 export type FinalizeFunction<TKey = ObjectId, TValue = Document> = (
   key: TKey,
@@ -8,7 +13,12 @@ export type FinalizeFunction<TKey = ObjectId, TValue = Document> = (
 export interface MapReduceOptions<TKey = ObjectId, TValue = Document>
   extends CommandOperationOptions {
   /** Sets the output target for the map reduce job. */
-  out?: 'inline' | { inline: 1 } | { replace: string } | { merge: string } | { reduce: string };
+  out?:
+    | 'inline'
+    | { inline: 1 }
+    | { replace: string }
+    | { merge: string }
+    | { reduce: string };
   /** Query filter object. */
   query?: Document;
   /** Sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces. */

package/src/printable-bson.spec.ts

@@ -3,73 +3,101 @@ import { bson } from './index';
 import { inspect } from 'util';
 import makePrintableBson from './printable-bson';
 
-describe('BSON printers', function() {
-  before('make BSON objects printable', function() {
+describe('BSON printers', function () {
+  before('make BSON objects printable', function () {
     makePrintableBson(bson);
   });
 
-  it('formats ObjectIds correctly', function() {
-    expect(inspect(new bson.ObjectId('5fa5694f88211043b23c7f11')))
-      .to.equal('ObjectId("5fa5694f88211043b23c7f11")');
+  it('formats ObjectIds correctly', function () {
+    expect(inspect(new bson.ObjectId('5fa5694f88211043b23c7f11'))).to.equal(
+      'ObjectId("5fa5694f88211043b23c7f11")'
+    );
   });
 
-  it('formats DBRefs correctly', function() {
-    expect(inspect(new bson.DBRef('a', new bson.ObjectId('5f16b8bebe434dc98cdfc9cb'), 'db')))
-      .to.equal('DBRef("a", ObjectId("5f16b8bebe434dc98cdfc9cb"), "db")');
-    expect(inspect(new bson.DBRef('a', 'foo' as any, 'db')))
-      .to.equal('DBRef("a", \'foo\', "db")');
-    expect(inspect(new bson.DBRef('a', { x: 1 } as any, 'db')))
-      .to.equal('DBRef("a", { x: 1 }, "db")');
+  it('formats DBRefs correctly', function () {
+    expect(
+      inspect(
+        new bson.DBRef('a', new bson.ObjectId('5f16b8bebe434dc98cdfc9cb'), 'db')
+      )
+    ).to.equal('DBRef("a", ObjectId("5f16b8bebe434dc98cdfc9cb"), "db")');
+    expect(inspect(new bson.DBRef('a', 'foo' as any, 'db'))).to.equal(
+      'DBRef("a", \'foo\', "db")'
+    );
+    expect(inspect(new bson.DBRef('a', { x: 1 } as any, 'db'))).to.equal(
+      'DBRef("a", { x: 1 }, "db")'
+    );
   });
 
-  it('formats MinKey and MaxKey correctly', function() {
+  it('formats MinKey and MaxKey correctly', function () {
     expect(inspect(new bson.MinKey())).to.equal('MinKey()');
     expect(inspect(new bson.MaxKey())).to.equal('MaxKey()');
   });
 
-  it('formats NumberInt correctly', function() {
+  it('formats NumberInt correctly', function () {
     expect(inspect(new bson.Int32(32))).to.equal('Int32(32)');
   });
 
-  it('formats NumberLong correctly', function() {
+  it('formats NumberLong correctly', function () {
     expect(inspect(bson.Long.fromString('64'))).to.equal('Long("64")');
   });
 
-  it('formats unsigned NumberLong correctly', function() {
-    expect(inspect(bson.Long.fromString('64', true))).to.equal('Long("64", true)');
+  it('formats unsigned NumberLong correctly', function () {
+    expect(inspect(bson.Long.fromString('64', true))).to.equal(
+      'Long("64", true)'
+    );
   });
 
-  it('formats NumberDecimal correctly', function() {
-    expect(inspect(bson.Decimal128.fromString('1'))).to.equal('Decimal128("1")');
+  it('formats NumberDecimal correctly', function () {
+    expect(inspect(bson.Decimal128.fromString('1'))).to.equal(
+      'Decimal128("1")'
+    );
   });
 
-  it('formats Timestamp correctly', function() {
-    expect(inspect(new bson.Timestamp(new bson.Long(100, 1)))).to.equal('Timestamp({ t: 1, i: 100 })');
+  it('formats Timestamp correctly', function () {
+    expect(inspect(new bson.Timestamp(new bson.Long(100, 1)))).to.equal(
+      'Timestamp({ t: 1, i: 100 })'
+    );
   });
 
-  it('formats Symbol correctly', function() {
+  it('formats Symbol correctly', function () {
     expect(inspect(new bson.BSONSymbol('abc'))).to.equal('BSONSymbol("abc")');
   });
 
-  it('formats Code correctly', function() {
+  it('formats Code correctly', function () {
     expect(inspect(new bson.Code('abc'))).to.equal('Code("abc")');
   });
 
-  it('formats BinData correctly', function() {
-    expect(inspect(new bson.Binary('abc'))).to.equal('Binary(Buffer.from("616263", "hex"), 0)');
+  it('formats BinData correctly', function () {
+    expect(inspect(new bson.Binary('abc'))).to.equal(
+      'Binary(Buffer.from("616263", "hex"), 0)'
+    );
   });
 
-  it('formats BSONRegExp correctly', function() {
-    expect(inspect(new bson.BSONRegExp('(?-i)AA_', 'im'))).to.equal('BSONRegExp("(?-i)AA_", "im")');
+  it('formats BSONRegExp correctly', function () {
+    expect(inspect(new bson.BSONRegExp('(?-i)AA_', 'im'))).to.equal(
+      'BSONRegExp("(?-i)AA_", "im")'
+    );
   });
 
-  it('formats UUIDs correctly', function() {
-    expect(inspect(new bson.Binary(Buffer.from('0123456789abcdef0123456789abcdef', 'hex'), 4)))
-      .to.equal('UUID("01234567-89ab-cdef-0123-456789abcdef")');
+  it('formats UUIDs correctly', function () {
+    expect(
+      inspect(
+        new bson.Binary(
+          Buffer.from('0123456789abcdef0123456789abcdef', 'hex'),
+          4
+        )
+      )
+    ).to.equal('UUID("01234567-89ab-cdef-0123-456789abcdef")');
   });
 
-  it('formats MD5s correctly', function() {
-    expect(inspect(new bson.Binary(Buffer.from('0123456789abcdef0123456789abcdef', 'hex'), 5)))
-      .to.equal('MD5("0123456789abcdef0123456789abcdef")');
+  it('formats MD5s correctly', function () {
+    expect(
+      inspect(
+        new bson.Binary(
+          Buffer.from('0123456789abcdef0123456789abcdef', 'hex'),
+          5
+        )
+      )
+    ).to.equal('MD5("0123456789abcdef0123456789abcdef")');
   });
 });

package/src/printable-bson.ts

@@ -2,56 +2,67 @@ import { bson as BSON } from './index';
 import { inspect } from 'util';
 const inspectCustom = Symbol.for('nodejs.util.inspect.custom');
 
-export const bsonStringifiers: Record<string, (this: any, depth: any, options: any) => string> = {
-  ObjectId: function(this: typeof BSON.ObjectId.prototype): string {
+export const bsonStringifiers: Record<
+  string,
+  (this: any, depth: any, options: any) => string
+> = {
+  ObjectId: function (this: typeof BSON.ObjectId.prototype): string {
     return `ObjectId("${this.toHexString()}")`;
   },
 
-  DBRef: function(this: typeof BSON.DBRef.prototype, depth: any, options: any): string {
-    return `DBRef("${this.collection}", ` +
+  DBRef: function (
+    this: typeof BSON.DBRef.prototype,
+    depth: any,
+    options: any
+  ): string {
+    return (
+      `DBRef("${this.collection}", ` +
       inspect(this.oid, options) +
       (this.db ? `, "${this.db}"` : '') +
-      ')';
+      ')'
+    );
   },
 
-  MaxKey: function(this: typeof BSON.MaxKey.prototype): string {
+  MaxKey: function (this: typeof BSON.MaxKey.prototype): string {
     return 'MaxKey()';
   },
 
-  MinKey: function(this: typeof BSON.MinKey.prototype): string {
+  MinKey: function (this: typeof BSON.MinKey.prototype): string {
     return 'MinKey()';
   },
 
-  Timestamp: function(this: typeof BSON.Timestamp.prototype): string {
+  Timestamp: function (this: typeof BSON.Timestamp.prototype): string {
     return `Timestamp({ t: ${this.getHighBits()}, i: ${this.getLowBits()} })`;
   },
 
-  BSONSymbol: function(this: typeof BSON.BSONSymbol.prototype): string {
+  BSONSymbol: function (this: typeof BSON.BSONSymbol.prototype): string {
     return `BSONSymbol("${this.valueOf()}")`;
   },
 
-  Code: function(this: typeof BSON.Code.prototype): string {
+  Code: function (this: typeof BSON.Code.prototype): string {
     const j = this.toJSON();
     return `Code("${j.code}"${j.scope ? `, ${JSON.stringify(j.scope)}` : ''})`;
   },
 
-  Decimal128: function(this: typeof BSON.Decimal128.prototype): string {
+  Decimal128: function (this: typeof BSON.Decimal128.prototype): string {
     return `Decimal128("${this.toString()}")`;
   },
 
-  Int32: function(this: typeof BSON.Int32.prototype): string {
+  Int32: function (this: typeof BSON.Int32.prototype): string {
     return `Int32(${this.valueOf()})`;
   },
 
-  Long: function(this: typeof BSON.Long.prototype): string {
+  Long: function (this: typeof BSON.Long.prototype): string {
     return `Long("${this.toString()}"${this.unsigned ? ', true' : ''})`;
   },
 
-  BSONRegExp: function(this: typeof BSON.BSONRegExp.prototype): string {
-    return `BSONRegExp(${JSON.stringify(this.pattern)}, ${JSON.stringify(this.options)})`;
+  BSONRegExp: function (this: typeof BSON.BSONRegExp.prototype): string {
+    return `BSONRegExp(${JSON.stringify(this.pattern)}, ${JSON.stringify(
+      this.options
+    )})`;
   },
 
-  Binary: function(this: typeof BSON.Binary.prototype): string {
+  Binary: function (this: typeof BSON.Binary.prototype): string {
     const hexString = this.toString('hex');
     switch (this.sub_type) {
       case BSON.Binary.SUBTYPE_MD5:
@@ -60,12 +71,14 @@ export const bsonStringifiers: Record<string, (this: any, depth: any, options: a
         if (hexString.length === 32) {
           // Format '0123456789abcdef0123456789abcdef' into
           // '01234567-89ab-cdef-0123-456789abcdef'.
-          const asUUID = hexString.match(/^(.{8})(.{4})(.{4})(.{4})(.{12})$/)!
-            .slice(1, 6).join('-');
+          const asUUID = /^(.{8})(.{4})(.{4})(.{4})(.{12})$/
+            .exec(hexString)!
+            .slice(1, 6)
+            .join('-');
           return `UUID("${asUUID}")`;
         }
-        // In case somebody did something weird and used an UUID with a
-        // non-standard length, fall through.
+      // In case somebody did something weird and used an UUID with a
+      // non-standard length, fall through.
       default:
         return `Binary(Buffer.from("${hexString}", "hex"), ${this.sub_type})`;
     }
@@ -78,12 +91,12 @@ bsonStringifiers.ObjectID = bsonStringifiers.ObjectId;
  * we can have the driver return our BSON classes without having to write our own serializer.
  * @param {Object} bson
  */
-export default function(bson?: typeof BSON): void {
+export default function (bson?: typeof BSON): void {
   if (!bson) {
     bson = BSON;
   }
 
-  for (const [ key, stringifier ] of Object.entries(bsonStringifiers)) {
+  for (const [key, stringifier] of Object.entries(bsonStringifiers)) {
     if (!(key in bson)) {
       continue;
     }