fix: CustomItemSerializer not applied correctly in queries and SqlParameter [Cosmos] by xinlian12 · Pull Request #48702 · Azure/azure-sdk-for-java

xinlian12 · 2026-04-07T03:03:43Z

Summary

Two bugs with CustomItemSerializer:

Bug 1 Deserialization failures in ORDER BY/GROUP BY/aggregate/DISTINCT queries

When customItemSerializer is configured on CosmosClientBuilder, complex queries (ORDER BY, GROUP BY, VALUE, COUNT, SUM, DISTINCT, HybridSearch) fail because the custom serializer leaks into the internal query pipeline and is used to deserialize internal SDK structures (OrderByRowResult, Document, etc.).

Root cause: PipelinedDocumentQueryExecutionContext.createBaseComponentFunction() called setCustomItemSerializer(null) on cloned request options, but RxDocumentClientImpl.getEffectiveItemSerializer() falls back to the client-level defaultCustomSerializer when the request-level serializer is null.

Fix: Set CosmosItemSerializer.DEFAULT_SERIALIZER instead of null on internal request options. This causes getEffectiveItemSerializer() to return DEFAULT_SERIALIZER immediately without falling through to the client-level custom serializer.

Bug 2 SqlParameter ignores customItemSerializer

SqlParameter.setValue() delegates to JsonSerializable.set() which hardcodes INTERNAL_DEFAULT_SERIALIZER. Custom serialization settings (e.g., dates as ISO strings) are never applied to query parameters.

Fix: Added rawValue field to SqlParameter to retain the original value, plus applySerializer() to re-serialize with a custom serializer. Called from PipelinedQueryExecutionContextBase.createAsync() where the effective serializer is known.

Changes

File	Change
`PipelinedDocumentQueryExecutionContext.java`	`null` `DEFAULT_SERIALIZER` in 4 internal pipeline paths
`PipelinedQueryExecutionContextBase.java`	Apply serializer to SqlParameters at query execution time
`SqlParameter.java`	Added `rawValue` field + `applySerializer()` method
`SqlQuerySpec.java`	Added `applySerializerToParameters()`

Testing

Build compiles cleanly. Existing tests unaffected. Additional test cases for ORDER BY/GROUP BY/aggregate queries with custom serializer and SqlParameter serialization should be added.

Copilot

Pull request overview

Fixes Cosmos DB query behavior when a CustomItemSerializer is configured by preventing it from deserializing internal SDK query structures, and by ensuring query parameters can be serialized with the effective item serializer.

Changes:

Force internal query pipeline request options to use CosmosItemSerializer.DEFAULT_SERIALIZER (instead of null) to avoid leaking client-level custom serializers into internal deserialization.
Add internal plumbing to re-serialize SqlParameter values using the effective serializer at query execution time.
Introduce internal bridge method to apply parameter re-serialization across packages.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/SqlQuerySpec.java	Adds internal method to apply an effective serializer to all parameters.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/SqlParameter.java	Stores raw parameter values and adds internal re-serialization hook.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/ModelBridgeInternal.java	Exposes internal bridge method to apply serializer to query parameters.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/query/PipelinedQueryExecutionContextBase.java	Applies effective serializer to parameters at query execution time.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/query/PipelinedDocumentQueryExecutionContext.java	Forces DEFAULT serializer on internal pipeline request options to prevent custom serializer leaks.
.coding-harness/spec.json	Adds harness metadata/spec for the reported issue and intended fix.

xinlian12 · 2026-04-07T22:26:24Z

@sdkReviewAgent-2

xinlian12 · 2026-04-07T23:21:37Z

✅ Review complete (54:56)

No new comments — existing review coverage is sufficient.

_{Steps: cross-sdk, history, past-prs, quality, sanity-check, synthesis, test-coverage}

xinlian12 · 2026-04-08T19:13:41Z

/azp run java - cosmos - spark

xinlian12 · 2026-04-08T19:13:48Z

/azp run java - cosmos - kafka

xinlian12 · 2026-04-08T19:13:53Z

/azp run java - cosmos - tests

azure-pipelines · 2026-04-08T19:14:04Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-08T19:14:15Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-08T19:14:57Z

Azure Pipelines successfully started running 1 pipeline(s).

xinlian12 · 2026-04-08T19:25:02Z

/azp run java - cosmos - spark

xinlian12 · 2026-04-08T19:25:07Z

/azp run java - cosmos - kafka

FabianMeiswinkel

LGTM

xinlian12 · 2026-04-08T19:25:13Z

/azp run java - cosmos - tests

azure-pipelines · 2026-04-08T19:25:13Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-08T19:25:23Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-08T19:25:40Z

Azure Pipelines successfully started running 1 pipeline(s).

xinlian12 · 2026-04-08T21:11:38Z

/azp run java - cosmos - kafka

xinlian12 · 2026-04-08T21:11:43Z

/azp run java - cosmos - spark

xinlian12 · 2026-04-08T21:11:50Z

/azp run java - cosmos - tests

xinlian12 · 2026-04-13T16:44:14Z

@sdkReviewAgent-2

xinlian12 · 2026-04-13T17:02:44Z

/azp run java - cosmos - kafka

xinlian12 · 2026-04-13T17:02:50Z

