refactor: rename to presetConnections, update test strict equality, use switch

Author: gagik

.vscode/settings.json

@@ -17,7 +17,7 @@
   },
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
   "typescript.tsc.autoDetect": "off",
-  "mdb.presetSavedConnections": [
+  "mdb.presetConnections": [
     {
       "name": "Preset Database",
       "connectionString": "mongodb://localhost:27017"

package.json

@@ -550,7 +550,7 @@
         },
         {
           "command": "mdb.editPresetConnections",
-          "when": "view == mongoDBConnectionExplorer && (viewItem == connectedPresetConnectionTreeItem)",
+          "when": "view == mongoDBConnectionExplorer && viewItem == connectedPresetConnectionTreeItem",
           "group": "3@2"
         },
         {
@@ -590,7 +590,7 @@
         },
         {
           "command": "mdb.editPresetConnections",
-          "when": "view == mongoDBConnectionExplorer && (viewItem == disconnectedPresetConnectionTreeItem)",
+          "when": "view == mongoDBConnectionExplorer && viewItem == disconnectedPresetConnectionTreeItem",
           "group": "2@2"
         },
         {
@@ -1193,7 +1193,7 @@
           "default": "",
           "description": "Specify a shell command that is run to start the browser for authenticating with the OIDC identity provider for the server connection. Leave this empty for default browser."
         },
-        "mdb.presetSavedConnections": {
+        "mdb.presetConnections": {
           "scope": "window",
           "type": "array",
           "description": "Defines preset saved connections. Can be used to share connection configurations in a workspace or global scope. Do not store sensitive credentials here.",

src/connectionController.ts

@@ -177,9 +177,7 @@ export default class ConnectionController {
     if (!source) {
       const mdbConfiguration = vscode.workspace.getConfiguration('mdb');
 
-      const presetConnections = mdbConfiguration?.inspect(
-        'presetSavedConnections'
-      );
+      const presetConnections = mdbConfiguration?.inspect('presetConnections');
 
       if (presetConnections?.workspaceValue) {
         source = 'workspaceSettings';
@@ -189,20 +187,28 @@ export default class ConnectionController {
         // 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', [
+        await mdbConfiguration.update('presetConnections', [
           {
             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'
-      );
+    switch (source) {
+      case 'globalSettings':
+        await vscode.commands.executeCommand(
+          'workbench.action.openSettingsJson'
+        );
+        break;
+      case 'workspaceSettings':
+      case 'user':
+        await vscode.commands.executeCommand(
+          'workbench.action.openWorkspaceSettingsFile'
+        );
+        break;
+      default:
+        throw new Error('Unknown preset connection source');
     }
   }
 

src/explorer/connectionTreeItem.ts

@@ -209,7 +209,9 @@ export default class ConnectionTreeItem
     return Object.values(this._childrenCache);
   }
 
-  private async _buildChildrenCacheForDatabases(dataService: DataService) {
+  private async _buildChildrenCacheForDatabases(
+    dataService: DataService
+  ): Promise<Record<string, DatabaseTreeItem>> {
     const databases = await this.listDatabases();
     databases.sort((a: string, b: string) => a.localeCompare(b));
 
@@ -231,7 +233,9 @@ export default class ConnectionTreeItem
     return newChildrenCache;
   }
 
-  private async _buildChildrenCacheForStreams(dataService: DataService) {
+  private async _buildChildrenCacheForStreams(
+    dataService: DataService
+  ): Promise<Record<string, StreamProcessorTreeItem>> {
     const processors = await this.listStreamProcessors();
     processors.sort((a, b) => a.name.localeCompare(b.name));
 

src/mdbExtensionController.ts

@@ -162,7 +162,7 @@ export default class MDBExtensionController implements vscode.Disposable {
 
   subscribeToConfigurationChanges(): void {
     const subscription = vscode.workspace.onDidChangeConfiguration((event) => {
-      if (event.affectsConfiguration('mdb.presetSavedConnections')) {
+      if (event.affectsConfiguration('mdb.presetConnections')) {
         void this._connectionController.loadSavedConnections();
       }
     });

src/storage/connectionStorage.ts

@@ -180,28 +180,27 @@ export class ConnectionStorage {
     );
   }
 
-  _loadPresetSavedConnections(): LoadedConnection[] {
+  _loadPresetConnections(): LoadedConnection[] {
     const configuration = vscode.workspace.getConfiguration('mdb');
-    const presetSavedConnectionsInfo = configuration.inspect<
-      PresetSavedConnection[]
-    >('presetSavedConnections');
+    const presetConnectionsInfo =
+      configuration.inspect<PresetSavedConnection[]>('presetConnections');
 
-    if (!presetSavedConnectionsInfo) {
+    if (!presetConnectionsInfo) {
       return [];
     }
 
-    const combinedPresetSavedConnections: PresetSavedConnectionWithSource[] = [
-      ...(presetSavedConnectionsInfo?.globalValue ?? []).map((preset) => ({
+    const combinedPresetConnections: PresetSavedConnectionWithSource[] = [
+      ...(presetConnectionsInfo?.globalValue ?? []).map((preset) => ({
         ...preset,
         source: 'globalSettings' as const,
       })),
-      ...(presetSavedConnectionsInfo?.workspaceValue ?? []).map((preset) => ({
+      ...(presetConnectionsInfo?.workspaceValue ?? []).map((preset) => ({
         ...preset,
         source: 'workspaceSettings' as const,
       })),
     ];
 
-    return combinedPresetSavedConnections.map((presetConnection) => ({
+    return combinedPresetConnections.map((presetConnection) => ({
       id: uuidv4(),
       name: presetConnection.name,
       connectionOptions: {
@@ -250,9 +249,9 @@ export class ConnectionStorage {
       })
     );
 
-    const presetSavedConnections = this._loadPresetSavedConnections();
+    const presetConnections = this._loadPresetConnections();
 
-    return [...loadedConnections, ...presetSavedConnections];
+    return [...loadedConnections, ...presetConnections];
   }
 
   async removeConnection(connectionId: string): Promise<void> {

src/test/suite/storage/connectionStorage.test.ts

@@ -349,11 +349,11 @@ suite('Connection Storage Test Suite', function () {
         ],
         vscode.WorkspaceConfiguration
       >;
-      let inspectPresetSavedConnectionsStub: sinon.SinonStub;
+      let inspectPresetConnectionsStub: sinon.SinonStub;
 
       beforeEach(() => {
         testSandbox.restore();
-        inspectPresetSavedConnectionsStub = testSandbox.stub();
+        inspectPresetConnectionsStub = testSandbox.stub();
       });
 
       test('loads the preset connections', async () => {
@@ -362,12 +362,12 @@ suite('Connection Storage Test Suite', function () {
           'getConfiguration'
         );
         getConfigurationStub.returns({
-          inspect: inspectPresetSavedConnectionsStub,
+          inspect: inspectPresetConnectionsStub,
           get: () => undefined,
         } as any);
 
-        inspectPresetSavedConnectionsStub
-          .withArgs('presetSavedConnections')
+        inspectPresetConnectionsStub
+          .withArgs('presetConnections')
           .returns(presetConnections);
 
         const loadedConnections = await testConnectionStorage.loadConnections();
@@ -391,7 +391,7 @@ suite('Connection Storage Test Suite', function () {
           const connection = loadedConnections[i];
           const expected = expectedConnectionValues[i];
           expect(connection.name).equals(expected.name);
-          expect(connection.connectionOptions.connectionString).contains(
+          expect(connection.connectionOptions.connectionString).equals(
             expected.connectionString
           );
           expect(connection.source).equals(expected.source);
@@ -407,12 +407,12 @@ suite('Connection Storage Test Suite', function () {
           'getConfiguration'
         );
         getConfigurationStub.returns({
-          inspect: inspectPresetSavedConnectionsStub,
+          inspect: inspectPresetConnectionsStub,
           get: () => undefined,
         } as any);
 
-        inspectPresetSavedConnectionsStub
-          .withArgs('presetSavedConnections')
+        inspectPresetConnectionsStub
+          .withArgs('presetConnections')
           .returns(presetConnections);
 
         const loadedConnections = await testConnectionStorage.loadConnections();
@@ -442,7 +442,7 @@ suite('Connection Storage Test Suite', function () {
           const connection = loadedConnections[i];
           const expected = expectedConnectionValues[i];
           expect(connection.name).equals(expected.name);
-          expect(connection.connectionOptions.connectionString).contains(
+          expect(connection.connectionOptions.connectionString).equals(
             expected.connectionString
           );
           expect(connection.source).equals(expected.source);