VSCODE-183: Edit documents from collection (#239)

* feat: edit documents from the collection view (VSCODE-183)

* feat: track document edited from collectionview

* refactor: update public and private functions for editors

* feat: handle identical namespaces for different connections

* test: import sinon and mock active editor

Author: alenakhineika

README.md

@@ -8,7 +8,7 @@ MongoDB for VS Code makes it easy to work with MongoDB, whether your own instanc
 
 ### Navigate your MongoDB Data
 
-- Navigate your database, collections and read-only views
+- Navigate your databases, collections, and read-only views
 - See the documents in your collections
 - Edit documents and save changes to the database
 - Get a quick overview of your schema and your indexes
@@ -21,8 +21,9 @@ MongoDB Playgrounds are the most convenient way to prototype and execute CRUD op
 
 - Prototype your queries, aggregations, and MongoDB commands with MongoDB syntax highlighting and intelligent autocomplete for MongoDB shell API, MongoDB operators, and for database, collection, and field names.
 - Run your playgrounds and see the results instantly. Click the play button in the tab bar to see the output.
-- Save your playgrounds in your workspace and use them to document how your application interacts with MongoDB
-- Build aggregations quickly with helpful and well-commented stage snippets
+- Edit documents returned by your playground.
+- Save your playgrounds in your workspace and use them to document how your application interacts with MongoDB.
+- Build aggregations quickly with helpful and well-commented stage snippets.
 
 ![Playgrounds](resources/screenshots/playground.png)
 

src/commands/index.ts

@@ -14,7 +14,7 @@ enum EXTENSION_COMMANDS {
   MDB_RUN_ALL_PLAYGROUND_BLOCKS = 'mdb.runAllPlaygroundBlocks',
   MDB_RUN_ALL_OR_SELECTED_PLAYGROUND_BLOCKS = 'mdb.runPlayground',
 
-  MDB_OPEN_MONGODB_DOCUMENT_FROM_PLAYGROUND = 'mdb.openMongoDBDocumentFromPlayground',
+  MDB_OPEN_MONGODB_DOCUMENT_FROM_CODE_LENS = 'mdb.openMongoDBDocumentFromCodeLens',
   MDB_OPEN_MONGODB_DOCUMENT_FROM_TREE = 'mdb.openMongoDBDocumentFromTree',
   MDB_SAVE_MONGODB_DOCUMENT = 'mdb.saveMongoDBDocument',
 

src/editors/collectionDocumentsCodeLensProvider.ts

@@ -10,13 +10,13 @@ import {
 } from './collectionDocumentsProvider';
 
 export default class CollectionDocumentsCodeLensProvider implements vscode.CodeLensProvider {
-  private _codeLenses: vscode.CodeLens[] = [];
-  private _activeOperationsStore: CollectionDocumentsOperationStore;
-  private uri: vscode.Uri = vscode.Uri.parse('');
-  private _onDidChangeCodeLenses: vscode.EventEmitter<
+  _codeLenses: vscode.CodeLens[] = [];
+  _activeOperationsStore: CollectionDocumentsOperationStore;
+  _uri: vscode.Uri = vscode.Uri.parse('');
+  _onDidChangeCodeLenses: vscode.EventEmitter<
     void
   > = new vscode.EventEmitter<void>();
-  public readonly onDidChangeCodeLenses: vscode.Event<void> = this
+  readonly onDidChangeCodeLenses: vscode.Event<void> = this
     ._onDidChangeCodeLenses.event;
 
   constructor(operationsStore: CollectionDocumentsOperationStore) {
@@ -27,9 +27,10 @@ export default class CollectionDocumentsCodeLensProvider implements vscode.CodeL
     });
   }
 
-  public provideCodeLenses(document: vscode.TextDocument): vscode.CodeLens[] {
+  provideCodeLenses(document: vscode.TextDocument): vscode.CodeLens[] {
     const uriParams = new URLSearchParams(document.uri.query);
     const operationId = uriParams.get(OPERATION_ID_URI_IDENTIFIER);
+
     if (!operationId) {
       return [];
     }
@@ -52,27 +53,27 @@ export default class CollectionDocumentsCodeLensProvider implements vscode.CodeL
       )
     ];
 
-    this.uri = document.uri;
+    this._uri = document.uri;
 
     return this._codeLenses;
   }
 
