Fix serialization for StoredProcedureDefinition inheritance #3045
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
…/Azure/data-api-builder into alpolava/fix_dollarSerialization
Alekhya-Polavarapu
requested review from
Aniruddh25,
RubenCerna2079,
aaronburtle,
anushakolan,
neeraj-sharma2592,
rusamant,
sourabh1007,
souvikghosh04 and
vadeveka
as code owners
Alekhya-Polavarapu
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request fixes a serialization issue where StoredProcedureDefinition objects (and other derived types of SourceDefinition) were being serialized as their base type, causing child-specific properties like Parameters to be omitted from the serialized output.
Key Changes:
- Modified serialization to use runtime type inference instead of explicit property type
- Updated property type checking to include derived types of
SourceDefinition - Enhanced tests to validate serialization of dollar-prefixed column names in dictionary context
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Core/Services/MetadataProviders/Converters/DatabaseObjectConverter.cs | Updated Write method to use runtime type for serialization instead of declared property type; modified IsSourceDefinitionProperty to recognize derived types using IsAssignableFrom |
| src/Service.Tests/UnitTests/SerializationDeserializationTests.cs | Refactored three test methods to serialize objects within Dictionary wrappers (matching real-world usage) and added assertions to verify dollar-prefixed columns are properly escaped |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/Core/Services/MetadataProviders/Converters/DatabaseObjectConverter.cs
Show resolved
Hide resolved
Aniruddh25
reviewed
Jan 9, 2026
src/Core/Services/MetadataProviders/Converters/DatabaseObjectConverter.cs
Outdated
Show resolved
Hide resolved
Aniruddh25
reviewed
Jan 9, 2026
Aniruddh25
approved these changes
Jan 9, 2026
Collaborator
Aniruddh25
left a comment
Aniruddh25
left a comment
There was a problem hiding this comment.
Approved with some suggestions to rename.
Aniruddh25
approved these changes
Jan 10, 2026
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Aniruddh25
approved these changes
Jan 12, 2026
rusamant
approved these changes
Jan 12, 2026
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Alekhya-Polavarapu
added a commit
that referenced
this pull request
Jan 13, 2026
## Why make this change? - To apply correct serialization and deserialization logic for stored procedures. With the previous changes, serialization was not working correctly for the StoredProcedureDefinition type, which extends SourceDefinition. When the value type was passed explicitly for serialization, the parent type was used instead, causing some child-type properties to be omitted. ## What is this change? Instead of manually specifying the value type during serialization, this change allows the library to infer the type automatically and perform the correct serialization. ## How was this tested? - [x] Unit Tests --------- Co-authored-by: Aniruddh Munde <anmunde@microsoft.com>
Alekhya-Polavarapu
added a commit
that referenced
this pull request
Jan 15, 2026
) Serialization and deserialization of metadata currently fail when column names are prefixed with the $ symbol. This issue occurs because we’ve enabled the ReferenceHandler flag in our System.Text.Json serialization settings. When this flag is active, the serializer treats $ as a reserved character used for special metadata (e.g., $id, $ref). As a result, any property name starting with $ is interpreted as metadata and cannot be deserialized properly. This update introduces custom logic in the converter’s Write and Read methods to handle $-prefixed column names safely. - During serialization, columns beginning with $ are escaped as "_$". - During deserialization, this transformation is reversed to restore the original property names. - [x] Unit tests --------- Co-authored-by: Aniruddh Munde <anmunde@microsoft.com> Fix serialization for StoredProcedureDefinition inheritance (#3045) - To apply correct serialization and deserialization logic for stored procedures. With the previous changes, serialization was not working correctly for the StoredProcedureDefinition type, which extends SourceDefinition. When the value type was passed explicitly for serialization, the parent type was used instead, causing some child-type properties to be omitted. Instead of manually specifying the value type during serialization, this change allows the library to infer the type automatically and perform the correct serialization. - [x] Unit Tests --------- Co-authored-by: Aniruddh Munde <anmunde@microsoft.com> Update src/Core/Services/MetadataProviders/Converters/DatabaseObjectConverter.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Fix documentation typos in serialization comments (#3057) Code review identified typos in XML documentation comments that inaccurately described the escaping mechanism and contained spelling errors. Fixed documentation comments to accurately reflect the implementation: - **DatabaseObjectConverter.cs**: Updated escape/unescape method summaries to correctly describe the `DAB_ESCAPE$` prefix transformation (previously incorrectly documented as `_$`) - **SerializationDeserializationTests.cs**: Corrected "deserilization" → "deserialization" in three test method comments - [x] Documentation-only change, no functional changes <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Alekhya-Polavarapu <67075378+Alekhya-Polavarapu@users.noreply.github.com>
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.
Why make this change?
What is this change?
Instead of manually specifying the value type during serialization, this change allows the library to infer the type automatically and perform the correct serialization.
How was this tested?