kenhuuu commented on code in PR #3508: URL: https://github.com/apache/tinkerpop/pull/3508#discussion_r3546542844
########## docs/src/upgrade/release-4.x.x.asciidoc: ########## @@ -106,6 +106,29 @@ These change runtime behavior on upgrade even if you do not change your configur See: link:https://lists.apache.org/thread/yqtr2wnb1kq2pqqq4002cz511q5o0bkg[[DISCUSS] Standardizing GLV connection options in TinkerPop 4]. +==== Renaming `evaluationTimeout` to `timeoutMs` + +The per-request execution timeout is now referred to by a single name, `timeoutMs`, everywhere. `timeoutMs` is the +maximum time in milliseconds that a request is allowed to execute on the server before it times out; it can be +configured server-wide and overridden on a per-request basis. Previously the same concept was called +`evaluationTimeout` in the server configuration, the `with()` script token, and several driver APIs, while the wire +protocol already used `timeoutMs` — collapsing to one name removes that inconsistency. + +This is a breaking change with no backward-compatible alias. The old `evaluationTimeout` name (and the long-deprecated +`scriptEvaluationTimeout`) are no longer recognized anywhere. Update each surface as follows: + +- *Server config*: the `gremlin-server.yaml` key `evaluationTimeout` becomes `timeoutMs` (default still 30000). +- *Script token*: `g.with('evaluationTimeout', 500)` becomes `g.with('timeoutMs', 500)`. +- *Java driver*: `RequestOptions.Builder.timeout(long)` becomes `timeoutMs(long)` and `getTimeout()` becomes `getTimeoutMs()`. +- *Go driver*: `RequestOptionsBuilder.SetEvaluationTimeout(int)` becomes `SetTimeoutMs(int)`. +- *.NET driver*: `Tokens.ArgsEvalTimeout` becomes `Tokens.ArgsTimeoutMs` and `RequestMessage.Builder.AddEvaluationTimeout(...)` + becomes `AddTimeoutMs(...)`. +- *JavaScript driver*: the request option `{ evaluationTimeout: N }` becomes `{ timeoutMs: N }`. +- *Python driver*: use the token `timeoutMs` (e.g. `g.with_('timeoutMs', 500)` or `request_options={'timeoutMs': 500}`). + +Driver and server should be upgraded together. A driver sending the old `evaluationTimeout` field to a 4.x server has +that field silently ignored and falls back to the server's default timeout, as with any unrecognized request argument. + Review Comment: I didn't have a Jira for this, though I could make one. The devlist is the original TinkerPop 4.x API that talked about naming this field timeoutMs. Would it be better to create a jira or just link that devlist post? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
