feat(tree-explorer): Add open and copy document tree view context menu items VSCODE-348 (#445)

Author: Anemy

package.json

@@ -404,6 +404,14 @@
       {
         "command": "mdb.generateObjectIdToClipboard",
         "title": "MongoDB: Generate ObjectId to Clipboard"
+      },
+      {
+        "command": "mdb.openMongoDBDocumentFromTree",
+        "title": "Open Document"
+      },
+      {
+        "command": "mdb.copyDocumentContentsFromTreeView",
+        "title": "Copy Document"
       }
     ],
     "menus": {
@@ -590,6 +598,16 @@
         {
           "command": "mdb.createIndexFromTreeView",
           "when": "view == mongoDBConnectionExplorer && viewItem == indexListTreeItem"
+        },
+        {
+          "command": "mdb.openMongoDBDocumentFromTree",
+          "when": "view == mongoDBConnectionExplorer && viewItem == documentTreeItem",
+          "group": "1@1"
+        },
+        {
+          "command": "mdb.copyDocumentContentsFromTreeView",
+          "when": "view == mongoDBConnectionExplorer && viewItem == documentTreeItem",
+          "group": "2@1"
         }
       ],
       "editor/title": [
@@ -755,6 +773,14 @@
         {
           "command": "mdb.copySchemaFieldName",
           "when": "false"
+        },
+        {
+          "command": "mdb.openMongoDBDocumentFromTree",
+          "when": "false"
+        },
+        {
+          "command": "mdb.copyDocumentContentsFromTreeView",
+          "when": "false"
         }
       ]
     },

src/commands/index.ts

@@ -60,6 +60,7 @@ enum EXTENSION_COMMANDS {
   MDB_CREATE_INDEX_TREE_VIEW = 'mdb.createIndexFromTreeView',
   MDB_INSERT_OBJECTID_TO_EDITOR = 'mdb.insertObjectIdToEditor',
   MDB_GENERATE_OBJECTID_TO_CLIPBOARD = 'mdb.generateObjectIdToClipboard',
+  MDB_COPY_DOCUMENT_CONTENTS_FROM_TREE_VIEW = 'mdb.copyDocumentContentsFromTreeView',
 }
 
 export default EXTENSION_COMMANDS;

src/editors/editorsController.ts

