FeedRanges: Fixes GetFeedRangesAsync throwing DocumentClientException

[ealsur]

Pull Request Template

Description

Container.GetFeedRangesAsync performs a read on PartitionKeyRanges leveraging the PartititonKeyRangeCache. This translates into an HTTP operation to Gateway.

In cases where Gateway returns a failure (see linked issue), the GatewayStoreClient will fail creating a DocumentClientException.

In normal circumstances, PartitionKeyRangeCache is used within the scope of the Handler pipeline, on which any DocumentClientException is converted to CosmosException, but because this is a direct invocation, there is nothing doing the conversion and DocumentClientException ends up being thrown to the user.

Solution

The proposed solution applies the conversion at the method level (GetFeedRangesAsync) to ensure the DocumentClientException is not received by the user.

An alternative that was evaluated was to apply the conversion within the PartitionKeyRangeCache but the problem is that this component is used within other components (such as the Direct Transport stack) where there are already contracts in-place that would expect DocumentClientException. Breaking this contract would be dangerous.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

Closing issues

Closes #4528