CFP AVAD: Adds Container IsFeedRangePartOfAsync support for FeedRange

Microsoft.Azure.Cosmos/src/ChangeFeed/ChangeFeedPartitionKeyResultSetIteratorCore.cs

@@ -59,13 +59,15 @@ public static ChangeFeedPartitionKeyResultSetIteratorCore Create(
                 container: container,
                 mode: mode,
                 changeFeedStartFrom: startFrom,
-                options: requestOptions);
+                options: requestOptions,
+                feedRangeEpk: lease?.FeedRange is FeedRangeEpk epk ? epk : default);
         }
 
         private readonly CosmosClientContext clientContext;
 
         private readonly ChangeFeedRequestOptions changeFeedOptions;
         private readonly ChangeFeedMode mode;
+        private readonly FeedRangeEpk feedRangeEpk;
 
         private ChangeFeedStartFrom changeFeedStartFrom;
         private bool hasMoreResultsInternal;
@@ -74,13 +76,15 @@ private ChangeFeedPartitionKeyResultSetIteratorCore(
             ContainerInternal container,
             ChangeFeedMode mode,
             ChangeFeedStartFrom changeFeedStartFrom,
-            ChangeFeedRequestOptions options)
+            ChangeFeedRequestOptions options,
+            FeedRangeEpk feedRangeEpk)
         {
             this.container = container ?? throw new ArgumentNullException(nameof(container));
             this.mode = mode;
             this.changeFeedStartFrom = changeFeedStartFrom ?? throw new ArgumentNullException(nameof(changeFeedStartFrom));
             this.clientContext = this.container.ClientContext;
             this.changeFeedOptions = options;
+            this.feedRangeEpk = feedRangeEpk;
         }
 
         public override bool HasMoreResults => this.hasMoreResultsInternal;
@@ -140,6 +144,16 @@ public override async Task<ResponseMessage> ReadNextAsync(ITrace trace, Cancella
             responseMessage.Headers.ContinuationToken = etag;
             this.changeFeedStartFrom = new ChangeFeedStartFromContinuationAndFeedRange(etag, (FeedRangeInternal)this.changeFeedStartFrom.FeedRange);
 
+            // Set the FeedRangeMinMax response header.
+
+            if (this.feedRangeEpk != null)
+            {
+                responseMessage.Headers.FeedRangeDetails = FeedRangeDetail.Create(
+                    minInclusive: this.feedRangeEpk.Range.Min,
+                    maxExclusive: this.feedRangeEpk.Range.Max,
+                    collectionRid: responseMessage.RequestMessage.DocumentServiceRequest.ResourceId);
+            }
+
             return responseMessage;
         }
     }

Microsoft.Azure.Cosmos/src/ChangeFeed/FeedRangeDetail.cs

@@ -0,0 +1,54 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+//------------------------------------------------------------
+
+namespace Microsoft.Azure.Cosmos.ChangeFeed
+{
+    /// <summary>
+    /// The feed range details.
+    /// </summary>
+    public class FeedRangeDetail
+    {
+        /// <summary>
+        /// Gets the min inclusive.
+        /// </summary>
+        public string MinInclusive { get; private set; }
+
+        /// <summary>
+        /// Gets the max exclusive.
+        /// </summary>
+        public string MaxExclusive { get; private set; }
+
+        /// <summary>
+        /// Gets the collection resource id.
+        /// </summary>
+        public string CollectionRid { get; private set; }
+
+        /// <summary>
+        /// Creates a new feed range detail.
+        /// </summary>
+        /// <param name="minInclusive"></param>
+        /// <param name="maxExclusive"></param>
+        /// <param name="collectionRid"></param>
+        /// <returns>A immutable feed range detail.</returns>
+        public static FeedRangeDetail Create(string minInclusive, string maxExclusive, string collectionRid)
+        {
+            return new FeedRangeDetail(
+                minInclusive: minInclusive,
+                maxExclusive: maxExclusive,
+                collectionRid: collectionRid);
+        }
+        /// <summary>
+        /// The construtor for the feed range detail.
+        /// </summary>
+        /// <param name="minInclusive">The minInclusive for the feed range.</param>
+        /// <param name="maxExclusive">The maxExclusive for the feed range.</param>
+        /// <param name="collectionRid">The collection resource id for the feed range.</param>
+        private FeedRangeDetail(string minInclusive, string maxExclusive, string collectionRid)
+        {
+            this.MinInclusive = minInclusive;
+            this.MaxExclusive = maxExclusive;
+            this.CollectionRid = collectionRid;
+        }
+    }
+}

Microsoft.Azure.Cosmos/src/Headers/Headers.cs

@@ -457,5 +457,14 @@ internal static SubStatusCodes GetSubStatusCodes(string value)
 
             return null;
         }
+
+        /// <summary>
+        /// Gets the feed range details.
+        /// </summary>
+        public virtual ChangeFeed.FeedRangeDetail FeedRangeDetails
+        {
+            get;
+            internal set;
+        }
     }
 }

Microsoft.Azure.Cosmos/src/Query/Core/QueryClient/ContainerQueryProperties.cs

@@ -1,39 +1,39 @@
-//------------------------------------------------------------
-// Copyright (c) Microsoft Corporation.  All rights reserved.
-//------------------------------------------------------------
-
-namespace Microsoft.Azure.Cosmos.Query.Core.QueryClient
-{
-    using System.Collections.Generic;
-    using Microsoft.Azure.Documents;
-    using Microsoft.Azure.Documents.Routing;
-
-    internal readonly struct ContainerQueryProperties
-    {
-        public ContainerQueryProperties(
-            string resourceId,
-            IReadOnlyList<Range<string>> effectivePartitionKeyRanges,
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+//------------------------------------------------------------
+
+namespace Microsoft.Azure.Cosmos.Query.Core.QueryClient
+{
+    using System.Collections.Generic;
+    using Microsoft.Azure.Documents;
+    using Microsoft.Azure.Documents.Routing;
+
+    internal readonly struct ContainerQueryProperties
+    {
+        public ContainerQueryProperties(
+            string resourceId,
+            IReadOnlyList<Range<string>> effectivePartitionKeyRanges,
             PartitionKeyDefinition partitionKeyDefinition,
-            Cosmos.VectorEmbeddingPolicy vectorEmbeddingPolicy,
-            Cosmos.GeospatialType geospatialType)
-        {
-            this.ResourceId = resourceId;
-            this.EffectiveRangesForPartitionKey = effectivePartitionKeyRanges;
+            Cosmos.VectorEmbeddingPolicy vectorEmbeddingPolicy,
+            Cosmos.GeospatialType geospatialType)
+        {
+            this.ResourceId = resourceId;
+            this.EffectiveRangesForPartitionKey = effectivePartitionKeyRanges;
             this.PartitionKeyDefinition = partitionKeyDefinition;
-            this.VectorEmbeddingPolicy = vectorEmbeddingPolicy;
-            this.GeospatialType = geospatialType;
-        }
-
-        public string ResourceId { get; }
-
-        //A PartitionKey has one range when it is a full PartitionKey value.
-        //It can span many  it is a prefix PartitionKey for a sub-partitioned container.
-        public IReadOnlyList<Range<string>> EffectiveRangesForPartitionKey { get; }
+            this.VectorEmbeddingPolicy = vectorEmbeddingPolicy;
+            this.GeospatialType = geospatialType;
+        }
+
+        public string ResourceId { get; }
+
+        //A PartitionKey has one range when it is a full PartitionKey value.
+        //It can span many  it is a prefix PartitionKey for a sub-partitioned container.
+        public IReadOnlyList<Range<string>> EffectiveRangesForPartitionKey { get; }
 
         public PartitionKeyDefinition PartitionKeyDefinition { get; }
 
-        public Cosmos.VectorEmbeddingPolicy VectorEmbeddingPolicy { get; }
+        public Cosmos.VectorEmbeddingPolicy VectorEmbeddingPolicy { get; }
 
-        public Cosmos.GeospatialType GeospatialType { get; }
-    }
+        public Cosmos.GeospatialType GeospatialType { get; }
+    }
 }

Microsoft.Azure.Cosmos/src/Routing/PartitionKeyRangeCache.cs

@@ -11,15 +11,16 @@ namespace Microsoft.Azure.Cosmos.Routing
     using System.Linq;
     using System.Net;
     using System.Text;
-    using System.Threading;
     using System.Threading.Tasks;
+    using Microsoft.Azure.Cosmos.ChangeFeed.Utils;
     using Microsoft.Azure.Cosmos.Common;
     using Microsoft.Azure.Cosmos.Core.Trace;
     using Microsoft.Azure.Cosmos.Tracing;
     using Microsoft.Azure.Cosmos.Tracing.TraceData;
     using Microsoft.Azure.Documents;
     using Microsoft.Azure.Documents.Collections;
     using Microsoft.Azure.Documents.Routing;
+    using Newtonsoft.Json;
 
     internal class PartitionKeyRangeCache : IRoutingMapProvider, ICollectionRoutingMapCache
     {
@@ -81,6 +82,75 @@ public virtual async Task<IReadOnlyList<PartitionKeyRange>> TryGetOverlappingRan
             }
         }
 
+        /// <summary>
+        /// Gets the overlapping ranges for a list of feed ranges.
+        /// </summary>
+        /// <param name="collectionRid"></param>
+        /// <param name="ranges"></param>
+        /// <param name="trace"></param>
+        /// <param name="forceRefresh"></param>
+        public virtual async Task<IReadOnlyList<PartitionKeyRange>> TryGetOverlappingRangesAsync(
+            string collectionRid,
+            IReadOnlyList<Range<string>> ranges,
+            ITrace trace,
+            bool forceRefresh = false)
+        {
+            List<PartitionKeyRange> partitionKeyRanges = new ();
+
+            using (ITrace childTrace = trace.StartChild("Try Get Overlapping Ranges", TraceComponent.Routing, Tracing.TraceLevel.Info))
+            {
+                Debug.Assert(ResourceId.TryParse(collectionRid, out ResourceId collectionRidParsed), "Could not parse CollectionRid from ResourceId.");
+
+                foreach (Range<string> range in ranges)
+                {
+                    IReadOnlyList<PartitionKeyRange> overlappingRanges = await this.TryGetOverlappingRangesAsync(
+                        collectionRid: collectionRid,
+                        range: range,
+                        trace: childTrace,
+                        forceRefresh: forceRefresh);
+
+                    Debug.Assert(overlappingRanges != null, $"There should always be overlapping ranges for {JsonConvert.SerializeObject(range)}.");
+
+                    partitionKeyRanges.AddRange(overlappingRanges);
+                }
+            }
+
+            return partitionKeyRanges.AsReadOnly();
+        }
+
+        /// <summary>
+        /// Gets the overlapping ranges for a list of feed ranges.
+        /// </summary>
+        /// <param name="collectionRid"></param>
+        /// <param name="partitionKey"></param>
+        /// <param name="trace"></param>
+        /// <param name="forceRefresh"></param>
+        public virtual async Task<IReadOnlyList<PartitionKeyRange>> TryGetOverlappingRangesAsync(
+            string collectionRid,
+            PartitionKey partitionKey,
+            ITrace trace,
+            bool forceRefresh = false)
+        {
+            List<PartitionKeyRange> partitionKeyRanges = new ();
+
+            using (ITrace childTrace = trace.StartChild("Try Get Overlapping Ranges", TraceComponent.Routing, Tracing.TraceLevel.Info))
+            {
+                Debug.Assert(ResourceId.TryParse(collectionRid, out ResourceId collectionRidParsed), "Could not parse CollectionRid from ResourceId.");
+
+                CollectionRoutingMap routingMap = await this.TryLookupAsync(
+                    collectionRid: collectionRid,
+                    previousValue: null,
+                    request: null,
+                    trace: childTrace);
+
+                Debug.WriteLine($"{nameof(routingMap)} -> {JsonConvert.SerializeObject(routingMap)}");
+            }
+
+            await Task.Delay(TimeSpan.FromSeconds(5));
+
+            return partitionKeyRanges.AsReadOnly();
+        }
+
         public virtual async Task<PartitionKeyRange> TryGetPartitionKeyRangeByIdAsync(
             string collectionResourceId,
             string partitionKeyRangeId,