Exception-less Streaming API for non-existing NP container scenarios by kirankumarkolli · Pull Request #227 · Azure/azure-cosmos-dotnet-v3

kirankumarkolli · 2019-05-10T07:53:25Z

Pull Request Template

Description

CreateItemStreamAsync targeting a NP collection with NonePartitionKeyValue should not throw exception. Expected to return status code.

Currently for partitioned collection its returning 404 and will return the same.
For GA we should make it 424 (Dependency failure) instead for dis-disambiguate it.

Type of change

ExecUtils moved to the path of deprecation. Related changes moved to RequestInvokerHandler
RequestInvokerHandler made primary entry contract for client
Fixed a bug introduced with FI from master, where cached ContainerSettings are not used.
Bug fix (non-breaking change which fixes an issue)

Closing issues

closes #233

Few proxy methods from ExecUtils are removed.

…227) * First cut of fix * Refreshing syntax as per C#7 * ComosContextCore depenency on ExecUtils removed. Few proxy methods from ExecUtils are removed.

* added new system strings (#210) * Ignoring TestLazyIndexAllTerms (#211) * PartitionedCRUDTest ignored (#217) * Exception-less Streaming API for non-existing NP container scenarios (#227) * First cut of fix * Refreshing syntax as per C#7 * ComosContextCore depenency on ExecUtils removed. Few proxy methods from ExecUtils are removed. * SDK version to 3.0.0.11-preview and Direct dependency to 3.0.0.27-preview * Cherry pick 15a9e26 into 3.0.0.11_preview (#235) * Query routing with partition key definition (#213) * Fix breaks for the release * Remove unused usings * Adding a unit test to verify setting PartitionKeyDefinition works. (#226) * More * Fixes for query pipeline * Some more fixes * Np tests and quarantine open-partition tests * small correction * Direct contract test pruning * Few test fixes * Bug fix for paramaterised queries * Including NP query tests * One more test fix * Fix for MixedModeTypoes unit test * MixedMode multi-targeting tests clean. * Enabling Distinct and TopOrderBy for NP. * Quarantine TestQueryCrossPartitionAggregateFunctionsWithMixedTypes

* Raising version to 22-preview * Merge master into release (CF Pull internal API) (#115) * Assemblyinfo clean-up (#104) * Signed build assembly info fix * Assembly info clean-up * Including test projects internal visible to (#107) * Stand By Feed and ChangeFeed pull model (#105) * Adding initial files * Using Etag for continuation * Removing unused * Refactoring to reduce variables * Refactoring to use CompositeToken * Adding feed test * Refactor through Options * Adding public methods and comments * Routing through the point transport handler * Moving to outer if * Adding split logic * Adding unit tests * Adding logic to detect invalid continuation tokens * Adding JSON validation * Routing based on PKRangeId * Renaming and adding more tests * Moving logic into the token * Forcing refresh on split * Addressing final coments * Addressing feedback * Added test to cover CT passing * Refactoring and adding pkrangedelegate * Argument checks * Moving contract to CosmosRequestMessage * Refactoring make EnsureInitialized async * Moving tests to a new file * Adding PKrange assert * Refactored back to parameters outside Options * UT split * Adding Start* checks * Adding new tests and renames * Addressing comments * Refactoring for cache tests * Adding comments to tests * Adding factory method * Addressing comments * Refactoring PKRange outside options * Addressing comments * Removing StartFromBeginning * Removing extra lines * Removing unnecessary ToList * Raising version to 22-preview (#113) * fix bugs * Fixing signing issue * Hot fixes for CosmosSerializationOptions and query partition key issues (#207) * Hot fixes for CosmosSerializationOptions and query partition key. * initial commit (#193) * Fixed formatting * added new system strings (#210) * Ignoring TestLazyIndexAllTerms (#211) * PartitionedCRUDTest ignored (#217) * Exception-less Streaming API for non-existing NP container scenarios (#227) * First cut of fix * Refreshing syntax as per C#7 * ComosContextCore depenency on ExecUtils removed. Few proxy methods from ExecUtils are removed. * SDK version to 3.0.0.11-preview and Direct dependency to 3.0.0.27-preview * Cherry pick 15a9e26 into 3.0.0.11_preview (#235) * Query routing with partition key definition (#213) * Fix breaks for the release * Remove unused usings * Adding a unit test to verify setting PartitionKeyDefinition works. (#226) * More * Revert "Fixing samples build break (#236)" This reverts commit cda8903. * Force samples to Nuget.org only * Fixes for query pipeline * Some more fixes * Np tests and quarantine open-partition tests * small correction * Direct contract test pruning * Few test fixes * Bug fix for paramaterised queries * Including NP query tests * One more test fix * Fix for MixedModeTypoes unit test * MixedMode multi-targeting tests clean. * Enabling Distinct and TopOrderBy for NP. * Quarantine TestQueryCrossPartitionAggregateFunctionsWithMixedTypes * Test fixes. * BadRequestException fixes * Owner attribute removed

…ontainer doesn't exist (Direct mode) (#5500) ## Description When operations fail with 404, it's ambiguous whether the item doesn't exist or the parent container/database doesn't exist. This PR fixes the SDK to properly set substatus code 1003 (OwnerResourceNotFound) when collection resolution fails during item operations, enabling developers to distinguish between these two fundamentally different error conditions. ### Changes -**SDK Fix**: Modified `ClientCollectionCache.ResolveCollectionWithSessionContainerCleanupAsync` to set substatus 1003 when collection resolution fails with 404 for non-container operations - Item/document operations now correctly get 404/1003 when container doesn't exist (Direct mode) - Container metadata operations continue to get 404/0 when container doesn't exist (the container itself is the missing resource) - Query and stored procedure operations get 404/1003 when container doesn't exist - **Emulator Tests**: Added parameterized tests validating substatus code behavior in both TCP (Direct) and Gateway connection modes - 404/0 → item not found in existing container - 404/1003 → container or database doesn't exist (Direct mode) - Tests run with `[DataRow]` attributes for both connection modes - Test names clarified with `_StreamingAPI` and `_TypedAPI` suffixes to indicate which API type is being tested - `ValidateSubStatusCodeForItemNotFoundVsContainerNotFound_StreamingAPI` tests streaming APIs (ReadItemStreamAsync) - `ValidateCosmosExceptionSubStatusCodeForNotFound_TypedAPI` tests typed/non-streaming APIs (ReadItemAsync) - `ValidateContainerMetadataRequestsHaveSubstatus0` validates that container operations correctly return substatus 0 - **Unit Tests**: Added tests for CosmosException and ResponseMessage substatus code handling - **Documentation**: Added examples in `Exceptions.md` showing how to distinguish these cases ### Direct Mode vs Gateway Mode __Direct Mode (TCP)__: - Fully supports substatus code 1003 for container-not-found scenarios - Can distinguish between item-not-found (404/0) and container-not-found (404/1003) __Gateway Mode__: - Known limitation: Cannot always distinguish these scenarios due to Gateway architecture - Returns 404/0 for both item-not-found and container-not-found - Database-not-found scenarios still return 404/1003 in both modes ### Usage Check `SubStatusCode` to differentiate 404 scenarios: ```csharp try { var response = await container.ReadItemAsync(id, partitionKey); } catch (CosmosException ex) when (ex.StatusCode == HttpStatusCode.NotFound) { if (ex.SubStatusCode == 1003) { // Container/database doesn't exist - may need to create it // (Direct mode only for container-not-found) } else { // Item doesn't exist - normal case } } ``` Same pattern works with `ResponseMessage.Headers.SubStatusCode` for stream APIs. ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) ## Closing issues Resolves #227 Fixes #229  --- 💬 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: kirankumarkolli <6880899+kirankumarkolli@users.noreply.github.com> Co-authored-by: Yash Trivedi <yash2710@users.noreply.github.com> Co-authored-by: yash2710 <8458233+yash2710@users.noreply.github.com>

First cut of fix

dbbd977

kirankumarkolli added the bug Something isn't working label May 10, 2019

kirankumarkolli requested a review from kirillg as a code owner May 10, 2019 07:53

kirankumarkolli self-assigned this May 10, 2019

kirankumarkolli mentioned this pull request May 10, 2019

Disambiguate 404 & 404 with (owner not found) #229

Closed

1 task

kirankumarkolli requested review from ausfeldt, ealsur, j82w, simplynaveen20 and visridha May 10, 2019 08:11

kirankumarkolli and others added 3 commits May 10, 2019 13:44

Merge branch 'master' into users/kirankk/collection_not_exists

51448f8

Refreshing syntax as per C#7

3e4569e

Merge branch 'master' into users/kirankk/collection_not_exists

a6e1651

j82w reviewed May 10, 2019

View reviewed changes

Comment thread Microsoft.Azure.Cosmos/src/Resource/CosmosClientContextCore.cs

Comment thread Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/CosmosItemTests.cs

ComosContextCore depenency on ExecUtils removed.

73d89fb

Few proxy methods from ExecUtils are removed.

j82w approved these changes May 10, 2019

View reviewed changes

simplynaveen20 approved these changes May 10, 2019

View reviewed changes

kirankumarkolli changed the title ~~Stream API for non-existing NP container should return status code as result~~ Exception-less Streaming API for non-existing NP container scenarios May 10, 2019

kirankumarkolli merged commit 4f5d872 into master May 10, 2019

kirankumarkolli deleted the users/kirankk/collection_not_exists branch May 10, 2019 14:50

Copilot AI mentioned this pull request Nov 15, 2025

Owner not found: Fixes substatus code 1003 for item operations when container doesn't exist (Direct mode) #5500

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exception-less Streaming API for non-existing NP container scenarios#227

Exception-less Streaming API for non-existing NP container scenarios#227
kirankumarkolli merged 5 commits intomasterfrom
users/kirankk/collection_not_exists

kirankumarkolli commented May 10, 2019 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

kirankumarkolli commented May 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Template

Description

Type of change

Closing issues

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kirankumarkolli commented May 10, 2019 •

edited

Loading