Add Json Payload Functionality for User Agent Feature Extension

[samsharma2700]

Description

Part 2 of UserAgent work. Previous PR: #3451

• Adding necessary classes for UserAgentInfo json payload.
• Implements the current spec guidelines for this FE(https://microsoft.sharepoint-df.com/:w:/t/sqldevx/ERIWTt0zlCxLroNHyaPlKYwBI_LNSff6iy_wXZ8xX6nctQ?e=iP8q75)
• The payload is defined by a DTO(Data Transfer Object) class and a UserAgentInfo that implements spec constraints(character limits, bytes limits and field dropping logic etc.)
• Part 3 will make the changes to write the payload as a part of login flow

Testing

Builds are running and added unit tests to verify changes.

[Copilot]

Pull Request Overview

This PR implements the JSON payload functionality for the User Agent feature extension in Microsoft.Data.SqlClient, adding the core infrastructure for generating and managing user agent information that will be sent to SQL Server during connection establishment.

• Implements UserAgentInfo class with OS detection, architecture detection, and runtime information gathering
• Adds UserAgentInfoDto as a serializable data transfer object with size constraints and field-dropping logic
• Includes comprehensive unit tests covering field truncation, payload sizing, and JSON serialization

Reviewed Changes

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

Show a summary per file

File	Description
UserAgentInfo.cs (netfx/netcore)	Core implementation with OS/runtime detection and JSON payload generation with size constraints
UserAgentInfoDto.cs (netfx/netcore)	Data transfer object for JSON serialization with property name constants
UserAgentInfoTests.cs	Unit tests covering truncation logic, payload sizing, and JSON contract validation
Microsoft.Data.SqlClient.csproj (netfx/netcore)	Project file updates to include the new UserAgent classes
Microsoft.Data.SqlClient.UnitTests.csproj	Test project configuration with empty folder reference

Comments suppressed due to low confidence (2)

[roji]

@samsharma2700 @cheenamalhotra great to see this work happening. I've taken a look at the spec doc linked above, and could you clarify how we'd go about injecting EF information into the user agent? We'd need to identify EF Core (as opposed to direct users of SqlClient), it's version, etc.

[paulmedynski]

Hi @roji - There is a V2 of the design that adds a public API for middleware like EF to pass version information, but we need to go through a security and privacy review before we can implement it. This V1 phase only includes values we can pull from the runtime that don't have any such concerns.

[paulmedynski]

Need to move the UserAgent files into the src/ project and avoid duplicating them. I'll complete my review after the move.

[roji]

@paulmedynski ok - can you clarify what's planned for the 6.1.0 (v1, v2?)

[paulmedynski]

The V1 work will arrive in 7.0.0. The V2 work to support EF and other middleware may also make it into that timeframe, but depends on which reviews we need and how long they take. There is also ongoing SQL Server support that we need to align with to make any of this driver side work useful.

@samsharma2700 will be completing the V1 work over several PRs. We have (and will) put them into the 7.0.0-preview1 milestone.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.82%. Comparing base (42146a3) to head (8ad6f59).
⚠️ Report is 48 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #3489       +/-   ##
===========================================
+ Coverage   68.85%   90.82%   +21.96%     
===========================================
  Files         277        6      -271     
  Lines       62237      316    -61921     
===========================================
- Hits        42854      287    -42567     
+ Misses      19383       29    -19354     

Flag	Coverage Δ
addons	90.82% <ø> (ø)
netcore	?
netfx	?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[roji]

@paulmedynski thanks for the clarifications!

[paulmedynski]

You're on the right track here. We can discuss my comments and suggestions.

[paulmedynski]

Very close now; just a few more comments.

[benrr101]

😬 I'm gonna force braces for if statements if it's the last thing I do

[paulmedynski]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[paulmedynski]

Getting closer!

[benrr101]

👍

[paulmedynski]

Abandoned in favour of #3582.