Fixing Beta-Version for Changefeed Pull public API (Azure#18838)

* Initial draft of FeedRange artifacts

* Iterating on FeedRange Apis

* Adding public surface area

* Adding FeedRange unit tests

* Adding test FeedRangePKRangeId_GetEffectiveRangesAsync_Refresh

* Adding test FeedRangePKRangeId_GetEffectiveRangesAsync_Null

* Adding test feedRangeEPK_getPartitionKeyRangesAsync

* Adding test feedRangePK_getPartitionKeyRangesAsync

* Adding test feedRangePKRangeId_getPartitionKeyRangesAsync

* Adding request visitor unit tests

* Finishing FeedRange tests

* Cleanup and prettifying

* Prettifying feed range tests

* Fixes and new test for Conatiner.getFeedRanges()

* Addressing some SpotBug violations

* Iterating on Changefeed Pull model draft

* Snapshot to be able to switch branches

* Finishing switch from deleted ChangeFeedOptions to new public CosmosChangeFeedRequestOptions

* Adding basic json serialization test coverage for FeedRangeContinuation

* Snapshot - converting Chagefeed to FeedRanges - tests not working yet

* Snapshot

* Snapshot

* Removing TODOs

* Fixing test regressions

* Fixing a couple SpotBug violations

* Fixing few more SPotBug violations

* Fixing ChangeFeedState unit test

* Code cleanup

* Test code cleanup

* Fixing a regression in Range json serialization

* Fixing CF split unit test failure

* Fixes for some code review feedback

* Fixing test flakiness (unrelated to actual change)

* Adding ChangeFeedPolicy

* Adding tests for ChangeFeedPolicy

* Fixing build break

* Fixing SpotBug issue

* Re-triggering CI

* Deleting temp data

* Deleting CosmosDB Emulator temp data

* Fixing scritp to delete temp folder

* Fixing PS script

* Adding message with Emulator version to emulator install yaml file

* Adding Cosmos DB Emulator installation logs

* Adding logic to unistall emulator to Cosmos Emulator yml

* Update cosmos-emulator.yml

* Fixing missing admin elevation in the uninstall step in Cosmos Emulator yml

* Iterating on cosmos-emulator.yml

* Iteratiing on cosmos-emulator.yml

* Iterating on cosmos-emulator.yml

* Iterating on cosmos-emulator.yml

* Iterating on comsos-emulator.yml

* Iterating on comsos-emulator.yml

* Iterate on cosmos-emulator.yml

* Adding FF changefeed unit tests

* Fixing build warning

* Fixing test regression when ContainerTest hit emulator limit of number of containers

* Fixing emulator config for CI tests

* Fixing test issue - causing Begin/After Method/Class to also happen for emulator tests in ChangeFeedTest

* Refactoring FeedRange visitors to populate request headers

* Implementing FeedRangeInternal.populateFeedRangeFilteringHeaders

* Fixes for FeedRangeTest

* Refactoring FeedRangeINternal.getEffectiveRanges to getEffectiveRange

* Fixing test issue in FeedRangeTest

* Reacting to self-Code review

* Actually adding public APIs for queryChangeFeed

* Adding public API in CosmosContainer and SomsosAsyncContainer for CF pull model

* Reacting to CR comments

* SpotBug fixes

* Fixing JavaDoc bug

* Reverting switch to @JsonDeserialize for custom deserializers

* Iterating on code review comments

* Adding more unit tests

* Spotbug fix

* Fix for test failures in FeedRangeTest

* Fixing SpotBUg issue

* Fixing test issues

* Iterating on Cosmos Container ChangeFeed tests

* Fixing test issue for small page size

* Adding addiitonal unit tests for change feed pull model

* Adding remaining tests for CF pull model

* Update FeedRange.java

* Cleanup

* Fixing typos in comments

* Fixing Duration in ChangeFeedPolicy

* Changing the encoding of FeedRange and ChangeFeedState to be base64-encoded Json vs. Json

* Cleanup

* Fixing spotbug issue

* Fixing test issue

* Switching deserializer registration to annotation based approach

* Reacting to code review feedback from Milis

* Fixing Test issues after changing ChangeFeedStateVersion from 0 to 1

* Fix test issue

* Renaming ShouldretryResult.RETRY_IMMEDIATELY to RETRY_NOW

* Adding Status code to JavaDoc description when processing FF CF outside retention

* Fixing ChangeFeedProcessor issues Matias found

- Continuation persisted in leases was stored as Base64-encoded josn of ChangeFeedState (vs. just LSN)
- Split handling was broken because the Change feed pull model is split-proof and doesn't surface GoneException which Change Feed processor relies on for splitting leases.

* Addressing code review comments from Mo

* Fixing SpotBUg issue

* Adding additional assert in CFP split test

* Addressing code review comments from Milis

* Fixing Beta-Version for Changefeed Pull public API

Author: FabianMeiswinkel

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosAsyncContainer.java

@@ -495,7 +495,7 @@ <T> Function<CosmosPagedFluxOptions, Flux<FeedResponse<T>>> queryItemsInternalFu
      * @return a {@link CosmosPagedFlux} containing one or several feed response pages of the obtained
      * items or an error.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public <T> CosmosPagedFlux<T> queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType) {
         checkNotNull(options, "Argument 'options' must not be null.");

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosContainer.java

@@ -27,7 +27,6 @@
 
 import java.util.List;
 
-import static com.azure.cosmos.implementation.Utils.setContinuationTokenAndMaxItemCount;
 import static com.azure.cosmos.implementation.guava25.base.Preconditions.checkNotNull;
 
 /**
@@ -352,7 +351,7 @@ public <T> CosmosPagedIterable<T> queryItems(SqlQuerySpec querySpec, CosmosQuery
      * @param classType the class type.
      * @return a {@link CosmosPagedFlux} containing one feed response page
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public <T> CosmosPagedIterable<T> queryChangeFeed(
         CosmosChangeFeedRequestOptions options,

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/ChangeFeedPolicy.java

@@ -52,7 +52,7 @@
  * }
  * </pre>
  */
-@Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION,
+@Beta(value = Beta.SinceVersion.V4_12_0,
     warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
 public final class ChangeFeedPolicy {
 
@@ -68,7 +68,7 @@ public final class ChangeFeedPolicy {
      *
      * @return ChangeFeedPolicy for full fidelity change feed.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION,
+    @Beta(value = Beta.SinceVersion.V4_12_0,
         warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static ChangeFeedPolicy createFullFidelityPolicy(Duration retentionDuration) {
 
@@ -95,7 +95,7 @@ public static ChangeFeedPolicy createFullFidelityPolicy(Duration retentionDurati
      *
      * @return ChangeFeedPolicy for default/incremental change feed without full fidelity.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION,
+    @Beta(value = Beta.SinceVersion.V4_12_0,
         warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static ChangeFeedPolicy createIncrementalPolicy() {
 
@@ -137,7 +137,7 @@ public static ChangeFeedPolicy createIncrementalPolicy() {
      *
      * @return full fidelity retention duration.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION,
+    @Beta(value = Beta.SinceVersion.V4_12_0,
         warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public Duration getFullFidelityRetentionDuration() {
         return Duration.ofMinutes(this.getFullFidelityRetentionDurationInMinutes());

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosChangeFeedRequestOptions.java

@@ -19,7 +19,7 @@
 import static com.azure.cosmos.implementation.guava25.base.Preconditions.checkArgument;
 import static com.azure.cosmos.implementation.guava25.base.Preconditions.checkNotNull;
 
-@Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+@Beta(value = Beta.SinceVersion.V4_12_0, warningText =
     Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
 public final class CosmosChangeFeedRequestOptions {
     private static final int DEFAULT_MAX_ITEM_COUNT = 100;
@@ -70,7 +70,7 @@ ChangeFeedState getContinuation() {
         return this.continuationState;
     }
 
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public FeedRange getFeedRange() {
         return this.feedRangeInternal;
@@ -82,7 +82,7 @@ public FeedRange getFeedRange() {
      *
      * @return the max number of items.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public int getMaxItemCount() {
         return this.maxItemCount;
@@ -95,7 +95,7 @@ public int getMaxItemCount() {
      * @param maxItemCount the max number of items.
      * @return the FeedOptionsBase.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount) {
         this.maxItemCount = maxItemCount;
@@ -114,7 +114,7 @@ public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount) {
      *
      * @return the modified change feed request options.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public int getMaxPrefetchPageCount() {
         return this.maxPrefetchPageCount;
@@ -134,7 +134,7 @@ public int getMaxPrefetchPageCount() {
      *                             asynchronously in the background
      * @return the modified change feed request options.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount) {
         checkArgument(
@@ -179,7 +179,7 @@ ChangeFeedStartFromInternal getStartFromSettings() {
      *                  logical partition or subset of a container)
      * @return a new {@link CosmosChangeFeedRequestOptions} instance
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange) {
         checkNotNull(feedRange, "Argument 'feedRange' must not be null.");
@@ -199,7 +199,7 @@ public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(Fe
      *                     FeedResponse
      * @return a new {@link CosmosChangeFeedRequestOptions} instance
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(
         String continuation) {
@@ -271,7 +271,7 @@ static CosmosChangeFeedRequestOptions createForProcessingFromEtagAndFeedRange(
      *                  logical partition or subset of a container)
      * @return a new {@link CosmosChangeFeedRequestOptions} instance
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange) {
         if (feedRange == null) {
@@ -294,7 +294,7 @@ public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRang
      *                    logical partition or subset of a container)
      * @return a new {@link CosmosChangeFeedRequestOptions} instance
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(
         Instant pointInTime,
@@ -368,7 +368,7 @@ CosmosChangeFeedRequestOptions withCosmosPagedFluxOptions(
      *
      * @return a {@link CosmosChangeFeedRequestOptions} instance with full fidelity mode enabled
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText =
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText =
         Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public CosmosChangeFeedRequestOptions fullFidelity() {
 

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerProperties.java

@@ -152,7 +152,7 @@ public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionP
      *
      * @return ChangeFeedPolicy
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION,
+    @Beta(value = Beta.SinceVersion.V4_12_0,
         warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public ChangeFeedPolicy getChangeFeedPolicy() {
         return this.documentCollection.getChangeFeedPolicy();
@@ -164,7 +164,7 @@ public ChangeFeedPolicy getChangeFeedPolicy() {
      * @param value ChangeFeedPolicy to be used.
      * @return the CosmosContainerProperties.
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION,
+    @Beta(value = Beta.SinceVersion.V4_12_0,
         warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value) {
         this.documentCollection.setChangeFeedPolicy(value);

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/FeedRange.java

@@ -36,7 +36,7 @@ public static FeedRange fromString(String json) {
      * @param partitionKey the logical partition key value
      * @return A feed range for a certain logical partition
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static FeedRange forLogicalPartition(PartitionKey partitionKey) {
         checkNotNull(partitionKey, "Argument 'partitionKey' must not be null.");
 
@@ -48,7 +48,7 @@ public static FeedRange forLogicalPartition(PartitionKey partitionKey) {
      * Creates a range for an entire container
      * @return A feed range for an entire container
      */
-    @Beta(value = Beta.SinceVersion.WHATEVER_NEW_VERSION, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    @Beta(value = Beta.SinceVersion.V4_12_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public static FeedRange forFullRange() {
         return FeedRangeEpkImpl.forFullRange();
     }

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/util/Beta.java

@@ -55,6 +55,7 @@ public enum SinceVersion {
         V4_9_0,
         /** v4.11.0 */
         V4_11_0,
-        WHATEVER_NEW_VERSION
+        /** v4.12.0 */
+        V4_12_0
     }
 }