Update supported version for adding primary_only parameter to force-m…

…erge API Signed-off-by: Gao Binlong <gbinlong@amazon.com>
opensearch-project · Mar 14, 2024 · 380451f · 380451f
1 parent da5b205
commit 380451f
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -96,6 +96,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [Bug] Check phase name before SearchRequestOperationsListener onPhaseStart ([#12035](https://github.com/opensearch-project/OpenSearch/pull/12035))
 - Fix Span operation names generated from RestActions ([#12005](https://github.com/opensearch-project/OpenSearch/pull/12005))
 - Fix error in RemoteSegmentStoreDirectory when debug logging is enabled ([#12328](https://github.com/opensearch-project/OpenSearch/pull/12328))
+- Update supported version for the primary_only parameter in force-merge API
 
 ### Security
 

diff --git a/...-spec/src/main/resources/rest-api-spec/test/indices.forcemerge/20_wait_for_completion.yml b/...-spec/src/main/resources/rest-api-spec/test/indices.forcemerge/20_wait_for_completion.yml
@@ -4,15 +4,17 @@
   # will return a task immediately and the merge process will run in background.
 
   - skip:
-      version: " - 2.99.99"
-      reason: "only available in 3.0+"
-      features: allowed_warnings
+      version: " - 2.6.99, 2.13.0 - "
+      reason: "wait_for_completion was introduced in 2.7.0 and task description was changed in 2.13.0"
+      features: allowed_warnings, node_selector
 
   - do:
       indices.create:
         index: test_index
 
   - do:
+      node_selector:
+        version: " 2.7.0 - 2.12.99"
       indices.forcemerge:
         index: test_index
         wait_for_completion: false
@@ -25,8 +27,31 @@
         wait_for_completion: true
         task_id: $taskId
   - match: { task.action: "indices:admin/forcemerge" }
-  - match: { task.description: "Force-merge indices [test_index], maxSegments[1], onlyExpungeDeletes[false], flush[true], primaryOnly[false]" }
+  - match: { task.description: "Force-merge indices [test_index], maxSegments[1], onlyExpungeDeletes[false], flush[true]" }
+
+---
+"Force merge index with wait_for_completion after task description changed":
+  - skip:
+      version: " - 2.12.99 "
+      reason: "task description was changed in 2.13.0"
+      features: allowed_warnings, node_selector
+
+  - do:
+      node_selector:
+        version: " 2.13.0 - "
+      indices.forcemerge:
+        index: test_index
+        wait_for_completion: false
+        max_num_segments: 1
+  - match: { task: /^.+$/ }
+  - set: { task: taskId }
 
+  - do:
+      tasks.get:
+        wait_for_completion: true
+        task_id: $taskId
+  - match: { task.action: "indices:admin/forcemerge" }
+  - match: { task.description: "Force-merge indices [test_index], maxSegments[1], onlyExpungeDeletes[false], flush[true], primaryOnly[false]" }
   # .tasks index is created when the force-merge operation completes, so we should delete .tasks index finally,
   # if not, the .tasks index may introduce unexpected warnings and then cause other test cases to fail.
   # Delete the .tasks index directly will also introduce warning, but currently we don't have such APIs which can delete one

diff --git a/server/src/main/java/org/opensearch/action/admin/indices/forcemerge/ForceMergeRequest.java b/server/src/main/java/org/opensearch/action/admin/indices/forcemerge/ForceMergeRequest.java
@@ -102,7 +102,7 @@ public ForceMergeRequest(StreamInput in) throws IOException {
         maxNumSegments = in.readInt();
         onlyExpungeDeletes = in.readBoolean();
         flush = in.readBoolean();
-        if (in.getVersion().onOrAfter(Version.V_3_0_0)) {
+        if (in.getVersion().onOrAfter(Version.V_2_13_0)) {
             primaryOnly = in.readBoolean();
         }
         if (in.getVersion().onOrAfter(FORCE_MERGE_UUID_VERSION)) {
@@ -219,7 +219,7 @@ public void writeTo(StreamOutput out) throws IOException {
         out.writeInt(maxNumSegments);
         out.writeBoolean(onlyExpungeDeletes);
         out.writeBoolean(flush);
-        if (out.getVersion().onOrAfter(Version.V_3_0_0)) {
+        if (out.getVersion().onOrAfter(Version.V_2_13_0)) {
             out.writeBoolean(primaryOnly);
         }
         if (out.getVersion().onOrAfter(FORCE_MERGE_UUID_VERSION)) {

diff --git a/.../src/test/java/org/opensearch/action/admin/indices/forcemerge/ForceMergeRequestTests.java b/.../src/test/java/org/opensearch/action/admin/indices/forcemerge/ForceMergeRequestTests.java
@@ -109,9 +109,11 @@ public void testBwcSerialization() throws Exception {
                 assertEquals(sample.maxNumSegments(), deserializedRequest.maxNumSegments());
                 assertEquals(sample.onlyExpungeDeletes(), deserializedRequest.onlyExpungeDeletes());
                 assertEquals(sample.flush(), deserializedRequest.flush());
-                if (compatibleVersion.onOrAfter(Version.V_3_0_0)) {
+                if (compatibleVersion.onOrAfter(Version.V_2_13_0)) {
                     assertEquals(sample.primaryOnly(), deserializedRequest.primaryOnly());
-                    assertEquals(sample.forceMergeUUID(), deserializedRequest.forceMergeUUID());
+                    if (compatibleVersion.onOrAfter(Version.V_3_0_0)) {
+                        assertEquals(sample.forceMergeUUID(), deserializedRequest.forceMergeUUID());
+                    }
                 }
             }
         }
@@ -127,7 +129,7 @@ public void testBwcSerialization() throws Exception {
                 out.writeInt(sample.maxNumSegments());
                 out.writeBoolean(sample.onlyExpungeDeletes());
                 out.writeBoolean(sample.flush());
-                if (compatibleVersion.onOrAfter(Version.V_3_0_0)) {
+                if (compatibleVersion.onOrAfter(Version.V_2_13_0)) {
                     out.writeBoolean(sample.primaryOnly());
                 }
                 if (compatibleVersion.onOrAfter(Version.V_3_0_0)) {
@@ -145,9 +147,7 @@ public void testBwcSerialization() throws Exception {
                 assertEquals(sample.maxNumSegments(), deserializedRequest.maxNumSegments());
                 assertEquals(sample.onlyExpungeDeletes(), deserializedRequest.onlyExpungeDeletes());
                 assertEquals(sample.flush(), deserializedRequest.flush());
-                if (compatibleVersion.onOrAfter(Version.V_3_0_0)) {
-                    assertEquals(sample.primaryOnly(), deserializedRequest.primaryOnly());
-                }
+                assertEquals(sample.primaryOnly(), deserializedRequest.primaryOnly());
                 assertEquals(sample.forceMergeUUID(), deserializedRequest.forceMergeUUID());
 
             }