[TINKERPOP-1474] API Alignment Between Java Gremlin Graph Structure and GLVs

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Won't Do
• Affects Version/s: 3.2.2
• Component/s: io
• Assignee: Stephen Mallette
• Reporter: Adam Holmberg
• Created: 26/Sep/16 21:30
• Updated: 13/Sep/17 16:02
• Resolved: 13/Sep/17 11:49

Description

The current Java GraphSON implementation and that in the Python GLV leave some question about what should be returned from a simple traversal like `g.V()`.

The java implementation presently assumes that properties could be present and returns a DetachedVertex: https://github.com/apache/tinkerpop/blob/master/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/graphson/GraphSONSerializersV2d0.java#L420-L433

The python implementation assumes no such thing and returns something more reminiscent of a ReferenceVertex: https://github.com/apache/tinkerpop/blob/master/gremlin-python/src/main/jython/gremlin_python/structure/io/graphson.py#L238-L242

Is the java version overreaching, and should not expect properties unless a step calls for them (e.g. ` g.V().valueMap()` or `g.V().values('name')`, or should the Python version be expanded?

Is there something we can do to establish guidelines for this, and align these APIs?

Issue Links

• relates to: TINKERPOP-1565 Setup GraphSON 3.0
• relates to: TINKERPOP-1592 Add withDetachment() and specify the "detachment" model.
• relates to: TINKERPOP-1701 HaltedTraverserStrategy should recurse into collections for detachment.
• links to: DISCUSS
• links to: GitHub Pull Request #490