[Azure.Core] Add Public Model Serialization #35946
Merged
Conversation
This file contains 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
* wip * wip * wip * wip * wip
|
Re-creating this PR as we had to rename the branch |
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
live1206
reviewed
May 5, 2023
sdk/core/Azure.Core/tests/ModelSerializationTests/IUtf8JsonSerializable.cs
Outdated
Show resolved
Hide resolved
live1206
reviewed
May 5, 2023
live1206
reviewed
May 6, 2023
* add scaffolding for readme * fix type on class name * one more typo :-( * make tests sync
…o feature/updateSerializer
* add use cases for explicit casts * remove extra empty line * add custom expected value for net462
* add use cases for stj * address feedback * add some clarification to readme
* wip * wip * wip * Update StaticDeserializerTests.cs * Update StaticDeserializerTests.cs * Update StaticDeserializerTests.cs
* add use cases for stj * address feedback * add some clarification to readme * add model serializer example * move serialization classes into azure.core.serialization * update after namespace move
* Update SerializableOptions.cs * wip * wip * update * wip * wip
…o feature/updateSerializer
* wip * Update ModelSerializer.cs * wip * Update ReadOnlyPropertyTests.cs * wip * Update SerializableOptions.cs * Update SerializableOptions.cs * wip * wip * Update SerializationSamples.cs
…o feature/updateSerializer
This was referenced Aug 10, 2023
* hide model writer * rename abstract hierarchy deserializer * update wire format docs
annelo-msft
reviewed
Aug 10, 2023
annelo-msft
reviewed
Aug 10, 2023
annelo-msft
reviewed
Aug 10, 2023
annelo-msft
reviewed
Aug 10, 2023
sdk/core/Azure.Core/src/Serialization/ModelWriter.SequenceBuilder.cs
Outdated
Show resolved
Hide resolved
annelo-msft
reviewed
Aug 10, 2023
annelo-msft
reviewed
Aug 10, 2023
annelo-msft
reviewed
Aug 10, 2023
annelo-msft
reviewed
Aug 10, 2023
sdk/core/Azure.Core/tests/public/ModelSerializationTests/Models/Animal.cs
Show resolved
Hide resolved
annelo-msft
reviewed
Aug 10, 2023
sdk/core/Azure.Core/tests/public/ModelSerializationTests/Models/Animal.cs
Show resolved
Hide resolved
* address feedback * add checks around stream with long length
Merged
annelo-msft
approved these changes
Aug 11, 2023
annelo-msft
reviewed
Aug 11, 2023
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.
Resolves #16977
Previous draft PR: #35742
The goal of this PR is to provide a public interface that exposes the currently internal serialization code so customers can access it without needing to use reflection or write their own translation. This interface would be applied to all models in all of our libraries today. The implementation simply uses the existing internal serialization logic since that code already knows all of the property name changes / structure changes that exist. We can at a future date change the underlying implementation as long as we maintain functional compatibility.
The SerializationOptions class introduces a couple concepts that are common across the other languages serialization implementations which are:
IncludeReadonlyProperties: This flag tells the serializer to include the readonly properties when making the payload. This is always off during client calls since the service would error out if we tried to change a readonly property, however if a customer wants to save the state of the model this can be included by setting this property to true.
HandleAdditionalProperties: This flag tells the serializer to keep any properties it didn't recognize during deserialization as an internal dictionary. If the same model instance is then serialized with the same property set to true these values will be echoed and not lost. This is useful for dealing with a large enterprise where various micro-services could be on different versions of the azure sdk library.
We should consider what defaults we want for the above properties. I would imagine most customers would want true for both in most cases and we can simply have false for both in our client invocations.
Currently the interface only takes in Stream as the input and output object we should consider other convenience overloads such as string.
We should also consider explicit / implict cast operators Model -> RequestContent and Response -> Model.
Contributing to the Azure SDK
Please see our CONTRIBUTING.md if you are not familiar with contributing to this repository or have questions.
For specific information about pull request etiquette and best practices, see this section.