Adding serializer for CredentialDescription in .NET 8+ #177
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a custom JSON serializer/deserializer for CredentialDescription to support new scenarios in .NET 8+. Key changes include:
- New test cases in CredentialDescriptionJsonConverterTest.cs validating roundtrip serialization for various CredentialSource values.
- Updates to the PublicAPI files to include the new CredentialDescriptionJsonConverter and related APIs.
- Implementation of CredentialDescriptionJsonConverter in the ApplicationOptions folder.
Reviewed Changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionJsonConverterTest.cs | Adds tests to verify correct roundtrip serialization for different credential sources. |
| src/Microsoft.Identity.Abstractions/PublicAPI/net9.0/PublicAPI.Unshipped.txt | Exposes the new converter API for upcoming releases. |
| src/Microsoft.Identity.Abstractions/PublicAPI/net9.0/PublicAPI.Shipped.txt | Documents the shipped public API changes including the serializer. |
| src/Microsoft.Identity.Abstractions/ApplicationOptions/CredentialDescriptionJsonConverter.cs | Provides the implementation of the custom JSON converter for CredentialDescription. |
Files not reviewed (2)
- Directory.Build.props: Language not supported
- src/Microsoft.Identity.Abstractions/PublicAPI/net8.0/PublicAPI.Unshipped.txt: Language not supported
Comments suppressed due to low confidence (1)
test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionJsonConverterTest.cs:162
- Consider adding test cases for additional CredentialSource values (for instance, StoreWithDistinguishedName) to ensure that the converter handles all supported sources consistently.
public void SerializeDeserialize_CustomSignedAssertion()
keegan-caruso
approved these changes
Apr 22, 2025
Revert version Signed-off-by: Jean-Marc Prieur <[email protected]>
src/Microsoft.Identity.Abstractions/ApplicationOptions/CredentialDescriptionJsonConverter.cs
Outdated
Show resolved
Hide resolved
jennyf19
approved these changes
Apr 29, 2025
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.
Add a custom serializer for CredentialDescription in .NET 8.
Fixes #176