Fix SqlServer sibling reference handling by paulmedynski · Pull Request #4259 · dotnet/SqlClient

paulmedynski · 2026-05-04T18:27:52Z

Summary

Core fix

Align Microsoft.SqlServer.Server sibling references across affected projects to respect ReferenceType (Project vs Package)
Ensure package-mode version flow includes SqlServerPackageVersion wiring through build orchestration
Update test/sample project references for consistent restore/build behavior

Additional changes

Fix Microsoft.SqlServer.Server pack output path so artefacts land in the expected artifacts/ directory
Gate unsigned net462 UDT tests via new SqlServerStrongNameTestCondition helper to avoid FileLoadException (0x80131044) when the assembly is unsigned (project-ref or local-feed builds)
Fix package-mode local feed mirroring and eliminate duplicate Versions.props imports
Add missing SqlServerPackageVersion to doc/samples project
Add implicit usings to Microsoft.Data.SqlClient.TestCommon to simplify shared test helpers
Add BuildAll target to build.proj that builds all projects across all OS/TFM combinations; hook CodeQL to BuildAll so more code is compiled during analysis
Remove obsolete/spurious <Project> attributes (ToolsVersion, stray DefaultTargets) from props files
Reduce build console noise by suppressing duplicate repo-URL messages
Keep BUILDGUIDE.md aligned with current build/pack entrypoint guidance
Post-rebase conflict cleanup in Microsoft.Data.SqlClient.csproj

Validation

dotnet build src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft.Data.SqlClient.UnitTests.csproj -f net8.0 -v minimal
dotnet build src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft.Data.SqlClient.UnitTests.csproj -f net462 -p:OS=Windows_NT
dotnet build src/Microsoft.Data.SqlClient/tests/ManualTests/Microsoft.Data.SqlClient.ManualTests.csproj -f net8.0 -v minimal
dotnet build build.proj -t:BuildSqlClientUnix -p:ReferenceType=Package -v minimal
dotnet build src/Microsoft.Data.SqlClient.slnx -v minimal
dotnet build build.proj -p:Configuration=Debug
dotnet msbuild build.proj -t:BuildAll -p:Configuration=Debug

Copilot

Pull request overview

This PR updates how the repo’s sibling Microsoft.SqlServer.Server dependency is referenced under ReferenceType (Project vs Package), so package-mode builds/restores can resolve consistent versions and projects that require internals can explicitly enforce project-mode.

Changes:

Switched several test/sample projects from unconditional Microsoft.SqlServer.Server package references to ProjectReference/PackageReference conditioned on $(ReferenceType).
Added a unit-test guard to explicitly reject ReferenceType=Package.
Updated build.proj/Directory.Packages.props to flow SqlServerPackageVersion in package mode and to pack Microsoft.SqlServer.Server into the local packages feed.

Reviewed changes

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

Show a summary per file

File	Description
src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft.Data.SqlClient.UnitTests.csproj	Adds `Microsoft.SqlServer.Server` project reference and rejects `ReferenceType=Package`.
src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/UdtTest/UDTs/Utf8String/Utf8String.csproj	Conditional project/package reference for `Microsoft.SqlServer.Server`.
src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/UdtTest/UDTs/Shapes/Shapes.csproj	Conditional project/package reference for `Microsoft.SqlServer.Server`.
src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/UdtTest/UDTs/Circle/Circle.csproj	Conditional project/package reference for `Microsoft.SqlServer.Server` (also normalizes file header).
src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/UdtTest/UDTs/Address/Address.csproj	Conditional project/package reference for `Microsoft.SqlServer.Server` (also normalizes file header).
src/Microsoft.Data.SqlClient/tests/ManualTests/Microsoft.Data.SqlClient.ManualTests.csproj	Centralizes conditional `Microsoft.SqlServer.Server` reference for manual tests.
src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.csproj	Removes unused `Microsoft.SqlServer.Server` package reference from ref build project.
src/Microsoft.Data.SqlClient/notsupported/Microsoft.Data.SqlClient.csproj	Uses project reference for `Microsoft.SqlServer.Server` in project mode and package ref in package mode.
src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj	Formatting-only tweak to conditional reference items.
doc/samples/Microsoft.Data.SqlClient.Samples.csproj	Makes `Microsoft.SqlServer.Server` a conditional project/package reference based on `ReferenceType`.
Directory.Packages.props	Moves `Microsoft.SqlServer.Server` version declaration under `ReferenceType=Package` and uses `$(SqlServerPackageVersion)`.
build.proj	Imports `Versions.props` to set default package versions in package mode; fixes SqlServer version forwarding; packs `Microsoft.SqlServer.Server` to `$(PackagesDir)`; adds package-mode pack dependencies to build targets.

