chore: allow opting out of the welcome screen VSCODE-697 (#1053)

Author: nirinchev

package.json

@@ -1277,6 +1277,11 @@
               "connectionString"
             ]
           }
+        },
+        "mdb.showOverviewPageAfterInstall": {
+          "type": "boolean",
+          "default": true,
+          "description": "Specify whether to show the overview page immediately after installing the extension."
         }
       }
     },

src/mdbExtensionController.ts

@@ -1018,24 +1018,35 @@ export default class MDBExtensionController implements vscode.Disposable {
   }
 
   showOverviewPageIfRecentlyInstalled(): void {
+    const showOverviewFromSettings = vscode.workspace
+      .getConfiguration('mdb')
+      .get<boolean>('showOverviewPageAfterInstall');
+
+    if (!showOverviewFromSettings) {
+      // Users may opt out of showing the overview page in the settings.
+      return;
+    }
+
     const hasBeenShownViewAlready = !!this._storageController.get(
       StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW,
     );
 
-    // Show the overview page when it hasn't been show to the
-    // user yet, and they have no saved connections.
-    if (!hasBeenShownViewAlready) {
-      if (!this._connectionStorage.hasSavedConnections()) {
-        void vscode.commands.executeCommand(
-          EXTENSION_COMMANDS.MDB_OPEN_OVERVIEW_PAGE,
-        );
-      }
+    if (hasBeenShownViewAlready) {
+      // Don't show the overview page if it has already been shown.
+      return;
+    }
 
-      void this._storageController.update(
-        StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW,
-        true,
+    if (!this._connectionStorage.hasSavedConnections()) {
+      // Only show the overview page if there are no saved connections.
+      void vscode.commands.executeCommand(
+        EXTENSION_COMMANDS.MDB_OPEN_OVERVIEW_PAGE,
       );
     }
+
+    void this._storageController.update(
+      StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW,
+      true,
+    );
   }
 
   async dispose(): Promise<void> {

src/test/suite/mdbExtensionController.test.ts

@@ -1716,6 +1716,32 @@ suite('MDBExtensionController Test Suite', function () {
           assert(!executeCommandStub.called);
         });
       });
+
+      suite('when a user has opted out of the overview page', () => {
+        beforeEach(async () => {
+          await vscode.workspace
+            .getConfiguration('mdb')
+            .update('showOverviewPageAfterInstall', false);
+
+          sandbox.replace(
+            mdbTestExtension.testExtensionController._storageController,
+            'get',
+            sandbox.fake.returns(false),
+          );
+
+          void mdbTestExtension.testExtensionController.showOverviewPageIfRecentlyInstalled();
+        });
+
+        afterEach(async () => {
+          await vscode.workspace
+            .getConfiguration('mdb')
+            .update('showOverviewPageAfterInstall', undefined);
+        });
+
+        test('they are not shown the overview page', () => {
+          assert(!executeCommandStub.called);
+        });
+      });
     });
   });