fix: deserialize document id before fetching document (#237)

* fix: deserialize document id before fetching document

* test: add additional assertion to make sure that ejson id is not bson id

* refactor: remove fire that left after refactoring

Author: alenakhineika

src/editors/editDocumentCodeLensProvider.ts

@@ -3,6 +3,7 @@ import EXTENSION_COMMANDS from '../commands';
 import type { OutputItem, ResultCodeLensInfo } from '../utils/types';
 import ConnectionController from '../connectionController';
 import { DocumentSource } from '../telemetry/telemetryService';
+import { EJSON } from 'bson';
 
 export default class EditDocumentCodeLensProvider
 implements vscode.CodeLensProvider {
@@ -25,6 +26,7 @@ implements vscode.CodeLensProvider {
 
   updateCodeLensesForPlayground(playgroundResult: OutputItem) {
     const source = DocumentSource.DOCUMENT_SOURCE_PLAYGROUND;
+    let codeLensesInfo: ResultCodeLensInfo[] = [];
 
     if (!playgroundResult || !playgroundResult.content) {
       this._codeLensesInfo = [];
@@ -38,17 +40,19 @@ implements vscode.CodeLensProvider {
     // Show code lenses only for the list of documents or a single document
     // that are returned by the find() method.
     if (type === 'Cursor') {
-      this._updateCodeLensesForCursor(data);
+      codeLensesInfo = this._updateCodeLensesForCursor(data);
     } else if (type === 'Document') {
-      this._updateCodeLensesForDocument(data);
+      codeLensesInfo = this._updateCodeLensesForDocument(data);
     }
+
+    this._codeLensesInfo = codeLensesInfo;
   }
 
   _updateCodeLensesForCursor(data: {
     content: any,
     namespace: string | null,
     source: string
-  }) {
+  }): ResultCodeLensInfo[] {
     const codeLensesInfo: ResultCodeLensInfo[] = [];
 
     if (Array.isArray(data.content)) {
@@ -64,7 +68,7 @@ implements vscode.CodeLensProvider {
         // to be able to save the editable document.
         if (item !== null && item._id && namespace) {
           codeLensesInfo.push({
-            documentId: item._id,
+            documentId: EJSON.deserialize(EJSON.serialize(item._id)),
             source,
             line,
             namespace,
@@ -79,34 +83,32 @@ implements vscode.CodeLensProvider {
       });
     }
 
-    this._codeLensesInfo = codeLensesInfo;
-    this._onDidChangeCodeLenses.fire();
+    return codeLensesInfo;
   }
 
   _updateCodeLensesForDocument(data: {
     content: any,
     namespace: string | null,
     source: string
-  }): void {
-    const codeLensesInfo: ResultCodeLensInfo[] = [];
+  }): ResultCodeLensInfo[] {
     const { content, namespace, source } = data;
+    const codeLensesInfo: ResultCodeLensInfo[] = [];
 
     if (content._id && namespace) {
       const connectionId = this._connectionController.getActiveConnectionId();
 
       // When the playground result is the single document,
       // show the single code lense after {.
       codeLensesInfo.push({
-        documentId: content._id,
+        documentId: EJSON.deserialize(EJSON.serialize(content._id)),
         source,
         line: 1,
         namespace,
         connectionId
       });
     }
 
-    this._codeLensesInfo = codeLensesInfo;
-    this._onDidChangeCodeLenses.fire();
+    return codeLensesInfo;
   }
 
   provideCodeLenses(): vscode.CodeLens[] {

src/test/suite/editors/editDocumentCodeLensProvider.test.ts

@@ -5,6 +5,12 @@ import { TestExtensionContext } from '../stubs';
 import { StorageController } from '../../../storage';
 import TelemetryService from '../../../telemetry/telemetryService';
 import { StatusView } from '../../../views';
+import { ObjectId } from 'bson';
+import { afterEach } from 'mocha';
+
+import sinon from 'sinon';
+
+import * as util from 'util';
 
 suite('Edit Document Code Lens Provider Test Suite', () => {
   const mockExtensionContext = new TestExtensionContext();
@@ -20,6 +26,10 @@ suite('Edit Document Code Lens Provider Test Suite', () => {
     testTelemetryService
   );
 
+  afterEach(() => {
+    sinon.restore();
+  });
+
   test('provideCodeLenses returns an empty array if codeLensesInfo is empty', () => {
     const testCodeLensProvider = new EditDocumentCodeLensProvider(
       testConnectionController
@@ -30,6 +40,72 @@ suite('Edit Document Code Lens Provider Test Suite', () => {
     assert(codeLens.length === 0);
   });
 
+  test('the _updateCodeLensesForCursor function deserialize document id', () => {
+    const testCodeLensProvider = new EditDocumentCodeLensProvider(
+      testConnectionController
+    );
+    const ejsinId = { $oid: '5d973ae744376d2aae72a160' };
+    const playgroundResult = {
+      content: [{
+        _id: ejsinId,
+        name: 'test name'
+      }],
+      namespace: 'db.coll',
+      source: 'playground'
+    };
+
+    const mockActiveConnectionId = sinon.fake.returns('tasty_sandwhich');
+    sinon.replace(
+      testCodeLensProvider._connectionController,
+      'getActiveConnectionId',
+      mockActiveConnectionId
+    );
+
+    const result = testCodeLensProvider._updateCodeLensesForCursor(playgroundResult);
+
+    assert(!!result);
+    const codeLensesInfo = result[0];
+    assert(!!codeLensesInfo);
+    assert(!!codeLensesInfo.documentId);
+    const bsonId = new ObjectId('5d973ae744376d2aae72a160');
+
+    assert(util.inspect(codeLensesInfo.documentId) !== util.inspect(ejsinId));
+    assert(util.inspect(codeLensesInfo.documentId) === util.inspect(bsonId));
+  });
+
+  test('the _updateCodeLensesForDocument function deserialize document id', () => {
+    const testCodeLensProvider = new EditDocumentCodeLensProvider(
+      testConnectionController
+    );
+    const ejsinId = { $oid: '5d973ae744376d2aae72a160' };
+    const playgroundResult = {
+      content: {
+        _id: ejsinId,
+        name: 'test name'
+      },
+      namespace: 'db.coll',
+      source: 'playground'
+    };
+
+    const mockActiveConnectionId = sinon.fake.returns('tasty_sandwhich');
+    sinon.replace(
+      testCodeLensProvider._connectionController,
+      'getActiveConnectionId',
+      mockActiveConnectionId
+    );
+
+    const result = testCodeLensProvider._updateCodeLensesForDocument(playgroundResult);
+
+    assert(!!result);
+    const codeLensesInfo = result[0];
+    assert(!!codeLensesInfo);
+    assert(!!codeLensesInfo.documentId);
+    const bsonId = new ObjectId('5d973ae744376d2aae72a160');
+
+    assert(util.inspect(codeLensesInfo.documentId) !== util.inspect(ejsinId));
+    assert(util.inspect(codeLensesInfo.documentId) === util.inspect(bsonId));
+  });
+
   suite('after updateCodeLensesForPlayground', () => {
     test('provideCodeLenses returns one code lens when result is a single document', () => {
       const testCodeLensProvider = new EditDocumentCodeLensProvider(

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

@@ -9,8 +9,8 @@ import TelemetryService from '../../../telemetry/telemetryService';
 import { afterEach } from 'mocha';
 import { EJSON } from 'bson';
 
-const sinon = require('sinon');
-const chai = require('chai');
+import sinon from 'sinon';
+import chai from 'chai';
 const expect = chai.expect;
 
 suite('MongoDB Document Service Test Suite', () => {