[6.0] Fix xevent and codeql (#3775)(#3819), add global.json #3827

mdaigle · 2025-12-04T18:17:53Z

Converted XEventScope to a class because ref struct types are only available starting in c# v13 and this branch uses v9.

Includes various fixes to enable compilation on linux.

Copilot

Pull request overview

This PR backports fixes from the main branch (#3775, #3819) to the 6.0 branch, addressing XEvent test failures and adding CodeQL workflow support. The key change involves converting XEventScope from a ref struct to a class to maintain C# v9 compatibility (ref struct interfaces require C# v13).

Adds comprehensive XEventScope utility class to manage XEvent sessions with automatic cleanup
Refactors test infrastructure to use instance methods with ITestOutputHelper for proper test name extraction
Implements a type-safe ServerProperty enum for querying SQL Server properties
Adds CodeQL security scanning workflow for the repository

Reviewed changes

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

File	Description
XEventsTracingTest.cs	New test validating that client-side activity IDs are correctly passed to server-side XEvent sessions
DataStreamTest.cs	Converts test class from static to instance-based; refactors XEvent streaming test to use XEventScope utility; contains unresolved merge conflict
DataTestUtility.cs	Adds XEventScope helper class, CurrentTestName method, and ServerProperty enum; refactors GetSqlServerProperty for type safety
codeql.yml	New GitHub Actions workflow for CodeQL security scanning; configured for 'main' branch instead of '6.0' branch

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

.github/workflows/codeql.yml

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

Copilot

Pull request overview

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

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

.github/workflows/codeql.yml

Copilot · 2025-12-04T19:05:03Z

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

+                    // Flush data
+                }
+
+                ids = TraceListener.ActivityIDs;


The property ActivityIDs does not exist on MDSEventListener or its base class BaseEventListener. The BaseEventListener class only has IDs (of type List<int>) and EventData properties. This code will fail to compile.

Either:

Add an ActivityIDs property to BaseEventListener or MDSEventListener, or

Change this line to use the correct property name (likely IDs if tracking event IDs)

Suggested change

ids = TraceListener.ActivityIDs;

ids = new HashSet<string>(TraceListener.IDs.ConvertAll(id => id.ToString()));

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

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

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

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

…talization to work on linux.

…3754.

Copilot

Pull request overview

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

src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

* Upgrade / align packages in test projects / * Reference System.ServiceProcess on netfx * Always include System.Transactions as well * Remove references to xunit.runner.console and xunit.runner.utility to enable discovery of netfx tests again. See dotnet/runtime#94183 * Revert nuget.org addition * Upgrade Versions Remove VersionsNet8OrLater, not needed anymore * Force build * Remove dummy * Add back console runners * Remove System.ServiceProcess, should not be needed * I think we do actually still need the net9 versions --------- Co-authored-by: Michel Zehnder <[email protected]>

Copilot

Pull request overview

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

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

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

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

tools/props/Versions.props

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

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 11 out of 12 changed files in this pull request and generated 2 comments.

src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

Copilot

Pull request overview

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

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

mdaigle · 2025-12-05T19:51:22Z

eng/pipelines/common/templates/jobs/ci-run-tests-job.yml

            $version = "${{parameters.targetFramework }}".Substring(3, "${{parameters.targetFramework }}".Length-3)
        }
        
+        # Install targetFramework specific .NET runtime (and sdk)


Like other test tasks, we want to test against specific runtime versions depending on the the target framework.

mdaigle · 2025-12-05T19:51:57Z

eng/pipelines/common/templates/jobs/ci-run-tests-job.yml

        .\dotnet-install.ps1 -Channel $version -Architecture x86 -InstallDir "$(dotnetx86RootPath)"
        
+        # Install globally required .NET sdk
+        .\dotnet-install.ps1 -Architecture x86 -InstallDir "$(dotnetx86RootPath)" -JSonFile global.json


