feat: suggest use and db commands VSCODE-380 (#491)

* feat: suggest use and db commands VSCODE-380

* refactor: proper english

Author: alenakhineika

src/connectionController.ts

@@ -155,7 +155,7 @@ export default class ConnectionController {
       } catch (error) {
         // Here we're lenient when loading connections in case their
         // connections have become corrupted.
-        log.error(`Connection migration failed: ${formatError(error).message}`);
+        log.error('Migrating previously saved connections failed', error);
         return;
       }
     }
@@ -164,7 +164,7 @@ export default class ConnectionController {
     // Return saved connection as it is.
     if (!ext.keytarModule) {
       log.error(
-        'Load saved connections failed: VSCode extension keytar module is undefined.'
+        'Getting connection info with secrets failed because VSCode extension keytar module is undefined'
       );
       return savedConnectionInfo as StoreConnectionInfoWithConnectionOptions;
     }
@@ -197,9 +197,7 @@ export default class ConnectionController {
     } catch (error) {
       // Here we're lenient when loading connections in case their
       // connections have become corrupted.
-      log.error(
-        `Merging connection with secrets failed: ${formatError(error).message}`
-      );
+      log.error('Getting connection info with secrets failed', error);
       return;
     }
   }
@@ -301,7 +299,7 @@ export default class ConnectionController {
   async addNewConnectionStringAndConnect(
     connectionString: string
   ): Promise<boolean> {
-    log.info('Trying to connect to a new connection configuration');
+    log.info('Trying to connect to a new connection configuration...');
 
     const connectionStringData = new ConnectionString(connectionString);
 
@@ -313,7 +311,7 @@ export default class ConnectionController {
     );
 
     try {
-      const connectResult = await this.saveNewConnectionAndConnect(
+      const connectResult = await this.saveNewConnectionFromFormAndConnect(
         {
           id: uuidv4(),
           connectionOptions: {
@@ -326,11 +324,10 @@ export default class ConnectionController {
       return connectResult.successfullyConnected;
     } catch (error) {
       const printableError = formatError(error);
-      log.error('Failed to connect', printableError);
+      log.error('Failed to connect with a connection string', error);
       void vscode.window.showErrorMessage(
         `Unable to connect: ${printableError.message}`
       );
-
       return false;
     }
   }
@@ -391,7 +388,7 @@ export default class ConnectionController {
     return savedConnectionInfo;
   }
 
-  async saveNewConnectionAndConnect(
+  async saveNewConnectionFromFormAndConnect(
     originalConnectionInfo: ConnectionInfo,
     connectionType: ConnectionTypes
   ): Promise<ConnectionAttemptResult> {
@@ -412,9 +409,7 @@ export default class ConnectionController {
       connectionOptions: originalConnectionInfo.connectionOptions, // The connection options with secrets.
     };
 
-    log.info(
-      `Connect called to connect to instance: ${savedConnectionInfo.name}`
-    );
+    log.info('Connect called to connect to instance', savedConnectionInfo.name);
 
     return this._connect(savedConnectionInfo.id, connectionType);
   }
@@ -539,19 +534,18 @@ export default class ConnectionController {
 
       return true;
     } catch (error) {
+      log.error('Failed to connect by a connection id', error);
       const printableError = formatError(error);
-      log.error('Failed to connect', printableError);
       void vscode.window.showErrorMessage(
         `Unable to connect: ${printableError.message}`
       );
-
       return false;
     }
   }
 
   async disconnect(): Promise<boolean> {
     log.info(
-      'Disconnect called, currently connected to:',
+      'Disconnect called, currently connected to',
       this._currentConnectionId
     );
 

src/editors/editorsController.ts

@@ -113,8 +113,6 @@ export default class EditorsController {
     codeActionProvider: PlaygroundSelectedCodeActionProvider,
     editDocumentCodeLensProvider: EditDocumentCodeLensProvider
   ) {
-    log.info('activating...');
-
     this._connectionController = connectionController;
     this._playgroundController = playgroundController;
     this._context = context;
@@ -152,8 +150,6 @@ export default class EditorsController {
 
       this._documentIdStore.removeByDocumentIdReference(documentIdReference);
     });
-
-    log.info('activated.');
   }
 
   async openMongoDBDocument(data: EditDocumentInfo): Promise<boolean> {
@@ -262,7 +258,7 @@ export default class EditorsController {
   }
 
   async onViewCollectionDocuments(namespace: string): Promise<boolean> {
-    log.info('view collection documents', namespace);
+    log.info('View collection documents', namespace);
 
     const operationId =
       this._collectionDocumentsOperationsStore.createNewOperation();
@@ -294,7 +290,7 @@ export default class EditorsController {
     connectionId: string,
     namespace: string
   ): Promise<boolean> {
-    log.info('view more collection documents', namespace);
+    log.info('View more collection documents', namespace);
 
     // A user might click to fetch more documents multiple times,
     // this ensures it only performs one fetch at a time.

src/editors/mongoDBDocumentService.ts

@@ -60,7 +60,7 @@ export default class MongoDBDocumentService {
     newDocument: EJSON.SerializableTypes;
     source: DocumentSource;
   }): Promise<void> {
-    log.info('replace document in MongoDB', data);
+    log.info('Replace document in MongoDB', data);
 
     const { documentId, namespace, connectionId, newDocument, source } = data;
     const activeConnectionId =
@@ -107,7 +107,7 @@ export default class MongoDBDocumentService {
   async fetchDocument(
     data: EditDocumentInfo
   ): Promise<EJSON.SerializableTypes | void> {
-    log.info('fetch document from MongoDB', data);
+    log.info('Fetch document from MongoDB', data);
 
     const { documentId, namespace, connectionId } = data;
     const activeConnectionId =

src/editors/playgroundController.ts

@@ -462,7 +462,7 @@ export default class PlaygroundController {
 
       return progressResult;
     } catch (error) {
-      log.error('Evaluate playground with cancel modal error', error);
+      log.error('Evaluating playground with cancel modal failed', error);
 
       return {
         outputLines: undefined,
@@ -752,7 +752,7 @@ export default class PlaygroundController {
     const { selectedText, importStatements, driverSyntax, builders, language } =
       this._exportToLanguageCodeLensProvider._exportToLanguageAddons;
 
-    log.info(`Start export to ${language} language`);
+    log.info(`Exporting to the '${language}' language...`);
 
     try {
       const transpiledContent = await this.getTranspiledContent();
@@ -782,7 +782,10 @@ export default class PlaygroundController {
         language,
       };
 
-      log.info(`Export to ${language} language result`, this._playgroundResult);
+      log.info(
+        `Exported to the '${language}' language`,
+        this._playgroundResult
+      );
 
       /* eslint-disable camelcase */
       if (
@@ -817,8 +820,8 @@ export default class PlaygroundController {
 
       await this._openPlaygroundResult();
     } catch (error) {
+      log.error(`Export to the '${language}' language failed`, error);
       const printableError = formatError(error);
-      log.error(`Export to ${language} language error`, printableError);
       void vscode.window.showErrorMessage(
         `Unable to export to ${language} language: ${printableError.message}`
       );

src/explorer/documentListTreeItem.ts

@@ -9,7 +9,7 @@ import TreeItemParent from './treeItemParentInterface';
 import type { DataService } from 'mongodb-data-service';
 
 const path = require('path');
-const log = createLogger('tree view document list');
+const log = createLogger('documents tree item');
 
 // We fetch 1 more than this in order to see if there are more to fetch.
 // Each time `show more` is clicked, the collection item increases the amount
@@ -244,7 +244,9 @@ export default class DocumentListTreeItem
   }
 
   onShowMoreClicked(): void {
-    log.info('show more clicked');
+    log.info(
+      `Show more documents clicked for the '${this.namespace}' namespace`
+    );
 
     this._maxDocumentsToShow += MAX_DOCUMENTS_VISIBLE;
     this.cacheIsUpToDate = false;

src/explorer/explorerController.ts

@@ -15,8 +15,6 @@ export default class ExplorerController {
   private _treeView?: vscode.TreeView<vscode.TreeItem>;
 
   constructor(connectionController: ConnectionController) {
-    log.info('activate explorer controller');
-
     this._connectionController = connectionController;
     this._treeController = new ExplorerTreeController(connectionController);
   }
@@ -40,12 +38,14 @@ export default class ExplorerController {
   };
 
   activateConnectionsTreeView(): void {
+    log.info('Activating explorer controller...');
     // Listen for a change in connections to occur before we create the tree
     // so that we show the `viewsWelcome` before any connections are added.
     this._connectionController.addEventListener(
       DataServiceEventTypes.CONNECTIONS_DID_CHANGE,
       this.createTreeView
     );
+    log.info('Explorer controller activated');
   }
 
   deactivate(): void {

src/explorer/explorerTreeController.ts

@@ -11,7 +11,7 @@ import { DOCUMENT_LIST_ITEM, CollectionTypes } from './documentListTreeItem';
 import EXTENSION_COMMANDS from '../commands';
 import { sortTreeItemsByLabel } from './treeItemUtils';
 
-const log = createLogger('explorer controller');
+const log = createLogger('explorer tree controller');
 
 export default class ExplorerTreeController
   implements vscode.TreeDataProvider<vscode.TreeItem>
@@ -48,7 +48,7 @@ export default class ExplorerTreeController
     treeView: vscode.TreeView<vscode.TreeItem>
   ): void => {
     treeView.onDidCollapseElement((event: any) => {
-      log.info('Tree item was collapsed:', event.element.label);
+      log.info('Tree item was collapsed', event.element.label);
 
       if (event.element.onDidCollapse) {
         event.element.onDidCollapse();
@@ -64,7 +64,7 @@ export default class ExplorerTreeController
     });
 
     treeView.onDidExpandElement(async (event: any): Promise<void> => {
-      log.info('Tree item was expanded:', event.element.label);
+      log.info('Tree item was expanded', event.element.label);
 
       if (!event.element.onDidExpand) {
         return;

src/explorer/helpExplorer.ts

@@ -3,26 +3,27 @@ import HelpTree from './helpTree';
 import { createLogger } from '../logging';
 import { TelemetryService } from '../telemetry';
 
-const log = createLogger('help and info explorer controller');
+const log = createLogger('help and info explorer');
 
 export default class HelpExplorer {
   _treeController: HelpTree;
   _treeView?: vscode.TreeView<vscode.TreeItem>;
 
   constructor() {
-    log.info('activate help explorer');
     this._treeController = new HelpTree();
   }
 
   activateHelpTreeView(telemetryService: TelemetryService): void {
     if (!this._treeView) {
+      log.info('Activating help explorer...');
       this._treeView = vscode.window.createTreeView('mongoDBHelpExplorer', {
         treeDataProvider: this._treeController,
       });
       this._treeController.activateTreeViewEventHandlers(
         this._treeView,
         telemetryService
       );
+      log.info('Help explorer activated');
     }
   }
 

src/explorer/playgroundsExplorer.ts

@@ -2,14 +2,13 @@ import * as vscode from 'vscode';
 import PlaygroundsTree from './playgroundsTree';
 import { createLogger } from '../logging';
 
-const log = createLogger('explorer controller');
+const log = createLogger('playgrounds explorer');
 
 export default class PlaygroundsExplorer {
   private _treeController: PlaygroundsTree;
   private _treeView?: vscode.TreeView<vscode.TreeItem>;
 
   constructor() {
-    log.info('activate playgrounds explorer');
     this._treeController = new PlaygroundsTree();
   }
 
@@ -26,7 +25,9 @@ export default class PlaygroundsExplorer {
   };
 
   public activatePlaygroundsTreeView(): void {
+    log.info('Activating playgrounds explorer...');
     this.createPlaygroundsTreeView();
+    log.info('Playgrounds explorer activated');
   }
 
   public deactivate(): void {

src/explorer/playgroundsTree.ts

@@ -6,7 +6,7 @@ import PlaygroundsTreeItem from './playgroundsTreeItem';
 import EXTENSION_COMMANDS from '../commands';
 import { getPlaygrounds } from '../utils/playground';
 
-const log = createLogger('playgrounds tree controller');
+const log = createLogger('playgrounds tree');
 
 export default class PlaygroundsTree
   implements vscode.TreeDataProvider<vscode.TreeItem>
@@ -34,7 +34,7 @@ export default class PlaygroundsTree
     treeView: vscode.TreeView<vscode.TreeItem>
   ): void => {
     treeView.onDidCollapseElement((event: any) => {
-      log.info('Tree item was collapsed:', event.element.label);
+      log.info('Tree item was collapsed', event.element.label);
 
       if (event.element.onDidCollapse) {
         event.element.onDidCollapse();
@@ -50,7 +50,7 @@ export default class PlaygroundsTree
     });
 
     treeView.onDidExpandElement(async (event: any): Promise<void> => {
-      log.info('Tree item was expanded:', event.element.label);
+      log.info('Tree item was expanded', event.element.label);
 
       if (!event.element.onDidExpand) {
         return;