fix: register EmbeddedObjectConverter in ContentstackClient constructor#182
Draft
OMpawar-21 wants to merge 1 commit into
Draft
fix: register EmbeddedObjectConverter in ContentstackClient constructor#182OMpawar-21 wants to merge 1 commit into
OMpawar-21 wants to merge 1 commit into
Conversation
Auto-register EmbeddedObjectConverter on SerializerSettings so that _embedded_items deserialization works out of the box when the model implements IEntryEmbedable. Bump utils dependency to 1.4.0. Fixes JsonSerializationException thrown by .includeEmbeddedItems().Fetch<T>() when the Delivery API response contains embedded entries or assets.
🔒 Security Scan Results
⏱️ SLA Breach Summary
✅ BUILD PASSED - All security checks passed |
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
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.
Summary
EmbeddedObjectConverterinContentstackClientconstructor so.includeEmbeddedItems().Fetch<T>()deserializes_embedded_itemswithout crashing when the model implementsIEntryEmbedablecontentstack.utilsdependency to1.4.0which ships the concreteEmbeddedObjectclass andEmbeddedObjectConverter2.28.0Problem
Customers calling
.includeEmbeddedItems().Fetch<T>()on a model implementingIEntryEmbedablereceived aJsonSerializationExceptionat runtime whenever the Delivery API returned_embedded_itemsin the response:IEntryEmbedable.embeddedItemsis typed asDictionary<string, List<IEmbeddedObject>>. With noJsonConverterregistered, Newtonsoft.Json tried tonew()the interface directly and threw.Changes
ContentstackClient.csOne line added in the constructor after the existing
CSJsonConverterAttributeloop: