Refactoring connection management #18684

Benjin · 2025-02-14T15:56:11Z

Lays the groundwork for connection grouping
Fixes an issue where similar connections could trample each other in the Object Explorer
cleans up a bunch of duplicate or poorly-named code in connection management

Before this change, there was a mix of keys being used, some of which were not guaranteed to be unique. Examples include:

STS-provided session ID (constructed using all properties)
vscode-mssql-generated session ID that seemed like it was supposed to be the same as the STS-provided one, but wasn't always (constructed using four primary connection properties)
OE nodePath

When trying to identify the correct tree node to update, it would store a node label mapping keyed on the server (not guaranteed to be unique among all connections), then later select a saved connection based on the matching server name; if you had multiple connections to the same server, it could end up selecting the wrong one (depending on ordering, IIRC), and expanding the wrong server in the tree (with the right underlying connection, IIRC).

After this change: everything is keyed on the STS sessionID and I'm hoping to remove the concept of a vscode sessionID entirely. It no longer matters how similar a connection is, if any property differs, then it's treated as a separate connection at both layers.

There are still some other cases I need to follow up with (e.g. what gets displayed if there are identical profile names or server + db combos), but this is an important first step.

Before:

416897517-20655331-d79c-4f6f-9010-f4fe4444920a.mp4

After:

connfix.mp4

github-actions · 2025-02-14T16:31:47Z

PR Changes

Category	Main Branch	PR Branch	Difference
Code Coverage	50.66%	51.28%	$${\color{lightgreen} .62\% }$$
VSIX Size	12982 KB	12983 KB	$${\color{lightgreen} 1 KB \space (0\%) }$$
Webview Bundle Size	3188 KB	3188 KB	$${\color{lightgreen} 0 KB \space (0\%) }$$

src/objectExplorer/objectExplorerService.ts

Benjin · 2025-02-14T19:34:27Z

src/objectExplorer/objectExplorerService.ts

