[Fix] Prompt and get acknowledge to update the missing projectGuid in sqlprojects by ssreerama · Pull Request #21524 · microsoft/vscode-mssql

ssreerama · 2026-03-09T17:20:29Z

Description

This pull request :

Ensures SQL projects have a valid ProjectGuid, which is important for cross-project references.
The changes add user prompts and automated handling for missing or invalid GUIDs as workspace leve, one toast message for all proejcts.
A debounce mechanism collects all projects opened within a 500ms window (the typical workspace load burst) so only one toast is shown instead of one per project. (Reason: there is no bulk hook or completion signal we can listen to)
Provided tests for the new behavior.
Additionally, a new request type is implemented to support updating project properties for STS handler.

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

github-actions · 2026-03-09T17:29:55Z

PR Changes

Category	Target Branch	PR Branch	Difference
vscode-mssql VSIX	6454 KB	6452 KB	⚪ -2 KB ( 0% )
sql-database-projects VSIX	7062 KB	7066 KB	⚪ 4 KB ( 0% )
data-workspace VSIX	535 KB	535 KB	⚪ 0 KB ( 0% )

codecov-commenter · 2026-03-09T18:22:50Z

Codecov Report

❌ Patch coverage is 64.00000% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.91%. Comparing base (3a32e24) to head (0df71a4).
⚠️ Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
...xtensions/mssql/src/services/sqlProjectsService.ts	43.75%	9 Missing ⚠️

