chore(telemetry): Attach anonymous ID of user to the url of the cta link to Atlas VSCODE-249 (#302)

Author: Anemy

src/mdbExtensionController.ts

@@ -116,6 +116,7 @@ export default class MDBExtensionController implements vscode.Disposable {
     );
     this._webviewController = new WebviewController(
       this._connectionController,
+      this._storageController,
       this._telemetryService
     );
     this._editorsController.registerProviders();

src/test/suite/explorer/databaseTreeItem.test.ts

@@ -57,7 +57,7 @@ suite('DatabaseTreeItem Test Suite', () => {
       .then(done, done);
   });
 
-  test('when expanded shows the collections of a database in tree', (done) => {
+  test('when expanded shows the collections of a database in tree', async () => {
     const testDatabaseTreeItem = new DatabaseTreeItem(
       mockDatabaseNames[1],
       new DataServiceStub(),
@@ -68,22 +68,18 @@ suite('DatabaseTreeItem Test Suite', () => {
 
     testDatabaseTreeItem.onDidExpand();
 
-    testDatabaseTreeItem
-      .getChildren()
-      .then((collections) => {
-        assert(
-          collections.length > 0,
-          `Expected more than one collection to be returned, recieved ${collections.length}`
-        );
+    const collections = await testDatabaseTreeItem.getChildren();
+    assert(
+      collections.length > 0,
+      `Expected more than one collection to be returned, recieved ${collections.length}`
+    );
 
-        assert(
-          collections[1].label ===
-          mockDatabases[mockDatabaseNames[1]].collections[1].name,
-          `Expected a tree item child with the label collection name ${mockDatabases[mockDatabaseNames[1]].collections[1].name
-          } found ${collections[1].label}`
-        );
-      })
-      .then(done, done);
+    assert(
+      collections[1].label ===
+      mockDatabases[mockDatabaseNames[1]].collections[1].name,
+      `Expected a tree item child with the label collection name ${mockDatabases[mockDatabaseNames[1]].collections[1].name
+      } found ${collections[1].label}`
+    );
   });
 
   test('when expanded and collapsed its collections cache their expanded documents', async () => {
@@ -150,7 +146,7 @@ suite('DatabaseTreeItem Test Suite', () => {
     );
   });
 
-  test('collections are displayed in the alphanumerical case insensitive order, with system collections last', (done) => {
+  test('collections are displayed in the alphanumerical case insensitive order, with system collections last', async () => {
     const testDatabaseTreeItem = new DatabaseTreeItem(
       mockDatabaseNames[2],
       new DataServiceStub(),
@@ -171,18 +167,15 @@ suite('DatabaseTreeItem Test Suite', () => {
       'system.views'
     ];
 
-    testDatabaseTreeItem
-      .getChildren()
-      .then((collectionTreeItems: CollectionTreeItem[]) => {
-        assert.deepEqual(
-          collectionTreeItems
-            .map(({ collectionName }) => collectionName)
-            .join(),
-          expectedCollectionsOrder.join(),
-          'Expected collections to be in alphanumerical order but they were not'
-        );
-      })
-      .then(done, done);
+    const collectionTreeItems: CollectionTreeItem[] = await testDatabaseTreeItem
+      .getChildren();
+    assert.deepEqual(
+      collectionTreeItems
+        .map(({ collectionName }) => collectionName)
+        .join(),
+      expectedCollectionsOrder.join(),
+      'Expected collections to be in alphanumerical order but they were not'
+    );
   });
 
   suite('Live Database Tests', function () {
@@ -192,7 +185,7 @@ suite('DatabaseTreeItem Test Suite', () => {
       await cleanupTestDB();
     });
 
-    test('schema is cached when a database is collapsed and expanded', (done) => {
+    test('schema is cached when a database is collapsed and expanded', async () => {
       const mockDocWithThirtyFields = {
         _id: 32,
         testerObject: {
@@ -203,106 +196,94 @@ suite('DatabaseTreeItem Test Suite', () => {
         mockDocWithThirtyFields[`field${i}`] = 'some value';
       }
 
-      seedDataAndCreateDataService('ramenNoodles', [
+      const dataService = await seedDataAndCreateDataService('ramenNoodles', [
         mockDocWithThirtyFields
-      ]).then((dataService) => {
-        const testDatabaseTreeItem = new DatabaseTreeItem(
-          TEST_DB_NAME,
-          dataService,
-          true,
-          false,
-          {}
-        );
-
-        testDatabaseTreeItem
-          .getChildren()
-          .then((collectionTreeItems: CollectionTreeItem[]) => {
-            assert(
-              collectionTreeItems[0].isExpanded === false,
-              'Expected collection tree item not to be expanded on default.'
-            );
-
-            collectionTreeItems[0].onDidExpand();
-            const schemaTreeItem = collectionTreeItems[0].getSchemaChild();
-            if (!schemaTreeItem) {
-              assert(false, 'No schema tree item found on collection.');
-              return;
-            }
-            schemaTreeItem.onDidExpand();
-            schemaTreeItem.onShowMoreClicked();
-
-            schemaTreeItem.getChildren().then((fields: any[]) => {
-              const amountOfFields = fields.length;
-              const expectedFields = 30;
-              assert(
-                expectedFields === amountOfFields,
-                `Expected ${expectedFields} fields, recieved ${amountOfFields}`
-              );
-
-              assert(
-                !!schemaTreeItem.childrenCache.testerObject,
-                'Expected the subdocument field to be in the schema cache.'
-              );
-              // Expand the subdocument.
-              schemaTreeItem.childrenCache.testerObject.onDidExpand();
-
-              testDatabaseTreeItem.onDidCollapse();
-              testDatabaseTreeItem
-                .getChildren()
-                .then((postCollapseCollectionTreeItems) => {
-                  assert(
-                    postCollapseCollectionTreeItems.length === 0,
-                    `Expected the database tree to return no children when collapsed, found ${collectionTreeItems.length}`
-                  );
-
-                  testDatabaseTreeItem.onDidExpand();
-                  testDatabaseTreeItem
-                    .getChildren()
-                    .then((newCollectionTreeItems) => {
-                      dataService.disconnect(() => {});
-
-                      const postCollapseSchemaTreeItem = newCollectionTreeItems[0].getSchemaChild();
-                      assert(
-                        postCollapseSchemaTreeItem.isExpanded === true,
-                        'Expected collection tree item to be expanded from cache.'
-                      );
-
-                      postCollapseSchemaTreeItem
-                        .getChildren()
-                        .then((fieldsPostCollapseExpand) => {
-                          // It should cache that we activated show more.
-                          const amountOfCachedFields =
-                            fieldsPostCollapseExpand.length;
-                          const expectedCachedFields = 30;
-                          assert(
-                            amountOfCachedFields === expectedCachedFields,
-                            `Expected a cached ${expectedCachedFields} fields to be returned, found ${amountOfCachedFields}`
-                          );
-
-                          const testerObjectField = fieldsPostCollapseExpand.find(
-                            (field) => field.fieldName === 'testerObject'
-                          );
-
-                          assert(
-                            !!testerObjectField,
-                            'Expected the subdocument field to still be in the schema cache.'
-                          );
-                          assert(
-                            testerObjectField.isExpanded,
-                            'Expected the subdocument field to still be expanded.'
-                          );
-                          assert(
-                            testerObjectField.collapsibleState ===
-                            vscode.TreeItemCollapsibleState.Expanded,
-                            `Expected the subdocument field to have an expanded state (2), found ${postCollapseSchemaTreeItem.childrenCache.testerObject.collapsibleState}.`
-                          );
-                        })
-                        .then(done, done);
-                    }, done);
-                }, done);
-            }, done);
-          }, done);
-      });
+      ]);
+      const testDatabaseTreeItem = new DatabaseTreeItem(
+        TEST_DB_NAME,
+        dataService,
+        true,
+        false,
+        {}
+      );
+
+      const collectionTreeItems: CollectionTreeItem[] = await testDatabaseTreeItem.getChildren();
+      assert(
+        collectionTreeItems[0].isExpanded === false,
+        'Expected collection tree item not to be expanded on default.'
+      );
+
+      collectionTreeItems[0].onDidExpand();
+      const schemaTreeItem = collectionTreeItems[0].getSchemaChild();
+      if (!schemaTreeItem) {
+        assert(false, 'No schema tree item found on collection.');
+        return;
+      }
+      schemaTreeItem.onDidExpand();
+      schemaTreeItem.onShowMoreClicked();
+
+      const fields: any[] = await schemaTreeItem.getChildren();
+      const amountOfFields = fields.length;
+      const expectedFields = 30;
+      assert(
+        expectedFields === amountOfFields,
+        `Expected ${expectedFields} fields, recieved ${amountOfFields}`
+      );
+
+      assert(
+        !!schemaTreeItem.childrenCache.testerObject,
+        'Expected the subdocument field to be in the schema cache.'
+      );
+      // Expand the subdocument.
+      schemaTreeItem.childrenCache.testerObject.onDidExpand();
+
+      testDatabaseTreeItem.onDidCollapse();
+      const postCollapseCollectionTreeItems = await testDatabaseTreeItem
+        .getChildren();
+      assert(
+        postCollapseCollectionTreeItems.length === 0,
+        `Expected the database tree to return no children when collapsed, found ${collectionTreeItems.length}`
+      );
+
+      testDatabaseTreeItem.onDidExpand();
+      const newCollectionTreeItems = await testDatabaseTreeItem
+        .getChildren();
+      dataService.disconnect(() => {});
+
+      const postCollapseSchemaTreeItem = newCollectionTreeItems[0].getSchemaChild();
+      assert(
+        postCollapseSchemaTreeItem.isExpanded === true,
+        'Expected collection tree item to be expanded from cache.'
+      );
+
+      const fieldsPostCollapseExpand = await postCollapseSchemaTreeItem
+        .getChildren();
+      // It should cache that we activated show more.
+      const amountOfCachedFields =
+        fieldsPostCollapseExpand.length;
+      const expectedCachedFields = 30;
+      assert(
+        amountOfCachedFields === expectedCachedFields,
+        `Expected a cached ${expectedCachedFields} fields to be returned, found ${amountOfCachedFields}`
+      );
+
+      const testerObjectField = fieldsPostCollapseExpand.find(
+        (field) => field.fieldName === 'testerObject'
+      );
+
+      assert(
+        !!testerObjectField,
+        'Expected the subdocument field to still be in the schema cache.'
+      );
+      assert(
+        testerObjectField.isExpanded,
+        'Expected the subdocument field to still be expanded.'
+      );
+      assert(
+        testerObjectField.collapsibleState ===
+        vscode.TreeItemCollapsibleState.Expanded,
+        `Expected the subdocument field to have an expanded state (2), found ${postCollapseSchemaTreeItem.childrenCache.testerObject.collapsibleState}.`
+      );
     });
   });
 });

src/test/suite/views/webview-app/components/atlas-cta/atlas-cta.test.tsx

@@ -10,6 +10,7 @@ import {
   rootReducer
 } from '../../../../../../views/webview-app/store/store';
 import AtlasCTA from '../../../../../../views/webview-app/components/atlas-cta/atlas-cta';
+import { USER_ID_GLOBAL_VARIABLE_NAME } from '../../../../../../views/webview-app/extension-app-message-constants';
 
 describe('Resources Panel Component Test Suite', () => {
   describe('when rendered', () => {
@@ -45,15 +46,16 @@ describe('Resources Panel Component Test Suite', () => {
       assert(!fakeVscodeWindowPostMessage.called);
       wrapper.find('a').at(0).simulate('click');
       assert(fakeVscodeWindowPostMessage.called);
-      assert(fakeVscodeWindowPostMessage.firstCall.args[0].command === 'EXTENSION_LINK_CLICKED');
+      assert.strictEqual(fakeVscodeWindowPostMessage.firstCall.args[0].command, 'EXTENSION_LINK_CLICKED');
     });
 
     test('when a trusted link is clicked it sends an event to the extension', () => {
       assert(!fakeVscodeWindowPostMessage.called);
+      window[USER_ID_GLOBAL_VARIABLE_NAME] = 'mockUserID';
       wrapper.find('a').at(1).simulate('click');
       assert(fakeVscodeWindowPostMessage.called);
-      assert(fakeVscodeWindowPostMessage.firstCall.args[0].command === 'OPEN_TRUSTED_LINK');
-      assert(fakeVscodeWindowPostMessage.firstCall.args[0].linkTo === 'https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product');
+      assert.strictEqual(fakeVscodeWindowPostMessage.firstCall.args[0].command, 'OPEN_TRUSTED_LINK');
+      assert.strictEqual(fakeVscodeWindowPostMessage.firstCall.args[0].linkTo, 'https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product&ajs_aid=mockUserID');
       // The assert below is a bit redundant but will prevent us from redirecting to a non-https URL by mistake
       assert(fakeVscodeWindowPostMessage.firstCall.args[0].linkTo.startsWith('https://') === true);
     });