merge with main

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

@@ -34,7 +34,8 @@
 from azure.cosmos._change_feed.change_feed_start_from import ChangeFeedStartFromInternal, \
     ChangeFeedStartFromETagAndFeedRange
 from azure.cosmos._change_feed.composite_continuation_token import CompositeContinuationToken
-from azure.cosmos._change_feed.feed_range import FeedRange, FeedRangeEpk, FeedRangePartitionKey
+from azure.cosmos._change_feed.feed_range_internal import (FeedRangeInternal, FeedRangeInternalEpk,
+                                                           FeedRangeInternalPartitionKey)
 from azure.cosmos._change_feed.feed_range_composite_continuation_token import FeedRangeCompositeContinuation
 from azure.cosmos._routing.aio.routing_map_provider import SmartRoutingMapProvider as AsyncSmartRoutingMapProvider
 from azure.cosmos._routing.routing_map_provider import SmartRoutingMapProvider
@@ -79,7 +80,7 @@ def apply_server_response_continuation(self, continuation: str, has_modified_res
     def from_json(
             container_link: str,
             container_rid: str,
-            change_feed_state_context: Dict[str, Any]):
+            change_feed_state_context: Dict[str, Any]) -> 'ChangeFeedState':
 
         if (change_feed_state_context.get("partitionKeyRangeId")
                 or change_feed_state_context.get("continuationPkRangeId")):
@@ -184,7 +185,7 @@ def __init__(
             self,
             container_link: str,
             container_rid: str,
-            feed_range: FeedRange,
+            feed_range: FeedRangeInternal,
             change_feed_start_from: ChangeFeedStartFromInternal,
             continuation: Optional[FeedRangeCompositeContinuation]
     ) -> None:
@@ -380,22 +381,20 @@ def from_initial_state(
             collection_rid: str,
             change_feed_state_context: Dict[str, Any]) -> 'ChangeFeedStateV2':
 
-        feed_range: Optional[FeedRange] = None
+        feed_range: Optional[FeedRangeInternal] = None
         if change_feed_state_context.get("feedRange"):
-            feed_range_str = base64.b64decode(change_feed_state_context["feedRange"]).decode('utf-8')
-            feed_range_json = json.loads(feed_range_str)
-            feed_range = FeedRangeEpk(Range.ParseFromDict(feed_range_json))
+            feed_range = change_feed_state_context.get("feedRange")
         elif change_feed_state_context.get("partitionKey"):
             if change_feed_state_context.get("partitionKeyFeedRange"):
                 feed_range =\
