feat(tree-explorer): allow running edit preset connections from the header

Running from header will automatically determine which scope to open and create a preset to edit if none are defined

Author: gagik

.vscode/settings.json

@@ -17,13 +17,10 @@
   },
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
   "typescript.tsc.autoDetect": "off",
-  "mdb.presetSavedConnections":[
+  "mdb.presetSavedConnections": [
     {
-      "name": "Local Test Connection",
+      "name": "Preset Database",
       "connectionString": "mongodb://localhost:27017"
     }
-  ],
-  "conventionalCommits.scopes": [
-    "tree-explorer"
   ]
 }

package.json

@@ -493,11 +493,18 @@
         },
         {
           "command": "mdb.addConnection",
-          "when": "view == mongoDBConnectionExplorer"
+          "when": "view == mongoDBConnectionExplorer",
+          "group": "1@1"
         },
         {
           "command": "mdb.addConnectionWithURI",
-          "when": "view == mongoDBConnectionExplorer"
+          "when": "view == mongoDBConnectionExplorer",
+          "group": "1@2"
+        },
+        {
+          "command": "mdb.editPresetConnections",
+          "when": "view == mongoDBConnectionExplorer",
+          "group": "2@1"
         }
       ],
       "view/item/context": [
@@ -1189,11 +1196,11 @@
         "mdb.presetSavedConnections": {
           "scope": "window",
           "type": "array",
-          "description": "Defines preset saved connections.",
+          "description": "Defines preset saved connections. Can be used to share connection configurations in a workspace or global scope. Do not store sensitive credentials here.",
           "examples": [
             [
               {
-                "name": "Local Test Connection",
+                "name": "Preset Database",
                 "connectionString": "mongodb://localhost:27017"
               }
             ]
@@ -1202,7 +1209,7 @@
             "type": "object",
             "examples": [
               {
-                "name": "Local Test Connection",
+                "name": "Preset Database",
                 "connectionString": "mongodb://localhost:27017"
               }
             ],

src/connectionController.ts

@@ -21,10 +21,15 @@ import type { StorageController } from './storage';
 import type { StatusView } from './views';
 import type TelemetryService from './telemetry/telemetryService';
 import { openLink } from './utils/linkHelper';
-import type { LoadedConnection } from './storage/connectionStorage';
+import type {
+  ConnectionSource,
+  LoadedConnection,
+} from './storage/connectionStorage';
 import { ConnectionStorage } from './storage/connectionStorage';
 import LINKS from './utils/links';
 import { isAtlasStream } from 'mongodb-build-info';
+import { DocumentSource } from './documentSource';
+import type { ConnectionTreeItem } from './explorer';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageJSON = require('../package.json');
@@ -161,6 +166,46 @@ export default class ConnectionController {
     });
   }
 
+  async openPresetConnectionsSettings(
+    originTreeItem: ConnectionTreeItem | undefined
+  ): Promise<void> {
+    this._telemetryService.trackPresetConnectionEdited({
+      source: DocumentSource.DOCUMENT_SOURCE_TREEVIEW,
+      source_details: originTreeItem ? 'tree_item' : 'header',
+    });
+    let source: ConnectionSource | undefined = originTreeItem?.source;
+    if (!source) {
+      const mdbConfiguration = vscode.workspace.getConfiguration('mdb');
+
+      const presetConnections = mdbConfiguration?.inspect(
+        'presetSavedConnections'
+      );
+
+      if (presetConnections?.workspaceValue) {
+        source = 'workspaceSettings';
+      } else if (presetConnections?.globalValue) {
+        source = 'globalSettings';
+      } else {
+        // If no preset settings exist in workspace and global scope,
+        // set a default one inside the workspace and open it.
+        source = 'workspaceSettings';
+        await mdbConfiguration.update('presetSavedConnections', [
+          {
+            name: 'Preset Database',
+            connectionString: 'mongodb://localhost:27017',
+          },
+        ]);
+      }
+    }
+    if (originTreeItem?.source === 'globalSettings') {
+      await vscode.commands.executeCommand('workbench.action.openSettingsJson');
+    } else {
+      await vscode.commands.executeCommand(
+        'workbench.action.openWorkspaceSettingsFile'
+      );
+    }
+  }
+
   async loadSavedConnections(): Promise<void> {
     this._connections = Object.create(null);
 

src/mdbExtensionController.ts

@@ -492,16 +492,8 @@ export default class MDBExtensionController implements vscode.Disposable {
     );
     this.registerCommand(
       EXTENSION_COMMANDS.MDB_EDIT_PRESET_CONNECTIONS,
-      async (element: ConnectionTreeItem) => {
-        if (element.source === 'workspaceSettings') {
-          await vscode.commands.executeCommand(
-            'workbench.action.openWorkspaceSettingsFile'
-          );
-        } else if (element.source === 'globalSettings') {
-          await vscode.commands.executeCommand(
-            'workbench.action.openSettingsJson'
-          );
-        }
+      async (element: ConnectionTreeItem | undefined) => {
+        await this._connectionController.openPresetConnectionsSettings(element);
         return true;
       }
     );

src/telemetry/telemetryService.ts

@@ -91,6 +91,8 @@ type ConnectionEditedTelemetryEventProperties = {
 type SavedConnectionsLoadedProperties = {
   // Total number of connections saved on disk
   saved_connections: number;
+  // Total number of connections from preset settings
+  preset_connections: number;
   // Total number of connections that extension was able to load, it might
   // differ from saved_connections since there might be failures in loading
   // secrets for a connection in which case we don't list the connections in the
@@ -145,6 +147,11 @@ export type ParticipantChatOpenedFromActionProperties = {
   command?: ParticipantCommandType;
 };
 
+export type PresetSavedConnectionEditedProperties = {
+  source: DocumentSource;
+  source_details: 'tree_item' | 'header';
+};
+
 export type ParticipantInputBoxSubmitted = {
   source: DocumentSource;
   input_length: number | undefined;
@@ -216,6 +223,7 @@ export enum TelemetryEventTypes {
   /** Tracks after a participant interacts with the input box we open to let the user write the prompt for participant. */
   PARTICIPANT_INPUT_BOX_SUBMITTED = 'Participant Inbox Box Submitted',
   PARTICIPANT_RESPONSE_GENERATED = 'Participant Response Generated',
+  PRESET_CONNECTION_EDITED = 'Preset Connection Edited',
 }
 
 /**
@@ -446,6 +454,12 @@ export default class TelemetryService {
     );
   }
 
+  trackPresetConnectionEdited(
+    props: PresetSavedConnectionEditedProperties
+  ): void {
+    this.track(TelemetryEventTypes.PRESET_CONNECTION_EDITED, props);
+  }
+
   trackPlaygroundCreated(playgroundType: string): void {
     this.track(TelemetryEventTypes.PLAYGROUND_CREATED, {
       playground_type: playgroundType,

src/test/suite/telemetry/telemetryService.test.ts

@@ -672,6 +672,7 @@ suite('Telemetry Controller Test Suite', () => {
     testTelemetryService.trackSavedConnectionsLoaded({
       saved_connections: 3,
       loaded_connections: 3,
+      preset_connections: 3,
       connections_with_secrets_in_keytar: 0,
       connections_with_secrets_in_secret_storage: 3,
     });
@@ -684,6 +685,7 @@ suite('Telemetry Controller Test Suite', () => {
         properties: {
           saved_connections: 3,
           loaded_connections: 3,
+          preset_connections: 3,
           connections_with_secrets_in_keytar: 0,
           connections_with_secrets_in_secret_storage: 3,
         },