@@ -124,7 +124,6 @@ export default class EditorsController {
     this._documentIdStore = new DocumentIdStore();
     this._mongoDBDocumentService = new MongoDBDocumentService(
       this._context,
-      this._documentIdStore,
       this._connectionController,
       this._statusView,
       this._telemetryService

src/editors/mongoDBDocumentService.ts

@@ -4,7 +4,6 @@ import { EJSON, Document } from 'bson';
 
 import ConnectionController from '../connectionController';
 import { createLogger } from '../logging';
-import DocumentIdStore from './documentIdStore';
 import { DocumentSource } from '../documentSource';
 import type { EditDocumentInfo } from '../types/editDocumentInfoType';
 import formatError from '../utils/formatError';
@@ -21,20 +20,17 @@ export const VIEW_DOCUMENT_SCHEME = 'VIEW_DOCUMENT_SCHEME';
 
 export default class MongoDBDocumentService {
   _context: vscode.ExtensionContext;
-  _documentIdStore: DocumentIdStore;
   _connectionController: ConnectionController;
   _statusView: StatusView;
   _telemetryService: TelemetryService;
 
   constructor(
     context: vscode.ExtensionContext,
-    documentIdStore: DocumentIdStore,
     connectionController: ConnectionController,
     statusView: StatusView,
     telemetryService: TelemetryService
   ) {
     this._context = context;
-    this._documentIdStore = documentIdStore;
     this._connectionController = connectionController;
     this._statusView = statusView;
     this._telemetryService = telemetryService;

src/explorer/documentListTreeItem.ts

@@ -7,6 +7,7 @@ import DocumentTreeItem from './documentTreeItem';
 import formatError from '../utils/formatError';
 import { getImagesPath } from '../extensionConstants';
 import TreeItemParent from './treeItemParentInterface';
+import type { DataService } from 'mongodb-data-service';
 
 const path = require('path');
 const log = createLogger('tree view document list');
@@ -104,15 +105,15 @@ export default class DocumentListTreeItem
   namespace: string;
   type: CollectionTypes;
 
-  private _dataService: any;
+  private _dataService: DataService;
 
   isExpanded: boolean;
 
   constructor(
     collectionName: string,
     databaseName: string,
     type: CollectionTypes,
-    dataService: any,
+    dataService: DataService,
     isExpanded: boolean,
     maxDocumentsToShow: number,
     cachedDocumentCount: number | null,
@@ -173,7 +174,8 @@ export default class DocumentListTreeItem
           new DocumentTreeItem(
             (pastTreeItem as DocumentTreeItem).document,
             this.namespace,
-            index
+            index,
+            this._dataService
           )
         );
       });
@@ -217,7 +219,12 @@ export default class DocumentListTreeItem
     if (documents) {
       documents.forEach((document, index) => {
         this._childrenCache.push(
-          new DocumentTreeItem(document, this.namespace, index)
+          new DocumentTreeItem(
+            document,
+            this.namespace,
+            index,
+            this._dataService
+          )
         );
       });
     }

src/explorer/documentTreeItem.ts

@@ -1,5 +1,9 @@
 import { EJSON } from 'bson';
 import * as vscode from 'vscode';
+import type { Document } from 'mongodb';
+import type { DataService } from 'mongodb-data-service';
+import { promisify } from 'util';
+import formatError from '../utils/formatError';
 
 export const DOCUMENT_ITEM = 'documentTreeItem';
 
@@ -10,10 +14,16 @@ export default class DocumentTreeItem
   contextValue = DOCUMENT_ITEM;
 
   namespace: string;
-  document: any;
+  dataService: DataService;
+  document: Document;
   documentId: EJSON.SerializableTypes;
 
-  constructor(document: any, namespace: string, documentIndexInTree: number) {
+  constructor(
+    document: Document,
+    namespace: string,
+    documentIndexInTree: number,
+    dataService: DataService
+  ) {
     // A document can not have a `_id` when it is in a view. In this instance
     // we just show the document's index in the tree.
     super(
@@ -27,6 +37,7 @@ export default class DocumentTreeItem
       ? JSON.stringify(document._id)
       : `Document ${documentIndexInTree + 1}`;
 
+    this.dataService = dataService;
     this.document = document;
     this.documentId = document._id;
     this.namespace = namespace;
@@ -41,4 +52,23 @@ export default class DocumentTreeItem
   getChildren(): Thenable<DocumentTreeItem[]> {
     return Promise.resolve([]);
   }
+
+  async getStringifiedEJSONDocumentContents(): Promise<string> {
+    try {
+      const find = promisify(this.dataService.find.bind(this.dataService));
+      const documents = await find(
+        this.namespace,
+        { _id: this.documentId },
+        { limit: 1 }
+      );
+
+      if (!documents || documents.length === 0) {
+        throw new Error('document not found');
+      }
+
+      return EJSON.stringify(documents[0], undefined, 2);
+    } catch (error) {
+      throw new Error(formatError(error).message);
+    }
+  }
 }

src/mdbExtensionController.ts

@@ -550,6 +550,17 @@ export default class MDBExtensionController implements vscode.Disposable {
       (playgroundsTreeItem: PlaygroundsTreeItem) =>
         this._playgroundController.openPlayground(playgroundsTreeItem.filePath)
     );
+    this.registerCommand(
+      EXTENSION_COMMANDS.MDB_COPY_DOCUMENT_CONTENTS_FROM_TREE_VIEW,
+      async (documentTreeItem: DocumentTreeItem): Promise<boolean> => {
+        const documentContents =
+          await documentTreeItem.getStringifiedEJSONDocumentContents();
+        await vscode.env.clipboard.writeText(documentContents);
+        void vscode.window.showInformationMessage('Copied to clipboard.');
+
+        return true;
+      }
+    );
     this.registerCommand(
       EXTENSION_COMMANDS.MDB_INSERT_OBJECTID_TO_EDITOR,
       async (): Promise<boolean> => {

src/test/suite/editors/mongoDBDocumentService.test.ts

@@ -5,7 +5,6 @@ import { EJSON } from 'bson';
 import sinon from 'sinon';
 
 import ConnectionController from '../../../connectionController';
-import DocumentIdStore from '../../../editors/documentIdStore';
 import { DocumentSource } from '../../../documentSource';
 import formatError from '../../../utils/formatError';
 import MongoDBDocumentService from '../../../editors/mongoDBDocumentService';
@@ -18,7 +17,6 @@ import { TestExtensionContext } from '../stubs';
 const expect = chai.expect;
 
 suite('MongoDB Document Service Test Suite', () => {
-  const testDocumentIdStore = new DocumentIdStore();
   const mockExtensionContext = new TestExtensionContext();
   const testStorageController = new StorageController(mockExtensionContext);
   const testStatusView = new StatusView(mockExtensionContext);
@@ -33,7 +31,6 @@ suite('MongoDB Document Service Test Suite', () => {
   );
   const testMongoDBDocumentService = new MongoDBDocumentService(
     mockExtensionContext,
-    testDocumentIdStore,
     testConnectionController,
     testStatusView,
     testTelemetryService

src/test/suite/explorer/documentListTreeItem.test.ts

@@ -1,5 +1,7 @@
 import * as vscode from 'vscode';
+import { before } from 'mocha';
 import assert from 'assert';
+import type { DataService } from 'mongodb-data-service';
 
 const { contributes } = require('../../../../package.json');
 
@@ -12,13 +14,19 @@ import DocumentListTreeItem, {
 import { DataServiceStub, mockDocuments } from '../stubs';
 
 suite('DocumentListTreeItem Test Suite', () => {
+  let dataServiceMock: DataService;
+
+  before(() => {
+    dataServiceMock = new DataServiceStub() as any as DataService;
+  });
+
   test('its context value should be in the package json', () => {
     let documentListRegisteredCommandInPackageJson = false;
     const testDocumentListTreeItem = new DocumentListTreeItem(
       'collectionName',
       'databaseName',
       CollectionTypes.collection,
-      'not_real_dataservice',
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       null,
@@ -44,7 +52,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'collectionName',
       'databaseName',
       CollectionTypes.collection,
-      'not_real_dataservice',
+      'not_real_dataservice' as any as DataService,
       false,
       MAX_DOCUMENTS_VISIBLE,
       null,
@@ -75,7 +83,7 @@ suite('DocumentListTreeItem Test Suite', () => {
         'mock_collection_name',
         'mock_db_name',
         CollectionTypes.collection,
-        new DataServiceStub(),
+        dataServiceMock,
         false,
         MAX_DOCUMENTS_VISIBLE,
         null,
@@ -96,7 +104,7 @@ suite('DocumentListTreeItem Test Suite', () => {
         'mock_collection_name',
         'mock_db_name',
         CollectionTypes.collection,
-        new DataServiceStub(),
+        dataServiceMock,
         false,
         MAX_DOCUMENTS_VISIBLE,
         null,
@@ -119,7 +127,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name',
       'mock_db_name',
       CollectionTypes.view,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       null,
@@ -139,7 +147,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_1',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       25,
@@ -166,7 +174,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_2',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       25,
@@ -193,7 +201,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_3',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       25,
@@ -225,7 +233,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_4',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       25,
@@ -258,7 +266,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_1',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       maxDocs,
@@ -275,7 +283,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_4',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       maxDocs,
@@ -300,7 +308,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_4',
       'mock_db_name',
       CollectionTypes.view,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       null,
@@ -319,7 +327,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_4',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       null,
@@ -340,7 +348,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_4',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       25,
@@ -357,7 +365,7 @@ suite('DocumentListTreeItem Test Suite', () => {
       'mock_collection_name_4',
       'mock_db_name',
       CollectionTypes.collection,
-      new DataServiceStub(),
+      dataServiceMock,
       false,
       MAX_DOCUMENTS_VISIBLE,
       2200000,