fix: add EmbeddedObject and EmbeddedObjectConverter to resolve IEmbeddedObject deserialization failure#69
Merged
Merged
Conversation
…ct deserialization IEmbeddedObject is an interface and cannot be instantiated directly by Newtonsoft.Json. Add EmbeddedObject as a concrete implementation covering both IEmbeddedEntry and IEmbeddedAsset, and EmbeddedObjectConverter to redirect deserialization from the interface to the concrete class. EmbeddedObject uses [JsonExtensionData] so custom fields on embedded entries and assets are preserved rather than silently dropped.
…ect deserialization Add EmbeddedObject as a concrete implementation of IEmbeddedObject covering both IEmbeddedEntry and IEmbeddedAsset. Add EmbeddedObjectConverter to redirect deserialization from the interface to the concrete class. Custom fields on embedded entries and assets are preserved via [JsonExtensionData]. Add unit tests covering CanConvert isolation, known field mapping, nested object and array fields in [JsonExtensionData], full Delivery API response shape, and regression guard for the interface instantiation crash.
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
2 participants
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
Calling
.includeEmbeddedItems().Fetch<T>()on a model that implementsIEntryEmbedablethrows aJsonSerializationExceptionat runtime:IEntryEmbedabledeclaresembeddedItemsasDictionary<string, List<IEmbeddedObject>>. When the Delivery API returns_embedded_itemsin the response, Newtonsoft.Json tries to instantiateIEmbeddedObjectdirectly. Because it is an interface, instantiation fails.Changes
Contentstack.Utils/Models/EmbeddedObject.cs(new)Concrete class implementing both
IEmbeddedEntryandIEmbeddedAsset.Newtonsoft.Json can instantiate this in place of
IEmbeddedObject.[JsonExtensionData]on theFieldsproperty preserves any custom fieldson the embedded entry or asset (e.g.
bio,email,avatar_url) that arenot explicitly declared.
Contentstack.Utils/Converters/EmbeddedObjectConverter.cs(new)JsonConverterthat interceptsIEmbeddedObjectat deserialization timeand redirects to
EmbeddedObject.CanConvertuses exact type equality(
==) rather thanIsAssignableFromso consumer-defined subclasses ofIEmbeddedObjectare not intercepted.Consumer Impact
No changes required in consumer code. Models implementing
IEntryEmbedablecontinue to work as-is after the delivery SDK registers
EmbeddedObjectConverterin
ContentstackClient.Testing
Verified with a
.includeEmbeddedItems().Fetch<T>()call against a JSON RTEfield containing embedded entries and embedded assets:
JsonSerializationExceptionuid,title,_content_type_uidandall custom fields are populated
Changelog
See
CHANGELOG.md→ Version 1.3.1