-  public resolveCodeLens?(codeLens: vscode.CodeLens): vscode.CodeLens {
-    const uriParams = new URLSearchParams(this.uri.query);
-
+  resolveCodeLens?(codeLens: vscode.CodeLens): vscode.CodeLens {
+    const uriParams = new URLSearchParams(this._uri.query);
     const namespace = uriParams.get(NAMESPACE_URI_IDENTIFIER);
     const connectionId = uriParams.get(CONNECTION_ID_URI_IDENTIFIER);
     const operationId = uriParams.get(OPERATION_ID_URI_IDENTIFIER);
 
     if (!operationId) {
       return codeLens;
     }
-    const operation = this._activeOperationsStore.operations[operationId];
 
+    const operation = this._activeOperationsStore.operations[operationId];
     const amountOfDocs = operation.currentLimit;
 
     let commandTitle;
     let commandTooltip;
+
     if (operation.isCurrentlyFetchingMoreDocuments) {
       commandTitle = `... Fetching ${amountOfDocs} documents...`;
       commandTooltip =

src/editors/collectionDocumentsProvider.ts

@@ -4,6 +4,8 @@ import * as vscode from 'vscode';
 import CollectionDocumentsOperationsStore from './collectionDocumentsOperationsStore';
 import ConnectionController from '../connectionController';
 import { StatusView } from '../views';
+import * as util from 'util';
+import EditDocumentCodeLensProvider from './editDocumentCodeLensProvider';
 
 export const NAMESPACE_URI_IDENTIFIER = 'namespace';
 export const OPERATION_ID_URI_IDENTIFIER = 'operationId';
@@ -13,84 +15,102 @@ export const VIEW_COLLECTION_SCHEME = 'VIEW_COLLECTION_SCHEME';
 
 export default class CollectionViewProvider
 implements vscode.TextDocumentContentProvider {
+  _context: vscode.ExtensionContext;
   _connectionController: ConnectionController;
   _operationsStore: CollectionDocumentsOperationsStore;
   _statusView: StatusView;
+  _editDocumentCodeLensProvider: EditDocumentCodeLensProvider;
 
   constructor(
+    context: vscode.ExtensionContext,
     connectionController: ConnectionController,
     operationsStore: CollectionDocumentsOperationsStore,
-    statusView: StatusView
+    statusView: StatusView,
+    editDocumentCodeLensProvider: EditDocumentCodeLensProvider
   ) {
+    this._context = context;
     this._connectionController = connectionController;
     this._operationsStore = operationsStore;
     this._statusView = statusView;
+    this._editDocumentCodeLensProvider = editDocumentCodeLensProvider;
   }
 
   onDidChangeEmitter = new vscode.EventEmitter<vscode.Uri>();
   onDidChange = this.onDidChangeEmitter.event;
 
-  provideTextDocumentContent(uri: vscode.Uri): Promise<string> {
-    return new Promise((resolve, reject) => {
-      const uriParams = new URLSearchParams(uri.query);
-      const namespace = String(uriParams.get(NAMESPACE_URI_IDENTIFIER));
-      const connectionId = uriParams.get(CONNECTION_ID_URI_IDENTIFIER);
-      const operationId = uriParams.get(OPERATION_ID_URI_IDENTIFIER);
-
-      if (!operationId) {
-        vscode.window.showErrorMessage(
-          'Unable to list documents: invalid operation'
-        );
-        return reject(new Error('Unable to list documents: invalid operation'));
-      }
+  async provideTextDocumentContent(uri: vscode.Uri): Promise<string> {
+    const uriParams = new URLSearchParams(uri.query);
+    const namespace = String(uriParams.get(NAMESPACE_URI_IDENTIFIER));
+    const connectionId = uriParams.get(CONNECTION_ID_URI_IDENTIFIER);
+    const operationId = uriParams.get(OPERATION_ID_URI_IDENTIFIER);
 
-      const operation = this._operationsStore.operations[operationId];
-      const documentLimit = operation.currentLimit;
-
-      // Ensure we're still connected to the correct connection.
-      if (connectionId !== this._connectionController.getActiveConnectionId()) {
-        operation.isCurrentlyFetchingMoreDocuments = false;
-        vscode.window.showErrorMessage(
-          `Unable to list documents: no longer connected to ${connectionId}`
-        );
-        return reject(
-          new Error(
-            `Unable to list documents: no longer connected to ${connectionId}`
-          )
-        );
-      }
+    if (!operationId) {
+      vscode.window.showErrorMessage(
+        'Unable to list documents: invalid operation'
+      );
 
-      this._statusView.showMessage('Fetching documents...');
+      throw new Error('Unable to list documents: invalid operation');
+    }
 
-      const dataservice = this._connectionController.getActiveDataService();
-      if (dataservice === null) {
-        const errorMessage = `Unable to list documents: no longer connected to ${connectionId}`;
-        vscode.window.showErrorMessage(errorMessage);
-        return reject(new Error(errorMessage));
-      }
-      dataservice.find(
+    const operation = this._operationsStore.operations[operationId];
+    const documentLimit = operation.currentLimit;
+
+    // Ensure we're still connected to the correct connection.
+    if (connectionId !== this._connectionController.getActiveConnectionId()) {
+      operation.isCurrentlyFetchingMoreDocuments = false;
+      vscode.window.showErrorMessage(
+        `Unable to list documents: no longer connected to ${connectionId}`
+      );
+
+      throw new Error(
+        `Unable to list documents: no longer connected to ${connectionId}`
+      );
+    }
+
+    this._statusView.showMessage('Fetching documents...');
+
+    const dataservice = this._connectionController.getActiveDataService();
+
+    if (dataservice === null) {
+      const errorMessage = `Unable to list documents: no longer connected to ${connectionId}`;
+
+      vscode.window.showErrorMessage(errorMessage);
+
+      throw new Error(errorMessage);
+    }
+
+    const find = util.promisify(dataservice.find.bind(dataservice));
+
+    try {
+      const documents = await find(
         namespace,
         {}, // No filter.
         {
           limit: documentLimit
-        },
-        (err: Error | undefined, documents: object[]) => {
-          operation.isCurrentlyFetchingMoreDocuments = false;
-          this._statusView.hideMessage();
-
-          if (err) {
-            const errorMessage = `Unable to list documents: ${err.message}`;
-            vscode.window.showErrorMessage(errorMessage);
-            return reject(new Error(errorMessage));
-          }
-
-          if (documents.length !== documentLimit) {
-            operation.hasMoreDocumentsToShow = false;
-          }
-
-          return resolve(JSON.stringify(documents, null, 2));
         }
       );
-    });
+
+      operation.isCurrentlyFetchingMoreDocuments = false;
+      this._statusView.hideMessage();
+
+      if (documents.length !== documentLimit) {
+        operation.hasMoreDocumentsToShow = false;
+      }
+
+      this._editDocumentCodeLensProvider.updateCodeLensesForCollection({
+        content: documents,
+        namespace,
+        uri
+      });
+
+      return JSON.stringify(documents, null, 2);
+    } catch (error) {
+      const printableError = error as { message: string };
+      const errorMessage = `Unable to list documents: ${printableError.message}`;
+
+      vscode.window.showErrorMessage(errorMessage);
+
+      throw Error(errorMessage);
+    }
   }
 }