You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by ke...@apache.org on 2024/04/19 22:44:46 UTC
(tinkerpop) 02/02: Renamed "evaluationTimeout" to "timeoutMs" in RequestMessageV4.
This is an automated email from the ASF dual-hosted git repository.
kenhuuu pushed a commit to branch master-http
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit b15809b8755c074af7401783eae1d7546845e716
Author: Ken Hu <10...@users.noreply.github.com>
AuthorDate: Fri Apr 19 15:38:43 2024 -0700
Renamed "evaluationTimeout" to "timeoutMs" in RequestMessageV4.
This only affects the request message. The server still recognizes the
timeout setting as being evaluationTimeout. Only the per request name
has been updated.
---
.../src/main/java/org/apache/tinkerpop/gremlin/server/Context.java | 4 ++--
.../tinkerpop/gremlin/server/handler/HttpGremlinEndpointHandler.java | 2 +-
.../tinkerpop/gremlin/server/handler/HttpRequestMessageDecoder.java | 2 +-
.../tinkerpop/gremlin/server/GremlinServerHttpIntegrateTest.java | 4 ++--
.../gremlin/server/handler/HttpRequestMessageDecoderTest.java | 5 ++++-
.../src/main/java/org/apache/tinkerpop/gremlin/util/Tokens.java | 5 +++++
.../org/apache/tinkerpop/gremlin/util/message/RequestMessageV4.java | 2 +-
.../apache/tinkerpop/gremlin/util/message/RequestMessageV4Test.java | 2 +-
8 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Context.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Context.java
index 88bd88e690..ff9e2e4d56 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Context.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Context.java
@@ -127,7 +127,7 @@ public class Context {
/**
* The timeout for the request. If the request is a script it examines the script for a timeout setting using
* {@code with()}. If that is not found then it examines the request itself to see if the timeout is provided by
- * {@link Tokens#ARGS_EVAL_TIMEOUT}. If that is not provided then the {@link Settings#evaluationTimeout} is
+ * {@link Tokens#TIMEOUT_MS}. If that is not provided then the {@link Settings#evaluationTimeout} is
* utilized as the default.
*/
public long getRequestTimeout() {
@@ -200,7 +200,7 @@ public class Context {
private long determineTimeout() {
// timeout override - handle both deprecated and newly named configuration. earlier logic should prevent
// both configurations from being submitted at the same time
- final Long timeoutMs = requestMessage.getField(Tokens.ARGS_EVAL_TIMEOUT);
+ final Long timeoutMs = requestMessage.getField(Tokens.TIMEOUT_MS);
final long seto = (null != timeoutMs) ? timeoutMs : settings.getEvaluationTimeout();
// override the timeout if the lifecycle has a value assigned. if the script contains with(timeout)
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpGremlinEndpointHandler.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpGremlinEndpointHandler.java
index 906792f414..e85efcdb0e 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpGremlinEndpointHandler.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpGremlinEndpointHandler.java
@@ -180,7 +180,7 @@ public class HttpGremlinEndpointHandler extends SimpleChannelInboundHandler<Requ
final Timer.Context timerContext = evalOpTimer.time();
// timeout override - handle both deprecated and newly named configuration. earlier logic should prevent
// both configurations from being submitted at the same time
- Long timeoutMs = requestMessage.getField(Tokens.ARGS_EVAL_TIMEOUT);
+ Long timeoutMs = requestMessage.getField(Tokens.TIMEOUT_MS);
final long seto = (null != timeoutMs) ? timeoutMs : requestCtx.getSettings().getEvaluationTimeout();
final FutureTask<Void> evalFuture = new FutureTask<>(() -> {
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoder.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoder.java
index 1b261c3152..d1c9b1ad94 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoder.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoder.java
@@ -224,7 +224,7 @@ public class HttpRequestMessageDecoder extends MessageToMessageDecoder<FullHttpR
final JsonNode chunkSizeNode = body.get(Tokens.ARGS_BATCH_SIZE);
if (null != chunkSizeNode) builder.addChunkSize(chunkSizeNode.asInt());
- final JsonNode timeoutMsNode = body.get(Tokens.ARGS_EVAL_TIMEOUT);
+ final JsonNode timeoutMsNode = body.get(Tokens.TIMEOUT_MS);
if (null != timeoutMsNode) builder.addTimeoutMillis(timeoutMsNode.asLong());
final JsonNode matPropsNode = body.get(Tokens.ARGS_MATERIALIZE_PROPERTIES);
diff --git a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerHttpIntegrateTest.java b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerHttpIntegrateTest.java
index 96b09abc22..8e2909f9b7 100644
--- a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerHttpIntegrateTest.java
+++ b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerHttpIntegrateTest.java
@@ -78,10 +78,10 @@ import java.util.concurrent.TimeUnit;
import static org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource.traversal;
import static org.apache.tinkerpop.gremlin.server.handler.HttpRequestIdHandler.REQUEST_ID_HEADER_NAME;
-import static org.apache.tinkerpop.gremlin.util.Tokens.ARGS_EVAL_TIMEOUT;
import static org.apache.tinkerpop.gremlin.util.Tokens.ARGS_MATERIALIZE_PROPERTIES;
import static org.apache.tinkerpop.gremlin.util.Tokens.MATERIALIZE_PROPERTIES_ALL;
import static org.apache.tinkerpop.gremlin.util.Tokens.MATERIALIZE_PROPERTIES_TOKENS;
+import static org.apache.tinkerpop.gremlin.util.Tokens.TIMEOUT_MS;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.hamcrest.core.IsInstanceOf.instanceOf;
@@ -1432,7 +1432,7 @@ public class GremlinServerHttpIntegrateTest extends AbstractGremlinServerIntegra
@Test
public void shouldAcceptTimeoutInRequestBody() throws Exception {
- final String body = "{ \"gremlin\": \"" + "Thread.sleep(5000)" + "\",\"language\":\"gremlin-groovy\",\"" + ARGS_EVAL_TIMEOUT + "\":\"100\"}";
+ final String body = "{ \"gremlin\": \"" + "Thread.sleep(5000)" + "\",\"language\":\"gremlin-groovy\",\"" + TIMEOUT_MS + "\":\"100\"}";
final CloseableHttpClient httpclient = HttpClients.createDefault();
final HttpPost httppost = new HttpPost(TestClientFactory.createURLString());
httppost.addHeader("Content-Type", "application/json");
diff --git a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoderTest.java b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoderTest.java
index 5b23fa634e..7a3e7cc7c6 100644
--- a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoderTest.java
+++ b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/handler/HttpRequestMessageDecoderTest.java
@@ -350,7 +350,8 @@ public class HttpRequestMessageDecoderTest {
final UUID rid = UUID.randomUUID();
final ByteBuf buffer = allocator.buffer();
buffer.writeCharSequence("{\"gremlin\":\"g.V().limit(2)\",\"batchSize\":\"10\",\"language\":\"gremlin-lang\"," +
- "\"g\":\"gmodern\",\"bindings\":{\"x\":\"1\"},\"requestId\":\"" + rid + "\"}", CharsetUtil.UTF_8);
+ "\"g\":\"gmodern\",\"bindings\":{\"x\":\"1\"},\"timeoutMs\":\"12\"," +
+ "\"materializeProperties\":\"" + Tokens.MATERIALIZE_PROPERTIES_TOKENS + "\"}", CharsetUtil.UTF_8);
final HttpHeaders headers = new DefaultHttpHeaders();
headers.add(HttpHeaderNames.CONTENT_TYPE, SerTokens.MIME_JSON);
@@ -368,5 +369,7 @@ public class HttpRequestMessageDecoderTest {
assertEquals("gmodern", decodedRequest.getField(Tokens.ARGS_G));
assertEquals("1", ((Map) decodedRequest.getField(Tokens.ARGS_BINDINGS)).get("x"));
assertEquals(1, ((Map) decodedRequest.getField(Tokens.ARGS_BINDINGS)).size());
+ assertEquals(12, (long) decodedRequest.getField(Tokens.TIMEOUT_MS));
+ assertEquals(Tokens.MATERIALIZE_PROPERTIES_TOKENS, decodedRequest.getField(Tokens.ARGS_MATERIALIZE_PROPERTIES));
}
}
diff --git a/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/Tokens.java b/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/Tokens.java
index e1a122e143..848a946b9d 100644
--- a/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/Tokens.java
+++ b/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/Tokens.java
@@ -42,6 +42,11 @@ public final class Tokens {
*/
public static final String REQUEST_ID = "requestId";
+ /**
+ * The key for the per request server-side timeout in milliseconds.
+ */
+ public static final String TIMEOUT_MS = "timeoutMs";
+
/**
* Argument name that allows definition of the number of iterations each {@link ResponseMessage} should contain -
* overrides the @{code resultIterationBatchSize} server setting.
diff --git a/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4.java b/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4.java
index 101f32e22b..c5b255ce0a 100644
--- a/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4.java
+++ b/gremlin-util/src/main/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4.java
@@ -188,7 +188,7 @@ public final class RequestMessageV4 {
Objects.requireNonNull(timeout, "timeout argument cannot be null.");
if (timeout < 0) throw new IllegalArgumentException("timeout argument cannot be negative.");
- this.fields.put(Tokens.ARGS_EVAL_TIMEOUT, timeout);
+ this.fields.put(Tokens.TIMEOUT_MS, timeout);
return this;
}
diff --git a/gremlin-util/src/test/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4Test.java b/gremlin-util/src/test/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4Test.java
index 7e46afbc2f..2626c33b55 100644
--- a/gremlin-util/src/test/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4Test.java
+++ b/gremlin-util/src/test/java/org/apache/tinkerpop/gremlin/util/message/RequestMessageV4Test.java
@@ -87,7 +87,7 @@ public class RequestMessageV4Test {
public void shouldSetTimeout() {
final long timeout = 101L;
final RequestMessageV4 msg = RequestMessageV4.build("g").addTimeoutMillis(timeout).create();
- assertEquals(timeout, (long) msg.getField(Tokens.ARGS_EVAL_TIMEOUT));
+ assertEquals(timeout, (long) msg.getField(Tokens.TIMEOUT_MS));
}
@Test