paulmedynski · 2026-05-04T18:40:59Z

  -->
-  <Target Name="BuildSqlClientNotSupported">
+  <PropertyGroup>
+    <BuildSqlClientNotSupportedDependsOn Condition="'$(ReferenceType.ToLower())' == 'package'">PackAbstractions</BuildSqlClientNotSupportedDependsOn>


@benrr101 - Do we want these Build* and Pack* targets to depend on the Pack targets of the siblings this target depends on?

I think I would like this to work without any previous targets run, and use default package versions:

dotnet build -t:BuildSqlClient -p:ReferenceType=Package

The latest commits achieve the above. Package mode now automatically ensures that the NuGet packages of sibling dependencies are built and put into packages/.

Copilot

Pull request overview

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

benrr101

Blocking on:

Package/project reference going in their own item group, as per existing pattern
Revisiting the intention of including the version props file in build.proj and confusing the recalculation of versions.

benrr101 · 2026-05-07T18:45:19Z

    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" />
    <PackageReference Include="Microsoft.IdentityModel.Protocols.OpenIdConnect" />
-    <PackageReference Include="Microsoft.SqlServer.Server" />
+    <PackageReference Include="Microsoft.SqlServer.Server" Condition="'$(ReferenceType)' == 'Package'" />


Please follow the above pattern above - put both package and project references (like this) in one item group.

benrr101 · 2026-05-07T18:45:44Z

    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" />
    <PackageReference Include="Microsoft.IdentityModel.Protocols.OpenIdConnect" />
-    <PackageReference Include="Microsoft.SqlServer.Server" />
+    <PackageReference Include="Microsoft.SqlServer.Server" Condition="'$(ReferenceType)' == 'Package'" />


Remove this in favor of the package/project reference in a separate item group above

benrr101 · 2026-05-07T18:51:57Z

  <!-- Imports ========================================================= -->
  <Import Project="src/Directory.Build.props" />

+  <!-- Import each project's Versions.props to apply default version numbers in Package mode. -->


I don't think this will work as well as you think it will ... The parameters passed to build.proj are PackageVersion* while the parameters passed to the csproj (and props files) are *PackageVersion. This was a compromise between wanting neat and orderly parameters in build2.proj, and not obliterating the existing csproj parameters.

Yep, this wasn't the correct approach. Added imports to Directory.Packages.props to ensure defaults are computed early enough in the build process to be applied correctly for Package builds.

benrr101 · 2026-05-07T18:58:33Z

      Example:        1.0.1-dev2345
    -->
-    <PackageVersionAbstractions Condition="'$(PackageVersionAbstractions)' == ''" />
+    <PackageVersionAbstractions Condition="'$(PackageVersionAbstractions)' == ''">$(AbstractionsPackageVersion)</PackageVersionAbstractions>


This more or less confound the whole versioning process I laid out...
The intention was that each project would know what its versions should be, and any projects that depend on another project just references that project and gets the sibling version. Further, the intention is that package reference goes away, so the remaining scenario where a package version is needed goes away.

