chore: sync with main 26 08 (#791)

* chore(testing): use source map support, improve test cleanup error handling VSCODE-593 (#784) * feat: show survey VSCODE-562 (#780) --------- Co-authored-by: Rhys <[email protected]> Co-authored-by: Rhys Howell <[email protected]> * fix: add telemetry events for survey VSCODE-595 (#787) * fix(editors): don't show connect code lens on regular js files VSCODE-538 (#789) --------- Co-authored-by: Rhys <[email protected]> Co-authored-by: Paula Stachova <[email protected]> Co-authored-by: Rhys Howell <[email protected]>
mongodb-js · Aug 26, 2024 · 16277cb · 16277cb
1 parent 934e830
commit 16277cb
Show file tree

Hide file tree

Showing 12 changed files with 254 additions and 79 deletions.
diff --git a/src/connectionController.ts b/src/connectionController.ts
@@ -806,6 +806,10 @@ export default class ConnectionController {
     this.eventEmitter.removeListener(eventType, listener);
   }
 
+  deactivate() {
+    this.eventEmitter.removeAllListeners();
+  }
+
   closeConnectionStringInput() {
     this._connectionStringInputCancellationToken?.cancel();
   }

diff --git a/src/editors/activeConnectionCodeLensProvider.ts b/src/editors/activeConnectionCodeLensProvider.ts
@@ -1,45 +1,40 @@
 import * as vscode from 'vscode';
-import type { TextEditor } from 'vscode';
+
 import EXTENSION_COMMANDS from '../commands';
 import type ConnectionController from '../connectionController';
 import { isPlayground } from '../utils/playground';
 import { getDBFromConnectionString } from '../utils/connection-string-db';
+import { DataServiceEventTypes } from '../connectionController';
 
 export default class ActiveConnectionCodeLensProvider
   implements vscode.CodeLensProvider
 {
   _connectionController: ConnectionController;
   _onDidChangeCodeLenses: vscode.EventEmitter<void> =
     new vscode.EventEmitter<void>();
-  activeTextEditor?: TextEditor;
+  _activeConnectionChangedHandler: () => void;
 
   readonly onDidChangeCodeLenses: vscode.Event<void> =
     this._onDidChangeCodeLenses.event;
 
   constructor(connectionController: ConnectionController) {
     this._connectionController = connectionController;
-    this.activeTextEditor = vscode.window.activeTextEditor;
 
     vscode.workspace.onDidChangeConfiguration(() => {
       this._onDidChangeCodeLenses.fire();
     });
-  }
-
-  setActiveTextEditor(activeTextEditor?: TextEditor) {
-    this.activeTextEditor = activeTextEditor;
-    this._onDidChangeCodeLenses.fire();
-  }
-
-  refresh(): void {
-    this._onDidChangeCodeLenses.fire();
-  }
 
-  isPlayground(): boolean {
-    return isPlayground(this.activeTextEditor?.document.uri);
+    this._activeConnectionChangedHandler = () => {
+      this._onDidChangeCodeLenses.fire();
+    };
+    this._connectionController.addEventListener(
+      DataServiceEventTypes.ACTIVE_CONNECTION_CHANGED,
+      this._activeConnectionChangedHandler
+    );
   }
 
-  provideCodeLenses(): vscode.CodeLens[] {
-    if (!this.isPlayground()) {
+  provideCodeLenses(document: vscode.TextDocument): vscode.CodeLens[] {
+    if (!isPlayground(document.uri)) {
       return [];
     }
 
@@ -69,4 +64,11 @@ export default class ActiveConnectionCodeLensProvider
 
     return [codeLens];
   }
+
+  deactivate() {
+    this._connectionController.removeEventListener(
+      DataServiceEventTypes.ACTIVE_CONNECTION_CHANGED,
+      this._activeConnectionChangedHandler
+    );
+  }
 }
diff --git a/src/editors/playgroundController.ts b/src/editors/playgroundController.ts
@@ -6,7 +6,6 @@ import vm from 'vm';
 import os from 'os';
 import transpiler from 'bson-transpilers';
 
-import type ActiveConnectionCodeLensProvider from './activeConnectionCodeLensProvider';
 import type PlaygroundSelectedCodeActionProvider from './playgroundSelectedCodeActionProvider';
 import type ConnectionController from '../connectionController';
 import { DataServiceEventTypes } from '../connectionController';
@@ -129,12 +128,12 @@ export default class PlaygroundController {
 
   _isPartialRun = false;
 
-  private _activeConnectionCodeLensProvider: ActiveConnectionCodeLensProvider;
   private _playgroundResultViewColumn?: vscode.ViewColumn;
   private _playgroundResultTextDocument?: vscode.TextDocument;
   private _statusView: StatusView;
   private _playgroundResultViewProvider: PlaygroundResultProvider;
   private _participantController: ParticipantController;
+  private _activeConnectionChangedHandler: () => void;
 
   private _codeToEvaluate = '';
 
@@ -144,7 +143,6 @@ export default class PlaygroundController {
     telemetryService,
     statusView,
     playgroundResultViewProvider,
-    activeConnectionCodeLensProvider,
     exportToLanguageCodeLensProvider,
     playgroundSelectedCodeActionProvider,
     participantController,
@@ -154,7 +152,6 @@ export default class PlaygroundController {
     telemetryService: TelemetryService;
     statusView: StatusView;
     playgroundResultViewProvider: PlaygroundResultProvider;
-    activeConnectionCodeLensProvider: ActiveConnectionCodeLensProvider;
     exportToLanguageCodeLensProvider: ExportToLanguageCodeLensProvider;
     playgroundSelectedCodeActionProvider: PlaygroundSelectedCodeActionProvider;
     participantController: ParticipantController;
@@ -165,17 +162,17 @@ export default class PlaygroundController {
     this._telemetryService = telemetryService;
     this._statusView = statusView;
     this._playgroundResultViewProvider = playgroundResultViewProvider;
-    this._activeConnectionCodeLensProvider = activeConnectionCodeLensProvider;
     this._exportToLanguageCodeLensProvider = exportToLanguageCodeLensProvider;
     this._playgroundSelectedCodeActionProvider =
       playgroundSelectedCodeActionProvider;
     this._participantController = participantController;
 
+    this._activeConnectionChangedHandler = () => {
+      void this._activeConnectionChanged();
+    };
     this._connectionController.addEventListener(
       DataServiceEventTypes.ACTIVE_CONNECTION_CHANGED,
-      () => {
-        void this._activeConnectionChanged();
-      }
+      this._activeConnectionChangedHandler
     );
 
     const onDidChangeActiveTextEditor = (
@@ -195,9 +192,6 @@ export default class PlaygroundController {
 
       if (isPlaygroundEditor) {
         this._activeTextEditor = editor;
-        this._activeConnectionCodeLensProvider.setActiveTextEditor(
-          this._activeTextEditor
-        );
         this._playgroundSelectedCodeActionProvider.setActiveTextEditor(
           this._activeTextEditor
         );
@@ -276,8 +270,6 @@ export default class PlaygroundController {
     const connectionId = this._connectionController.getActiveConnectionId();
     let mongoClientOption;
 
-    this._activeConnectionCodeLensProvider.refresh();
-
     if (dataService && connectionId) {
       mongoClientOption =
         this._connectionController.getMongoClientConnectionOptions();
@@ -919,9 +911,7 @@ export default class PlaygroundController {
   deactivate(): void {
     this._connectionController.removeEventListener(
       DataServiceEventTypes.ACTIVE_CONNECTION_CHANGED,
-      () => {
-        // No action is required after removing the listener.
-      }
+      this._activeConnectionChangedHandler
     );
   }
 }
diff --git a/src/mdbExtensionController.ts b/src/mdbExtensionController.ts
@@ -33,7 +33,9 @@ import launchMongoShell from './commands/launchMongoShell';
 import type SchemaTreeItem from './explorer/schemaTreeItem';
 import { StatusView } from './views';
 import { StorageController, StorageVariables } from './storage';
-import TelemetryService from './telemetry/telemetryService';
+import TelemetryService, {
+  TelemetryEventTypes,
+} from './telemetry/telemetryService';
 import type PlaygroundsTreeItem from './explorer/playgroundsTreeItem';
 import PlaygroundResultProvider from './editors/playgroundResultProvider';
 import WebviewController from './views/webviewController';
@@ -117,7 +119,6 @@ export default class MDBExtensionController implements vscode.Disposable {
       telemetryService: this._telemetryService,
       statusView: this._statusView,
       playgroundResultViewProvider: this._playgroundResultViewProvider,
-      activeConnectionCodeLensProvider: this._activeConnectionCodeLensProvider,
       exportToLanguageCodeLensProvider: this._exportToLanguageCodeLensProvider,
       playgroundSelectedCodeActionProvider:
         this._playgroundSelectedCodeActionProvider,
@@ -157,6 +158,7 @@ export default class MDBExtensionController implements vscode.Disposable {
 
     this.registerCommands();
     this.showOverviewPageIfRecentlyInstalled();
+    void this.showSurveyForEstablishedUsers();
   }
 
   registerCommands = (): void => {
@@ -887,6 +889,51 @@ export default class MDBExtensionController implements vscode.Disposable {
     }
   }
 
+  async showSurveyForEstablishedUsers(): Promise<void> {
+    const surveyId = '9viN9wcbsC3zvHyg7';
+
+    const hasBeenShownSurveyAlready =
+      this._storageController.get(StorageVariables.GLOBAL_SURVEY_SHOWN) ===
+      surveyId;
+
+    // Show the survey when it hasn't been show to the
+    // user yet, and they have saved connections
+    // -> they haven't just started using this extension
+    if (
+      hasBeenShownSurveyAlready ||
+      !this._connectionStorage.hasSavedConnections()
+    ) {
+      return;
+    }
+
+    const action = 'Share your thoughts';
+    const text = 'How can we make the MongoDB extension better for you?';
+    const link = 'https://forms.gle/9viN9wcbsC3zvHyg7';
+    const result = await vscode.window.showInformationMessage(
+      text,
+      {},
+      {
+        title: action,
+      }
+    );
+    if (result?.title === action) {
+      void vscode.env.openExternal(vscode.Uri.parse(link));
+      this._telemetryService.track(TelemetryEventTypes.SURVEY_CLICKED, {
+        survey_id: surveyId,
+      });
+    } else {
+      this._telemetryService.track(TelemetryEventTypes.SURVEY_DISMISSED, {
+        survey_id: surveyId,
+      });
+    }
+
+    // whether action was taken or the prompt dismissed, we won't show this again
+    void this._storageController.update(
+      StorageVariables.GLOBAL_SURVEY_SHOWN,
+      surveyId
+    );
+  }
+
   async dispose(): Promise<void> {
     await this.deactivate();
   }
@@ -902,5 +949,7 @@ export default class MDBExtensionController implements vscode.Disposable {
     this._telemetryService.deactivate();
     this._editorsController.deactivate();
     this._webviewController.deactivate();
+    this._activeConnectionCodeLensProvider.deactivate();
+    this._connectionController.deactivate();
   }
 }
diff --git a/src/storage/storageController.ts b/src/storage/storageController.ts
@@ -6,6 +6,7 @@ import type { StoreConnectionInfo } from './connectionStorage';
 export enum StorageVariables {
   // Only exists on globalState.
   GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW = 'GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW',
+  GLOBAL_SURVEY_SHOWN = 'GLOBAL_SURVEY_SHOWN',
   GLOBAL_SAVED_CONNECTIONS = 'GLOBAL_SAVED_CONNECTIONS',
   // Analytics user identify.
   GLOBAL_USER_ID = 'GLOBAL_USER_ID',
@@ -51,6 +52,7 @@ interface StorageVariableContents {
   [StorageVariables.GLOBAL_USER_ID]: string;
   [StorageVariables.GLOBAL_ANONYMOUS_ID]: string;
   [StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW]: boolean;
+  [StorageVariables.GLOBAL_SURVEY_SHOWN]: string;
   [StorageVariables.GLOBAL_SAVED_CONNECTIONS]: ConnectionsFromStorage;
   [StorageVariables.WORKSPACE_SAVED_CONNECTIONS]: ConnectionsFromStorage;
   [StorageVariables.COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE]: boolean;

diff --git a/src/telemetry/telemetryService.ts b/src/telemetry/telemetryService.ts
@@ -77,6 +77,10 @@ type ConnectionEditedTelemetryEventProperties = {
   success: boolean;
 };
 
+type SurveyActionProperties = {
+  survey_id: string;
+};
+
 type SavedConnectionsLoadedProperties = {
   // Total number of connections saved on disk
   saved_connections: number;
@@ -102,7 +106,8 @@ export type TelemetryEventProperties =
   | PlaygroundSavedTelemetryEventProperties
   | PlaygroundLoadedTelemetryEventProperties
   | KeytarSecretsMigrationFailedProperties
-  | SavedConnectionsLoadedProperties;
+  | SavedConnectionsLoadedProperties
+  | SurveyActionProperties;
 
 export enum TelemetryEventTypes {
   PLAYGROUND_CODE_EXECUTED = 'Playground Code Executed',
@@ -120,6 +125,8 @@ export enum TelemetryEventTypes {
   PLAYGROUND_CREATED = 'Playground Created',
   KEYTAR_SECRETS_MIGRATION_FAILED = 'Keytar Secrets Migration Failed',
   SAVED_CONNECTIONS_LOADED = 'Saved Connections Loaded',
+  SURVEY_CLICKED = 'Survey link clicked',
+  SURVEY_DISMISSED = 'Survey prompt dismissed',
 }
 
 /**