Added CollectionGenericType to ClientPropertyAnnotation #3170
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
Modified EntryValueMaterializationPolicy to ensure the correct collection element type is used if a POCO does not have a collection initializer for collection properties.
|
@lawynn Could you please add tests |
WanjohiSammy
requested review from
Copilot,
habbes,
xuzhg,
WanjohiSammy,
ElizabethOkerio,
gathogojr,
emmanuel-karanja and
DButoyez
There was a problem hiding this comment.
PR Overview
This pull request fixes an issue with POCO collection property materialization by introducing a new property, CollectionGenericType, to properly identify the element type.
- Adds the CollectionGenericType property to ClientPropertyAnnotation.
- Replaces EntityCollectionItemType with CollectionGenericType in EntryValueMaterializationPolicy when creating collection instances.
Reviewed Changes
| File | Description |
|---|---|
| src/Microsoft.OData.Client/Metadata/ClientPropertyAnnotation.cs | Introduces CollectionGenericType to expose the generic collection type. |
| src/Microsoft.OData.Client/Materialization/EntryValueMaterializationPolicy.cs | Updates the creation of List<> and Collection<> instances to use CollectionGenericType. |
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
src/Microsoft.OData.Client/Metadata/ClientPropertyAnnotation.cs:264
- [nitpick] Consider adding XML documentation for the new CollectionGenericType property to clarify its intended usage and assumptions regarding its initialization.
internal Type CollectionGenericType
src/Microsoft.OData.Client/Materialization/EntryValueMaterializationPolicy.cs:488
- Ensure that property.CollectionGenericType is properly initialized and non-null before its use in MakeGenericType to avoid potential runtime exceptions.
Type listCollectionType = typeof(List<>).MakeGenericType(property.CollectionGenericType);
src/Microsoft.OData.Client/Materialization/EntryValueMaterializationPolicy.cs:501
- Ensure that property.CollectionGenericType is non-null before using it to construct the generic Collection<> type; consider adding a null check or an assertion.
collectionType = typeof(System.Collections.ObjectModel.Collection<>).MakeGenericType(property.CollectionGenericType);
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.
Modified EntryValueMaterializationPolicy to ensure the correct collection element type is used if a POCO does not have a collection initializer for collection properties.
Issues
This pull request fixes #3124.
Description
In cases where POCO classes are used, and contain collection properties, the materializer does not correctly identify the element type. The property.EntityCollectionItemType erroneously returns a null for complex types, which then fails on the MakeGenericType call.
This fix surfaces the CollectionGenericType, and uses that in the 2 logic branches that will fail if the value is null.
Checklist (Uncheck if it is not completed)
Additional work necessary
If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.