Doing things this way means .... we calculate the versions with only some of the parameters provided, then call dotnet with this version, then recalculate the version with the package version provided. I think it's confusing and I'm not sure what scenario its trying to solve.

Correct - see above reply.

benrr101 · 2026-05-07T18:59:52Z

        $(ReferenceTypeArgument)
        $(PackageVersionAbstractionsArgument)
        $(PackageVersionLoggingArgument)
+        $(PackageVersionSqlServerArgument)


This isn't being added as a parameter at the top.

This property is computed as expected now.

Copilot

Pull request overview

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

…ports

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Comments suppressed due to low confidence (1)

src/Microsoft.SqlServer.Server/Microsoft.SqlServer.Server.csproj:13

Because this Versions.props import is now gated by $(SqlServerVersionsImported), any earlier import (e.g., via Directory.Packages.props in ReferenceType=Package builds) will prevent re-importing after src/Directory.Build.props defines FileVersionBuildNumber. If the earlier import occurs before FileVersionBuildNumber is set, SqlServerFileVersion/SqlServerAssemblyVersion can be computed incorrectly and then “locked in” for the rest of the build. To make the guard safe, ensure Versions.props can compute correct versions even when imported before Directory.Build.props (e.g., define BuildNumber/FileVersionBuildNumber defaults inside Versions.props).

  <!-- Versioning ====================================================== -->
  <Import Project="Versions.props" Condition="'$(SqlServerVersionsImported)' != 'true'" />
  <PropertyGroup>
    <AssemblyVersion>$(SqlServerAssemblyVersion)</AssemblyVersion>
    <FileVersion>$(SqlServerFileVersion)</FileVersion>
    <Version>$(SqlServerPackageVersion)</Version>

+  <!-- Import Versions.props files when building via Package references -->
+  <!-- This makes version properties available early for package pinning -->
+  <ImportGroup Condition="'$(ReferenceType)' == 'Package'">
+    <Import Project="src/Microsoft.Data.SqlClient/Versions.props" />
+    <Import Project="src/Microsoft.SqlServer.Server/Versions.props" />


…mbinations to help catch obvious problems pre-commit. - Updated CodeQL to use the new BuildAll target, since it compiles more code than using the solution. - Removed some obsolete and spurious <Project> attributes. - Reduced build console noise about repo URLs.

Copilot

Pull request overview

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

+
+  <!-- Setup of list of the supported OSes. -->
+  <PropertyGroup>
+    <_OsList>Windows_NT;Unix</_OsList>


      if: matrix.build-mode == 'manual'
      shell: bash
-      run: dotnet build src/Microsoft.Data.SqlClient.slnx
+      run: dotnet build build.proj -t:BuildAll



+  <Target Name="ValidateReferenceType"
+          BeforeTargets="Restore;PrepareForBuild"
+          Condition="'$(ReferenceType)' != 'Project'">


paulmedynski · 2026-05-12T14:20:18Z

      if: matrix.build-mode == 'manual'
      shell: bash
-      run: dotnet build src/Microsoft.Data.SqlClient.slnx
+      run: dotnet build build.proj -t:BuildAll


This compiles more code than the bare solution due to our TFM choice via host OS conditionals in some projects.

paulmedynski · 2026-05-12T14:22:14Z


  <!-- Versioning ====================================================== -->
-  <Import Project="Versions.props" />
+  <Import Project="Versions.props" Condition="'$(AkvProviderVersionsImported)' != 'true'" />


See Directory.Packages.props for an explanation of why Versions.props may already be imported by the time we get here. Same for all the other driver projects.

paulmedynski · 2026-05-12T14:23:50Z

  <Target Name="TrimDocsForIntelliSense"
          AfterTargets="Build"
-          Condition="'$(IsCrossTargetingBuild)' != 'true' AND '$(GenerateDocumentationFile)' == 'true'">
+          Condition="'$(TrimDocs)' != 'false' AND '$(IsCrossTargetingBuild)' != 'true' AND '$(GenerateDocumentationFile)' == 'true'">


