Fix Windows desktop OS build version reporting by bmehta001 · Pull Request #1441 · microsoft/cpp_client_telemetry

bmehta001 · 2026-05-18T22:29:57Z

Summary

Stop using stale BuildLabEx to populate the Windows desktop OsBuild / �xt.os.ver field.
Use the Windows-team-recommended source of truth: RtlGetVersion().dwBuildNumber for the running OS build, combined with the registry UBR (Update Build Revision) for serviced builds.
Add Windows PAL unit tests for the formatted OS full version with UBR present, UBR absent, and a zero UBR.

⚠️ Behavior change for downstream telemetry consumers

Please include in the release notes for the next tagged build.

Before this PR, DeviceInfo.OsBuild / ext.os.ver on Windows desktop could be a BuildLabEx-style string (e.g. 26100.1.amd64fre.ge_release.240331-1435). After this PR it is always a numeric major.minor.build[.ubr] value (e.g. 10.0.26100.4061).

✅ Queries that already expected the four-dotted-numeric form will start receiving correct, servicing-aware values (this fixes [Windows] 1DS reports OS version of the base OS at RTM and does not reflect any servicing updates #1407).
❌ Dashboards / Kusto queries that parsed the BuildLabEx form (split on ., substring extraction for branch / flavor / date) will need to be updated.

If you maintain downstream consumers of DeviceInfo.OsBuild / ext.os.ver, please audit those queries before the next release containing this change rolls out.

Why this source

Confirmed with the Windows team:

Ideally use the API, and it is always safe to combine with UBR. The API and the registry should always be in sync. The reason the registry can be used is for offline reading.

So we prefer RtlGetVersion() (kernel-authoritative for the running OS) and add UBR from HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\UBR. The registry CurrentBuildNumber / CurrentBuild precedence chain is not needed here — those are useful for offline-reading another Windows installation's hive, not the live running OS.

Validation

msbuild Solutions\MSTelemetrySDK.sln /t:Tests\UnitTests /p:Configuration=Release /p:Platform=x64 /p:PlatformToolset=v145
UnitTests.exe --gtest_filter=PalTests.* → 10 tests passed, including the three new WindowsOsFullVersion* cases
UnitTests.exe (full run) → 463 tests passed

Use servicing-aware registry values so desktop telemetry reports the current Windows build instead of stale BuildLabEx data after OS updates. Files changed: - lib/pal/desktop/WindowsDesktopSystemInformationImpl.cpp - tests/unittests/PalTests.cpp Fixes microsoft#1407 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Refactor the Windows OS full-version composition into a testable helper so registry and Rtl build source precedence can be covered without depending on the host machine state. The new PAL tests cover CurrentBuildNumber precedence, CurrentBuild fallback, Rtl build fallback, and missing UBR formatting so future key or fallback regressions are caught before merge. Files changed: - lib/pal/desktop/WindowsDesktopSystemInformationImpl.cpp - tests/unittests/PalTests.cpp Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add a deterministic PAL test proving that UBR value 0 is still included when the source reports it as present. This keeps zero-value handling separate from the missing-UBR fallback. Files changed: - tests/unittests/PalTests.cpp Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

This PR fixes incorrect Windows desktop OS full version reporting by switching from the stale BuildLabEx registry value to servicing-aware build sources (CurrentBuildNumber/CurrentBuild + UBR), with a fallback to RtlGetVersion() when registry values are unavailable. This addresses issue #1407 where serviced builds were reported as their RTM base build.

Changes:

Replace BuildLabEx usage with CurrentBuildNumber/CurrentBuild and UBR (with fallback to RtlGetVersion() build).
Add helper routines to format and select the OS build string from available sources.
Add Windows PAL unit tests covering formatting and source-precedence behavior, including UBR-present vs UBR-missing cases.

Reviewed changes

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

File	Description
tests/unittests/PalTests.cpp	Adds Windows-only unit tests validating OS full version formatting and precedence/fallback behavior.
lib/pal/desktop/WindowsDesktopSystemInformationImpl.cpp	Updates Windows desktop OS version detection to use servicing-aware registry values (and fallback to RTL build) instead of `BuildLabEx`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bmehta001 · 2026-05-21T00:58:47Z

@GovM-MSFT from the Windows org is familiar with versioning and his team was the one that reported the issue, so I requested him to review the PR. He could not access the PR here for some reason, but was able to review a mirror I created on my fork with his personal GitHub account and has approved it.

lalitb · 2026-05-22T01:48:30Z

One compatibility note: this changes the shape of the Windows value that flows into DeviceInfo.OsBuild / ext.os.ver. Previously this could be a BuildLabEx-style string, and after this change it becomes a numeric major.minor.build[.ubr] value. We should call it out clearly in the PR description and also in release notes so downstream telemetry consumers are aware of the field format change.

Apart from that, changes look good to me - but would let @ThomsonTan approve this, as he knows this part of code better.

Per Windows-team guidance on issue microsoft#1407: the RtlGetVersion() API is the authoritative source for the running OS build number, and the registry CurrentBuildNumber / CurrentBuild values are only useful for offline reads of another Windows installation. For the running OS the API and registry are always in sync, so prefer the API. UBR is registry-only and is always safe to combine with the kernel-provided build number. Drop the registry CurrentBuildNumber / CurrentBuild precedence chain and the now-unused getCurrentVersionStringValue helper. Format the OS full version directly from rtlOsvi.dwBuildNumber plus the optional UBR. Update PalTests to cover the simplified formatter (UBR present, UBR missing, zero UBR present), replacing the obsolete source-precedence tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

bmehta001 · 2026-05-23T00:12:34Z

Modified the PR body

Spelled out both sides explicitly:

queries that already expected major.minor.build[.ubr] start getting correct servicing-aware values (fixes [Windows] 1DS reports OS version of the base OS at RTM and does not reflect any servicing updates #1407)
queries that parsed BuildLabEx (split on ., branch/flavor/date substrings) will need updates

Copilot

Pull request overview

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

bmehta001 requested a review from a team as a code owner May 18, 2026 22:29

bmehta001 requested a review from stevevd May 20, 2026 15:48

Merge branch 'main' into bhamehta/fix-windows-os-version

9ab7dec

ThomsonTan reviewed May 20, 2026

View reviewed changes

Comment thread tests/unittests/PalTests.cpp Outdated

bmehta001 and others added 2 commits May 20, 2026 18:43

bmehta001 self-assigned this May 21, 2026

bmehta001 requested review from GovM-MSFT and Copilot May 21, 2026 00:30

Copilot started reviewing on behalf of bmehta001 May 21, 2026 00:34 View session

Copilot AI reviewed May 21, 2026

View reviewed changes

bmehta001 requested a review from ThomsonTan May 21, 2026 00:58

lalitb reviewed May 22, 2026

View reviewed changes

Comment thread lib/pal/desktop/WindowsDesktopSystemInformationImpl.cpp Outdated

bmehta001 and others added 3 commits May 22, 2026 01:48

Merge branch 'main' into bhamehta/fix-windows-os-version

278d785

Merge branch 'main' into bhamehta/fix-windows-os-version

969145e

bmehta001 force-pushed the bhamehta/fix-windows-os-version branch from 5042ec7 to 78e6db4 Compare May 23, 2026 00:01

bmehta001 mentioned this pull request May 23, 2026

[Mirror] Fix Windows desktop OS build version reporting bmehta001/cpp_client_telemetry#5

Open

bmehta001 requested a review from Copilot May 28, 2026 17:23

Copilot started reviewing on behalf of bmehta001 May 28, 2026 17:24 View session

Copilot AI reviewed May 28, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Windows desktop OS build version reporting#1441

Fix Windows desktop OS build version reporting#1441
bmehta001 wants to merge 7 commits into
microsoft:mainfrom
bmehta001:bhamehta/fix-windows-os-version

bmehta001 commented May 18, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

bmehta001 commented May 21, 2026 •

edited

Loading

Uh oh!

Uh oh!

lalitb commented May 22, 2026 •

edited

Loading

Uh oh!

bmehta001 commented May 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

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

Uh oh!

Summary

⚠️ Behavior change for downstream telemetry consumers

Why this source

Validation

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

bmehta001 commented May 23, 2026 • 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

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bmehta001 commented May 18, 2026 •

edited

Loading

bmehta001 commented May 21, 2026 •

edited

Loading

lalitb commented May 22, 2026 •

edited

Loading

bmehta001 commented May 23, 2026 •

edited

Loading