implement connect

aherlihy · aherlihy · commit 77867aa2ec01 · 2020-06-13T18:59:21.000+02:00
diff --git a/packages/cli-repl/src/cli-repl.ts b/packages/cli-repl/src/cli-repl.ts
@@ -8,7 +8,7 @@ import { LineByLineInput } from './line-by-line-input';
 import { TELEMETRY, MONGOSH_WIKI } from './constants';
 import isRecoverableError from 'is-recoverable-error';
 import { MongoshWarning } from '@mongosh/errors';
-import { changeHistory } from '@mongosh/history';
+import { changeHistory, retractPassword } from '@mongosh/history';
 import { REPLServer, Recoverable } from 'repl';
 import jsonParse from 'fast-json-parse';
 import CliOptions from './cli-options';
@@ -17,7 +17,6 @@ import i18n from '@mongosh/i18n';
 import { ObjectId } from 'bson';
 import repl from 'pretty-repl';
 import Nanobus from 'nanobus';
-import { redactPwd } from '.';
 import logger from './logger';
 import mkdirp from 'mkdirp';
 import clr from './clr';
@@ -95,7 +94,7 @@ class CliRepl {
    * @param {NodeOptions} driverOptions - The driver options.
    */
   async connect(driverUri: string, driverOptions: NodeOptions): Promise<any> {
-    console.log(i18n.__(CONNECTING), '    ', clr(redactPwd(driverUri), ['bold', 'green']));
+    console.log(i18n.__(CONNECTING), '    ', clr(retractPassword(driverUri), ['bold', 'green']));
     return await CliServiceProvider.connect(driverUri, driverOptions);
   }
 
diff --git a/packages/cli-repl/src/index.ts b/packages/cli-repl/src/index.ts
@@ -1,5 +1,4 @@
 import CliRepl from './cli-repl';
-import redactPwd from './redact-pwd';
 import parseCliArgs from './arg-parser';
 import mapCliToDriver from './arg-mapper';
 import generateUri from './uri-generator';
@@ -15,7 +14,6 @@ export {
   TELEMETRY,
   MONGOSH_WIKI,
   CliRepl,
-  redactPwd,
   completer,
   generateUri,
   parseCliArgs,
diff --git a/packages/cli-repl/src/logger.ts b/packages/cli-repl/src/logger.ts
@@ -2,7 +2,7 @@
 
 import redactInfo from 'mongodb-redact';
 import Analytics from 'analytics-node';
-import redactPwd from './redact-pwd';
+import { retractPassword } from '@mongosh/history';
 import { ObjectId } from 'bson';
 import pino from 'pino';
 import path from 'path';
@@ -74,7 +74,7 @@ export default function logger(bus: any, logDir: string): void {
   }
 
   bus.on('mongosh:connect', function(args: ConnectEvent) {
-    const connectionUri = redactPwd(args.uri);
+    const connectionUri = retractPassword(args.uri);
     delete args.uri;
     const params = { session_id, userId, connectionUri, ...args };
     log.info('mongosh:connect', params);
diff --git a/packages/history/src/history.spec.ts b/packages/history/src/history.spec.ts
@@ -11,6 +11,21 @@ describe('changeHistory', () => {
       changeHistory(i);
       expect(i).to.deep.equal(history);
     });
+    it('removes connect commands from history', () => {
+      const i = ['db = connect(\'uri\', \'u\', \'p\')', 'db.shipwrecks.findOne()', 'use ships'];
+      changeHistory(i);
+      expect(i).to.deep.equal(history);
+    });
+    it('removes URI having Mongo from history', () => {
+      const i = ['m = new Mongo(\'mongodb://anna:anna@127.0.0.1:27017/test\')', 'db.shipwrecks.findOne()', 'use ships'];
+      changeHistory(i);
+      expect(i).to.deep.equal(['m = new Mongo(\'mongodb://<credentials>@127.0.0.1:27017/test\')'].concat(history));
+    });
+    it('removes URI having Mongo from history for srv', () => {
+      const i = ['m = new Mongo(\'mongodb+srv://admin:catscat3ca1s@cats-data-sets-e08dy.mongodb.net/admin\')', 'db.shipwrecks.findOne()', 'use ships'];
+      changeHistory(i);
+      expect(i).to.deep.equal(['m = new Mongo(\'mongodb+srv://admin:catscat3ca1s@cats-data-sets-e08dy.mongodb.net/admin\')'].concat(history));
+    });
 
     it('leaves history as is if command is not sensitive', () => {
       const i = ['db.shipwrecks.find({quasou: "depth unknown"})', 'db.shipwrecks.findOne()', 'use ships'];
diff --git a/packages/history/src/history.ts b/packages/history/src/history.ts
@@ -1,4 +1,5 @@
 import redactInfo from 'mongodb-redact';
+import redactPwd from './redact-pwd';
 
 /**
  * Modifies command history array based on sensitive information.
@@ -11,12 +12,16 @@ import redactInfo from 'mongodb-redact';
  */
 export function changeHistory(history: string[], redact = false): void {
   const hiddenCommands =
-    RegExp('createUser|auth|updateUser|changeUserPassword', 'g');
+    RegExp('createUser|auth|updateUser|changeUserPassword|connect', 'g');
 
   if (hiddenCommands.test(history[0])) {
     history.shift();
     return;
   }
+  if (/Mongo\(([^+)]+)\)/g.test(history[0])) {
+    history[0] = history[0].replace(/Mongo\(([^+)]+)\)/g, (substr) => redactPwd(substr));
+    return;
+  }
 
   if (redact) history[0] = redactInfo(history[0]);
 }
diff --git a/packages/history/src/index.ts b/packages/history/src/index.ts
@@ -1 +1,3 @@
 export * from './history';
+import retractPassword from './redact-pwd';
+export { retractPassword };
diff --git a/packages/history/src/redact-pwd.spec.ts b/packages/history/src/redact-pwd.spec.ts
diff --git a/packages/history/src/redact-pwd.ts b/packages/history/src/redact-pwd.ts
diff --git a/packages/shell-api/package.json b/packages/shell-api/package.json
@@ -35,6 +35,7 @@
   "dependencies": {
     "@mongosh/async-rewriter": "^0.0.5",
     "@mongosh/errors": "^0.0.5",
+    "@mongosh/history": "^0.0.5",
     "@mongosh/i18n": "^0.0.5",
     "@mongosh/service-provider-core": "^0.0.5",
     "bson": "^4.0.4"
diff --git a/packages/shell-api/src/mongo.ts b/packages/shell-api/src/mongo.ts
@@ -13,6 +13,7 @@ import Database from './database';
 import ShellInternalState from './shell-internal-state';
 import { CommandResult } from './result';
 import { MongoshInternalError, MongoshInvalidInputError } from '@mongosh/errors';
+import { retractPassword } from '@mongosh/history';
 
 @shellApiClassDefault
 @hasAsyncChild
@@ -39,7 +40,7 @@ export default class Mongo extends ShellApiClass {
   }
 
   toReplString(): any {
-    return this.uri;
+    return retractPassword(this.uri);
   }
 
   async connect(): Promise<void> {
diff --git a/packages/shell-api/src/shell-api.spec.ts b/packages/shell-api/src/shell-api.spec.ts
@@ -1,11 +1,12 @@
+/* eslint-disable new-cap */
 import { expect } from 'chai';
 import ShellApi from './shell-api';
 import { signatures } from './index';
 import Cursor from './cursor';
 import { ALL_PLATFORMS, ALL_SERVER_VERSIONS, ALL_TOPOLOGIES } from './enums';
 import { StubbedInstance, stubInterface } from 'ts-sinon';
 import Mongo from './mongo';
-import { ServiceProvider } from '@mongosh/service-provider-core';
+import { ReplPlatform, ServiceProvider } from '@mongosh/service-provider-core';
 import { EventEmitter } from 'events';
 import ShellInternalState from './shell-internal-state';
 
@@ -25,7 +26,15 @@ describe('ShellApi', () => {
       });
       expect(signatures.ShellApi.attributes.show).to.deep.equal({
         type: 'function',
-        returnsPromise: false,
+        returnsPromise: true,
+        returnType: { type: 'unknown', attributes: {} },
+        platforms: ALL_PLATFORMS,
+        topologies: ALL_TOPOLOGIES,
+        serverVersions: ALL_SERVER_VERSIONS
+      });
+      expect(signatures.ShellApi.attributes.exit).to.deep.equal({
+        type: 'function',
+        returnsPromise: true,
         returnType: { type: 'unknown', attributes: {} },
         platforms: ALL_PLATFORMS,
         topologies: ALL_TOPOLOGIES,
@@ -39,6 +48,22 @@ describe('ShellApi', () => {
         topologies: ALL_TOPOLOGIES,
         serverVersions: ALL_SERVER_VERSIONS
       });
+      expect(signatures.ShellApi.attributes.Mongo).to.deep.equal({
+        type: 'function',
+        returnsPromise: true,
+        returnType: 'Mongo',
+        platforms: [ ReplPlatform.CLI ],
+        topologies: ALL_TOPOLOGIES,
+        serverVersions: ALL_SERVER_VERSIONS
+      });
+      expect(signatures.ShellApi.attributes.connect).to.deep.equal({
+        type: 'function',
+        returnsPromise: true,
+        returnType: 'Database',
+        platforms: [ ReplPlatform.CLI ],
+        topologies: ALL_TOPOLOGIES,
+        serverVersions: ALL_SERVER_VERSIONS
+      });
     });
   });
   describe('help', () => {
@@ -60,6 +85,7 @@ describe('ShellApi', () => {
       mongo = stubInterface<Mongo>();
       internalState = new ShellInternalState(serviceProvider, bus);
       internalState.currentDb.mongo = mongo;
+      serviceProvider.platform = ReplPlatform.CLI;
     });
     describe('use', () => {
       beforeEach(() => {
@@ -89,6 +115,33 @@ describe('ShellApi', () => {
         expect(internalState.currentCursor._it).to.have.been.called;
       });
     });
+    describe('Mongo', () => {
+      beforeEach(() => {
+        serviceProvider.platform = ReplPlatform.CLI;
+      });
+      it('returns a new Mongo object', async() => {
+        const m = await internalState.shellApi.Mongo('uri');
+        expect(m.shellApiType()).to.equal('Mongo');
+        expect(m.uri).to.equal('uri');
+      });
+      it('fails for non-CLI', async() => {
+        serviceProvider.platform = ReplPlatform.Browser;
+        try {
+          await internalState.shellApi.Mongo('uri');
+        } catch (e) {
+          return expect(e.name).to.equal('MongoshUnimplementedError');
+        }
+        expect.fail('MongoshInvalidInputError not thrown for Mongo');
+      });
+    });
+    describe('connect', () => {
+      it('returns a new DB', async() => {
+        serviceProvider.platform = ReplPlatform.CLI;
+        const db = await internalState.shellApi.connect('uri', 'username', 'pwd');
+        expect(db.shellApiType()).to.equal('Database');
+        expect(db.getMongo().uri).to.equal('uri');
+      });
+    });
   });
   describe('from context', () => {
     let serviceProvider: StubbedInstance<ServiceProvider>;
@@ -132,5 +185,39 @@ describe('ShellApi', () => {
         expect(internalState.currentCursor._it).to.have.been.called;
       });
     });
+    describe('Mongo', () => {
+      beforeEach(() => {
+        serviceProvider.platform = ReplPlatform.CLI;
+      });
+      it('returns a new Mongo object', async() => {
+        const m = await internalState.context.Mongo('uri');
+        expect(m.shellApiType()).to.equal('Mongo');
+        expect(m.uri).to.equal('uri');
+      });
+      it('fails for non-CLI', async() => {
+        serviceProvider.platform = ReplPlatform.Browser;
+        try {
+          await internalState.shellApi.Mongo('uri');
+        } catch (e) {
+          return expect(e.name).to.equal('MongoshUnimplementedError');
+        }
+        expect.fail('MongoshInvalidInputError not thrown for Mongo');
+      });
+    });
+    describe('connect', () => {
+      it('returns a new DB', async() => {
+        serviceProvider.platform = ReplPlatform.CLI;
+        const db = await internalState.context.connect('uri');
+        expect(db.shellApiType()).to.equal('Database');
+        expect(db.getMongo().uri).to.equal('uri');
+      });
+      it('handles username/pwd', async() => {
+        serviceProvider.platform = ReplPlatform.CLI;
+        const db = await internalState.context.connect('uri', 'username', 'pwd');
+        expect(db.shellApiType()).to.equal('Database');
+        expect(db.getMongo().uri).to.equal('uri');
+        expect(db.getMongo().options).to.deep.equal({ auth: { username: 'username', password: 'pwd' } });
+      });
+    });
   });
 });
diff --git a/packages/shell-api/src/shell-api.ts b/packages/shell-api/src/shell-api.ts
@@ -1,13 +1,24 @@
-import { hasAsyncChild, returnsPromise, ShellApiClass, shellApiClassDefault } from './decorators';
+/* eslint-disable new-cap */
+import {
+  shellApiClassDefault,
+  hasAsyncChild,
+  ShellApiClass,
+  returnsPromise,
+  returnType,
+  platforms
+} from './decorators';
 import { CursorIterationResult } from './result';
+import Mongo from './mongo';
+import Database from './database';
+import { CommandResult } from './result';
 import ShellInternalState from './shell-internal-state';
 import { ReplPlatform } from '@mongosh/service-provider-core';
 import { MongoshUnimplementedError } from '@mongosh/errors';
 
 @shellApiClassDefault
 @hasAsyncChild
 export default class ShellApi extends ShellApiClass {
-  private internalState: ShellInternalState;
+  readonly internalState: ShellInternalState;
 
   constructor(internalState) {
     super();
@@ -17,9 +28,13 @@ export default class ShellApi extends ShellApiClass {
   use(db): any {
     return this.internalState.currentDb.mongo.use(db);
   }
-  show(arg): any {
-    return this.internalState.currentDb.mongo.show(arg);
+
+  @returnsPromise
+  async show(arg): Promise<CommandResult> {
+    return await this.internalState.currentDb.mongo.show(arg);
   }
+
+  @returnsPromise
   async exit(): Promise<void> {
     await this.internalState.close(true);
     if (this.internalState.initialServiceProvider.platform === ReplPlatform.CLI) {
@@ -31,6 +46,36 @@ export default class ShellApi extends ShellApiClass {
     }
   }
 
+  @returnsPromise
+  @returnType('Mongo')
+  @platforms([ ReplPlatform.CLI ] )
+  public async Mongo(uri?, options?): Promise<Mongo> {
+    if (
+      this.internalState.initialServiceProvider.platform !== ReplPlatform.CLI
+    ) {
+      throw new MongoshUnimplementedError(
+        `new Mongo connection are not supported for current platform: ${
+          ReplPlatform[this.internalState.initialServiceProvider.platform]
+        }`
+      );
+    }
+    const mongo = new Mongo(this.internalState, uri, options);
+    await mongo.connect();
+    this.internalState.mongos.push(mongo);
+    return mongo;
+  }
+
+  @returnsPromise
+  @returnType('Database')
+  @platforms([ ReplPlatform.CLI ] )
+  async connect(uri?, user?, pwd?): Promise<Database> {
+    const options = {} as any;
+    if (user) options.username = user;
+    if (pwd) options.password = pwd;
+    const mongo = await this.Mongo(uri, { auth: options });
+    return mongo.getDB('test');
+  }
+
   @returnsPromise
   async it(): Promise<any> {
     if (!this.internalState.currentCursor) {
diff --git a/packages/shell-api/src/shell-internal-state.ts b/packages/shell-api/src/shell-internal-state.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`export * from './history';`
	`2`	`+import retractPassword from './redact-pwd';`
	`3`	`+export { retractPassword };`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ import Database from './database';`
`13`	`13`	`import ShellInternalState from './shell-internal-state';`
`14`	`14`	`import { CommandResult } from './result';`
`15`	`15`	`import { MongoshInternalError, MongoshInvalidInputError } from '@mongosh/errors';`
	`16`	`+import { retractPassword } from '@mongosh/history';`
`16`	`17`
`17`	`18`	`@shellApiClassDefault`
`18`	`19`	`@hasAsyncChild`
`@@ -39,7 +40,7 @@ export default class Mongo extends ShellApiClass {`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`toReplString(): any {`
`42`		`- return this.uri;`
	`43`	`+ return retractPassword(this.uri);`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`async connect(): Promise<void> {`