The new BuildAll target wants to generate the docs, but doesn't want to run the trimming.

paulmedynski · 2026-05-12T14:25:36Z

      <NuspecProperties>$(NuspecProperties);COMMITID=$(CommitId)</NuspecProperties>
+    </PropertyGroup>
+
+    <!-- Check for empty sibling package versions. -->


@benrr101 - Do you think we need these checks? AI suggested them, but then why not for the other driver projects that depend on siblings?

paulmedynski · 2026-05-12T14:30:09Z

+namespace Microsoft.Data.SqlClient.TestCommon;
+
+/// <summary>
+/// Provides a shared xUnit conditional check for tests that depend on SQL Server UDT types.


This is a side-effect of promoting the SqlServer project to a first-class citizen in the build system. Now that we have proper Project vs Package refs for it throughout, we end up sometimes wanting to run tests with an unsigned SqlServer assembly, which we never did before. A few of our tests require the unrelated Microsoft.SqlServer.Types package, which in turn depends on SqlServer, and on .NET Framework will require a signed SqlServer assembly.

We now avoid running these few tests when SqlServer isn't signed and we're using .NET Framework. These tests still run fine on all .NET runtimes. Our ADO.Net CI pipelines will sign everything, and these tests will run for .NET Framework there.

Alternatively, we could isolate these tests into their own project that always references a known published SqlServer package that is signed, and then they could run all the time. Thoughts?

paulmedynski · 2026-05-12T14:36:56Z

      graphs with packages they never asked for.
    -->
    <CentralPackageTransitivePinningEnabled>false</CentralPackageTransitivePinningEnabled>
+


@paulmedynski - Unnecessary blank line.

paulmedynski · 2026-05-12T14:37:52Z

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">


I think previously Build was the default because it appeared first. Now it's official.

paulmedynski · 2026-05-12T14:40:01Z

  -->
-  <Target Name="BuildSqlClientNotSupported">
+  <PropertyGroup>
+    <BuildSqlClientNotSupportedDependsOn Condition="'$(ReferenceType.ToLower())' == 'package'">PackAbstractions;PackSqlServer</BuildSqlClientNotSupportedDependsOn>


@paulmedynski - Remove ToLower() here - the acceptable values are "Package" and "Project", case-sensitive. There's no need to support random casing.

paulmedynski · 2026-05-12T14:41:58Z

+  <!-- ================================================================= -->
+  <!-- Ancillary Targets -->
+
+  <!-- Setup of list of the supported OSes. -->


@paulmedynski - "Setup the list of supported OSes."

paulmedynski · 2026-05-12T14:42:50Z

+    <Exec ConsoleToMsBuild="true"
+          Command="&quot;$(DotnetPath)dotnet&quot; build $(AzureTestsProjectPath) $(_DotnetArguments) -p:OS=%(_OsValues.Identity)" />
+  </Target>
+


@paulmedynski - Add a note that AKV Provider has no tests.

Copilot AI review requested due to automatic review settings May 4, 2026 18:27

github-project-automation Bot added this to SqlClient Board May 4, 2026

github-project-automation Bot moved this to To triage in SqlClient Board May 4, 2026

Copilot started reviewing on behalf of paulmedynski May 4, 2026 18:28 View session

paulmedynski added the Area\Engineering Use this for issues that are targeted for changes in the 'eng' folder or build systems. label May 4, 2026

paulmedynski moved this from To triage to In progress in SqlClient Board May 4, 2026

paulmedynski added this to the 7.1.0-preview2 milestone May 4, 2026

Copilot AI reviewed May 4, 2026

View reviewed changes

Comment thread src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft.Data.SqlClient.UnitTests.csproj Outdated

Comment thread build.proj Outdated

paulmedynski commented May 4, 2026

View reviewed changes

paulmedynski mentioned this pull request May 4, 2026

