Skip to content

Update UserAgent to pipe-delimited format#3826

Merged
paulmedynski merged 1 commit intomainfrom
dev/paul/user-agent
Jan 9, 2026
Merged

Update UserAgent to pipe-delimited format#3826
paulmedynski merged 1 commit intomainfrom
dev/paul/user-agent

Conversation

@paulmedynski
Copy link
Contributor

@paulmedynski paulmedynski commented Dec 4, 2025 •
edited
Loading

Description

This PR updates the UserAgent feature (once again) to employ the latest pipe-delimited format. The previous JSON format code has been removed.

The latest spec is here: SQL Drivers User Aget V1

Testing

  • Added unit tests for the new UserAgent static class.
  • Updated existing TDS tests to expect the new format.
  • Manually tested with a development version of SQL Server that supports the UserAgent feature extension.

@paulmedynski paulmedynski added this to the 7.0.0 milestone Dec 4, 2025
@paulmedynski paulmedynski requested a review from a team as a code owner December 4, 2025 16:28
Copilot AI review requested due to automatic review settings December 4, 2025 16:28
@github-project-automation github-project-automation bot moved this to To triage in SqlClient Board Dec 4, 2025
@paulmedynski paulmedynski moved this from To triage to In review in SqlClient Board Dec 4, 2025
Copilot AI reviewed Dec 4, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR transitions the UserAgent feature from a JSON-based format to a pipe-delimited format for the TDS LOGIN7 USERAGENT Feature Extension. The change simplifies the implementation by eliminating JSON serialization overhead and aligns with the latest specification.

Key Changes:

  • Replaced JSON-serialized UserAgent with a pipe-delimited string format (1|MS-MDS|{version}|{OS}|{arch}|{OS info}|{runtime info})
  • Removed version byte from the feature extension payload (previously 1 byte for version + JSON, now just the UCS-2 encoded pipe-delimited string)
  • Changed encoding from UTF-8 to UCS-2 (little-endian Unicode)

Reviewed changes

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

Show a summary per file
File Description
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/UserAgent.cs New implementation of UserAgent class with pipe-delimited format, replacing the previous JSON-based implementation
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/UserAgent/UserAgentInfo.cs Removed - old JSON-based UserAgent implementation
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/UserAgent/UserAgentInfoDto.cs Removed - DTO for JSON serialization, no longer needed
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParser.cs Updated to use new pipe-delimited format; removed version byte from payload; updated parameter types from byte[] to ReadOnlyMemory<byte>
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsEnums.cs Removed constants for version byte and SQL_PROVIDER_NAME that are no longer used
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlException.cs Replaced TdsEnums.SQL_PROVIDER_NAME with direct reference to DbConnectionStringDefaults.ApplicationName
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlError.cs Replaced TdsEnums.SQL_PROVIDER_NAME with direct reference to DbConnectionStringDefaults.ApplicationName
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/LocalAppContextSwitches.cs Updated documentation comment for EnableUserAgent property
src/Microsoft.Data.SqlClient/tests/UnitTests/UserAgentTests.cs New comprehensive unit tests for the pipe-delimited UserAgent implementation
src/Microsoft.Data.SqlClient/tests/UnitTests/UserAgentInfoTests.cs Removed - tests for old JSON-based implementation
src/Microsoft.Data.SqlClient/tests/UnitTests/TdsParserInternalsTest.cs Updated tests to expect new pipe-delimited format without version byte
src/Microsoft.Data.SqlClient/tests/UnitTests/SimulatedServerTests/ConnectionTests.cs Updated integration test to validate new UserAgent format
src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/UdtSerialization/NativeSerializationTest.cs Added DisableDiscoveryEnumeration to improve test performance (unrelated optimization)
src/Microsoft.Data.SqlClient/tests/tools/TDS/TDS.Servers/GenericTdsServer.cs Added comment clarification (cosmetic change)
src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj Updated project file to reference new UserAgent.cs and remove old files
src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj Updated project file to reference new UserAgent.cs and remove old files
spec/user-agent-v1.jsonc Removed - JSON schema specification no longer applicable

paulmedynski
paulmedynski commented Dec 4, 2025
View reviewed changes
Copy link
Contributor Author

@paulmedynski paulmedynski left a comment

Choose a reason for hiding this comment

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

Commentary for reviewers, and things for me to fix.

Copilot AI review requested due to automatic review settings December 8, 2025 14:03
Copilot AI reviewed Dec 8, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

@priyankatiwari08 priyankatiwari08 self-assigned this Dec 9, 2025
@paulmedynski paulmedynski modified the milestones: 7.0.0, 7.0.0-preview4 Dec 16, 2025
Copilot AI review requested due to automatic review settings December 16, 2025 10:35
Copilot AI reviewed Dec 16, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

mdaigle
mdaigle previously approved these changes Dec 18, 2025
View reviewed changes
@ErikEJ
Copy link
Contributor

ErikEJ commented Dec 18, 2025

Is this feature available in any released version of the SQL engine?

@paulmedynski
Copy link
Contributor Author

paulmedynski commented Dec 18, 2025

Is this feature available in any released version of the SQL engine?

AFAIK the server side is being implemented for Azure SQL. I don't believe there are plans to include it with SQL Server box editions.

Copilot AI review requested due to automatic review settings December 23, 2025 17:32
Copilot AI reviewed Dec 23, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

@edwardneal edwardneal mentioned this pull request Dec 26, 2025
Merged
Copilot AI review requested due to automatic review settings January 2, 2026 11:58
Copilot AI reviewed Jan 2, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

@paulmedynski
Copy link
Contributor Author

paulmedynski commented Jan 5, 2026

I will wait for #3772 to merge before I merge this PR.

@paulmedynski
- Resurrected the original pipe-delimited work and renamed it to User…
db6cc4d 
…Agent.

  - Reverted commit e0fa87b.
- Removed the JSON-based user agent classes.
- Updated UserAgent to produce the proper pipe-delimited format.
- Updated TDS emission to remove UserAgent version byte.
- Swapped the Architecture and OS Type fields.
samsharma2700
samsharma2700 approved these changes Jan 6, 2026
View reviewed changes
Copy link
Contributor

@samsharma2700 samsharma2700 left a comment

Choose a reason for hiding this comment

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

Minor change suggestion, everything else looks great!

@paulmedynski paulmedynski merged commit 2343c81 into main Jan 9, 2026
250 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in SqlClient Board Jan 9, 2026
@paulmedynski paulmedynski deleted the dev/paul/user-agent branch January 9, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@mdaigle mdaigle mdaigle approved these changes

@samsharma2700 samsharma2700 samsharma2700 approved these changes

Assignees

@priyankatiwari08 priyankatiwari08

Labels

None yet

Projects

SqlClient Board
Status: Done

Milestone

7.0.0-preview4

Development

Successfully merging this pull request may close these issues.

6 participants

@paulmedynski @ErikEJ @mdaigle @samsharma2700 @priyankatiwari08