feat(shell-api): include db name in prompt MONGOSH-832 (#964)

Author: addaleax

packages/cli-repl/src/mongosh-repl.spec.ts

@@ -400,8 +400,8 @@ describe('MongoshNodeRepl', () => {
         expect((mongoshRepl.runtimeState().repl as any)._prompt).to.equal('');
         input.write('\u0003'); // Ctrl+C for abort
         await tick();
-        expect((mongoshRepl.runtimeState().repl as any)._prompt).to.equal('> ');
-        expect(stripAnsi(output)).to.equal('db.foo\r\nbar\r\n\r\n> ');
+        expect((mongoshRepl.runtimeState().repl as any)._prompt).to.equal('test> ');
+        expect(stripAnsi(output)).to.equal('db.foo\r\nbar\r\n\r\ntest> ');
       });
       it('does not autocomplete tab-indented code', async() => {
         output = '';
@@ -655,7 +655,7 @@ describe('MongoshNodeRepl', () => {
         output = '';
         input.write('throw new Error("yellow")\n');
         await waitEval(bus);
-        expect(stripAnsi(output)).to.match(/Error: yellow\n(> )+$/);
+        expect(stripAnsi(output)).to.match(/Error: yellow\n(test> )+$/);
 
         input.write('config.set("showStackTraces", true)\n');
         await waitEval(bus);
@@ -679,7 +679,7 @@ describe('MongoshNodeRepl', () => {
       output = '';
       outputStream.emit('resize');
       await tick();
-      expect(stripAnsi(output)).to.equal('> ');
+      expect(stripAnsi(output)).to.equal('test> ');
     });
 
     it('does not refresh the prompt if a window resize occurs while evaluating', async() => {
@@ -701,7 +701,7 @@ describe('MongoshNodeRepl', () => {
       output = '';
       resolveInProgress();
       await tick();
-      expect(stripAnsi(output)).to.equal('\n> ');
+      expect(stripAnsi(output)).to.equal('\ntest> ');
     });
 
     context('thrown non-Errors', () => {
@@ -1018,7 +1018,7 @@ describe('MongoshNodeRepl', () => {
 
       const initialized = await mongoshRepl.initialize(serviceProvider);
       await mongoshRepl.startRepl(initialized);
-      expect(output).to.contain('Enterprise > ');
+      expect(output).to.contain('Enterprise test> ');
     });
 
     it('defaults if an error occurs', async() => {
@@ -1057,11 +1057,11 @@ describe('MongoshNodeRepl', () => {
 
       const initialized = await mongoshRepl.initialize(serviceProvider);
       await mongoshRepl.startRepl(initialized);
-      expect(output).to.contain('Enterprise > ');
+      expect(output).to.contain('Enterprise test> ');
 
       input.write('db = Mongo("foo").getDB("bar")\n');
       await waitEval(bus);
-      expect(output).to.contain('Atlas Data Lake > ');
+      expect(output).to.contain('AtlasDataLake bar> ');
     });
 
     context('user-provided prompt', () => {

packages/shell-api/src/shell-internal-state.spec.ts

@@ -89,7 +89,7 @@ describe('ShellInternalState', () => {
 
         await internalState.fetchConnectionInfo();
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('Atlas Data Lake > ');
+        expect(prompt).to.equal('AtlasDataLake test> ');
       });
 
       it('wins against enterprise', async() => {
@@ -103,7 +103,7 @@ describe('ShellInternalState', () => {
 
         await internalState.fetchConnectionInfo();
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('Atlas Data Lake > ');
+        expect(prompt).to.equal('AtlasDataLake test> ');
       });
     });
 
@@ -113,7 +113,7 @@ describe('ShellInternalState', () => {
 
         await internalState.fetchConnectionInfo();
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('Enterprise > ');
+        expect(prompt).to.equal('Enterprise test> ');
       });
 
       it('inferred from buildInfo modules', async() => {
@@ -124,7 +124,7 @@ describe('ShellInternalState', () => {
 
         await internalState.fetchConnectionInfo();
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('Enterprise > ');
+        expect(prompt).to.equal('Enterprise test> ');
       });
     });
 
@@ -156,7 +156,7 @@ describe('ShellInternalState', () => {
           setupServiceProviderWithTopology(topology);
 
           const prompt = await internalState.getDefaultPrompt();
-          expect(prompt).to.equal(`configset [direct: ${p}]> `);
+          expect(prompt).to.equal(`configset [direct: ${p}] test> `);
         });
       });
 
@@ -186,7 +186,7 @@ describe('ShellInternalState', () => {
           setupServiceProviderWithTopology(topology);
 
           const prompt = await internalState.getDefaultPrompt();
-          expect(prompt).to.equal('> ');
+          expect(prompt).to.equal('test> ');
         });
       });
     });
@@ -203,7 +203,7 @@ describe('ShellInternalState', () => {
         setupServiceProviderWithTopology(topology);
 
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('leSet [secondary]> ');
+        expect(prompt).to.equal('leSet [secondary] test> ');
       });
 
       it('shows the setName and primary hint for ReplicaSetWithPrimary', async() => {
@@ -217,7 +217,7 @@ describe('ShellInternalState', () => {
         setupServiceProviderWithTopology(topology);
 
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('leSet [primary]> ');
+        expect(prompt).to.equal('leSet [primary] test> ');
       });
     });
 
@@ -232,7 +232,7 @@ describe('ShellInternalState', () => {
         setupServiceProviderWithTopology(topology);
 
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('[mongos]> ');
+        expect(prompt).to.equal('[mongos] test> ');
       });
       it('shows mongos and a setName', async() => {
         const topology = {
@@ -245,7 +245,7 @@ describe('ShellInternalState', () => {
         setupServiceProviderWithTopology(topology);
 
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('leSet [mongos]> ');
+        expect(prompt).to.equal('leSet [mongos] test> ');
       });
     });
 
@@ -266,7 +266,7 @@ describe('ShellInternalState', () => {
 
         await internalState.fetchConnectionInfo();
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('> ');
+        expect(prompt).to.equal('test> ');
       });
     });
 
@@ -291,7 +291,7 @@ describe('ShellInternalState', () => {
         setupServiceProviderWithTopology(topology);
 
         const prompt = await internalState.getDefaultPrompt();
-        expect(prompt).to.equal('> ');
+        expect(prompt).to.equal('test> ');
       });
     });
   });

packages/shell-api/src/shell-internal-state.ts

@@ -390,15 +390,21 @@ export default class ShellInternalState {
   }
 
   async getDefaultPrompt(): Promise<string> {
-    return `${this.getDefaultPromptPrefix()}${this.getTopologySpecificPrompt()}> `;
+    const prefix = this.getDefaultPromptPrefix();
+    const topologyInfo = this.getTopologySpecificPrompt();
+    let dbname = '';
+    try {
+      dbname = this.currentDb.getName();
+    } catch { /* nodb */ }
+    return `${[prefix, topologyInfo, dbname].filter(Boolean).join(' ')}> `;
   }
 
   private getDefaultPromptPrefix(): string {
     const extraConnectionInfo = this.connectionInfo?.extraInfo;
     if (extraConnectionInfo?.is_data_lake) {
-      return 'Atlas Data Lake ';
+      return 'AtlasDataLake';
     } else if (extraConnectionInfo?.is_enterprise || this.connectionInfo?.buildInfo?.modules?.indexOf('enterprise') >= 0) {
-      return 'Enterprise ';
+      return 'Enterprise';
     }
     return '';
   }