Migrate SqlClient packaging to dotnet pack and centralize pack fallback #4257

Merged

paulmedynski force-pushed the dev/paul/dotnet-pack-sqlclient branch from 2851620 to 775fa11 Compare May 5, 2026 12:54

Copilot AI review requested due to automatic review settings May 5, 2026 13:14

paulmedynski force-pushed the dev/paul/reference-type branch from f4fcba7 to d0492fe Compare May 5, 2026 13:14

Copilot started reviewing on behalf of paulmedynski May 5, 2026 13:15 View session

paulmedynski changed the title ~~Fix SqlServer sibling reference handling~~ Workstream 1.5: SqlClient dotnet pack migration with sibling reference alignment May 5, 2026

paulmedynski changed the title ~~Workstream 1.5: SqlClient dotnet pack migration with sibling reference alignment~~ Sibling prokect reference alignment May 5, 2026

paulmedynski changed the title ~~Sibling prokect reference alignment~~ Sibling project reference alignment May 5, 2026

paulmedynski changed the title ~~Sibling project reference alignment~~ Fix SqlServer sibling reference handling May 5, 2026

Copilot AI reviewed May 5, 2026

View reviewed changes

Comment thread src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft.Data.SqlClient.UnitTests.csproj Outdated

Comment thread BUILDGUIDE.md Outdated

Comment thread Directory.Packages.props Outdated

benrr101 requested changes May 7, 2026

View reviewed changes

paulmedynski force-pushed the dev/paul/reference-type branch from d0492fe to 88d1198 Compare May 8, 2026 13:32

Base automatically changed from dev/paul/dotnet-pack-sqlclient to main May 8, 2026 19:10

paulmedynski added 3 commits May 8, 2026 17:02

Fix SqlServer sibling reference handling

56da973

Address Copilot review comments in PR 4259

191c536

Resolve merge conflicts after rebase

8200659

Copilot AI review requested due to automatic review settings May 8, 2026 20:03

paulmedynski force-pushed the dev/paul/reference-type branch from 88d1198 to 8200659 Compare May 8, 2026 20:03

Copilot started reviewing on behalf of paulmedynski May 8, 2026 20:03 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Comment thread src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj Outdated

Comment thread build.proj

Comment thread build.proj Outdated

Comment thread build.proj

Fix package-mode local feed mirroring and Versions.props duplicate im…

088fa13

…ports

paulmedynski added 2 commits May 11, 2026 12:57

Address remaining PR 4259 review feedback

82e400b

Added missing SqlServer package version to Samples.

5f11e17

Copilot AI review requested due to automatic review settings May 11, 2026 16:05

Copilot started reviewing on behalf of paulmedynski May 11, 2026 16:06 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

Comment thread src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj Outdated

Comment thread build.proj

Comment thread src/Microsoft.Data.SqlClient/notsupported/Microsoft.Data.SqlClient.csproj Outdated

paulmedynski added 2 commits May 11, 2026 13:35

Address remaining Copilot PR 4259 feedback

90ba43d

Fix SqlServer pack output path and gate unsigned net462 UDT tests

da86109

Copilot AI review requested due to automatic review settings May 11, 2026 18:22

Copilot started reviewing on behalf of paulmedynski May 11, 2026 18:23 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

paulmedynski added 2 commits May 12, 2026 08:26

Added implicit usings to the Test.Common project.

c9d879a

Copilot AI review requested due to automatic review settings May 12, 2026 14:19

Copilot started reviewing on behalf of paulmedynski May 12, 2026 14:20 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

paulmedynski commented May 12, 2026

View reviewed changes

Conversation

paulmedynski commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Core fix

Additional changes

Validation

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!

paulmedynski May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

Uh oh!

Uh oh!

benrr101 left a comment

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!

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!

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

paulmedynski commented May 4, 2026 •

edited

Loading

paulmedynski May 4, 2026 •

edited

Loading