Extension UI cleanup with multiple SQL extension #21101

aasimkhan30 · 2026-02-05T08:26:44Z

Description

Fixes: #20357

This PR implements a URI ownership coordination system between the MSSQL and PostgreSQL VS Code extensions. When both extensions are installed, they now coordinate to ensure only one extension shows UI elements (status bar, CodeLens) for a given SQL file at a time, based on which extension has an active connection to that file.

Problem

When both MSSQL and PostgreSQL extensions are installed, users experienced:

Duplicate status bar items (both extensions showing "Connect" or connection status)
Duplicate CodeLens prompts at the top of SQL files
Confusion about which extension is managing a particular SQL file
Ability to accidentally run commands against the wrong database type

Solution

Implemented a UriOwnershipCoordinator that:

Exposes an API (uriOwnershipApi) for other extensions to query URI ownership
Listens for ownership changes from coordinating extensions
Hides UI elements when another extension owns the active file
Shows informative messages when users try to use commands on files owned by another extension

Behavior

Scenario	MSSQL UI	PostgreSQL UI
File not connected to either	Show	Shown
File connected to MSSQL	Shown	Hidden
File connected to PostgreSQL	Hidden	Shown

User-Facing Messages

When a user tries to connect or run a query on a file connected to PostgreSQL through commands:

"This file is currently connected to PostgreSQL. Please disconnect from PostgreSQL before proceeding."

Backward Compatibility

✅ Works normally if PostgreSQL extension is not installed
✅ Works normally if PostgreSQL extension doesn't have uriOwnershipApi (older version)
✅ No breaking changes to existing MSSQL functionality
✅ Graceful degradation - both extensions work independently if coordination unavailable

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

…oord

…and UI visibility

…L command labels

Copilot

Pull request overview

This PR implements a URI ownership coordination system between the MSSQL and PostgreSQL VS Code extensions to prevent duplicate UI elements (status bar items, CodeLens, editor buttons) when both extensions are installed. The coordination is achieved through a shared API that allows extensions to query which extension owns a given file URI.

Changes:

Introduced UriOwnershipCoordinator class to manage coordination with other database extensions
Added command name suffixes "(MSSQL)" to disambiguate from PostgreSQL commands in the command palette
Implemented UI hiding logic in status bar, CodeLens, and editor menus based on URI ownership

Reviewed changes

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

Show a summary per file

File	Description
extensions/mssql/src/uriOwnership.ts	New coordinator class that manages URI ownership API and listens for ownership changes from other extensions
extensions/mssql/typings/vscode-mssql.d.ts	Added UriOwnershipApi interface to the public API
extensions/mssql/src/extension.ts	Instantiates and initializes the URI ownership coordinator
extensions/mssql/src/views/statusView.ts	Hides status bar items when active file is owned by another extension
extensions/mssql/src/queryResult/sqlCodeLensProvider.ts	Hides CodeLens when URI is owned by another extension
extensions/mssql/package.json	Added context-based visibility conditions to editor menu commands
extensions/mssql/src/controllers/mainController.ts	Added ownership checks to prevent command execution on files owned by other extensions
extensions/mssql/src/constants/locConstants.ts	Added localized error message for files owned by other extensions
extensions/mssql/package.nls.json	Updated command titles with "(MSSQL)" suffix
localization/xliff/vscode-mssql.xlf	Updated localization resources
extensions/mssql/l10n/bundle.l10n.json	Updated l10n bundle with new messages

Comments suppressed due to low confidence (2)

extensions/mssql/package.json:440

