Fix xevent test failures, avoid orphaned sessions #3775

paulmedynski · 2025-11-17T21:46:57Z

Description

Added max event session duration where that feature is supported.
Added test name to event session name.
Flattened using blocks to statements.
Applied single-branch config to the approver policy (an unrelated change).

Copilot

Pull Request Overview

This PR fixes XEvent test failures by preventing orphaned event sessions through two key improvements: adding automatic session expiration via MAX_DURATION on SQL Server 2017+ and incorporating test names into session names for better traceability.

Key Changes:

Added version detection to conditionally set MAX_DURATION for XEvent sessions on SQL Server 2017+
Refactored XEventScope to accept test names as session prefixes for improved identification
Introduced ServerProperty enum for type-safe server property queries

Reviewed Changes

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

File	Description
DataTestUtility.cs	Added CurrentTestName() helper, ServerProperty enum, refactored GetSqlServerProperty() for type safety, and enhanced XEventScope with version detection and duration support
XEventsTracingTest.cs	Converted to instance class with constructor injection to pass test name to XEventScope
DataStreamTest.cs	Converted from static to instance class with constructor injection to pass test name to XEventScope

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

Copilot

Pull Request Overview

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

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataStreamTest/DataStreamTest.cs

Copilot

Pull Request Overview

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

Comments suppressed due to low confidence (1)

.azuredevops/policies/approvercountpolicy.yml:1

[nitpick] The original comment referencing a specific Merlinbot PR (line 6 in the old version) has been replaced with a generic documentation link. While the new link is useful, removing the historical reference to the PR that suggested this configuration may reduce traceability. Consider keeping both the original PR reference and the new documentation link.

# This file configures the Approver Count Policy Validator status check.  Some

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

.azuredevops/policies/approvercountpolicy.yml

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

Copilot

Pull Request Overview

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

.azuredevops/policies/approvercountpolicy.yml

src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataStreamTest/DataStreamTest.cs

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

paulmedynski

Commentary for reviewers.

paulmedynski · 2025-11-21T12:21:23Z

.azuredevops/policies/approvercountpolicy.yml

-    - refs/heads/internal/release/5.2
-    - refs/heads/internal/release/5.1
-    displayName: dotnet-sqlclient Approver Count Policy
+    - internal/main


This is an unrelated change, but it seemed too small to bother with a separate PR.

Do we need to apply this to all branches we maintain? Or can it be done only in the main branch?

