Add setting to disable opening saved query results (#22062)

* Add setting to disable opening saved query results

* Update localization for query export setting

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Aasim Khan <aasimkhan@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 3 people

extensions/mssql/package.json

@@ -2033,6 +2033,12 @@
                     "default": null,
                     "scope": "resource"
                 },
+                "mssql.results.openAfterSave": {
+                    "type": "boolean",
+                    "description": "%mssql.results.openAfterSave%",
+                    "default": true,
+                    "scope": "resource"
+                },
                 "mssql.saveAsCsv.includeHeaders": {
                     "type": "boolean",
                     "description": "%mssql.saveAsCsv.includeHeaders%",

extensions/mssql/package.nls.json

@@ -127,6 +127,7 @@
     "mssql.messagesDefaultOpen": "True for the messages pane to be open by default; false for closed",
     "mssql.resultsFontFamily": "Set the font family for the results grid; set to blank to use the editor font",
     "mssql.resultsFontSize": "Set the font size for the results grid; set to blank to use the editor size",
+    "mssql.results.openAfterSave": "When enabled, saved query result exports are opened after export. Excel exports open with the system file handler; text exports open in VS Code.",
     "mssql.saveAsCsv.includeHeaders": "[Optional] When true, column headers are included when saving results as CSV",
     "mssql.saveAsCsv.delimiter": "[Optional] Delimiter for separating data items when saving results as CSV. Choose from common separators like comma (,), tab (\\t), semicolon (;), or pipe (|)",
     "mssql.saveAsCsv.lineSeparator": "[Optional] Character(s) used for separating rows when saving results as CSV",

extensions/mssql/src/constants/constants.ts

@@ -266,6 +266,7 @@ export const configMyConnections = "connections";
 export const configSaveAsCsv = "saveAsCsv";
 export const configSaveAsJson = "saveAsJson";
 export const configSaveAsExcel = "saveAsExcel";
+export const configResultsOpenAfterSave = "results.openAfterSave";
 export const configRecentConnections = "recentConnections";
 export const configMaxRecentConnections = "maxRecentConnections";
 export const configCopyRemoveNewLine = "copyRemoveNewLine";

extensions/mssql/src/models/resultsSerializer.ts

@@ -74,7 +74,7 @@ export default class ResultsSerializer {
 
     private getConfigForCsv(): Contracts.SaveResultsAsCsvRequestParams {
         // get save results config from vscode config
-        let config = this._vscodeWrapper.getConfiguration(
+        const config = this._vscodeWrapper.getConfiguration(
             Constants.extensionConfigSectionName,
             this._uri,
         );
@@ -201,6 +201,14 @@ export default class ResultsSerializer {
         );
     }
 
+    private shouldOpenSavedFile(): boolean {
+        const config = this._vscodeWrapper.getConfiguration(
+            Constants.extensionConfigSectionName,
+            this._uri,
+        );
+        return config.get<boolean>(Constants.configResultsOpenAfterSave, true);
+    }
+
     /**
      * Send request to sql tools service to save a result set
      */
@@ -254,7 +262,9 @@ export default class ResultsSerializer {
                     self._vscodeWrapper.logToOutputChannel(
                         LocalizedConstants.msgSaveSucceeded + filePath,
                     );
-                    self.openSavedFile(self._filePath, format);
+                    if (self.shouldOpenSavedFile()) {
+                        self.openSavedFile(self._filePath, format);
+                    }
                 }
             },
             (error) => {

extensions/mssql/test/unit/saveResults.test.ts

@@ -92,16 +92,20 @@ suite("save results tests", () => {
     function testSaveSuccess(format: string): Thenable<void> {
         configureSuccess();
         const saveResults = createSerializer();
+        const openSavedFileStub = sandbox.stub(saveResults, "openSavedFile");
         return saveResults.onSaveResults(testFile, 0, 0, format, undefined).then(() => {
             expect(vscodeWrapper.showInformationMessage).to.have.been.calledOnce;
+            expect(openSavedFileStub).to.have.been.calledOnceWith(fileUri.fsPath, format);
         });
     }
 
     function testSaveFailure(format: string): Thenable<void> {
         configureFailure("failure");
         const saveResults = createSerializer();
+        const openSavedFileStub = sandbox.stub(saveResults, "openSavedFile");
         return saveResults.onSaveResults(testFile, 0, 0, format, undefined).then(() => {
             expect(vscodeWrapper.showErrorMessage).to.have.been.calledOnce;
+            expect(openSavedFileStub).to.not.have.been.called;
         });
     }
 
@@ -129,6 +133,44 @@ suite("save results tests", () => {
         return testSaveFailure("excel");
     });
 
+    test("Save as CSV - opens saved file when openAfterSave is enabled by default", () => {
+        configureSuccess();
+        const saveResults = createSerializer();
+        const openSavedFileStub = sandbox.stub(saveResults, "openSavedFile");
+
+        return saveResults.onSaveResults(testFile, 0, 0, "csv", undefined).then(() => {
+            expect(openSavedFileStub).to.have.been.calledOnceWith(fileUri.fsPath, "csv");
+        });
+    });
+
+    test("Save as CSV - does not open saved file when openAfterSave is disabled", () => {
+        configureSuccess();
+        (vscodeWrapper.getConfiguration as sinon.SinonStub).returns({
+            get: (key: string) => (key === "results.openAfterSave" ? false : undefined),
+        } as unknown as vscode.WorkspaceConfiguration);
+        const saveResults = createSerializer();
+        const openSavedFileStub = sandbox.stub(saveResults, "openSavedFile");
+
+        return saveResults.onSaveResults(testFile, 0, 0, "csv", undefined).then(() => {
+            expect(vscodeWrapper.showInformationMessage).to.have.been.calledOnce;
+            expect(openSavedFileStub).to.not.have.been.called;
+        });
+    });
+
+    test("Save as Excel - does not open saved file when openAfterSave is disabled", () => {
+        configureSuccess();
+        (vscodeWrapper.getConfiguration as sinon.SinonStub).returns({
+            get: (key: string) => (key === "results.openAfterSave" ? false : undefined),
+        } as unknown as vscode.WorkspaceConfiguration);
+        const saveResults = createSerializer();
+        const openSavedFileStub = sandbox.stub(saveResults, "openSavedFile");
+
+        return saveResults.onSaveResults(testFile, 0, 0, "excel", undefined).then(() => {
+            expect(vscodeWrapper.showInformationMessage).to.have.been.calledOnce;
+            expect(openSavedFileStub).to.not.have.been.called;
+        });
+    });
+
     test("Save as with selection - test if selected range is passed in parameters", () => {
         const selection: Interfaces.ISlickRange[] = [
             {
@@ -179,14 +221,22 @@ suite("save results tests", () => {
         (vscodeWrapper.showSaveDialog as sinon.SinonStub).resolves(undefined);
 
         const saveResults = createSerializer();
+        const openSavedFileStub = sandbox.stub(saveResults, "openSavedFile");
         await saveResults.onSaveResults(testFile, 0, 0, "csv", undefined);
 
         expect(serverClient.sendRequest).to.not.have.been.called;
+        expect(openSavedFileStub).to.not.have.been.called;
     });
 
     test("CSV configuration options are properly applied", (done) => {
         const customWrapper = stubVscodeWrapper(sandbox);
         (customWrapper.showSaveDialog as sinon.SinonStub).resolves(fileUri);
+        (customWrapper.openTextDocument as sinon.SinonStub).resolves(
+            undefined as unknown as vscode.TextDocument,
+        );
+        (customWrapper.showTextDocument as sinon.SinonStub).resolves(
+            undefined as unknown as vscode.TextEditor,
+        );
         (customWrapper.getConfiguration as sinon.SinonStub).returns({
             saveAsCsv: {
                 delimiter: "\t",

localization/xliff/vscode-mssql.xlf

@@ -7998,6 +7998,9 @@
     <trans-unit id="mssql.objectExplorer.collapseConnectionGroupsOnStartupDescription">
       <source xml:lang="en">When enabled, connection groups will be collapsed instead of expanded at startup.</source>
     </trans-unit>
+    <trans-unit id="mssql.results.openAfterSave">
+      <source xml:lang="en">When enabled, saved query result exports are opened after export. Excel exports open with the system file handler; text exports open in VS Code.</source>
+    </trans-unit>
     <trans-unit id="mssql.objectExplorer.groupBySchema">
       <source xml:lang="en">When enabled, the database objects in Object Explorer will be categorized by schema.</source>
     </trans-unit>