For defensive programming and consistency, consider adding the !mssql.hideUIElements condition to other MSSQL-specific commands in the editor/title menu (disconnect, changeConnection, changeDatabase, showEstimatedPlan, etc.), not just runQuery and connect. While the resource in mssql.connections check should prevent these buttons from showing when a file is owned by another extension, adding the explicit hideUIElements check would provide an extra layer of protection against potential race conditions during connection handoff between extensions.

            "editor/title": [
                {
                    "command": "mssql.runQuery",
                    "when": "editorLangId == sql && !isInDiffEditor && resourcePath not in mssql.runningQueries && !mssql.hideUIElements",
                    "group": "navigation@1"
                },
                {
                    "command": "mssql.cancelQuery",
                    "when": "editorLangId == sql && !isInDiffEditor && resourcePath in mssql.runningQueries",
                    "group": "navigation@2"
                },
                {
                    "command": "mssql.revealQueryResult",
                    "when": "editorLangId == sql && resource in mssql.connections && !isInDiffEditor",
                    "group": "navigation@2"
                },
                {
                    "command": "mssql.connect",
                    "when": "editorLangId == sql && !isInDiffEditor && resource not in mssql.connections && !mssql.hideUIElements",
                    "group": "navigation@3"
                },
                {
                    "command": "mssql.disconnect",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@3"
                },
                {
                    "command": "mssql.changeConnection",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@4"
                },
                {
                    "command": "mssql.changeDatabase",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@5"
                },
                {
                    "command": "mssql.showEstimatedPlan",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@10"
                },
                {
                    "command": "mssql.enableActualPlan",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && (resource not in mssql.executionPlan.urisWithActualPlanEnabled) && (resourcePath not in mssql.runningQueries)",
                    "group": "navigation@11"
                },
                {
                    "command": "mssql.disableActualPlan",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && (resource in mssql.executionPlan.urisWithActualPlanEnabled) && (resourcePath not in mssql.runningQueries)",
                    "group": "navigation@12"
                }

extensions/mssql/src/controllers/mainController.ts:241

The cmdChangeConnection command handler doesn't check for URI ownership like cmdConnect and cmdRunQuery do. While the editor menu buttons are hidden via package.json conditions, users can still invoke this command from the command palette. If a file is owned by another extension (e.g., PostgreSQL), users could potentially invoke "Change Connection (MSSQL)" from the command palette and get unexpected behavior. Consider adding the same ownership check here for consistency.

            this.registerCommand(Constants.cmdChangeConnection);
            this._event.on(Constants.cmdChangeConnection, () => {
                void this.runAndLogErrors(this.onNewConnection());
            });

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

extensions/mssql/src/uriOwnership.ts

extensions/mssql/src/queryResult/sqlCodeLensProvider.ts

extensions/mssql/src/uriOwnership.ts

github-actions · 2026-02-05T08:36:36Z

PR Changes

Category	Target Branch	PR Branch	Difference
vscode-mssql VSIX	5911 KB	5913 KB	⚪ 2 KB ( 0% )
sql-database-projects VSIX	7877 KB	7877 KB	⚪ 0 KB ( 0% )
data-workspace VSIX	544 KB	544 KB	⚪ 0 KB ( 0% )

codecov-commenter · 2026-02-05T08:36:47Z

Codecov Report

❌ Patch coverage is 35.29412% with 33 lines in your changes missing coverage. Please review.
✅ Project coverage is 68.22%. Comparing base (8c2a6a9) to head (3bd3878).

Files with missing lines	Patch %	Lines
extensions/mssql/src/views/statusView.ts	30.43%	16 Missing ⚠️
extensions/mssql/src/extension.ts	30.00%	7 Missing ⚠️
extensions/mssql/src/controllers/mainController.ts	20.00%	4 Missing ⚠️
...sions/mssql/src/queryResult/sqlCodeLensProvider.ts	42.85%	4 Missing ⚠️
...nsions/mssql/src/controllers/sqlDocumentService.ts	66.66%	2 Missing ⚠️

❌ Your patch status has failed because the patch coverage (35.29%) 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   #21101      +/-   ##
==========================================
- Coverage   68.29%   68.22%   -0.08%     
==========================================
  Files         242      242              
  Lines       23543    23594      +51     
  Branches     3114     3127      +13     
==========================================
+ Hits        16078    16096      +18     
- Misses       7336     7369      +33     
  Partials      129      129

Files with missing lines	Coverage Δ
...nsions/mssql/src/controllers/sqlDocumentService.ts	`86.15% <66.66%> (-0.62%)`	⬇️
extensions/mssql/src/controllers/mainController.ts	`17.51% <20.00%> (+0.01%)`	⬆️
...sions/mssql/src/queryResult/sqlCodeLensProvider.ts	`38.46% <42.85%> (+0.96%)`	⬆️
extensions/mssql/src/extension.ts	`22.00% <30.00%> (+0.88%)`	⬆️
extensions/mssql/src/views/statusView.ts	`40.19% <30.43%> (-0.80%)`	⬇️

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

…ng during activation

…tion

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 8 comments.

Comments suppressed due to low confidence (1)

extensions/mssql/package.json:440

Several editor/title menu items that should be hidden when the URI is owned by another extension are missing the && !mssql.hideUIElements condition:

mssql.disconnect (line 413)
mssql.changeConnection (line 418)
mssql.changeDatabase (line 423)
mssql.revealQueryResult (line 403)
mssql.cancelQuery (line 398)
mssql.showEstimatedPlan (line 428)
mssql.enableActualPlan (line 433)
mssql.disableActualPlan (line 438)

These commands all operate on the active editor and should not be visible when the file is owned by a coordinating extension like PostgreSQL, for consistency with the mssql.runQuery and mssql.connect commands that already have this condition.

                {
                    "command": "mssql.cancelQuery",
                    "when": "editorLangId == sql && !isInDiffEditor && resourcePath in mssql.runningQueries",
                    "group": "navigation@2"
                },
                {
                    "command": "mssql.revealQueryResult",
                    "when": "editorLangId == sql && resource in mssql.connections && !isInDiffEditor",
                    "group": "navigation@2"
                },
                {
                    "command": "mssql.connect",
                    "when": "editorLangId == sql && !isInDiffEditor && resource not in mssql.connections && !mssql.hideUIElements",
                    "group": "navigation@3"
                },
                {
                    "command": "mssql.disconnect",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@3"
                },
                {
                    "command": "mssql.changeConnection",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@4"
                },
                {
                    "command": "mssql.changeDatabase",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@5"
                },
                {
                    "command": "mssql.showEstimatedPlan",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && resourcePath not in mssql.runningQueries",
                    "group": "navigation@10"
                },
                {
                    "command": "mssql.enableActualPlan",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && (resource not in mssql.executionPlan.urisWithActualPlanEnabled) && (resourcePath not in mssql.runningQueries)",
                    "group": "navigation@11"
                },
                {
                    "command": "mssql.disableActualPlan",
                    "when": "editorLangId == sql && !isInDiffEditor && resource in mssql.connections && (resource in mssql.executionPlan.urisWithActualPlanEnabled) && (resourcePath not in mssql.runningQueries)",
                    "group": "navigation@12"
                }

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

extensions/mssql/src/uriOwnership.ts

extensions/mssql/src/controllers/mainController.ts

extensions/mssql/src/uriOwnership.ts

extensions/mssql/src/views/statusView.ts

extensions/mssql/src/uriOwnership.ts

extensions/mssql/test/e2e/executionPlan.spec.ts

extensions/mssql/src/uriOwnership.ts

extensions/mssql/package.json

…c and event handling

…d clarity

Copilot

Pull request overview

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

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

extensions/mssql/src/queryResult/sqlCodeLensProvider.ts

localization/xliff/vscode-mssql.xlf

extensions/mssql/src/uriOwnership.ts

extensions/mssql/src/views/statusView.ts

…nd PostgreSQL extensions

manujoseph85

It would be nice if we can find a way to share this code with PG without duplicating the code. Coordinating fixes with them if we need changes would be a hassle

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.

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

extensions/mssql/src/uriOwnership.ts

…adability and maintainability

…oord

Copilot

Pull request overview

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

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

packages/vscode-sql-common/README.md

extensions/mssql/src/constants/locConstants.ts

packages/vscode-sql-common/README.md

extensions/mssql/test/unit/uriOwnershipCoordinator.test.ts

packages/vscode-sql-common/test/uriOwnershipCoordinator.test.ts

… package.json and related files for consistency

Copilot

Pull request overview

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

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

Copilot · 2026-02-06T06:58:42Z

packages/vscode-sql-common/src/uriOwnership/uriOwnershipCoordinator.ts

+    private _refreshCoordinatingExtensions(): void {
+        const newExtensions = discoverCoordinatingExtensions(this._context.extension.id);
+
+        // Find newly added extensions
+        for (const extInfo of newExtensions) {
+            if (!this._coordinatingExtensionApis.has(extInfo.extensionId)) {
+                const extension = vscode.extensions.getExtension(extInfo.extensionId);
+                if (extension?.isActive) {
+                    this._registerCoordinatingExtensionApi(extInfo.extensionId, extension.exports);
+                }
+            }
+        }
+
+        this._coordinatingExtensions = newExtensions;
+    }


The _refreshCoordinatingExtensions method does not handle the case where an extension is uninstalled or deactivated. When an extension is removed, it remains in _coordinatingExtensionApis Map and its event listener remains registered in context.subscriptions, potentially causing errors when the extension tries to call the API or when events fire. The method should check for removed extensions and clean up their entries from _coordinatingExtensionApis.

packages/vscode-sql-common/README.md

packages/vscode-sql-common/src/uriOwnership/uriOwnershipCoordinator.ts

packages/vscode-sql-common/package.json

…mmon

… and adding releaseUri callback

Copilot

Pull request overview

Copilot reviewed 24 out of 28 changed files in this pull request and generated 3 comments.

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

packages/vscode-sql-common/README.md

packages/vscode-sql-common/test/setup.ts

Aasim Khan added 4 commits February 4, 2026 14:34

Add UriOwnershipCoordinator to manage URI ownership across extensions

d1494bb

Merge remote-tracking branch 'origin/main' into aasim/feat/extensionC…

ab84e12

…oord

Implement URI ownership management to enhance extension coordination …

03fca7d

…and UI visibility

Add localization for URI ownership disconnect message and update MSSQ…

62ee8f2

…L command labels

aasimkhan30 requested a review from kburtram as a code owner February 5, 2026 08:26

Copilot AI review requested due to automatic review settings February 5, 2026 08:26

aasimkhan30 requested review from Benjin, allancascante, caohai, laurenastrid1, lewis-sanchez, manujoseph85 and ssreerama as code owners February 5, 2026 08:26

Copilot started reviewing on behalf of aasimkhan30 February 5, 2026 08:27 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

Aasim Khan added 2 commits February 5, 2026 00:55

Fix typos in coordinating extensions handling and improve error loggi…

3bed77e

…ng during activation

Refactor query plan test setup and improve locator for SQL file execu…

e394183

…tion

Copilot AI review requested due to automatic review settings February 5, 2026 09:33

Copilot started reviewing on behalf of aasimkhan30 February 5, 2026 09:34 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

Aasim Khan added 2 commits February 5, 2026 01:41

Add unit tests for UriOwnershipCoordinator to validate ownership logi…

c0a6801

…c and event handling

Refactor UriOwnershipCoordinator test setup to improve type safety an…

fe16017

…d clarity

Copilot AI review requested due to automatic review settings February 5, 2026 09:50

Copilot started reviewing on behalf of aasimkhan30 February 5, 2026 09:50 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

extensions/mssql/src/queryResult/sqlCodeLensProvider.ts Show resolved Hide resolved

localization/xliff/vscode-mssql.xlf Show resolved Hide resolved

extensions/mssql/src/uriOwnership.ts Outdated Show resolved Hide resolved

extensions/mssql/src/uriOwnership.ts Outdated Show resolved Hide resolved

fix bad test mockups

5f61a1b

manujoseph85 reviewed Feb 5, 2026

View reviewed changes

extensions/mssql/src/uriOwnership.ts Outdated Show resolved Hide resolved

manujoseph85 reviewed Feb 6, 2026

View reviewed changes

extensions/mssql/src/views/statusView.ts Show resolved Hide resolved

Implement ownership checks to prevent race conditions between MSSQL a…

30106ad

…nd PostgreSQL extensions

Copilot AI review requested due to automatic review settings February 6, 2026 00:16

Copilot started reviewing on behalf of aasimkhan30 February 6, 2026 00:17 View session

manujoseph85 previously approved these changes Feb 6, 2026

View reviewed changes

Copilot AI reviewed Feb 6, 2026

View reviewed changes

extensions/mssql/src/uriOwnership.ts Outdated Show resolved Hide resolved

Refactor code structure for improved readability and maintainability

d94b285

aasimkhan30 dismissed manujoseph85’s stale review via d94b285 February 6, 2026 06:18

Aasim Khan added 2 commits February 5, 2026 22:20

Refactor code structure and remove redundant sections for improved re…

c6f40a3

…adability and maintainability

Fix more issues

902b393

Copilot AI review requested due to automatic review settings February 6, 2026 06:20

Remove package.json for sql-extension-common as it is no longer needed

b85c415

Copilot started reviewing on behalf of aasimkhan30 February 6, 2026 06:20 View session

Merge remote-tracking branch 'origin/main' into aasim/feat/extensionC…

c26f052

…oord

Copilot AI reviewed Feb 6, 2026

View reviewed changes

Aasim Khan added 2 commits February 5, 2026 22:31

Rename sql-extension-common-features to vscode-sql-common-features in…

cddfa2a

… package.json and related files for consistency

Remove uriOwnershipCoordinator test file as it is no longer needed

26a48bb

Copilot AI review requested due to automatic review settings February 6, 2026 06:52

Copilot started reviewing on behalf of aasimkhan30 February 6, 2026 06:53 View session

Copilot AI reviewed Feb 6, 2026

View reviewed changes

Aasim Khan added 2 commits February 5, 2026 23:04

Update vscode-sql-common dependency link in package.json and yarn.lock

3a8ad4d

Remove peerDependencies for vscode from package.json in vscode-sql-co…

9bf97d8

…mmon

Copilot AI review requested due to automatic review settings February 6, 2026 07:08

Copilot started reviewing on behalf of aasimkhan30 February 6, 2026 07:08 View session

Enhance UriOwnershipCoordinator configuration by removing extensionId…

7c30820

… and adding releaseUri callback

Copilot AI reviewed Feb 6, 2026

View reviewed changes

packages/vscode-sql-common/README.md Show resolved Hide resolved

packages/vscode-sql-common/README.md Show resolved Hide resolved

packages/vscode-sql-common/test/setup.ts Show resolved Hide resolved

Aasim Khan added 2 commits February 5, 2026 23:15

Remove file ownership message from Common class in locConstants.ts

2f8d2e6

Remove connection warning message from localization files

3bd3878

Extension UI cleanup with multiple SQL extension #21101

Are you sure you want to change the base?

Extension UI cleanup with multiple SQL extension #21101

Conversation

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

Uh oh!

Description

Problem

Solution

Behavior

User-Facing Messages

Backward Compatibility

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!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

PR Changes

Uh oh!

codecov-commenter commented Feb 5, 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!

Uh oh!

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!

Uh oh!

Uh oh!

manujoseph85 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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 Feb 6, 2026

Choose a reason for hiding this comment

aasimkhan30 commented Feb 5, 2026 •

edited

Loading

github-actions bot commented Feb 5, 2026 •

edited

Loading

codecov-commenter commented Feb 5, 2026 •

edited

Loading