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

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

Summary

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
Keep BUILDGUIDE.md aligned with the current build/pack entrypoint guidance
Include 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/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

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:34:36Z

  </ItemGroup>

+  <ItemGroup>
+    <ProjectReference Include="../../src/Microsoft.SqlServer.Server/Microsoft.SqlServer.Server.csproj"


@paulmedynski - Not sure this is necessary. The other siblings are all package refs.

Yeah, I think the samples should remain package references?

paulmedynski · 2026-05-04T18:35:43Z

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


@paulmedynski - Figure out why this project references SqlServer differently than src and ref.

paulmedynski · 2026-05-04T18:38:13Z

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

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


An alternative would be to execute a dotnet build and use the -getProperty option to return the computed version. That is likely the preferred approach.

paulmedynski · 2026-05-04T18:38:50Z

-                      instead (see Directory.Packages.props). When running in project mode, the
+                      parameters. If these are not provided, defaults are evaluated from each
+                      package's Versions.props and applied via Directory.Packages.props. When
+                      running in project mode, the


@paulmedynski - Fix wrapping.

paulmedynski · 2026-05-04T18:39:06Z

    <ReferenceTypeArgument Condition="'$(ReferenceType.ToLower())' == 'package'">
      -p:ReferenceType=Package
    </ReferenceTypeArgument>
-


@paulmedynski - Keep this empty line.

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

Copilot

Pull request overview

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

  </ItemGroup>

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


+For `PackSqlClient`, these additional parameters are required because dependency versions are injected into the SqlClient nuspec during pack:
+
+- `-p:PackageVersionAbstractions=<version>`
+- `-p:PackageVersionLogging=<version>`
+


-    We only need other driver package versions specified when building via
-    package references.
-  -->
+  <!-- The driver packages need versions numbers when we build via Package references. -->


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:46:37Z

Nb: I hate these dang little projects.

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.

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.

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

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


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

Copilot

Pull request overview

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

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


+  <PropertyGroup>
+    <BuildSqlClientUnixDependsOn Condition="'$(ReferenceType.ToLower())' == 'package'">PackAbstractions;PackLogging;PackSqlServer</BuildSqlClientUnixDependsOn>
+  </PropertyGroup>
+  <Target Name="BuildSqlClientUnix" DependsOnTargets="$(BuildSqlClientUnixDependsOn)">


      <DotnetCommand>
        "$(DotnetPath)dotnet" pack $(SqlServerProjectPath)
        -p:Configuration=$(Configuration)
+        -p:PackageOutputPath="$(PackagesDir)"


        <!-- Reference Type Arguments -->
        $(ReferenceTypeArgument)
        $(PackageVersionAbstractionsArgument)
        $(PackageVersionLoggingArgument)
+        $(PackageVersionSqlServerArgument)
      </DotnetCommand>


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

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

Conversation

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

Uh oh!

Summary

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!

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!

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

paulmedynski commented May 4, 2026 •

edited

Loading

paulmedynski May 4, 2026 •

edited

Loading