This ensures that we have installed the SDK version required by the global.json file.

mdaigle · 2025-12-05T19:52:47Z

src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj

    </Compile>
-    <Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\SqlMetadataFactory.cs">
-      <Link>Microsoft\Data\SqlClient\SqlMetadataFactory.cs</Link>
+    <Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\SqlMetaDataFactory.cs">


Case change to support building on linux.

mdaigle · 2025-12-05T19:55:15Z

.github/workflows/codeql.yml

      run: |
        mkdir packages
-        dotnet build src/
+        dotnet build src/Microsoft.Data.SqlClient.sln


I think our solution file on this branch is old and doesn't play nicely with certain .NET versions, so it doesn't get recognized as the default target. Specifying the file explicitly helps dotnet determine what to build when there are multiple targets available.

It's because there is a .dcproj file in src/ too, so dotnet doesn't know which one you want to build.

mdaigle · 2025-12-05T19:55:51Z

src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.Net.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">


Case change for linux

mdaigle · 2025-12-05T19:56:17Z

src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj

      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </EmbeddedResource>
  </ItemGroup>
-  <ItemGroup>


Following the lead of #3403

mdaigle · 2025-12-05T19:56:55Z

src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj

    <ErrorReport>None</ErrorReport>
-    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+    <!-- This code analysis ruleset only exists with the .NET Framework toolset. -->
+    <CodeAnalysisRuleSet Condition="$(MSBuildRuntimeType) == 'Full'">MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>


Following the lead of #3754

mdaigle · 2025-12-05T19:57:10Z

src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj

    <Compile Include="Common\Microsoft\Data\Common\NameValuePermission.cs" />
    <Compile Include="Microsoft\Data\Common\DbConnectionOptions.cs" />
-    <Compile Include="Microsoft\Data\Common\DbConnectionString.cs" />
+    <Compile Include="Microsoft\Data\Common\DBConnectionString.cs" />


Case change for linux

mdaigle · 2025-12-05T19:57:26Z

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlMetaDataFactory.cs

Case change for linux

mdaigle · 2025-12-05T19:58:22Z

tools/props/Versions.props

    <MicrosoftWin32RegistryVersion>5.0.0</MicrosoftWin32RegistryVersion>
    <NewtonsoftJsonVersion>13.0.3</NewtonsoftJsonVersion>
    <SystemDataOdbcVersion>8.0.1</SystemDataOdbcVersion>
+    <SystemFormatsAsn1Version>6.0.1</SystemFormatsAsn1Version>


Accidentally deleted this in the last commit.

mdaigle · 2025-12-05T19:59:24Z

