Enable Request Level Excluded Locations to Metadata API calls (#40905)

* Enable excluded locations to metadata API calls

* Added prefix partition key table to test config

* Fixed failed live tests

* Fixed emulator test failures

* Fixed live tests

* Fixed python style errors

* Update Python version for live tests

* Fix bug with is_endpoint_unavailable_internal

* Revert fix for is_endpoint_unavailable_internal

This was not a bug

* Added Metadata tests with reordering with excluded locations

* Added docstring to metadata APIs

* Added CHANGELOG

* Updated predicate_is_collection_operation to predicate_is_resource_type

* Fixed typo

* Enable excluded_locations to query plan workflow

* Remove docstring of excluded_location for READ API

* Updated emulator tests

* Clean up unnecessary mapping during QueryChangeFeed

* Fixed bug

* Cleanup codes

* Fixed bugs with test_change_feed_split

* Fixed mypy error

* Upgrade Python SDK version

* Cleanup excluded location conditions

* Removed unnecessary test

* Removed unused import

Author: allenkim0129

sdk/cosmos/azure-cosmos/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Release History
 
 ### 4.12.0b2 (Unreleased)
+* Added ability to use request level `excluded_locations` on metadata calls, such as getting container properties. See [PR 40905](https://github.com/Azure/azure-sdk-for-python/pull/40905)
 
 #### Features Added
 

sdk/cosmos/azure-cosmos/azure/cosmos/_change_feed/aio/change_feed_fetcher.py

@@ -145,9 +145,11 @@ async def callback():
         except CosmosHttpResponseError as e:
             if exceptions._partition_range_is_gone(e) or exceptions._is_partition_split_or_merge(e):
                 # refresh change feed state
-                await self._change_feed_state.handle_feed_range_gone_async(
-                    self._client._routing_map_provider,
-                    self._resource_link)
+                options = None
+                if "excludedLocations" in self._feed_options:
+                    options = {'excludedLocations': self._feed_options["excludedLocations"]}
+                await self._change_feed_state.handle_feed_range_gone_async(self._client._routing_map_provider,
+                    self._resource_link, options)
             else:
                 raise e
 

sdk/cosmos/azure-cosmos/azure/cosmos/_change_feed/change_feed_fetcher.py

@@ -140,7 +140,11 @@ def callback():
         except CosmosHttpResponseError as e:
             if exceptions._partition_range_is_gone(e) or exceptions._is_partition_split_or_merge(e):
                 # refresh change feed state
-                self._change_feed_state.handle_feed_range_gone(self._client._routing_map_provider, self._resource_link)
+                options = None
+                if "excludedLocations" in self._feed_options:
+                    options = {'excludedLocations': self._feed_options["excludedLocations"]}
+                self._change_feed_state.handle_feed_range_gone(self._client._routing_map_provider, self._resource_link,
+                                                               options)
             else:
                 raise e
 

sdk/cosmos/azure-cosmos/azure/cosmos/_change_feed/change_feed_state.py

@@ -64,14 +64,16 @@ def populate_feed_options(self, feed_options: Dict[str, Any]) -> None:
     def populate_request_headers(
             self,
             routing_provider: SmartRoutingMapProvider,
-            request_headers: Dict[str, Any]) -> None:
+            request_headers: Dict[str, Any],
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
         pass
 
     @abstractmethod
     async def populate_request_headers_async(
             self,
             async_routing_provider: AsyncSmartRoutingMapProvider,
-            request_headers: Dict[str, Any]) -> None:
+            request_headers: Dict[str, Any],
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
         pass
 
     @abstractmethod
@@ -149,7 +151,8 @@ def from_json(
     def populate_request_headers(
             self,
             routing_provider: SmartRoutingMapProvider,
-            request_headers: Dict[str, Any]) -> None:
+            request_headers: Dict[str, Any],
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
         request_headers[http_constants.HttpHeaders.AIM] = http_constants.HttpHeaders.IncrementalFeedHeaderValue
 
         self._change_feed_start_from.populate_request_headers(request_headers)
@@ -159,7 +162,8 @@ def populate_request_headers(
     async def populate_request_headers_async(
             self,
             async_routing_provider: AsyncSmartRoutingMapProvider,
-            request_headers: Dict[str, Any]) -> None: # pylint: disable=unused-argument
+            request_headers: Dict[str, Any],
+            feed_options: Optional[Dict[str, Any]] = None) -> None: # pylint: disable=unused-argument
 
         request_headers[http_constants.HttpHeaders.AIM] = http_constants.HttpHeaders.IncrementalFeedHeaderValue
 
@@ -277,14 +281,16 @@ def set_mode_request_headers(
     def populate_request_headers(
             self,
             routing_provider: SmartRoutingMapProvider,
-            request_headers: Dict[str, Any]) -> None:
+            request_headers: Dict[str, Any],
+            feed_options = None) -> None:
         self.set_start_from_request_headers(request_headers)
 
         # based on the feed range to find the overlapping partition key range id
         over_lapping_ranges = \
             routing_provider.get_overlapping_ranges(
                 self._container_link,
-                [self._continuation.current_token.feed_range])
+                [self._continuation.current_token.feed_range],
+                feed_options)
 
         self.set_pk_range_id_request_headers(over_lapping_ranges, request_headers)
 
@@ -294,14 +300,16 @@ def populate_request_headers(
     async def populate_request_headers_async(
             self,
             async_routing_provider: AsyncSmartRoutingMapProvider,
-            request_headers: Dict[str, Any]) -> None:
+            request_headers: Dict[str, Any],
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
         self.set_start_from_request_headers(request_headers)
 
         # based on the feed range to find the overlapping partition key range id
         over_lapping_ranges = \
             await async_routing_provider.get_overlapping_ranges(
                 self._container_link,
-                [self._continuation.current_token.feed_range])
+                [self._continuation.current_token.feed_range],
+                feed_options)
 
         self.set_pk_range_id_request_headers(over_lapping_ranges, request_headers)
 
@@ -313,14 +321,16 @@ def populate_feed_options(self, feed_options: Dict[str, Any]) -> None:
     def handle_feed_range_gone(
             self,
             routing_provider: SmartRoutingMapProvider,
-            resource_link: str) -> None:
-        self._continuation.handle_feed_range_gone(routing_provider, resource_link)
+            resource_link: str,
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
+        self._continuation.handle_feed_range_gone(routing_provider, resource_link, feed_options)
 
     async def handle_feed_range_gone_async(
             self,
             routing_provider: AsyncSmartRoutingMapProvider,
-            resource_link: str) -> None:
-        await self._continuation.handle_feed_range_gone_async(routing_provider, resource_link)
+            resource_link: str,
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
+        await self._continuation.handle_feed_range_gone_async(routing_provider, resource_link, feed_options)
 
     def apply_server_response_continuation(self, continuation: str, has_modified_response: bool) -> None:
         self._continuation.apply_server_response_continuation(continuation, has_modified_response)

sdk/cosmos/azure-cosmos/azure/cosmos/_change_feed/feed_range_composite_continuation_token.py

@@ -101,8 +101,10 @@ def from_json(cls, data) -> 'FeedRangeCompositeContinuation':
     def handle_feed_range_gone(
             self,
             routing_provider: SmartRoutingMapProvider,
-            collection_link: str) -> None:
-        overlapping_ranges = routing_provider.get_overlapping_ranges(collection_link, [self._current_token.feed_range])
+            collection_link: str,
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
+        overlapping_ranges = routing_provider.get_overlapping_ranges(collection_link,
+                                                                     [self._current_token.feed_range], feed_options)
 
         if len(overlapping_ranges) == 1:
             # merge,reusing the existing the feedRange and continuationToken
@@ -122,11 +124,13 @@ def handle_feed_range_gone(
     async def handle_feed_range_gone_async(
             self,
             routing_provider: AsyncSmartRoutingMapProvider,
-            collection_link: str) -> None:
+            collection_link: str,
+            feed_options: Optional[Dict[str, Any]] = None) -> None:
         overlapping_ranges = \
             await routing_provider.get_overlapping_ranges(
                 collection_link,
-                [self._current_token.feed_range])
+                [self._current_token.feed_range],
+                feed_options)
 
         if len(overlapping_ranges) == 1:
             # merge,reusing the existing the feedRange and continuationToken