You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/11/04 19:13:35 UTC
[5/6] incubator-tinkerpop git commit: TINKERPOP3-913 Deprecated
rebindings argument in favor of aliases.
TINKERPOP3-913 Deprecated rebindings argument in favor of aliases.
Should not be a breaking change as everything was done through deprecation.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/bdf05534
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/bdf05534
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/bdf05534
Branch: refs/heads/TINKERPOP3-913
Commit: bdf0553420ef830f72e43b42b9c471e62a92dcf1
Parents: ebec095
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Nov 4 12:42:09 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Nov 4 13:10:03 2015 -0500
----------------------------------------------------------------------
CHANGELOG.asciidoc | 1 +
docs/src/gremlin-applications.asciidoc | 18 ++---
.../upgrade-release-3.1.x-incubating.asciidoc | 14 +++-
.../apache/tinkerpop/gremlin/driver/Client.java | 71 ++++++++++++++++++--
.../apache/tinkerpop/gremlin/driver/Tokens.java | 6 ++
.../handler/HttpGremlinEndpointHandler.java | 47 ++++++++++---
.../server/op/standard/StandardOpProcessor.java | 20 ++++--
.../server/GremlinDriverIntegrateTest.java | 29 +++++---
.../server/GremlinServerHttpIntegrateTest.java | 38 +++++++++--
.../server/GremlinServerIntegrateTest.java | 27 +++++++-
10 files changed, 224 insertions(+), 47 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/CHANGELOG.asciidoc
----------------------------------------------------------------------
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index 31671c0..b91ac0c 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -29,6 +29,7 @@ TinkerPop 3.1.0 (NOT OFFICIALLY RELEASED YET)
* `CountMatchAlgorithm`, in OLAP, now biases traversal selection towards those traversals that start at the current traverser location to reduce message passing.
* Fixed a file stream bug in Hadoop OLTP that showed up if the streamed file was more than 2G of data.
* Bumped to Neo4j 2.3.0.
+* Deprecated "rebindings" as an argument to Gremlin Server and replaced it with "aliases".
* Added `PersistedInputRDD` and `PersistedOutputRDD` which enables `SparkGraphComputer` to store the graph RDD in the context between jobs (no HDFS serialization required).
* Renamed the `public static String` configuration variable names of TinkerGraph (deprecated old variables).
* Added `GraphComputer.configure(key,value)` to allow engine-specific configurations.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/docs/src/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/gremlin-applications.asciidoc b/docs/src/gremlin-applications.asciidoc
index 88684ab..8343d7a 100644
--- a/docs/src/gremlin-applications.asciidoc
+++ b/docs/src/gremlin-applications.asciidoc
@@ -491,8 +491,8 @@ In this case, they are streamed from the server as they arrive.
<5> Parameterized request are considered the most efficient way to send Gremlin to the server as they can be cached,
which will boost performance and reduce resources required on the server.
-Rebinding
-^^^^^^^^^
+Aliases
+^^^^^^^
Scripts submitted to Gremlin Server automatically have the globally configured `Graph` and `TraversalSource` instances
made available to them. Therefore, if Gremlin Server configures two `TraversalSource` instances called "g1" and "g2"
@@ -505,15 +505,15 @@ client.submit("g2.V()")
While this is an acceptable way to submit scripts, it has the downside of forcing the client to encode the server-side
variable name directly into the script being sent. If the server configuration ever changed such that "g1" became
"g100", the client-side code might have to see a significant amount of change. Decoupling the script code from the
-server configuration can be managed by the `rebind` method on `Client` as follows:
+server configuration can be managed by the `alias` method on `Client` as follows:
[source,java]
-Client g1Client = client.rebind("g1")
-Client g2Client = client.rebind("g2")
+Client g1Client = client.alias("g1")
+Client g2Client = client.alias("g2")
g1Client.submit("g.V()")
g2Client.submit("g.V()")
-The above code demonstrates how the `rebind` method can be used such that the script need only contain a reference
+The above code demonstrates how the `alias` method can be used such that the script need only contain a reference
to "g" and "g1" and "g2" are automatically rebound into "g" on the server-side.
Serialization
@@ -1303,11 +1303,11 @@ evaluated and is committed when the script completes (or rolled back if an error
|gremlin |String | *Required* The Gremlin script to evaluate
|bindings |Map |A map of key/value pairs to apply as variables in the context of the Gremlin script
|language |String |The flavor used (e.g. `gremlin-groovy`)
-|rebindings |Map |A map of key/value pairs that allow globally bound `Graph` and `TraversalSource` objects to
-be rebound to different variable names for purposes of the current request. The value represents the name the
+|aliases |Map |A map of key/value pairs that allow globally bound `Graph` and `TraversalSource` objects to
+be aliased to different variable names for purposes of the current request. The value represents the name the
global variable and its key represents the new binding name as it will be referenced in the Gremlin query. For
example, if the Gremlin Server defines two `TraversalSource` instances named `g1` and `g2`, it would be possible
-to send a `rebinding` pair with key of "g" and value of "g2" and thus allow the script to refer to "g2" simply as "g".
+to send an alias pair with key of "g" and value of "g2" and thus allow the script to refer to "g2" simply as "g".
|=========================================================
Session OpProcessor
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/docs/src/upgrade-release-3.1.x-incubating.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade-release-3.1.x-incubating.asciidoc b/docs/src/upgrade-release-3.1.x-incubating.asciidoc
index ada54f9..5632468 100644
--- a/docs/src/upgrade-release-3.1.x-incubating.asciidoc
+++ b/docs/src/upgrade-release-3.1.x-incubating.asciidoc
@@ -85,7 +85,6 @@ TinkerGraph-Gremlin Updates
* The `public static String` configurations have been renamed. The old `public static` variables have been deprecated.
-
Gremlin Process
^^^^^^^^^^^^^^^
@@ -181,3 +180,16 @@ GraphComputer Updates
This allows the user to specify engine-specific parameters to the underlying OLAP system. These parameters are not intended
to be cross engine supported. Moreover, if there are not parameters that can be altered (beyond the standard `GraphComputer`
methods), then the provider's `GraphComputer` implementation should simply return and do nothing.
+
+Driver Providers
+^^^^^^^^^^^^^^^^
+
+Aliases Parameter
++++++++++++++++++
+
+The "rebindings" argument to the "standard" `OpProcessor` has been renamed to "aliases". While "rebindings" is still
+supported it is recommended that the upgrade to "aliases" be made as soon as possible as support will be removed in
+the future. Gremlin Server will not accept both parameters at the same time - a request must contain either one
+parameter or the other if either is supplied.
+
+See link:https://issues.apache.org/jira/browse/TINKERPOP3-913[TINKERPOP3-913] for more information.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
index b54d6dc..a8fa127 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
@@ -84,13 +84,24 @@ public abstract class Client {
public abstract CompletableFuture<Void> closeAsync();
/**
- * Create a new {@code Client} that rebinds the specified {@link Graph} or {@link TraversalSource} name on the
+ * Create a new {@code Client} that aliases the specified {@link Graph} or {@link TraversalSource} name on the
* server to a variable called "g" for the context of the requests made through that {@code Client}.
*
* @param graphOrTraversalSource rebinds the specified global Gremlin Server variable to "g"
+ * @deprecated As of release 3.1.0, replaced by {@link #alias(String)}
*/
+ @Deprecated
public abstract Client rebind(final String graphOrTraversalSource);
+
+ /**
+ * Create a new {@code Client} that aliases the specified {@link Graph} or {@link TraversalSource} name on the
+ * server to a variable called "g" for the context of the requests made through that {@code Client}.
+ *
+ * @param graphOrTraversalSource rebinds the specified global Gremlin Server variable to "g"
+ */
+ public abstract Client alias(final String graphOrTraversalSource);
+
/**
* Initializes the client which typically means that a connection is established to the server. Depending on the
* implementation and configuration this blocking call may take some time. This method will be called
@@ -256,7 +267,7 @@ public abstract class Client {
Optional.ofNullable(parameters).ifPresent(params -> request.addArg(Tokens.ARGS_BINDINGS, parameters));
if (graphOrTraversalSource != null && !graphOrTraversalSource.isEmpty())
- request.addArg(Tokens.ARGS_REBINDINGS, makeRebindings(graphOrTraversalSource));
+ request.addArg(Tokens.ARGS_ALIASES, makeRebindings(graphOrTraversalSource));
return submitAsync(buildMessage(request));
}
@@ -265,17 +276,36 @@ public abstract class Client {
* {@inheritDoc}
*/
@Override
+ @Deprecated
public Client rebind(final String graphOrTraversalSource) {
+ return alias(graphOrTraversalSource);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Client alias(String graphOrTraversalSource) {
return new ReboundClusteredClient(this, graphOrTraversalSource);
}
/**
- * Creates a {@code Client} that supplies the specified set of rebindings, thus allowing the user to re-name
+ * Creates a {@code Client} that supplies the specified set of aliases, thus allowing the user to re-name
* one or more globally defined {@link Graph} or {@link TraversalSource} server bindings for the context of
* the created {@code Client}.
*/
+ @Deprecated
public Client rebind(final Map<String,String> rebindings) {
- return new ReboundClusteredClient(this, rebindings);
+ return alias(rebindings);
+ }
+
+ /**
+ * Creates a {@code Client} that supplies the specified set of aliases, thus allowing the user to re-name
+ * one or more globally defined {@link Graph} or {@link TraversalSource} server bindings for the context of
+ * the created {@code Client}.
+ */
+ public Client alias(final Map<String,String> aliases) {
+ return new ReboundClusteredClient(this, aliases);
}
/**
@@ -363,7 +393,7 @@ public abstract class Client {
public RequestMessage buildMessage(final RequestMessage.Builder builder) {
if (close.isDone()) throw new IllegalStateException("Client is closed");
if (!rebindings.isEmpty())
- builder.addArg(Tokens.ARGS_REBINDINGS, rebindings);
+ builder.addArg(Tokens.ARGS_ALIASES, rebindings);
return builder.create();
}
@@ -393,8 +423,20 @@ public abstract class Client {
return close;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
+ @Deprecated
public Client rebind(final String graphOrTraversalSource) {
+ return alias(graphOrTraversalSource);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Client alias(String graphOrTraversalSource) {
if (close.isDone()) throw new IllegalStateException("Client is closed");
return new ReboundClusteredClient(clusteredClient, graphOrTraversalSource);
}
@@ -419,9 +461,26 @@ public abstract class Client {
return sessionId;
}
+ /**
+ * The sessioned client does not support this feature.
+ *
+ * @throws UnsupportedOperationException
+ * @deprecated As of release 3.1.0, replaced by {@link #alias(String)}
+ */
+ @Deprecated
@Override
public Client rebind(final String graphOrTraversalSourceName){
- throw new UnsupportedOperationException("Sessioned client do no support rebinding");
+ throw new UnsupportedOperationException("Sessioned client do no support aliasing");
+ }
+
+ /**
+ * The sessioned client does not support this feature.
+ *
+ * @throws UnsupportedOperationException
+ */
+ @Override
+ public Client alias(String graphOrTraversalSource) {
+ throw new UnsupportedOperationException("Sessioned client do no support aliasing");
}
/**
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Tokens.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Tokens.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Tokens.java
index 447f42d..64d2fe1 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Tokens.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Tokens.java
@@ -41,11 +41,17 @@ public final class Tokens {
public static final String ARGS_BATCH_SIZE = "batchSize";
public static final String ARGS_BINDINGS = "bindings";
+ public static final String ARGS_ALIASES = "aliases";
public static final String ARGS_COORDINATES = "coordinates";
public static final String ARGS_GREMLIN = "gremlin";
public static final String ARGS_IMPORTS = "imports";
public static final String ARGS_INFO_TYPE = "infoType";
public static final String ARGS_LANGUAGE = "language";
+
+ /**
+ * @deprecated As of release 3.1.0, replaced by {@link #ARGS_ALIASES}.
+ */
+ @Deprecated
public static final String ARGS_REBINDINGS = "rebindings";
public static final String ARGS_SESSION = "session";
public static final String ARGS_SASL = "sasl";
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/HttpGremlinEndpointHandler.java
----------------------------------------------------------------------
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 2852dc9..51fcc26 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
@@ -97,7 +97,13 @@ public class HttpGremlinEndpointHandler extends ChannelInboundHandlerAdapter {
static final Meter errorMeter = MetricManager.INSTANCE.getMeter(name(GremlinServer.class, "errors"));
private static final String ARGS_BINDINGS_DOT = Tokens.ARGS_BINDINGS + ".";
+
+ /**
+ * @deprecated As of release 3.1.0, replaced by {@link #ARGS_ALIASES_DOT}.
+ */
+ @Deprecated
private static final String ARGS_REBINDINGS_DOT = Tokens.ARGS_REBINDINGS + ".";
+ private static final String ARGS_ALIASES_DOT = Tokens.ARGS_ALIASES + ".";
private static final Timer evalOpTimer = MetricManager.INSTANCE.getTimer(name(GremlinServer.class, "op", "eval"));
@@ -317,6 +323,7 @@ public class HttpGremlinEndpointHandler extends ChannelInboundHandlerAdapter {
if (request.getMethod() == GET) {
final QueryStringDecoder decoder = new QueryStringDecoder(request.getUri());
final List<String> gremlinParms = decoder.parameters().get(Tokens.ARGS_GREMLIN);
+
if (null == gremlinParms || gremlinParms.size() == 0)
throw new IllegalArgumentException("no gremlin script supplied");
final String script = gremlinParms.get(0);
@@ -327,14 +334,23 @@ public class HttpGremlinEndpointHandler extends ChannelInboundHandlerAdapter {
decoder.parameters().entrySet().stream().filter(kv -> kv.getKey().startsWith(ARGS_BINDINGS_DOT))
.forEach(kv -> bindings.put(kv.getKey().substring(ARGS_BINDINGS_DOT.length()), kv.getValue().get(0)));
- final Map<String, String> rebindings = new HashMap<>();
- decoder.parameters().entrySet().stream().filter(kv -> kv.getKey().startsWith(ARGS_REBINDINGS_DOT))
- .forEach(kv -> rebindings.put(kv.getKey().substring(ARGS_REBINDINGS_DOT.length()), kv.getValue().get(0)));
+ // don't allow both rebindings and aliases parameters as they are the same thing. aliases were introduced
+ // as of 3.1.0 as a replacement for rebindings. this check can be removed when rebindings are completely
+ // removed from the protocol
+ final boolean hasRebindings = decoder.parameters().entrySet().stream().anyMatch(kv -> kv.getKey().startsWith(ARGS_REBINDINGS_DOT));
+ final boolean hasAliases = decoder.parameters().entrySet().stream().anyMatch(kv -> kv.getKey().startsWith(ARGS_ALIASES_DOT));
+ if (hasRebindings && hasAliases)
+ throw new IllegalArgumentException("prefer use of the 'aliases' parameter over 'rebindings' and do not use both");
+
+ final Map<String, String> aliases = new HashMap<>();
+ final String rebindingOrAliasParameter = hasRebindings ? ARGS_REBINDINGS_DOT : ARGS_ALIASES_DOT;
+ decoder.parameters().entrySet().stream().filter(kv -> kv.getKey().startsWith(rebindingOrAliasParameter))
+ .forEach(kv -> aliases.put(kv.getKey().substring(rebindingOrAliasParameter.length()), kv.getValue().get(0)));
final List<String> languageParms = decoder.parameters().get(Tokens.ARGS_LANGUAGE);
final String language = (null == languageParms || languageParms.size() == 0) ? null : languageParms.get(0);
- return Quartet.with(script, bindings, language, rebindings);
+ return Quartet.with(script, bindings, language, aliases);
} else {
final JsonNode body;
try {
@@ -354,18 +370,27 @@ public class HttpGremlinEndpointHandler extends ChannelInboundHandlerAdapter {
if (bindingsNode != null)
bindingsNode.fields().forEachRemaining(kv -> bindings.put(kv.getKey(), fromJsonNode(kv.getValue())));
- final JsonNode rebindingsNode = body.get(Tokens.ARGS_REBINDINGS);
- if (rebindingsNode != null && !rebindingsNode.isObject())
- throw new IllegalArgumentException("rebindings must be a Map");
+ // don't allow both rebindings and aliases parameters as they are the same thing. aliases were introduced
+ // as of 3.1.0 as a replacement for rebindings. this check can be removed when rebindings are completely
+ // removed from the protocol
+ final boolean hasRebindings = body.has(Tokens.ARGS_REBINDINGS);
+ final boolean hasAliases = body.has(Tokens.ARGS_ALIASES);
+ if (hasRebindings && hasAliases)
+ throw new IllegalArgumentException("prefer use of the 'aliases' parameter over 'rebindings' and do not use both");
+
+ final String rebindingOrAliasParameter = hasRebindings ? Tokens.ARGS_REBINDINGS : Tokens.ARGS_ALIASES;
+ final JsonNode aliasesNode = body.get(rebindingOrAliasParameter);
+ if (aliasesNode != null && !aliasesNode.isObject())
+ throw new IllegalArgumentException("aliases must be a Map");
- final Map<String, String> rebindings = new HashMap<>();
- if (rebindingsNode != null)
- rebindingsNode.fields().forEachRemaining(kv -> rebindings.put(kv.getKey(), kv.getValue().asText()));
+ final Map<String, String> aliases = new HashMap<>();
+ if (aliasesNode != null)
+ aliasesNode.fields().forEachRemaining(kv -> aliases.put(kv.getKey(), kv.getValue().asText()));
final JsonNode languageNode = body.get(Tokens.ARGS_LANGUAGE);
final String language = null == languageNode ? null : languageNode.asText();
- return Quartet.with(scriptNode.asText(), bindings, language, rebindings);
+ return Quartet.with(scriptNode.asText(), bindings, language, aliases);
}
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/standard/StandardOpProcessor.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/standard/StandardOpProcessor.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/standard/StandardOpProcessor.java
index 017594f..c54cbad 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/standard/StandardOpProcessor.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/standard/StandardOpProcessor.java
@@ -80,9 +80,21 @@ public class StandardOpProcessor extends AbstractEvalOpProcessor {
super.evalOpInternal(context, context::getGremlinExecutor, () -> {
final Bindings bindings = new SimpleBindings();
- // rebind any global bindings to a different variable.
- if (msg.getArgs().containsKey(Tokens.ARGS_REBINDINGS)) {
- final Map<String, String> rebinds = (Map<String, String>) msg.getArgs().get(Tokens.ARGS_REBINDINGS);
+ // don't allow both rebindings and aliases parameters as they are the same thing. aliases were introduced
+ // as of 3.1.0 as a replacement for rebindings. this check can be removed when rebindings are completely
+ // removed from the protocol
+ final boolean hasRebindings = msg.getArgs().containsKey(Tokens.ARGS_REBINDINGS);
+ final boolean hasAliases = msg.getArgs().containsKey(Tokens.ARGS_ALIASES);
+ if (hasRebindings && hasAliases) {
+ final String error = "Prefer use of the 'aliases' parameter over 'rebindings' and do not use both";
+ throw new OpProcessorException(error, ResponseMessage.build(msg).code(ResponseStatusCode.REQUEST_ERROR_INVALID_REQUEST_ARGUMENTS).result(error).create());
+ }
+
+ final String rebindingOrAliasParameter = hasRebindings ? Tokens.ARGS_REBINDINGS : Tokens.ARGS_ALIASES;
+
+ // alias any global bindings to a different variable.
+ if (msg.getArgs().containsKey(rebindingOrAliasParameter)) {
+ final Map<String, String> rebinds = (Map<String, String>) msg.getArgs().get(rebindingOrAliasParameter);
for (Map.Entry<String,String> kv : rebinds.entrySet()) {
boolean found = false;
final Map<String, Graph> graphs = context.getGraphManager().getGraphs();
@@ -100,7 +112,7 @@ public class StandardOpProcessor extends AbstractEvalOpProcessor {
}
if (!found) {
- final String error = String.format("Could not rebind [%s] to [%s] as [%s] not in the Graph or TraversalSource global bindings",
+ final String error = String.format("Could not alias [%s] to [%s] as [%s] not in the Graph or TraversalSource global bindings",
kv.getKey(), kv.getValue(), kv.getValue());
throw new OpProcessorException(error, ResponseMessage.build(msg).code(ResponseStatusCode.REQUEST_ERROR_INVALID_REQUEST_ARGUMENTS).result(error).create());
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinDriverIntegrateTest.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinDriverIntegrateTest.java b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinDriverIntegrateTest.java
index cbe23d5..92c9671 100644
--- a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinDriverIntegrateTest.java
+++ b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinDriverIntegrateTest.java
@@ -80,7 +80,7 @@ public class GremlinDriverIntegrateTest extends AbstractGremlinServerIntegration
final String nameOfTest = name.getMethodName();
switch (nameOfTest) {
- case "shouldRebindTraversalSourceVariables":
+ case "shouldAliasTraversalSourceVariables":
try {
final String p = TestHelper.generateTempFileFromResource(
GremlinDriverIntegrateTest.class, "generate-shouldRebindTraversalSourceVariables.groovy", "").getAbsolutePath();
@@ -787,7 +787,7 @@ public class GremlinDriverIntegrateTest extends AbstractGremlinServerIntegration
}
@Test
- public void shouldRebindGraphVariables() throws Exception {
+ public void shouldAliasGraphVariables() throws Exception {
final Cluster cluster = Cluster.build().create();
final Client client = cluster.connect();
@@ -801,20 +801,25 @@ public class GremlinDriverIntegrateTest extends AbstractGremlinServerIntegration
assertEquals(ResponseStatusCode.SERVER_ERROR_SCRIPT_EVALUATION, re.getResponseStatusCode());
}
- final Client rebound = cluster.connect().rebind("graph");
- final Vertex v = rebound.submit("g.addVertex('name','stephen')").all().get().get(0).getVertex();
- assertEquals("stephen", v.value("name"));
+ // keep the testing here until "rebind" is completely removed
+ final Client reboundLegacy = cluster.connect().rebind("graph");
+ final Vertex vLegacy = reboundLegacy.submit("g.addVertex('name','stephen')").all().get().get(0).getVertex();
+ assertEquals("stephen", vLegacy.value("name"));
+
+ final Client rebound = cluster.connect().alias("graph");
+ final Vertex v = rebound.submit("g.addVertex('name','jason')").all().get().get(0).getVertex();
+ assertEquals("jason", v.value("name"));
cluster.close();
}
@Test
- public void shouldRebindTraversalSourceVariables() throws Exception {
+ public void shouldAliasTraversalSourceVariables() throws Exception {
final Cluster cluster = Cluster.build().create();
final Client client = cluster.connect();
try {
- client.submit("g.addV('name','stephen');").all().get().get(0).getVertex();
+ client.submit("g.addV('name','stephen')").all().get().get(0).getVertex();
fail("Should have tossed an exception because \"g\" is readonly in this context");
} catch (Exception ex) {
final Throwable root = ExceptionUtils.getRootCause(ex);
@@ -823,8 +828,14 @@ public class GremlinDriverIntegrateTest extends AbstractGremlinServerIntegration
assertEquals(ResponseStatusCode.SERVER_ERROR, re.getResponseStatusCode());
}
- final Vertex v = client.rebind("g1").submit("g.addV('name','stephen')").all().get().get(0).getVertex();
- assertEquals("stephen", v.value("name"));
+ // keep the testing here until "rebind" is completely removed
+ final Client clientLegacy = client.rebind("g1");
+ final Vertex vLegacy = clientLegacy.submit("g.addV('name','stephen')").all().get().get(0).getVertex();
+ assertEquals("stephen", vLegacy.value("name"));
+
+ final Client clientAliased = client.alias("g1");
+ final Vertex v = clientAliased.submit("g.addV('name','jason')").all().get().get(0).getVertex();
+ assertEquals("jason", v.value("name"));
cluster.close();
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerHttpIntegrateTest.java
----------------------------------------------------------------------
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 a56b9cf..f46f022 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
@@ -61,8 +61,8 @@ public class GremlinServerHttpIntegrateTest extends AbstractGremlinServerIntegra
switch (nameOfTest) {
case "should200OnGETWithGremlinQueryStringArgumentWithIteratorResult":
case "should200OnPOSTWithGremlinJsonEndcodedBodyWithIteratorResult":
- case "should200OnPOSTWithGremlinJsonEndcodedBodyWithIteratorResultAndRebinding":
- case "should200OnGETWithGremlinQueryStringArgumentWithIteratorResultAndRebinding":
+ case "should200OnPOSTWithGremlinJsonEndcodedBodyWithIteratorResultAndAliases":
+ case "should200OnGETWithGremlinQueryStringArgumentWithIteratorResultAndAliases":
settings.scriptEngines.get("gremlin-groovy").scripts = Arrays.asList("scripts/generate-classic.groovy");
break;
case "should200OnPOSTTransactionalGraph":
@@ -253,9 +253,21 @@ public class GremlinServerHttpIntegrateTest extends AbstractGremlinServerIntegra
}
@Test
- public void should200OnGETWithGremlinQueryStringArgumentWithIteratorResultAndRebinding() throws Exception {
+ public void should200OnGETWithGremlinQueryStringArgumentWithIteratorResultAndAliases() throws Exception {
+ // we can remove this first test when rebindings are completely removed
+ final CloseableHttpClient httpclientLegacy = HttpClients.createDefault();
+ final HttpGet httpgetLegacy = new HttpGet("http://localhost:8182?gremlin=g1.V()&rebindings.g1=g");
+
+ try (final CloseableHttpResponse response = httpclientLegacy.execute(httpgetLegacy)) {
+ assertEquals(200, response.getStatusLine().getStatusCode());
+ assertEquals("application/json", response.getEntity().getContentType().getValue());
+ final String json = EntityUtils.toString(response.getEntity());
+ final JsonNode node = mapper.readTree(json);
+ assertEquals(6, node.get("result").get("data").size());
+ }
+
final CloseableHttpClient httpclient = HttpClients.createDefault();
- final HttpGet httpget = new HttpGet("http://localhost:8182?gremlin=g1.V()&rebindings.g1=g");
+ final HttpGet httpget = new HttpGet("http://localhost:8182?gremlin=g1.V()&aliases.g1=g");
try (final CloseableHttpResponse response = httpclient.execute(httpget)) {
assertEquals(200, response.getStatusLine().getStatusCode());
@@ -411,11 +423,25 @@ public class GremlinServerHttpIntegrateTest extends AbstractGremlinServerIntegra
}
@Test
- public void should200OnPOSTWithGremlinJsonEndcodedBodyWithIteratorResultAndRebinding() throws Exception {
+ public void should200OnPOSTWithGremlinJsonEndcodedBodyWithIteratorResultAndAliases() throws Exception {
+ // we can remove this first test when rebindings are completely removed
+ final CloseableHttpClient httpclientLegacy = HttpClients.createDefault();
+ final HttpPost httppostLegacy = new HttpPost("http://localhost:8182");
+ httppostLegacy.addHeader("Content-Type", "application/json");
+ httppostLegacy.setEntity(new StringEntity("{\"gremlin\":\"g1.V()\",\"rebindings\":{\"g1\":\"g\"}}", Consts.UTF_8));
+
+ try (final CloseableHttpResponse response = httpclientLegacy.execute(httppostLegacy)) {
+ assertEquals(200, response.getStatusLine().getStatusCode());
+ assertEquals("application/json", response.getEntity().getContentType().getValue());
+ final String json = EntityUtils.toString(response.getEntity());
+ final JsonNode node = mapper.readTree(json);
+ assertEquals(6, node.get("result").get("data").size());
+ }
+
final CloseableHttpClient httpclient = HttpClients.createDefault();
final HttpPost httppost = new HttpPost("http://localhost:8182");
httppost.addHeader("Content-Type", "application/json");
- httppost.setEntity(new StringEntity("{\"gremlin\":\"g1.V()\",\"rebindings\":{\"g1\":\"g\"}}", Consts.UTF_8));
+ httppost.setEntity(new StringEntity("{\"gremlin\":\"g1.V()\",\"aliases\":{\"g1\":\"g\"}}", Consts.UTF_8));
try (final CloseableHttpResponse response = httpclient.execute(httppost)) {
assertEquals(200, response.getStatusLine().getStatusCode());
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bdf05534/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerIntegrateTest.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerIntegrateTest.java b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerIntegrateTest.java
index 0b4f7cd..6977100 100644
--- a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerIntegrateTest.java
+++ b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinServerIntegrateTest.java
@@ -36,6 +36,7 @@ import org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine;
import org.apache.tinkerpop.gremlin.structure.T;
import org.apache.tinkerpop.gremlin.server.channel.NioChannelizer;
import org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor;
+import org.apache.tinkerpop.gremlin.structure.util.detached.DetachedVertex;
import org.apache.tinkerpop.gremlin.util.Log4jRecordingAppender;
import org.junit.After;
import org.junit.Before;
@@ -44,6 +45,7 @@ import org.junit.Test;
import java.nio.channels.ClosedChannelException;
import java.util.ArrayList;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CountDownLatch;
@@ -660,6 +662,29 @@ public class GremlinServerIntegrateTest extends AbstractGremlinServerIntegration
assertTrue("Transaction should still be closed", !isStillOpen.get());
}
-
+
+ @Test
+ public void shouldStillSupportDeprecatedRebindingsParameterOnServer() throws Exception {
+ // this test can be removed when the rebindings arg is removed
+ try (SimpleClient client = new WebSocketClient()) {
+ final Map<String,String> rebindings = new HashMap<>();
+ rebindings.put("xyz", "graph");
+ final RequestMessage request = RequestMessage.build(Tokens.OPS_EVAL)
+ .addArg(Tokens.ARGS_GREMLIN, "xyz.addVertex('name','jason')")
+ .addArg(Tokens.ARGS_REBINDINGS, rebindings).create();
+ final CountDownLatch latch = new CountDownLatch(1);
+ final AtomicBoolean pass = new AtomicBoolean(false);
+ client.submit(request, result -> {
+ final List<Object> results = (List<Object>) result.getResult().getData();
+ final DetachedVertex v = (DetachedVertex) results.get(0);
+ pass.set(ResponseStatusCode.SUCCESS == result.getStatus().getCode() && v.value("name").equals("jason"));
+ latch.countDown();
+ });
+
+ if (!latch.await(300, TimeUnit.MILLISECONDS)) fail("Request should have returned a response");
+
+ assertTrue(pass.get());
+ }
+ }
}