-                    FeedRangePartitionKey(
+                    FeedRangeInternalPartitionKey(
                         change_feed_state_context["partitionKey"],
                         change_feed_state_context["partitionKeyFeedRange"])
             else:
                 raise ValueError("partitionKey is in the changeFeedStateContext, but missing partitionKeyFeedRange")
         else:
             # default to full range
-            feed_range = FeedRangeEpk(
+            feed_range = FeedRangeInternalEpk(
                 Range(
                 "",
                 "FF",
@@ -405,9 +404,12 @@ def from_initial_state(
 
         change_feed_start_from = (
             ChangeFeedStartFromInternal.from_start_time(change_feed_state_context.get("startTime")))
-        return cls(
-            container_link=container_link,
-            container_rid=collection_rid,
-            feed_range=feed_range,
-            change_feed_start_from=change_feed_start_from,
-            continuation=None)
+
+        if feed_range is not None:
+            return cls(
+                container_link=container_link,
+                container_rid=collection_rid,
+                feed_range=feed_range,
+                change_feed_start_from=change_feed_start_from,
+                continuation=None)
+        raise RuntimeError("feed_range is empty")

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

@@ -26,7 +26,8 @@
 from typing import Any, Deque, Dict, Optional
 
 from azure.cosmos._change_feed.composite_continuation_token import CompositeContinuationToken
-from azure.cosmos._change_feed.feed_range import FeedRange, FeedRangeEpk, FeedRangePartitionKey
+from azure.cosmos._change_feed.feed_range_internal import (FeedRangeInternal, FeedRangeInternalEpk,
+                                                           FeedRangeInternalPartitionKey)
 from azure.cosmos._routing.routing_map_provider import SmartRoutingMapProvider
 from azure.cosmos._routing.aio.routing_map_provider import SmartRoutingMapProvider as AsyncSmartRoutingMapProvider
 from azure.cosmos._routing.routing_range import Range
@@ -39,7 +40,7 @@ class FeedRangeCompositeContinuation:
     def __init__(
             self,
             container_rid: str,
-            feed_range: FeedRange,
+            feed_range: FeedRangeInternal,
             continuation: Deque[CompositeContinuationToken]) -> None:
         if container_rid is None:
             raise ValueError("container_rid is missing")
@@ -87,11 +88,11 @@ def from_json(cls, data) -> 'FeedRangeCompositeContinuation':
                         for child_range_continuation_token in continuation_data]
 
         # parsing feed range
-        feed_range: Optional[FeedRange] = None
-        if data.get(FeedRangeEpk.type_property_name):
-            feed_range = FeedRangeEpk.from_json(data)
-        elif data.get(FeedRangePartitionKey.type_property_name):
-            feed_range = FeedRangePartitionKey.from_json(data, continuation[0].feed_range)
+        feed_range: Optional[FeedRangeInternal] = None
+        if data.get(FeedRangeInternalEpk.type_property_name):
+            feed_range = FeedRangeInternalEpk.from_json(data)
+        elif data.get(FeedRangeInternalPartitionKey.type_property_name):
+            feed_range = FeedRangeInternalPartitionKey.from_json(data, continuation[0].feed_range)
         else:
             raise ValueError("Invalid feed range composite continuation token [Missing feed range scope]")
 
@@ -171,5 +172,5 @@ def apply_not_modified_response(self) -> None:
             self._initial_no_result_range = self._current_token.feed_range
 
     @property
-    def feed_range(self) -> FeedRange:
+    def feed_range(self) -> FeedRangeInternal:
         return self._feed_range

sdk/cosmos/azure-cosmos/azure/cosmos/_cosmos_client_connection.py

@@ -30,8 +30,6 @@
 from urllib3.util.retry import Retry
 
 from azure.core import PipelineClient
-
-from ._change_feed.feed_range import FeedRange
 from ._session_token_helpers import is_compound_session_token, merge_session_tokens
 from ._vector_session_token import VectorSessionToken
 from azure.core.credentials import TokenCredential

sdk/cosmos/azure-cosmos/azure/cosmos/_routing/routing_range.py

@@ -25,12 +25,8 @@
 import base64
 import binascii
 import json
-from typing import Dict, Any
 
 
-def partition_key_range_to_range_string(partition_key_range: Dict[str, Any]) -> str:
-    return Range.PartitionKeyRangeToRange(partition_key_range).to_base64_encoded_string()
-
 class PartitionKeyRange(object):
     """Partition Key Range Constants"""
 

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py

@@ -41,7 +41,8 @@
     GenerateGuidId,
     _set_properties_cache
 )
-from .._routing.routing_range import Range, partition_key_range_to_range_string
+from .._feed_range import FeedRange, FeedRangeEpk
+from .._routing.routing_range import Range
 from ..offer import ThroughputProperties
 from ..partition_key import (
     NonePartitionKeyValue,
@@ -532,15 +533,16 @@ def query_items_change_feed(
     def query_items_change_feed(
             self,
             *,
-            feed_range: str,
+            feed_range: FeedRange,
             max_item_count: Optional[int] = None,
             start_time: Optional[Union[datetime, Literal["Now", "Beginning"]]] = None,
             priority: Optional[Literal["High", "Low"]] = None,
             **kwargs: Any
     ) -> AsyncItemPaged[Dict[str, Any]]:
         """Get a sorted list of items that were changed, in the order in which they were modified.
 
-        :keyword str feed_range: The feed range that is used to define the scope.
+        :keyword feed_range: The feed range that is used to define the scope.
+        :type feed_range: ~azure.cosmos.FeedRange
         :keyword int max_item_count: Max number of items to be returned in the enumeration operation.
         :keyword start_time: The start time to start processing chang feed items.
             Beginning: Processing the change feed items from the beginning of the change feed.
@@ -614,6 +616,30 @@ def query_items_change_feed( # pylint: disable=unused-argument
             *args: Any,
             **kwargs: Any
     ) -> AsyncItemPaged[Dict[str, Any]]:
+
+        """Get a sorted list of items that were changed, in the order in which they were modified.
+
+        :keyword str continuation: The continuation token retrieved from previous response.
+        :keyword feed_range: The feed range that is used to define the scope.
+        :type feed_range: ~azure.cosmos.FeedRange
+        :keyword partition_key: The partition key that is used to define the scope
+            (logical partition or a subset of a container)
+        :type partition_key: Union[str, int, float, bool, List[Union[str, int, float, bool]]]
+        :keyword int max_item_count: Max number of items to be returned in the enumeration operation.
+        :keyword start_time: The start time to start processing chang feed items.
+            Beginning: Processing the change feed items from the beginning of the change feed.
+            Now: Processing change feed from the current time, so only events for all future changes will be retrieved.
+            ~datetime.datetime: processing change feed from a point of time. Provided value will be converted to UTC.
+            By default, it is start from current ("Now")
+        :type start_time: Union[~datetime.datetime, Literal["Now", "Beginning"]]
+        :keyword Literal["High", "Low"] priority: Priority based execution allows users to set a priority for each
+            request. Once the user has reached their provisioned throughput, low priority requests are throttled
+            before high priority requests start getting throttled. Feature must first be enabled at the account level.
+        :keyword Callable response_hook: A callable invoked with the response metadata.
+        :param Any args: args
+        :returns: An Iterable of items (dicts).
+        :rtype: Iterable[Dict[str, Any]]
+        """
         # pylint: disable=too-many-statements
         if kwargs.get("priority") is not None:
             kwargs['priority'] = kwargs['priority']
@@ -665,7 +691,8 @@ def query_items_change_feed( # pylint: disable=unused-argument
                 self._get_epk_range_for_partition_key(kwargs.pop('partition_key'))
 
         if kwargs.get("feed_range") is not None:
-            change_feed_state_context["feedRange"] = kwargs.pop('feed_range')
+            feed_range: FeedRangeEpk = kwargs.pop('feed_range')
+            change_feed_state_context["feedRange"] = feed_range._feed_range_internal
 
         feed_options["containerProperties"] = self._get_properties()
         feed_options["changeFeedStateContext"] = change_feed_state_context
@@ -1271,7 +1298,7 @@ async def read_feed_ranges(
             *,
             force_refresh: Optional[bool] = False,
             **kwargs: Any
-    ) -> List[str]:
+    ) -> List[FeedRange]:
         """ Obtains a list of feed ranges that can be used to parallelize feed operations.
 
         :keyword bool force_refresh:
@@ -1290,4 +1317,5 @@ async def read_feed_ranges(
                 [Range("", "FF", True, False)],
                 **kwargs)
 
-        return [partition_key_range_to_range_string(partitionKeyRange) for partitionKeyRange in partition_key_ranges]
+        return [FeedRangeEpk(Range.PartitionKeyRangeToRange(partitionKeyRange))
+                for partitionKeyRange in partition_key_ranges]

sdk/cosmos/azure-cosmos/azure/cosmos/container.py

@@ -40,9 +40,9 @@
     ParsePaths,
     TrimBeginningAndEndingSlashes
 )
-from ._change_feed.feed_range import FeedRange, FeedRangeEpk
 from ._cosmos_client_connection import CosmosClientConnection
-from ._routing.routing_range import Range, partition_key_range_to_range_string, PartitionKeyRange
+from ._feed_range import FeedRange, FeedRangeEpk
+from ._routing.routing_range import Range
 from .offer import Offer, ThroughputProperties
 from .partition_key import (
     NonePartitionKeyValue,
@@ -358,7 +358,7 @@ def query_items_change_feed(
     def query_items_change_feed(
             self,
             *,
-            feed_range: str,
+            feed_range: FeedRange,
             max_item_count: Optional[int] = None,
             start_time: Optional[Union[datetime, Literal["Now", "Beginning"]]] = None,
             priority: Optional[Literal["High", "Low"]] = None,
@@ -367,7 +367,8 @@ def query_items_change_feed(
 
         """Get a sorted list of items that were changed, in the order in which they were modified.
 
-        :keyword str feed_range: The feed range that is used to define the scope.
+        :keyword feed_range: The feed range that is used to define the scope.
+        :type feed_range: ~azure.cosmos.FeedRange
         :keyword int max_item_count: Max number of items to be returned in the enumeration operation.
         :keyword start_time: The start time to start processing chang feed items.
             Beginning: Processing the change feed items from the beginning of the change feed.
@@ -440,6 +441,31 @@ def query_items_change_feed(
             *args: Any,
             **kwargs: Any
     ) -> ItemPaged[Dict[str, Any]]:
+
+        """Get a sorted list of items that were changed, in the order in which they were modified.
+
+        :keyword str continuation: The continuation token retrieved from previous response.
+        :keyword feed_range: The feed range that is used to define the scope.
+        :type feed_range: ~azure.cosmos.FeedRange
+        :keyword partition_key: The partition key that is used to define the scope
+            (logical partition or a subset of a container)
+        :type partition_key: Union[str, int, float, bool, List[Union[str, int, float, bool]]]
+        :keyword int max_item_count: Max number of items to be returned in the enumeration operation.
+        :keyword start_time: The start time to start processing chang feed items.
+            Beginning: Processing the change feed items from the beginning of the change feed.
+            Now: Processing change feed from the current time, so only events for all future changes will be retrieved.
+            ~datetime.datetime: processing change feed from a point of time. Provided value will be converted to UTC.
+            By default, it is start from current ("Now")
+        :type start_time: Union[~datetime.datetime, Literal["Now", "Beginning"]]
+        :keyword Literal["High", "Low"] priority: Priority based execution allows users to set a priority for each
+            request. Once the user has reached their provisioned throughput, low priority requests are throttled
+            before high priority requests start getting throttled. Feature must first be enabled at the account level.
+        :keyword Callable response_hook: A callable invoked with the response metadata.
+        :param Any args: args
+        :returns: An Iterable of items (dicts).
+        :rtype: Iterable[Dict[str, Any]]
+        """
+
         # pylint: disable=too-many-statements
         if kwargs.get("priority") is not None:
             kwargs['priority'] = kwargs['priority']
@@ -508,6 +534,8 @@ def query_items_change_feed(
 
         if kwargs.get("feed_range") is not None:
             change_feed_state_context["feedRange"] = kwargs.pop('feed_range')
+            feed_range: FeedRangeEpk = kwargs.pop('feed_range')
+            change_feed_state_context["feedRange"] = feed_range._feed_range_internal
 
         container_properties = self._get_properties()
         feed_options["changeFeedStateContext"] = change_feed_state_context
@@ -736,7 +764,7 @@ def replace_item(  # pylint:disable=docstring-missing-param
             document_link=item_link, new_document=body, request_context=request_context, options=request_options, **kwargs
         )
         self._add_request_context(request_context)
-        return result
+        return result or {}
 
     @distributed_trace
     def upsert_item(  # pylint:disable=docstring-missing-param
@@ -814,7 +842,7 @@ def upsert_item(  # pylint:disable=docstring-missing-param
             **kwargs
         )
         self._add_request_context(request_context)
-        return result
+        return result or {}
 
     @distributed_trace
     def create_item(  # pylint:disable=docstring-missing-param
@@ -895,7 +923,7 @@ def create_item(  # pylint:disable=docstring-missing-param
         result = self.client_connection.CreateItem(
             database_or_container_link=self.container_link, document=body, request_context=request_context, options=request_options, **kwargs)
         self._add_request_context(request_context)
-        return result
+        return result or {}
 
     @distributed_trace
     def patch_item(
@@ -972,7 +1000,7 @@ def patch_item(
         result = self.client_connection.PatchItem(
             document_link=item_link, operations=patch_operations, request_context=request_context, options=request_options, **kwargs)
         self._add_request_context(request_context)
-        return result
+        return result or {}
 
     @distributed_trace
     def execute_item_batch(
@@ -1361,7 +1389,7 @@ def read_feed_ranges(
             self,
             *,
             force_refresh: Optional[bool] = False,
-            **kwargs: Any) -> List[str]:
+            **kwargs: Any) -> List[FeedRange]:
 
         """ Obtains a list of feed ranges that can be used to parallelize feed operations.
 
@@ -1380,7 +1408,8 @@ def read_feed_ranges(
                 [Range("", "FF", True, False)], # default to full range
                 **kwargs)
 
-        return [partition_key_range_to_range_string(partitionKeyRange) for partitionKeyRange in partition_key_ranges]
+        return [FeedRangeEpk(Range.PartitionKeyRangeToRange(partitionKeyRange))
+            for partitionKeyRange in partition_key_ranges]
 
     def get_updated_session_token(self,
                              feed_ranges_to_session_tokens: List,

sdk/cosmos/azure-cosmos/test/test_vector_policy.py

@@ -163,7 +163,8 @@ def test_fail_replace_vector_indexing_policy(self):
             pytest.fail("Container replace should have failed for indexing policy.")
         except exceptions.CosmosHttpResponseError as e:
             assert e.status_code == 400
-            assert "vector indexing policy cannot be modified in Collection Replace" in e.http_error_message
+            assert "Paths in existing vector indexing policy cannot be modified in Collection Replace." \
+                   " They can only be added or removed." in e.http_error_message
         self.test_db.delete_container(container_id)
 
     def test_fail_create_vector_embedding_policy(self):

sdk/cosmos/azure-cosmos/test/test_vector_policy_async.py

@@ -173,7 +173,8 @@ async def test_fail_replace_vector_indexing_policy_async(self):
             pytest.fail("Container replace should have failed for indexing policy.")
         except exceptions.CosmosHttpResponseError as e:
             assert e.status_code == 400
-            assert "vector indexing policy cannot be modified in Collection Replace" in e.http_error_message
+            assert "Paths in existing vector indexing policy cannot be modified in Collection Replace." \
+                   " They can only be added or removed." in e.http_error_message
         await self.test_db.delete_container(container_id)
 
     async def test_fail_create_vector_embedding_policy_async(self):