@@ -872,40 +869,30 @@ export class ObjectExplorerService {
        isDisconnect: boolean = false,
    ): Promise<void> {
        await this.closeSession(node);
-        const nodeUri = ObjectExplorerUtils.getNodeUri(node);
+        const nodeUri = this.getNodeIdentifier(node);


update ObjectExplorerUtils.getNodeUri()?

src/connectionconfig/connectionconfig.ts

caohai · 2025-02-14T23:39:41Z

where similar connections could trample each other in the Object Explorer

Do we have an issue for this? Would love to understand how "similar" two connections need to be to trigger this isse, maybe a before/after screenshot with the fix?

caohai · 2025-02-15T00:07:07Z

src/objectExplorer/objectExplorerService.ts

-                    (connectionCredentials as IConnectionProfile).profileName,
+            if ((connectionProfile as IConnectionProfile).profileName) {
+                this._sessionIdToNodeLabelMap.set(
+                    sessionIdResponse.sessionId,


This part appears to be one of the important changes. At a high level I can see why we want to use sessionId instead of server name but would love to see more detailed explanation of the before/after workfow. (Not necessarily in this PR)

Yup, swapping everything to use the sessionId as the sole key was the main change that solidified some unexpected behavior in the OE.

Before this change, there was a mix of keys being used, some of which were not guaranteed to be unique. Examples include:

STS-provided session ID (constructed using all properties)

vscode-mssql-generated session ID that seemed like it was supposed to be the same as the STS-provided one, but wasn't always (constructed using four primary connection properties)

OE nodePath

When trying to identify the correct tree node to update, it would store a node label mapping keyed on the server (not guaranteed to be unique among all connections), then later select a saved connection based on the matching server name; if you had multiple connections to the same server, it could end up selecting the wrong one (depending on ordering, IIRC), and expanding the wrong server in the tree (with the right underlying connection, IIRC).

After this change: everything is keyed on the STS sessionID and I'm hoping to remove the concept of a vscode sessionID entirely. It no longer matters how similar a connection is, if any property differs, then it's treated as a separate connection at both layers.

There are still some other cases I need to follow up with (e.g. what gets displayed if there are identical profile names or server + db combos), but this is an important first step.

I'll add recordings of before/after the change

Thanks for the detailed explanation!

Thanks for the detailed explanation.

Can you update the js doc for this interface with some explanation? Something like this maybe

/** * A unique session ID used for all requests within a connection sub-tree. * All child nodes must use the same session ID when sending expand requests. */

vscode-mssql/src/models/contracts/objectExplorer/createSessionRequest.ts

Lines 26 to 32 in 694c6db

export class CreateSessionResponse {

/**

* Unique Id to use when sending any requests for objects in the tree

* under the node

*/

public sessionId: string;

}

vscode-mssql/src/models/contracts/objectExplorer/createSessionRequest.ts

Lines 48 to 51 in 57f780a

/**

* Unique ID to use when sending any requests for objects in the

* tree under the node

*/

@caohai before/after recordings now added, with detailed (and consistent) repro information in the bug: #18849

caohai

LGTM overall, I'd say we might need do more manual testings next week just to make sure this change won't break any existing OE experience.

Benjin · 2025-02-15T00:41:43Z

@caohai

I'd say we might need do more manual testings next week just to make sure this change won't break any existing OE experience.

Agreed. I really wanted to get this in on the earlier side of a release cycle, but too many things were competing with my time when I wanted to get this PR out. The right call could be to hold this PR after the release branch splits so we can decide whether to take it as a port.

src/models/contracts/objectExplorer/getSessionIdRequest.ts

aasimkhan30

Thanks for the code cleanup. Left a comment about a jsdoc comment.

Benjin added 16 commits January 7, 2025 13:43

populating missing IDs for connections and groups

26b0df1

loc

f6e5c1b

adding description text for new config props

794893a

more loc

a33d03b

removing quickpick connection typing

ff134d4

correcting map names

4b8d1b3

everyone swapped to sessionID as key

94d8bbb

correction string

39b5c0e

Merge branch 'main' into dev/benjin/connRefac

f64ec5f

reverting serviceclient changes

cda4ed7

cleaning up disconnected node type

f7bcd88

deduping entra token checks

4f9ae4a

spacing

d38dfbf

fixing test

1a0e20b

fix up test

5b6ea66

adding typing to compare func

dc4949c

Benjin requested review from kburtram, aasimkhan30, cssuh, caohai, laurennat and lewis-sanchez as code owners February 14, 2025 15:56

ignore settings.json in test for both ends of transfer

8be9d2b

Benjin commented Feb 14, 2025

View reviewed changes

lewis-sanchez reviewed Feb 14, 2025

View reviewed changes

src/connectionconfig/connectionconfig.ts Outdated Show resolved Hide resolved

lewis-sanchez approved these changes Feb 14, 2025

View reviewed changes

caohai reviewed Feb 15, 2025

View reviewed changes

caohai approved these changes Feb 15, 2025

View reviewed changes

Benjin added 2 commits February 17, 2025 19:18

Merge branch 'main' into dev/benjin/connRefac

a2e776b

PR cleanup

6ca9c8b

Benjin mentioned this pull request Feb 20, 2025

Adding multiple similar connections doesn't work correctly #18001

Open

Benjin added 2 commits February 25, 2025 10:54

Merge branch 'main' into dev/benjin/connRefac

ffa436c

loc

9a38613

aasimkhan30 reviewed Feb 25, 2025

View reviewed changes

src/models/contracts/objectExplorer/getSessionIdRequest.ts Show resolved Hide resolved

aasimkhan30 approved these changes Feb 25, 2025

View reviewed changes

fixing merge

c69a647

Benjin merged commit 5e1d743 into main Feb 26, 2025
6 checks passed

Benjin deleted the dev/benjin/connRefac branch February 26, 2025 01:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactoring connection management #18684

Refactoring connection management #18684

Benjin commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

Benjin Feb 14, 2025

caohai commented Feb 14, 2025

caohai Feb 15, 2025

Benjin Feb 15, 2025

Benjin Feb 15, 2025

caohai Feb 15, 2025

aasimkhan30 Feb 25, 2025

Benjin Feb 25, 2025

caohai left a comment •

edited

Loading

Benjin commented Feb 15, 2025

aasimkhan30 left a comment

	export class CreateSessionResponse {
	/**
	* Unique Id to use when sending any requests for objects in the tree
	* under the node
	*/
	public sessionId: string;
	}

	/**
	* Unique ID to use when sending any requests for objects in the
	* tree under the node
	*/

Refactoring connection management #18684

Refactoring connection management #18684

Conversation

Benjin commented Feb 14, 2025 • edited Loading

github-actions bot commented Feb 14, 2025 • edited Loading

PR Changes

Benjin Feb 14, 2025

Choose a reason for hiding this comment

caohai commented Feb 14, 2025

caohai Feb 15, 2025

Choose a reason for hiding this comment

Benjin Feb 15, 2025

Choose a reason for hiding this comment

Benjin Feb 15, 2025

Choose a reason for hiding this comment

caohai Feb 15, 2025

Choose a reason for hiding this comment

aasimkhan30 Feb 25, 2025

Choose a reason for hiding this comment

Benjin Feb 25, 2025

Choose a reason for hiding this comment

caohai left a comment • edited Loading

Choose a reason for hiding this comment

Benjin commented Feb 15, 2025

aasimkhan30 left a comment

Choose a reason for hiding this comment

Benjin commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

caohai left a comment •

edited

Loading