Migrate ComponentDetectionIntegrationTests exclusively to System.Text.Json
#1558
+3
−3
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
…ext.Json` In #1523 we added the `[JsonProperty(Order = int.MinValue]` `Newtonsoft.Json` attribute to the `Type` property of the `TypedComponent` class to ensure that `"type"` would appear first in the serialized object. This is because `System.Text.Json` requires the type discriminator to be the first property of the object[^1]. `System.Text.Json` `9.0.0` and later does support the `JsonSerializerOptions.AllowOutOfOrder` option[^2], but as we're targeting .NET 8, we don't have access to that. [^1]: https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism#polymorphic-type-discriminators [^2]: https://learn.microsoft.com/en-us/dotnet/api/system.text.json.jsonserializeroptions.allowoutofordermetadataproperties?view=net-10.0#system-text-json-jsonserializeroptions-allowoutofordermetadataproperties
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1558 +/- ##
=====================================
Coverage 90.2% 90.2%
=====================================
Files 426 426
Lines 35965 35965
Branches 2216 2216
=====================================
+ Hits 32463 32464 +1
Misses 3045 3045
+ Partials 457 456 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR migrates the ComponentDetectionIntegrationTests class from Newtonsoft.Json to System.Text.Json for deserializing scan manifest files. The change aligns with the broader codebase effort to support polymorphic deserialization of TypedComponent objects using System.Text.Json's built-in polymorphism support introduced in .NET 7+.
Key Changes
- Removed
Newtonsoft.Jsonusing directive and replaced withSystem.Text.Json - Converted
JsonConvert.DeserializeObjectcalls toJsonSerializer.Deserialize - Removed redundant fully-qualified namespace prefix from one deserialization call
test/Microsoft.ComponentDetection.VerificationTests/ComponentDetectionIntegrationTests.cs
Show resolved
Hide resolved
test/Microsoft.ComponentDetection.VerificationTests/ComponentDetectionIntegrationTests.cs
Show resolved
Hide resolved
jpinz
approved these changes
Nov 24, 2025
JamieMagee
deleted the
users/jamagee/component-detection-integration-tests-system-text-json
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.
In #1523 we added the
[JsonProperty(Order = int.MinValue]Newtonsoft.Jsonattribute to theTypeproperty of theTypedComponentclass to ensure that"type"would appear first in the serialized object. This is becauseSystem.Text.Jsonrequires the type discriminator to be the first property of the object1.System.Text.Json9.0.0and later does support theJsonSerializerOptions.AllowOutOfOrderoption2, but as we're targeting .NET 8, we don't have access to that.Footnotes
https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism#polymorphic-type-discriminators ↩
https://learn.microsoft.com/en-us/dotnet/api/system.text.json.jsonserializeroptions.allowoutofordermetadataproperties?view=net-10.0#system-text-json-jsonserializeroptions-allowoutofordermetadataproperties ↩