Add System.Text.Json polymorphic serialization support to TypedComponent
#1554
Conversation
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
…ponent` This change adds support for `System.Text.Json` serialization while maintaining backward compatibility with `Newtonsoft.Json`. `TypedComponent` and its derived types can now be serialized/deserialized with either JSON library. This enables gradual migration from `Newtonsoft.Json` to `System.Text.Json` without breaking existing serialization code or changing JSON output format. Related to #231
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1554 +/- ##
=====================================
Coverage 90.2% 90.2%
=====================================
Files 426 426
Lines 35965 35965
Branches 2216 2216
=====================================
+ Hits 32463 32465 +2
Misses 3045 3045
+ Partials 457 455 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Copilot finished reviewing on behalf of
JamieMagee
November 21, 2025 22:28
There was a problem hiding this comment.
Pull request overview
This PR adds System.Text.Json polymorphic serialization support to the TypedComponent class hierarchy while maintaining backward compatibility with Newtonsoft.Json. The implementation uses the [JsonPolymorphic] and [JsonDerivedType] attributes to enable polymorphic deserialization across all 19 component types.
Key changes:
- Adds
System.Text.Json.Serializationnamespace and polymorphic serialization attributes to TypedComponent - Registers all 19 derived component types (Cargo, Conan, Conda, DockerImage, DockerReference, DotNet, Git, Go, Linux, Maven, Npm, NuGet, Other, Pip, Pod, RubyGems, Spdx, Swift, Vcpkg) with type discriminators
- Uses attribute aliasing to distinguish between Newtonsoft.Json and System.Text.Json attributes where they share the same name
src/Microsoft.ComponentDetection.Contracts/TypedComponent/TypedComponent.cs
Show resolved
Hide resolved
jpinz
approved these changes
Nov 21, 2025
ryanbrandenburg
approved these changes
Nov 21, 2025
JamieMagee
deleted the
users/jamagee/system-text-json-typed-component
branch
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.
This change adds support for
System.Text.Jsonserialization while maintaining backward compatibility withNewtonsoft.Json.TypedComponentand its derived types can now be serialized/deserialized with either JSON library.This enables gradual migration from
Newtonsoft.JsontoSystem.Text.Jsonwithout breaking existing serialization code or changing JSON output format.Related to #231