/azp run java - cosmos - spark

xinlian12 · 2026-04-13T17:02:56Z

/azp run java - cosmos - tests

azure-pipelines · 2026-04-13T17:03:03Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-13T17:03:07Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-13T17:03:16Z

Azure Pipelines successfully started running 1 pipeline(s).

xinlian12 · 2026-04-13T17:29:55Z

✅ Review complete (45:12)

Posted 2 inline comment(s).

_{Steps: ✓ context, correctness, cross-sdk, design, history, past-prs, synthesis, test-coverage}

xinlian12 · 2026-04-13T17:38:02Z

@sdkReviewAgent-2

xinlian12 · 2026-04-13T18:24:16Z

✅ Review complete (45:25)

Posted 1 inline comment(s).

_{Steps: ✓ context, correctness, cross-sdk, design, history, past-prs, synthesis, test-coverage}

xinlian12 · 2026-04-13T20:23:42Z

/azp run java - cosmos - spark

xinlian12 · 2026-04-13T20:23:47Z

/azp run java - cosmos - kafka

azure-pipelines · 2026-04-13T20:23:52Z

Azure Pipelines successfully started running 1 pipeline(s).

xinlian12 · 2026-04-13T20:23:53Z

/azp run java - cosmos - tests

azure-pipelines · 2026-04-13T20:24:04Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-04-13T20:24:17Z

Azure Pipelines successfully started running 1 pipeline(s).

FabianMeiswinkel

LGTM

xinlian12 · 2026-04-14T18:41:59Z

The failed tests are all related to thin client due to recent disablement

xinlian12 · 2026-04-14T18:42:17Z

/check-enforcer override

xinlian12 · 2026-04-14T18:45:48Z

/check-enforcer override

xinlian12 requested review from a team and kirankumarkolli as code owners April 7, 2026 03:03

Copilot AI review requested due to automatic review settings April 7, 2026 03:03

xinlian12 requested a review from a team as a code owner April 7, 2026 03:03

github-actions Bot added the Cosmos label Apr 7, 2026

Copilot started reviewing on behalf of xinlian12 April 7, 2026 03:05 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

xinlian12 changed the title ~~fix: CustomItemSerializer not applied correctly in queries and SqlParameter [Cosmos]~~ [NO REVIEW]fix: CustomItemSerializer not applied correctly in queries and SqlParameter [Cosmos] Apr 7, 2026

xinlian12 commented Apr 7, 2026

View reviewed changes

Comment thread sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/ModelBridgeInternal.java Outdated

xinlian12 commented Apr 8, 2026

View reviewed changes

Comment thread sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosItemSerializerTest.java Outdated

xinlian12 commented Apr 8, 2026

View reviewed changes

Comment thread sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosItemSerializerTest.java Outdated

xinlian12 changed the title ~~[NO REVIEW]fix: CustomItemSerializer not applied correctly in queries and SqlParameter [Cosmos]~~ fix: CustomItemSerializer not applied correctly in queries and SqlParameter [Cosmos] Apr 8, 2026

FabianMeiswinkel approved these changes Apr 8, 2026

View reviewed changes

xinlian12 force-pushed the fix/issue-45521-custom-item-serializer branch 4 times, most recently from 8838549 to f6140fa Compare April 13, 2026 16:40

xinlian12 commented Apr 13, 2026

View reviewed changes

Comment thread sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosItemSerializer.java Outdated

xinlian12 commented Apr 13, 2026

View reviewed changes

Comment thread .../src/main/java/com/azure/cosmos/implementation/query/PipelinedQueryExecutionContextBase.java Outdated

xinlian12 commented Apr 13, 2026

View reviewed changes

Comment thread .../main/java/com/azure/cosmos/implementation/query/PipelinedDocumentQueryExecutionContext.java Outdated

FabianMeiswinkel approved these changes Apr 13, 2026

View reviewed changes

xinlian12 closed this Apr 14, 2026

xinlian12 force-pushed the fix/issue-45521-custom-item-serializer branch from f0d09d4 to 8a671dd Compare April 14, 2026 19:26

github-actions Bot mentioned this pull request Apr 24, 2026

[BUG] CustomItemSerializer causes NullPointerException on ORDER BY queries samvaity/azure-sdk-for-java#12

Open

Conversation

xinlian12 commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Testing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xinlian12 commented Apr 7, 2026

Uh oh!

xinlian12 commented Apr 7, 2026

Uh oh!

Uh oh!

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

azure-pipelines Bot commented Apr 8, 2026

Uh oh!

azure-pipelines Bot commented Apr 8, 2026

Uh oh!

azure-pipelines Bot commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

FabianMeiswinkel left a comment

Choose a reason for hiding this comment

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

azure-pipelines Bot commented Apr 8, 2026

Uh oh!

azure-pipelines Bot commented Apr 8, 2026

Uh oh!

azure-pipelines Bot commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 8, 2026

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

azure-pipelines Bot commented Apr 13, 2026

Uh oh!

azure-pipelines Bot commented Apr 13, 2026

Uh oh!

azure-pipelines Bot commented Apr 13, 2026

Uh oh!

Uh oh!

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

xinlian12 commented Apr 13, 2026

Uh oh!

xinlian12 commented Apr 7, 2026 •

edited

Loading