making query history persistent by aasimkhan30 · Pull Request #21544 · microsoft/vscode-mssql

aasimkhan30 · 2026-03-10T02:43:25Z

Description

Partially address: #21196

Query history is now restored from and written to an AES-256-GCM encrypted file in extension global storage, with the encryption key kept in SecretStorage.

Code Changes Checklist

New or updated unit tests added
All existing tests pass (npm run test)
Code follows contributing guidelines
Telemetry/logging updated if relevant
No regressions or UX breakage

Reviewers: Please read our reviewer guidelines

…ctionality

Copilot

Pull request overview

Adds persistence for the MSSQL Query History tree so entries can be restored across VS Code sessions (partial progress toward #21196).

Changes:

Persist/restore query history via ExtensionContext.secrets in QueryHistoryProvider, with versioned payload + bounds on stored nodes/query length.
Wire ExtensionContext into QueryHistoryProvider from MainController and add a dedicated SecretStorage key constant.
Add unit tests covering persistence/restore behavior and edge cases; expose isSuccess getter on QueryHistoryNode.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
extensions/mssql/src/queryHistory/queryHistoryProvider.ts	Implements query history persistence/restore and adjusts node handling/sorting.
extensions/mssql/src/controllers/mainController.ts	Passes `ExtensionContext` into `QueryHistoryProvider`.
extensions/mssql/src/constants/constants.ts	Adds `queryHistorySecretStorageKey` constant for persistence.
extensions/mssql/src/queryHistory/queryHistoryNode.ts	Adds `isSuccess` getter used by persistence/tests.
extensions/mssql/test/unit/queryHistoryProvider.test.ts	Adds unit test coverage for persistence/restore and related behaviors.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

extensions/mssql/src/queryHistory/queryHistoryProvider.ts

github-actions · 2026-03-10T02:54:22Z

PR Changes

Category	Target Branch	PR Branch	Difference
vscode-mssql VSIX	6452 KB	6411 KB	⚪ -41 KB ( 0% )
sql-database-projects VSIX	7062 KB	7061 KB	⚪ -1 KB ( 0% )
data-workspace VSIX	535 KB	535 KB	⚪ 0 KB ( 0% )

codecov-commenter · 2026-03-10T02:55:00Z

Codecov Report

❌ Patch coverage is 76.47059% with 76 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.80%. Comparing base (a41239d) to head (bd83c7b).
⚠️ Report is 61 commits behind head on main.

Files with missing lines	Patch %	Lines
...ons/mssql/src/queryHistory/queryHistoryProvider.ts	71.60%	71 Missing ⚠️
extensions/mssql/src/utils/encryptionUtils.ts	93.93%	4 Missing ⚠️
extensions/mssql/src/controllers/mainController.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #21544      +/-   ##
==========================================
+ Coverage   72.67%   72.80%   +0.12%     
==========================================
  Files         331      332       +1     
  Lines       98489    98802     +313     
  Branches     5462     5495      +33     
==========================================
+ Hits        71580    71934     +354     
+ Misses      26909    26868      -41

Files with missing lines	Coverage Δ
extensions/mssql/src/constants/constants.ts	`100.00% <100.00%> (ø)`
...ensions/mssql/src/queryHistory/queryHistoryNode.ts	`96.90% <100.00%> (+48.52%)`	⬆️
extensions/mssql/src/controllers/mainController.ts	`33.92% <0.00%> (-0.02%)`	⬇️
extensions/mssql/src/utils/encryptionUtils.ts	`93.93% <93.93%> (ø)`
...ons/mssql/src/queryHistory/queryHistoryProvider.ts	`67.28% <71.60%> (+29.52%)`	⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Added encryptionUtils.ts for data encryption and decryption using AES-256-GCM. - Implemented functions to generate encryption keys, encrypt data, and decrypt data. - Created unit tests for encryption utilities to ensure functionality and security. - Updated queryHistoryProvider tests to utilize encrypted storage for query history. - Ensured sensitive data, such as passwords, are handled securely during storage and retrieval.

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-10T18:13:19Z

extensions/mssql/src/queryHistory/queryHistoryProvider.ts

+        const persistedCredentials = { ...credentials };
+        if ((credentials as IConnectionProfile).savePassword === false) {
+            persistedCredentials.password = "";
+        }
+


sanitizeCredentialsForPersistence currently persists the entire IConnectionInfo object (including fields like azureAccountToken/expiresOn and potentially connectionString, which may embed credentials). Even though the file is encrypted, persisting access tokens/connection strings extends the lifetime of secrets and increases exposure risk. Consider persisting a minimal, explicit allow-list (e.g., server/database/authenticationType/user and only password when savePassword=true), and explicitly omit azureAccountToken/expiresOn/connectionString (or scrub secrets from it) before writing.

Suggested change

const persistedCredentials = { ...credentials };

if ((credentials as IConnectionProfile).savePassword === false) {

persistedCredentials.password = "";

}

const savePassword = (credentials as IConnectionProfile).savePassword;

const passwordToPersist =

savePassword === false ? "" : (credentials as vscodeMssql.IConnectionInfo).password;

// Explicitly allow-list non-sensitive fields needed to restore context.

// Do not persist access tokens, expiry times, or connection strings.

const persistedCredentials = {

server: credentials.server,

database: credentials.database,

authenticationType: credentials.authenticationType,

user: (credentials as vscodeMssql.IConnectionInfo).user,

password: passwordToPersist,

} as vscodeMssql.IConnectionInfo;

extensions/mssql/src/queryHistory/queryHistoryProvider.ts

…ve structure

extensions/mssql/src/queryHistory/queryHistoryProvider.ts

… test expectations

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

extensions/mssql/src/queryHistory/queryHistoryProvider.ts

Aasim Khan added 4 commits March 2, 2026 07:10

Add query history secret storage and enhance QueryHistoryProvider fun…

480b0c2

…ctionality

Merge remote-tracking branch 'origin/main' into aasim/fix/queryHistory

926168d

Merge remote-tracking branch 'origin/main' into aasim/fix/queryHistory

01e68de

Adding tests

f1eae54

Copilot AI review requested due to automatic review settings March 10, 2026 02:43

aasimkhan30 requested review from Benjin, allancascante, caohai, kburtram, laurenastrid1, lewis-sanchez, manujoseph85 and ssreerama as code owners March 10, 2026 02:43

Copilot started reviewing on behalf of aasimkhan30 March 10, 2026 02:44 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Aasim Khan added 2 commits March 10, 2026 10:46

Merge remote-tracking branch 'origin/main' into aasim/fix/queryHistory

0a62cd7

Copilot AI review requested due to automatic review settings March 10, 2026 18:09

Copilot started reviewing on behalf of aasimkhan30 March 10, 2026 18:10 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Refactor query history tests to enhance encryption handling and impro…

ad04f33

…ve structure

aasimkhan30 changed the title ~~making query history persistent across session~~ making query history persistent Mar 18, 2026

kburtram previously approved these changes Mar 18, 2026

View reviewed changes

extensions/mssql/src/queryHistory/queryHistoryProvider.ts Outdated Show resolved Hide resolved

lewis-sanchez previously approved these changes Mar 18, 2026

View reviewed changes

Refactor query history persistence to remove length limits and adjust…

bd83c7b

… test expectations

Copilot AI review requested due to automatic review settings March 18, 2026 23:03

aasimkhan30 dismissed stale reviews from lewis-sanchez and kburtram via bd83c7b March 18, 2026 23:03

Copilot AI reviewed Mar 18, 2026

View reviewed changes

kburtram approved these changes Mar 18, 2026

View reviewed changes

lewis-sanchez approved these changes Mar 18, 2026

View reviewed changes

aasimkhan30 merged commit 539d3e2 into main Mar 18, 2026
7 checks passed

aasimkhan30 deleted the aasim/fix/queryHistory branch March 18, 2026 23:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

making query history persistent#21544

making query history persistent#21544
aasimkhan30 merged 8 commits intomainfrom
aasim/fix/queryHistory

aasimkhan30 commented Mar 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 10, 2026 •

edited

Loading

Uh oh!

codecov-commenter commented Mar 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

-        const persistedCredentials = { ...credentials };
-        if ((credentials as IConnectionProfile).savePassword === false) {
-            persistedCredentials.password = "";
-        }
+        const savePassword = (credentials as IConnectionProfile).savePassword;
+        const passwordToPersist =
+            savePassword === false ? "" : (credentials as vscodeMssql.IConnectionInfo).password;
+        // Explicitly allow-list non-sensitive fields needed to restore context.
+        // Do not persist access tokens, expiry times, or connection strings.
+        const persistedCredentials = {
+            server: credentials.server,
+            database: credentials.database,
+            authenticationType: credentials.authenticationType,
+            user: (credentials as vscodeMssql.IConnectionInfo).user,
+            password: passwordToPersist,
+        } as vscodeMssql.IConnectionInfo;

Conversation

aasimkhan30 commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Code Changes Checklist

Reviewers: Please read our reviewer guidelines

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Changes

Uh oh!

codecov-commenter commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

aasimkhan30 commented Mar 10, 2026 •

edited

Loading

github-actions bot commented Mar 10, 2026 •

edited

Loading

codecov-commenter commented Mar 10, 2026 •

edited

Loading