global.json

 {
  "sdk": {
-    "version": "9.0.0",
+    "version": "9.0.308",


Specifying a feature version allows this file to be used by the install-dotnet powershell script to install this version.

mdaigle · 2025-12-05T20:02:14Z

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

+
+        #nullable enable
+
+        public sealed class XEventScope : IDisposable


Converted XEventScope to a class because ref struct types are only available starting in c# v13 and this branch uses v9.

paulmedynski added 2 commits December 4, 2025 10:15

Fix xevent test failures, avoid orphaned sessions (#3775)

137905c

Disable scanning of Actions in CodeQL workflow (#3819)

a613600

Copilot AI review requested due to automatic review settings December 4, 2025 18:17

mdaigle changed the base branch from main to release/6.0 December 4, 2025 18:18

Copilot started reviewing on behalf of mdaigle December 4, 2025 18:18 View session

Copilot finished reviewing on behalf of mdaigle December 4, 2025 18:21

Copilot AI reviewed Dec 4, 2025

View reviewed changes

mdaigle added 2 commits December 4, 2025 10:46

Fix missed merge conflict. Adjust codeql trigger branch.

3380a1a

Fix compilation issues.

5bf7a5a

Copilot AI review requested due to automatic review settings December 4, 2025 18:56

Copilot started reviewing on behalf of mdaigle December 4, 2025 18:57 View session

Copilot finished reviewing on behalf of mdaigle December 4, 2025 19:01

Add basic global.json file and update codeql to reference it.

24ebf42

Copilot AI reviewed Dec 4, 2025

View reviewed changes

mdaigle added 2 commits December 4, 2025 11:27

Remove COMReference following the lead of #3403. Fix project sdk capi…

e9bb3fd

…talization to work on linux.

Fix file capitalization. Fix ruleset inclusion following the lead of #…

ec76c2f

…3754.

Copilot AI review requested due to automatic review settings December 4, 2025 19:41

Copilot started reviewing on behalf of mdaigle December 4, 2025 19:41 View session

Fix capitalization in netcore csproj file.

fb867eb

Copilot finished reviewing on behalf of mdaigle December 4, 2025 19:45

Copilot AI reviewed Dec 4, 2025

View reviewed changes

src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj Show resolved Hide resolved

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs Show resolved Hide resolved

mdaigle and others added 3 commits December 4, 2025 16:26

Downgrade xunit.

f23c4af

Add back asn1 version.

bd9d2a2

Copilot AI review requested due to automatic review settings December 5, 2025 00:43

Copilot started reviewing on behalf of mdaigle December 5, 2025 00:44 View session

Copilot finished reviewing on behalf of mdaigle December 5, 2025 00:47

Copilot AI reviewed Dec 5, 2025

View reviewed changes

mdaigle added 2 commits December 5, 2025 10:13

Use global.json for x86 sdk install.

1b9facd

Use more specific version for compatibility with install script.

428f91d

Copilot AI review requested due to automatic review settings December 5, 2025 18:56

Copilot started reviewing on behalf of mdaigle December 5, 2025 18:56 View session

Copilot AI reviewed Dec 5, 2025

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj Show resolved Hide resolved

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs Show resolved Hide resolved

mdaigle added 2 commits December 5, 2025 11:19

Install appropriate runtime for target framework.

6dc7593

Fix comments.

197250a

Copilot AI review requested due to automatic review settings December 5, 2025 19:33

Copilot started reviewing on behalf of mdaigle December 5, 2025 19:33 View session

Copilot AI reviewed Dec 5, 2025

View reviewed changes

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

mdaigle commented Dec 5, 2025

View reviewed changes

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlMetaDataFactory.cs

Copy link

Contributor Author

mdaigle Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Case change for linux

mdaigle commented Dec 5, 2025

View reviewed changes

mdaigle changed the title ~~[6.0] Fix xevent and codeql (#3775)(#3819)~~ [6.0] Fix xevent and codeql (#3775)(#3819), add global.json Dec 5, 2025

mdaigle commented Dec 5, 2025

View reviewed changes

mdaigle marked this pull request as ready for review December 5, 2025 20:02

mdaigle requested a review from a team as a code owner December 5, 2025 20:02

paulmedynski previously approved these changes Dec 5, 2025

View reviewed changes

cheenamalhotra previously approved these changes Dec 5, 2025

View reviewed changes

Update code coverage job to use global.json sdk version.

b666719

mdaigle dismissed stale reviews from cheenamalhotra and paulmedynski via b666719 December 5, 2025 22:01

	ids = TraceListener.ActivityIDs;
	ids = new HashSet<string>(TraceListener.IDs.ConvertAll(id => id.ToString()));

		@@ -1,4 +1,4 @@
		<Project Sdk="Microsoft.Net.Sdk">
		<Project Sdk="Microsoft.NET.Sdk">


		#nullable enable

		public sealed class XEventScope : IDisposable

[6.0] Fix xevent and codeql (#3775)(#3819), add global.json #3827

Are you sure you want to change the base?

[6.0] Fix xevent and codeql (#3775)(#3819), add global.json #3827

Uh oh!

Conversation

mdaigle commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

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!

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdaigle commented Dec 4, 2025 •

edited

Loading