Fix heartbeat telemetry serialization of nested objects#2032
Open
tyrielv wants to merge 1 commit into
Open
Conversation
EventMetadataConverter.WriteValue() was falling through to the default case (ToString()) for EventMetadata and Dictionary<string, string> values, producing type names like "GVFS.Common.Tracing.EventMetadata" instead of their key-value contents in the VFS.Heartbeat payload. Add pattern-match cases for EventMetadata (recursive) and IDictionary<string, string> so nested objects serialize as JSON objects. Assisted-by: Claude Opus 4.6 Signed-off-by: Tyrie Vella <tyrielv@gmail.com>
31309b1 to
e1854be
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
In GVFS 2.0.26162.1, the VFS.Heartbeat event's payload has a serialization regression. Fields that should contain structured data (
FilePlaceholderCreation,FolderPlaceholderCreation,FilePlaceholdersHydrated,PhysicalDiskInfo) are serialized as .NET type names instead of their key-value contents:{ "FilePlaceholderCreation": "GVFS.Common.Tracing.EventMetadata", "PhysicalDiskInfo": "System.Collections.Generic.Dictionary\2[System.String,System.String]" }Root Cause
EventMetadataConverter.WriteValue()had no pattern-match cases for nestedEventMetadataorDictionary<string, string>values. Both fell through todefault: writer.WriteStringValue(value.ToString()), which produces the type name.Fix
Added two case arms before the
defaultfall-through:EventMetadata nested— recursively serializes as a JSON objectIDictionary<string, string> dict— serializes as a flat string-to-string JSON objectTesting
Added
EventMetadataConverterTestswith 4 test cases covering nested EventMetadata, Dictionary<string, string>, empty nested objects, and primitive value passthrough. All pass.