paulmedynski · 2025-11-21T12:22:04Z

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

                if (!string.IsNullOrEmpty(TCPConnectionString))
                {
-                    s_sqlServerEngineEdition ??= GetSqlServerProperty(TCPConnectionString, "EngineEdition");
+                    s_sqlServerEngineEdition ??= GetSqlServerProperty(TCPConnectionString, ServerProperty.EngineEdition);


I converted these strings into an enum for consistency.

paulmedynski · 2025-11-21T12:29:16Z

src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataStreamTest/DataStreamTest.cs

+
+            using DataTestUtility.XEventScope xEventScope =
+                new DataTestUtility.XEventScope(
+                    _testName,


Each XEvent session name will now contain the test name so we can track down the source or orphaned sessions on older SQL Server instances.

Copilot

Pull Request Overview

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

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

- Added max event session duration where that feature is supported. - Added test name to event session name. - Restricting approve count policy to internal/main.

Copilot

Pull request overview

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

paulmedynski · 2025-11-24T15:59:21Z

Ignore the Merge Code Coverage job failure - that is being worked on in #3798.

… running.

mdaigle

One request, otherwise looks good.

mdaigle · 2025-11-24T22:43:58Z

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

-                }
+                using SqlCommand command = new SqlCommand(xEventQuery, _connection);
+
+                Thread.Sleep(MaxDispatchLatencySeconds * 1000);


Can we add a comment here on the purpose of this sleep? My read is that we need to wait for the buffered events to get persisted, which may take up to MaxDispatchLatencySeconds seconds.

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

Copilot AI review requested due to automatic review settings November 17, 2025 21:46

Copilot started reviewing on behalf of paulmedynski November 17, 2025 21:47 View session

Copilot finished reviewing on behalf of paulmedynski November 17, 2025 21:48

Copilot AI reviewed Nov 17, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings November 18, 2025 13:07

Copilot started reviewing on behalf of paulmedynski November 18, 2025 13:07 View session

Copilot finished reviewing on behalf of paulmedynski November 18, 2025 13:11

Copilot AI reviewed Nov 18, 2025

View reviewed changes

cheenamalhotra previously approved these changes Nov 18, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings November 20, 2025 13:10

paulmedynski dismissed cheenamalhotra’s stale review via 0e15a79 November 20, 2025 13:10

Copilot started reviewing on behalf of paulmedynski November 20, 2025 13:11 View session

Copilot finished reviewing on behalf of paulmedynski November 20, 2025 13:12

Copilot AI reviewed Nov 20, 2025

View reviewed changes

paulmedynski marked this pull request as ready for review November 20, 2025 18:31

paulmedynski requested a review from a team as a code owner November 20, 2025 18:31

Copilot AI review requested due to automatic review settings November 20, 2025 18:31

paulmedynski changed the title ~~[DRAFT] Fix xevent test failures, avoid orphaned sessions~~ Fix xevent test failures, avoid orphaned sessions Nov 20, 2025

Copilot started reviewing on behalf of paulmedynski November 20, 2025 18:31 View session

Copilot finished reviewing on behalf of paulmedynski November 20, 2025 18:35

Copilot AI reviewed Nov 20, 2025

View reviewed changes

paulmedynski force-pushed the dev/paul/xevents branch from 20a788e to ec9bbd4 Compare November 20, 2025 20:36

paulmedynski commented Nov 21, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings November 21, 2025 13:33

Copilot started reviewing on behalf of paulmedynski November 21, 2025 13:33 View session

Copilot finished reviewing on behalf of paulmedynski November 21, 2025 13:37

Copilot AI reviewed Nov 21, 2025

View reviewed changes

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs Outdated Show resolved Hide resolved

paulmedynski marked this pull request as draft November 21, 2025 15:42

paulmedynski changed the title ~~Fix xevent test failures, avoid orphaned sessions~~ [DRAFT] Fix xevent test failures, avoid orphaned sessions Nov 21, 2025

Task 39257: Fix xevent test failures, avoid orphaned sessions

e60f020

- Added max event session duration where that feature is supported. - Added test name to event session name. - Restricting approve count policy to internal/main.

paulmedynski force-pushed the dev/paul/xevents branch from 7adf0b3 to e60f020 Compare November 21, 2025 16:00

paulmedynski changed the title ~~[DRAFT] Fix xevent test failures, avoid orphaned sessions~~ Fix xevent test failures, avoid orphaned sessions Nov 21, 2025

paulmedynski marked this pull request as ready for review November 21, 2025 16:08

Copilot AI review requested due to automatic review settings November 21, 2025 16:08

Copilot started reviewing on behalf of paulmedynski November 21, 2025 16:09 View session

Copilot finished reviewing on behalf of paulmedynski November 21, 2025 16:11

Copilot AI reviewed Nov 21, 2025

View reviewed changes

- Fixed XEvent session cleanup to remove sessions even if they aren't…

b895d7f

… running.

cheenamalhotra previously approved these changes Nov 24, 2025

View reviewed changes

mdaigle requested changes Nov 24, 2025

View reviewed changes

apoorvdeshmukh previously approved these changes Nov 25, 2025

View reviewed changes

- Added XML docs for XEventSession test helper.

aa5cd2d

Copilot AI review requested due to automatic review settings November 25, 2025 12:26

paulmedynski dismissed stale reviews from apoorvdeshmukh and cheenamalhotra via aa5cd2d November 25, 2025 12:26

Copilot started reviewing on behalf of paulmedynski November 25, 2025 12:27 View session

Copilot finished reviewing on behalf of paulmedynski November 25, 2025 12:29

Copilot AI reviewed Nov 25, 2025

View reviewed changes

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs Show resolved Hide resolved

Merge branch 'main' into dev/paul/xevents

2464f8b

Fix xevent test failures, avoid orphaned sessions #3775

Are you sure you want to change the base?

Fix xevent test failures, avoid orphaned sessions #3775

Conversation

paulmedynski commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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!

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!

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!

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!

paulmedynski left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

cheenamalhotra Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

paulmedynski Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

paulmedynski Nov 21, 2025

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!

paulmedynski commented Nov 24, 2025

Uh oh!

mdaigle left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski commented Nov 17, 2025 •

edited

Loading