Use TimeValue instead of an int

carlosdelest · carlosdelest · commit ab0805d60d8e · 2025-04-04T13:22:41.000+02:00
diff --git a/server/src/internalClusterTest/java/org/elasticsearch/synonyms/SynonymsManagementAPIServiceIT.java b/server/src/internalClusterTest/java/org/elasticsearch/synonyms/SynonymsManagementAPIServiceIT.java
@@ -15,6 +15,7 @@
 import org.elasticsearch.action.bulk.BulkResponse;
 import org.elasticsearch.cluster.ClusterName;
 import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.index.mapper.extras.MapperExtrasPlugin;
 import org.elasticsearch.indices.IndexCreationException;
 import org.elasticsearch.plugins.Plugin;
@@ -309,7 +310,7 @@ public void testCreateSynonymsWithYellowSynonymsIndex() throws Exception {
         // Override health method check to simulate a timeout in checking the synonyms index
         synonymsManagementAPIService = new SynonymsManagementAPIService(client()) {
             @Override
-            void checkSynonymsIndexHealth(int timeout, ActionListener<ClusterHealthResponse> listener) {
+            void checkSynonymsIndexHealth(TimeValue timeout, ActionListener<ClusterHealthResponse> listener) {
                 ClusterState clusterState = ClusterState.builder(ClusterName.DEFAULT).build();
                 ClusterHealthResponse response = new ClusterHealthResponse(randomIdentifier(),
                     new String[]{SynonymsManagementAPIService.SYNONYMS_INDEX_CONCRETE_NAME},
@@ -365,12 +366,12 @@ public void onFailure(Exception e) {
 
         updateLatch.await(5, TimeUnit.SECONDS);
 
-        // But, we can still create a synonyms set with timeout 0
+        // But, we can still create a synonyms set with timeout -1
         CountDownLatch putWithoutTimeoutLatch = new CountDownLatch(1);
         synonymsManagementAPIService.putSynonymsSet(
             synonymSetId,
             randomSynonymsSet(1, 1),
-            0,
+            TimeValue.MINUS_ONE,
             new ActionListener<>() {
                 @Override
                 public void onResponse(SynonymsManagementAPIService.SynonymsReloadResult synonymsReloadResult) {
@@ -391,7 +392,7 @@ public void onFailure(Exception e) {
         synonymsManagementAPIService.putSynonymRule(
             synonymSetId,
             randomSynonymRule(randomIdentifier()),
-            0,
+            TimeValue.MINUS_ONE,
             new ActionListener<>() {
                 @Override
                 public void onResponse(SynonymsManagementAPIService.SynonymsReloadResult synonymsReloadResult) {
diff --git a/server/src/main/java/org/elasticsearch/action/synonyms/PutSynonymRuleAction.java b/server/src/main/java/org/elasticsearch/action/synonyms/PutSynonymRuleAction.java
@@ -19,6 +19,7 @@
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.xcontent.XContentHelper;
+import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.synonyms.SynonymRule;
 import org.elasticsearch.synonyms.SynonymsManagementAPIService;
 import org.elasticsearch.xcontent.ConstructingObjectParser;
@@ -35,7 +36,7 @@ public class PutSynonymRuleAction extends ActionType<SynonymUpdateResponse> {
     public static final PutSynonymRuleAction INSTANCE = new PutSynonymRuleAction();
     public static final String NAME = "cluster:admin/synonym_rules/put";
 
-    public static final int DEFAULT_TIMEOUT = 5;
+    public static final TimeValue DEFAULT_TIMEOUT = TimeValue.timeValueSeconds(10);
 
     public PutSynonymRuleAction() {
         super(NAME);
@@ -44,7 +45,7 @@ public PutSynonymRuleAction() {
     public static class Request extends ActionRequest {
         private final String synonymsSetId;
         private final SynonymRule synonymRule;
-        private final int timeout;
+        private final TimeValue timeout;
 
         public static final ParseField SYNONYMS_FIELD = new ParseField(SynonymsManagementAPIService.SYNONYMS_FIELD);
         private static final ConstructingObjectParser<SynonymRule, String> PARSER = new ConstructingObjectParser<>(
@@ -62,14 +63,15 @@ public Request(StreamInput in) throws IOException {
             this.synonymsSetId = in.readString();
             this.synonymRule = new SynonymRule(in);
             if (in.getTransportVersion().onOrAfter(TransportVersions.SYNONYMS_UPDATE_TIMEOUT)) {
-                this.timeout = in.readInt();
+                this.timeout = in.readTimeValue();
             } else {
                 this.timeout = DEFAULT_TIMEOUT;
             }
         }
 
-        public Request(String synonymsSetId, String synonymRuleId, int timeout, BytesReference content, XContentType contentType)
+        public Request(String synonymsSetId, String synonymRuleId, TimeValue timeout, BytesReference content, XContentType contentType)
             throws IOException {
+            Objects.requireNonNull(timeout);
             this.synonymsSetId = synonymsSetId;
             try (XContentParser parser = XContentHelper.createParser(XContentParserConfiguration.EMPTY, content, contentType)) {
                 this.synonymRule = PARSER.apply(parser, synonymRuleId);
@@ -79,7 +81,8 @@ public Request(String synonymsSetId, String synonymRuleId, int timeout, BytesRef
             this.timeout = timeout;
         }
 
-        Request(String synonymsSetId, SynonymRule synonymRule, int timeout) {
+        Request(String synonymsSetId, SynonymRule synonymRule, TimeValue timeout) {
+            Objects.requireNonNull(timeout);
             this.synonymsSetId = synonymsSetId;
             this.synonymRule = synonymRule;
             this.timeout = timeout;
@@ -94,13 +97,6 @@ public ActionRequestValidationException validate() {
             if (Strings.isNullOrEmpty(synonymRule.id())) {
                 validationException = ValidateActions.addValidationError("synonym rule id must be specified", validationException);
             }
-            if (timeout < 0) {
-                validationException = ValidateActions.addValidationError("timeout must be greater than or equal to 0", validationException);
-            }
-            String error = synonymRule.validate();
-            if (error != null) {
-                validationException = ValidateActions.addValidationError(error, validationException);
-            }
 
             return validationException;
         }
@@ -111,7 +107,7 @@ public void writeTo(StreamOutput out) throws IOException {
             out.writeString(synonymsSetId);
             synonymRule.writeTo(out);
             if (out.getTransportVersion().onOrAfter(TransportVersions.SYNONYMS_UPDATE_TIMEOUT)) {
-                out.writeInt(timeout);
+                out.writeTimeValue(timeout);
             }
         }
 
@@ -123,7 +119,7 @@ public SynonymRule synonymRule() {
             return synonymRule;
         }
 
-        public int timeout() {
+        public TimeValue timeout() {
             return timeout;
         }
 
diff --git a/server/src/main/java/org/elasticsearch/action/synonyms/PutSynonymsAction.java b/server/src/main/java/org/elasticsearch/action/synonyms/PutSynonymsAction.java
@@ -19,6 +19,7 @@
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.xcontent.XContentHelper;
+import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.synonyms.SynonymRule;
 import org.elasticsearch.synonyms.SynonymsManagementAPIService;
 import org.elasticsearch.xcontent.ConstructingObjectParser;
@@ -46,7 +47,7 @@ public PutSynonymsAction() {
     public static class Request extends ActionRequest {
         private final String synonymsSetId;
         private final SynonymRule[] synonymRules;
-        private final int timeout;
+        private final TimeValue timeout;
 
         public static final ParseField SYNONYMS_SET_FIELD = new ParseField(SynonymsManagementAPIService.SYNONYMS_SET_FIELD);
         private static final ConstructingObjectParser<SynonymRule[], Void> PARSER = new ConstructingObjectParser<>("synonyms_set", args -> {
@@ -64,13 +65,15 @@ public Request(StreamInput in) throws IOException {
             this.synonymsSetId = in.readString();
             this.synonymRules = in.readArray(SynonymRule::new, SynonymRule[]::new);
             if (in.getTransportVersion().onOrAfter(TransportVersions.SYNONYMS_UPDATE_TIMEOUT)) {
-                this.timeout = in.readInt();
+                this.timeout = in.readTimeValue();
             } else {
                 this.timeout = DEFAULT_TIMEOUT;
             }
         }
 
-        public Request(String synonymsSetId, int timeout, BytesReference content, XContentType contentType) throws IOException {
+        public Request(String synonymsSetId, TimeValue timeout, BytesReference content, XContentType contentType) throws IOException {
+            Objects.requireNonNull(timeout);
+            Objects.requireNonNull(synonymsSetId);
             this.synonymsSetId = synonymsSetId;
             this.timeout = timeout;
             try (XContentParser parser = XContentHelper.createParser(XContentParserConfiguration.EMPTY, content, contentType)) {
@@ -80,7 +83,10 @@ public Request(String synonymsSetId, int timeout, BytesReference content, XConte
             }
         }
 
-        Request(String synonymsSetId, SynonymRule[] synonymRules, int timeout) {
+        Request(String synonymsSetId, SynonymRule[] synonymRules, TimeValue timeout) {
+            Objects.requireNonNull(timeout);
+            Objects.requireNonNull(synonymsSetId);
+            Objects.requireNonNull(synonymRules);
             this.synonymsSetId = synonymsSetId;
             this.synonymRules = synonymRules;
             this.timeout = timeout;
@@ -107,15 +113,15 @@ public void writeTo(StreamOutput out) throws IOException {
             out.writeString(synonymsSetId);
             out.writeArray(synonymRules);
             if (out.getTransportVersion().onOrAfter(TransportVersions.SYNONYMS_UPDATE_TIMEOUT)) {
-                out.writeInt(timeout);
+                out.writeTimeValue(timeout);
             }
         }
 
         public String synonymsSetId() {
             return synonymsSetId;
         }
 
-        public int timeout() {
+        public TimeValue timeout() {
             return timeout;
         }
 
diff --git a/server/src/main/java/org/elasticsearch/rest/action/synonyms/RestPutSynonymRuleAction.java b/server/src/main/java/org/elasticsearch/rest/action/synonyms/RestPutSynonymRuleAction.java
@@ -14,6 +14,7 @@
 import org.elasticsearch.client.internal.node.NodeClient;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
+import org.elasticsearch.rest.RestUtils;
 import org.elasticsearch.rest.Scope;
 import org.elasticsearch.rest.ServerlessScope;
 import org.elasticsearch.rest.action.RestToXContentListener;
@@ -41,7 +42,7 @@ protected RestChannelConsumer prepareRequest(RestRequest restRequest, NodeClient
         PutSynonymRuleAction.Request request = new PutSynonymRuleAction.Request(
             restRequest.param("synonymsSet"),
             restRequest.param("synonymRuleId"),
-            restRequest.paramAsInt("timeout", PutSynonymRuleAction.DEFAULT_TIMEOUT),
+            RestUtils.getAckTimeout(restRequest),
             restRequest.content(),
             restRequest.getXContentType()
         );
diff --git a/server/src/main/java/org/elasticsearch/rest/action/synonyms/RestPutSynonymsAction.java b/server/src/main/java/org/elasticsearch/rest/action/synonyms/RestPutSynonymsAction.java
@@ -14,6 +14,7 @@
 import org.elasticsearch.client.internal.node.NodeClient;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
+import org.elasticsearch.rest.RestUtils;
 import org.elasticsearch.rest.Scope;
 import org.elasticsearch.rest.ServerlessScope;
 import org.elasticsearch.rest.action.RestToXContentListener;
@@ -41,7 +42,7 @@ public List<Route> routes() {
     protected RestChannelConsumer prepareRequest(RestRequest restRequest, NodeClient client) throws IOException {
         PutSynonymsAction.Request request = new PutSynonymsAction.Request(
             restRequest.param("synonymsSet"),
-            restRequest.paramAsInt("timeout", DEFAULT_TIMEOUT),
+            RestUtils.getAckTimeout(restRequest),
             restRequest.content(),
             restRequest.getXContentType()
         );
diff --git a/server/src/main/java/org/elasticsearch/synonyms/SynonymsManagementAPIService.java b/server/src/main/java/org/elasticsearch/synonyms/SynonymsManagementAPIService.java
@@ -306,7 +306,7 @@ private static void logUniqueFailureMessagesWithIndices(List<BulkItemResponse.Fa
         });
     }
 
-    public void putSynonymsSet(String synonymSetId, SynonymRule[] synonymsSet, int timeout, ActionListener<SynonymsReloadResult> listener) {
+    public void putSynonymsSet(String synonymSetId, SynonymRule[] synonymsSet, TimeValue timeout, ActionListener<SynonymsReloadResult> listener) {
         if (synonymsSet.length > maxSynonymsSets) {
             listener.onFailure(
                 new IllegalArgumentException("The number of synonyms rules in a synonym set cannot exceed " + maxSynonymsSets)
@@ -377,7 +377,7 @@ void bulkUpdateSynonymsSet(String synonymSetId, SynonymRule[] synonymsSet, Actio
         bulkRequestBuilder.setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE).execute(listener);
     }
 
-    public void putSynonymRule(String synonymsSetId, SynonymRule synonymRule, int timeout, ActionListener<SynonymsReloadResult> listener) {
+    public void putSynonymRule(String synonymsSetId, SynonymRule synonymRule, TimeValue timeout, ActionListener<SynonymsReloadResult> listener) {
         checkSynonymSetExists(synonymsSetId, listener.delegateFailureAndWrap((l1, obj) -> {
             // Count synonym rules to check if we're at maximum
             BoolQueryBuilder queryFilter = QueryBuilders.boolQuery()
@@ -399,13 +399,13 @@ public void putSynonymRule(String synonymsSetId, SynonymRule synonymRule, int ti
                             new IllegalArgumentException("The number of synonym rules in a synonyms set cannot exceed " + maxSynonymsSets)
                         );
                     } else {
-                        indexSynonymRule(synonymsSetId, synonymRule, searchListener, timeout);
+                        indexSynonymRule(synonymsSetId, synonymRule, timeout, searchListener);
                     }
                 }));
         }));
     }
 
-    private void indexSynonymRule(String synonymsSetId, SynonymRule synonymRule, ActionListener<SynonymsReloadResult> listener, int timeout)
+    private void indexSynonymRule(String synonymsSetId, SynonymRule synonymRule, TimeValue timeout, ActionListener<SynonymsReloadResult> listener)
         throws IOException {
         IndexRequest indexRequest = createSynonymRuleIndexRequest(synonymsSetId, synonymRule).setRefreshPolicy(
             WriteRequest.RefreshPolicy.IMMEDIATE
@@ -557,10 +557,10 @@ private <T> void ensureSynonymsSearchableAndReloadAnalyzers(
         boolean preview,
         ActionListener<SynonymsReloadResult> listener,
         UpdateSynonymsResultStatus synonymsOperationResult,
-        int timeout
+        TimeValue timeout
     ) {
         // Ensure synonyms index is searchable if timeout is present
-        if (timeout > 0) {
+        if (TimeValue.MINUS_ONE.equals(timeout) == false) {
             checkSynonymsIndexHealth(timeout, listener.delegateFailure((l, response) -> {
                 if (response.isTimedOut()) {
                     l.onFailure(new IndexCreationException("synonyms index [" + SYNONYMS_ALIAS_NAME + "] is not searchable. "
@@ -576,8 +576,8 @@ private <T> void ensureSynonymsSearchableAndReloadAnalyzers(
     }
 
     // Allows checking failures in tests
-    void checkSynonymsIndexHealth(int timeout, ActionListener<ClusterHealthResponse> listener) {
-        ClusterHealthRequest healthRequest = new ClusterHealthRequest(TimeValue.timeValueSeconds(timeout), SYNONYMS_ALIAS_NAME)
+    void checkSynonymsIndexHealth(TimeValue timeout, ActionListener<ClusterHealthResponse> listener) {
+        ClusterHealthRequest healthRequest = new ClusterHealthRequest(timeout, SYNONYMS_ALIAS_NAME)
             .waitForGreenStatus();
 
         client.execute(TransportClusterHealthAction.TYPE, healthRequest, listener);
diff --git a/server/src/test/java/org/elasticsearch/action/synonyms/PutSynonymRuleActionRequestSerializingTests.java b/server/src/test/java/org/elasticsearch/action/synonyms/PutSynonymRuleActionRequestSerializingTests.java
@@ -22,7 +22,7 @@ protected Writeable.Reader<PutSynonymRuleAction.Request> instanceReader() {
 
     @Override
     protected PutSynonymRuleAction.Request createTestInstance() {
-        return new PutSynonymRuleAction.Request(randomIdentifier(), SynonymsTestUtils.randomSynonymRule(), randomNonNegativeInt());
+        return new PutSynonymRuleAction.Request(randomIdentifier(), SynonymsTestUtils.randomSynonymRule(), randomTimeValue());
     }
 
     @Override
diff --git a/server/src/test/java/org/elasticsearch/action/synonyms/PutSynonymsActionRequestSerializingTests.java b/server/src/test/java/org/elasticsearch/action/synonyms/PutSynonymsActionRequestSerializingTests.java
@@ -25,7 +25,7 @@ protected Writeable.Reader<PutSynonymsAction.Request> instanceReader() {
 
     @Override
     protected PutSynonymsAction.Request createTestInstance() {
-        return new PutSynonymsAction.Request(randomIdentifier(), randomSynonymsSet(), randomNonNegativeInt());
+        return new PutSynonymsAction.Request(randomIdentifier(), randomSynonymsSet(), randomTimeValue());
     }
 
     @Override

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ protected Writeable.Reader<PutSynonymRuleAction.Request> instanceReader() {`
`22`	`22`
`23`	`23`	`@Override`
`24`	`24`	`protected PutSynonymRuleAction.Request createTestInstance() {`
`25`		`- return new PutSynonymRuleAction.Request(randomIdentifier(), SynonymsTestUtils.randomSynonymRule(), randomNonNegativeInt());`
	`25`	`+ return new PutSynonymRuleAction.Request(randomIdentifier(), SynonymsTestUtils.randomSynonymRule(), randomTimeValue());`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ protected Writeable.Reader<PutSynonymsAction.Request> instanceReader() {`
`25`	`25`
`26`	`26`	`@Override`
`27`	`27`	`protected PutSynonymsAction.Request createTestInstance() {`
`28`		`- return new PutSynonymsAction.Request(randomIdentifier(), randomSynonymsSet(), randomNonNegativeInt());`
	`28`	`+ return new PutSynonymsAction.Request(randomIdentifier(), randomSynonymsSet(), randomTimeValue());`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`@Override`