[jira] [Commented] (TINKERPOP-2337) In upgrade guide for 3.4.2, the option RemoteConnection.PER_REQUEST_TIMEOUT does not exist

["Stephen Mallette (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/TINKERPOP-2337?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17036220#comment-17036220 ] 

Stephen Mallette commented on TINKERPOP-2337:
---------------------------------------------

That's odd. I wonder why that was written that way. I can't find any reference in time to when that token was on {{RemoteConnection}}. Usually, we consider upgrade documentation static and historical, but in this case it just seems wrong so I think a correction is in order. Since the upgrade notes are on 3.4.2, I think the correct token is actually: {{Tokens.ARGS_SCRIPT_EVAL_TIMEOUT}}. It appears to only have been deprecated at 3.3.9 (and thus 3.4.4):

https://github.com/apache/tinkerpop/blob/3.4.4/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Tokens.java#L62

and replaced with {{Tokens.ARGS_EVAL_TIMEOUT}} at that point. So, I'd say we want two fixes here:

1. 3.4.2 upgrade docs should specify {{Tokens.ARGS_SCRIPT_EVAL_TIMEOUT}}
2. As you suggested the main reference documentation should make some mention of the {{with(Tokens, value)}} syntax. I would say that it should probably just go at the end of the "Connecting" section: http://tinkerpop.apache.org/docs/current/reference/#_connecting

[~trangosi] did you intend to submit a pull request for these changes? if so, I think we can forego changes to 3.3.-dev and the PR can simply target the 3.4-dev branch.

> In upgrade guide for 3.4.2, the option RemoteConnection.PER_REQUEST_TIMEOUT does not exist
> ------------------------------------------------------------------------------------------
>
>                 Key: TINKERPOP-2337
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP-2337
>             Project: TinkerPop
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 3.4.2, 3.4.3, 3.4.4, 3.4.5
>            Reporter: Nicolas Trangosi
>            Priority: Minor
>
> in  the file {{docs/src/upgrade/release-3.4.x.asciidoc}} the sentence
>  {{ List<Vertex> vertices = g.with(RemoteConnection.PER_REQUEST_TIMEOUT, 500).V().out("knows").toList()}} 
>  should be replaced by
>  {{ List<Vertex> vertices = g.with(Tokens.ARGS_EVAL_TIMEOUT, 500L).V().out("knows").toList()}}
>  Note: a Long should be used as argument instead of an integer else the following exception is thrown:
> {noformat}
> java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.Long
>         at org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection.getRequestOptions(DriverRemoteConnection.java:238)
>         at org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection.submitAsync(DriverRemoteConnection.java:225)
>         at org.apache.tinkerpop.gremlin.process.remote.traversal.step.map.RemoteStep.promise(RemoteStep.java:89)
>         at org.apache.tinkerpop.gremlin.process.remote.traversal.step.map.RemoteStep.processNextStart(RemoteStep.java:65)
>         at org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep.next(AbstractStep.java:128)
>         at org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep.next(AbstractStep.java:38)
>         at org.apache.tinkerpop.gremlin.process.traversal.Traversal.fill(Traversal.java:180)
>         at org.apache.tinkerpop.gremlin.process.traversal.Traversal.toList(Traversal.java:118)
> {noformat}
> This option is only documented in upgrade guide, it could be useful to document all options in main documentation.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)