❌ Your patch status has failed because the patch coverage (64.00%) is below the target coverage (70.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #21524      +/-   ##
==========================================
- Coverage   72.91%   72.91%   -0.01%     
==========================================
  Files         326      326              
  Lines       98731    98756      +25     
  Branches     5569     5570       +1     
==========================================
+ Hits        71992    72008      +16     
- Misses      26739    26748       +9

Files with missing lines	Coverage Δ
...dels/contracts/sqlProjects/sqlProjectsContracts.ts	`100.00% <100.00%> (ø)`
...xtensions/mssql/src/services/sqlProjectsService.ts	`48.04% <43.75%> (-0.10%)`	⬇️

🚀 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.

…rops get scenario

Copilot

Pull request overview

This PR adds a new user-facing flow and supporting API surface to ensure SQL projects have a valid ProjectGuid, enabling reliable cross-project references and avoiding the all-zeros GUID behavior seen when <ProjectGuid> is missing.

Changes:

Adds a prompt to detect missing/null ProjectGuid and optionally generate/write a new GUID to the project.
Introduces a new setProjectProperties request/contract and public typings to update SQL project properties via STS.
Adds unit tests and localization strings for the new prompt/label.

Reviewed changes

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

Show a summary per file

File	Description
typings/vscode-mssql.d.ts	Exposes `setProjectProperties` and `SetProjectPropertiesParams` in the public API typings.
localization/xliff/sql-database-projects.xlf	Adds new trans-units for “Add ProjectGuid” and the missing-guid prompt text.
extensions/sql-database-projects/test/project.test.ts	Adds tests for prompting behavior and GUID generation/update path.
extensions/sql-database-projects/src/models/project.ts	Implements prompt + GUID generation/write logic and calls it during project open/update.
extensions/sql-database-projects/src/common/constants.ts	Adds localized label/message constants and the null GUID constant.
extensions/sql-database-projects/l10n/bundle.l10n.json	Adds the corresponding localized strings for runtime lookup.
extensions/mssql/typings/vscode-mssql.d.ts	Mirrors the public API typing additions in the extension-local typings.
extensions/mssql/src/services/sqlProjectsService.ts	Adds client-side `setProjectProperties` implementation that issues the new request.
extensions/mssql/src/models/contracts/sqlProjects/sqlProjectsContracts.ts	Defines the new `SetProjectPropertiesRequest` request type/route.

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

extensions/sql-database-projects/test/project.test.ts

extensions/sql-database-projects/src/models/project.ts

localization/xliff/sql-database-projects.xlf

extensions/sql-database-projects/test/project.test.ts

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

localization/xliff/sql-database-projects.xlf

extensions/sql-database-projects/src/models/project.ts

extensions/sql-database-projects/test/project.test.ts

allancascante · 2026-03-13T18:46:31Z

@ssreerama please check the failing test before merging the changes.

extensions/sql-database-projects/src/models/project.ts

ssreerama · 2026-03-13T20:39:53Z

@ssreerama please check the failing test before merging the changes.

This PR requires the STS change, probably the failing test is related to it.

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

extensions/sql-database-projects/test/project.test.ts

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

extensions/sql-database-projects/src/models/project.ts

extensions/sql-database-projects/test/project.test.ts

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

extensions/sql-database-projects/src/models/project.ts

…ffected projects

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

extensions/sql-database-projects/src/models/project.ts

Copilot

Pull request overview

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

Copilot · 2026-03-19T23:34:08Z

extensions/sql-database-projects/src/models/project.ts

+    public static async checkPromptProjectGuidStatus(projects: Project[]): Promise<void> {
+        // De-duplicate by projectFilePath in case the same project was queued
+        // multiple times or this method is called directly with duplicates.
+        const uniqueProjects = projects.filter(
+            (p, index, self) =>
+                self.findIndex((q) => q.projectFilePath === p.projectFilePath) === index,
+        );
+
+        if (uniqueProjects.length === 0) {
+            return;
+        }


checkPromptProjectGuidStatus builds uniqueProjects only by de-duplicating the input list, but it never filters to projects that are currently missing a GUID. This can lead to showing a prompt even when none of the projects passed in actually need fixing (e.g., if a caller passes mixed projects, or a project's GUID is updated between queueing and prompt display). Consider filtering uniqueProjects with isMissingProjectGuid() before building the message, and returning early if the filtered list is empty.

Copilot · 2026-03-19T23:34:09Z

extensions/sql-database-projects/src/models/project.ts

+    public async ensureValidProjectGuid(): Promise<void> {
+        if (!this.isMissingProjectGuid()) {
+            return;
+        }
+        const guid = `{${randomUUID().toUpperCase()}}`;
+        const result = await this.sqlProjService.setProjectProperties(this.projectFilePath, {
+            [constants.ProjectGuid]: guid,
+        });
+        utils.throwIfFailed(result);
+        this._projectGuid = guid;


ensureValidProjectGuid is described as idempotent, but it only checks the in-memory _projectGuid before writing. Since Project.openProject creates new Project instances per call, it’s possible for _projectGuid to be stale relative to the underlying .sqlproj/STS state (e.g., another instance already added a GUID). In that case, this method could overwrite an existing valid GUID. Consider re-reading the current projectGuid from getProjectProperties (or readProjectProperties) immediately before calling setProjectProperties, and only writing when the persisted value is still missing/null.

Copilot · 2026-03-19T23:34:09Z

extensions/sql-database-projects/test/project.test.ts

+                    project2.projectFileName,
+                ]),
+            ),
+            `showInformationMessage not called with expected message. Actual: "${showInfoStub.firstCall.args[0]}"`,


This test uses showInfoStub.firstCall.args[0] to report the actual message. Repo review guidance recommends avoiding “n-th call”/call-index inspection (e.g., firstCall, getCall(0)) because it’s brittle. Prefer asserting the stub was called with the expected message using calledWith/calledWithMatch (and, if needed, use a matcher to capture the argument) instead of inspecting a specific call index.

Suggested change

`showInformationMessage not called with expected message. Actual: "${showInfoStub.firstCall.args[0]}"`,

"showInformationMessage not called with expected message",

ssreerama added 2 commits March 9, 2026 12:07

Show info message to customer for proj guid update during guid abscence

fa9745a

loc

9348382

ssreerama self-assigned this Mar 9, 2026

ssreerama added this to the April 2026 Release milestone Mar 9, 2026

ssreerama added 2 commits March 9, 2026 13:35

fixing tests

91fb35b

moving the check inside the promptIfneeded should not prompt on all p…

838100a

…rops get scenario

ssreerama marked this pull request as ready for review March 10, 2026 21:00

ssreerama requested review from aasimkhan30, caohai, kburtram and laurenastrid1 as code owners March 10, 2026 21:00

Copilot AI review requested due to automatic review settings March 10, 2026 21:00

ssreerama requested review from Benjin, allancascante, lewis-sanchez and manujoseph85 as code owners March 10, 2026 21:00

Copilot started reviewing on behalf of ssreerama March 10, 2026 21:01 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Merge branch 'main' into sai/mar/ssdtProjGuidFix

462eb02

ssreerama requested a review from dzsquared March 13, 2026 18:01

addressing copilot comments

49b9cea

Copilot AI review requested due to automatic review settings March 13, 2026 18:19

Copilot started reviewing on behalf of ssreerama March 13, 2026 18:20 View session

Copilot AI reviewed Mar 13, 2026

View reviewed changes

allancascante previously approved these changes Mar 13, 2026

View reviewed changes

lewis-sanchez reviewed Mar 13, 2026

View reviewed changes

extensions/sql-database-projects/src/models/project.ts Outdated Show resolved Hide resolved

lewis-sanchez reviewed Mar 13, 2026

View reviewed changes

extensions/sql-database-projects/src/models/project.ts Outdated Show resolved Hide resolved

test fix, missing templates setup

e651dc6

ssreerama dismissed allancascante’s stale review via e651dc6 March 13, 2026 20:38

ssreerama requested a review from Copilot March 13, 2026 20:40

Copilot started reviewing on behalf of ssreerama March 13, 2026 20:41 View session

Copilot AI reviewed Mar 13, 2026

View reviewed changes

extensions/sql-database-projects/test/project.test.ts Outdated Show resolved Hide resolved

extensions/sql-database-projects/test/project.test.ts Outdated Show resolved Hide resolved

addressing comments

45af164

ssreerama linked an issue Mar 13, 2026 that may be closed by this pull request

[Bug]: SQL Database Projects generates invalid all-zeros ProjectGuid and modifies files without consent #21156

Open

2 tasks

ssreerama added 2 commits March 16, 2026 10:46

Merge branch 'main' into sai/mar/ssdtProjGuidFix

9858707

Merge branch 'main' into sai/mar/ssdtProjGuidFix

ce35283

Copilot AI review requested due to automatic review settings March 18, 2026 21:16

Copilot AI reviewed Mar 18, 2026

View reviewed changes

extensions/sql-database-projects/src/models/project.ts Outdated Show resolved Hide resolved

extensions/sql-database-projects/src/models/project.ts Outdated Show resolved Hide resolved

extensions/sql-database-projects/test/project.test.ts Outdated Show resolved Hide resolved

ssreerama added 2 commits March 18, 2026 17:21

fixes

243cffb

Merge branch 'main' into sai/mar/ssdtProjGuidFix

8f511f5

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

Copilot AI reviewed Mar 18, 2026

View reviewed changes

ssreerama added 4 commits March 19, 2026 06:53

converting the confirmation to workspace level instead of project

b991289

loc

837f319

Batch missing-GUID prompt: single consolidated notification for all a…

130f388

…ffected projects

refactoring tests and removing duplicate scenario validations

7c0ed8e

Copilot AI review requested due to automatic review settings March 19, 2026 12:15

Copilot AI reviewed Mar 19, 2026

View reviewed changes

addressing copilot comments

0df71a4

ssreerama requested review from Benjin, allancascante, Copilot and lewis-sanchez March 19, 2026 23:27

Copilot started reviewing on behalf of ssreerama March 19, 2026 23:29 View session

Copilot AI reviewed Mar 19, 2026

View reviewed changes

kburtram approved these changes Mar 20, 2026

View reviewed changes

	`showInformationMessage not called with expected message. Actual: "${showInfoStub.firstCall.args[0]}"`,
	"showInformationMessage not called with expected message",

Conversation

ssreerama commented Mar 9, 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!

github-actions bot commented Mar 9, 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 9, 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

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

allancascante commented Mar 13, 2026

Uh oh!

Uh oh!

Uh oh!

ssreerama commented Mar 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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!

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!

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

ssreerama commented Mar 9, 2026 •

edited

Loading

github-actions bot commented Mar 9, 2026 •

edited

Loading

codecov-commenter commented Mar 9, 2026 •

edited

Loading