Fix graph Direction serialization

Author: jorgebay

lib/datastax/graph/index.d.ts

@@ -82,4 +82,11 @@ export namespace graph {
     const label: EnumValue;
     const value: EnumValue;
   }
+
+  namespace direction {
+    // `in` is a reserved word
+    const in_: EnumValue;
+    const out: EnumValue;
+    const both: EnumValue;
+  }
 }

lib/datastax/graph/index.js

@@ -46,6 +46,20 @@ const t = {
   value: new EnumValue('T', 'value'),
 };
 
+/**
+ * Represents the edge direction.
+ */
+const direction = {
+  'both': new EnumValue('Direction', 'BOTH'),
+  'in': new EnumValue('Direction', 'IN'),
+  'out': new EnumValue('Direction', 'OUT')
+};
+
+// `in` is a reserved keyword depending on the context
+// TinkerPop JavaScript GLV only exposes `in` but it can lead to issues for TypeScript users and others.
+// Expose an extra property to represent `Direction.IN`.
+direction.in_ = direction.in;
+
 module.exports = {
   Edge,
   Element,
@@ -59,6 +73,7 @@ module.exports = {
   asFloat,
   asTimestamp,
   asUdt,
+  direction,
   getCustomTypeSerializers,
   GraphResultSet,
   GraphTypeWrapper,

lib/datastax/graph/type-serializers.js

@@ -30,13 +30,14 @@
 // Replace dependencies to minimize code changes from Apache TinkerPop
 const t = {
   P: UnsupportedType, TextP: UnsupportedType, Traversal: UnsupportedType, Traverser: UnsupportedType,
-  EnumValue: UnsupportedType, direction: {}
+  EnumValue: UnsupportedType
 };
 const ts = { TraversalStrategy: UnsupportedType };
 const Bytecode = UnsupportedType;
 const g = require('./index');
 const utils = { Long: UnsupportedType };
 t.t = g.t;
+t.direction = g.direction;
 
 function UnsupportedType() { }
 

test/integration/short/graph/graph-tests.js

@@ -28,7 +28,7 @@ const { InetAddress, Uuid, Tuple } = types;
 const ExecutionProfile = require('../../../../lib/execution-profile').ExecutionProfile;
 const utils = require('../../../../lib/utils');
 const graphModule = require('../../../../lib/datastax/graph');
-const { asInt, asFloat, asUdt, t } = graphModule;
+const { asInt, asFloat, asUdt, t, Edge, direction } = graphModule;
 const { graphProtocol } = require('../../../../lib/datastax/graph/options');
 const graphTestHelper = require('./graph-test-helper');
 
@@ -857,16 +857,25 @@ vdescribe('dse-5.0', 'Client @SERVER_API', function () {
       return client.executeGraph(query, null, { graphName });
     });
 
-    before(() => {
-      const createLabelQuery = `schema.vertexLabel('label_test').ifNotExists().partitionBy('id', Int)
+    before(async () => {
+      const createVertexLabel1Query = `schema.vertexLabel('label_test').ifNotExists().partitionBy('id', Int)
           .property('prop_double', Double)
           .property('prop_text', Text)
           .property('prop_uuid', Uuid)
           .property('prop_long', Bigint)
           .property('prop_blob', Blob)
           .property('prop_duration', Duration)
           .create()`;
-      return client.executeGraph(createLabelQuery, null, { graphName });
+      const createVertexLabel2Query = `schema.vertexLabel('label_test2').ifNotExists().partitionBy('id', Int)
+          .property('prop_text', Text)
+          .create()`;
+      const createEdgeLabelQuery = `schema.edgeLabel('created')
+        .from('label_test').to('label_test2')
+        .property('tag', Text)
+        .create()`;
+      await client.executeGraph(createVertexLabel1Query, null, { graphName });
+      await client.executeGraph(createVertexLabel2Query, null, { graphName });
+      await client.executeGraph(createEdgeLabelQuery, null, { graphName });
     });
 
     after(() => client.shutdown());
@@ -911,6 +920,43 @@ vdescribe('dse-5.0', 'Client @SERVER_API', function () {
         assert.deepEqual(rs.toArray(), ['value1']);
       });
 
+      it('should be able to add a edge and retrieve it', async () => {
+        const id1 = schemaCounter++;
+        const id2 = schemaCounter++;
+        const addTraversal = `g.addV('label_test')
+            .property('id', ${id1})
+            .property('prop_text', 'value1')
+            .as('first')
+          .addV('label_test2')
+            .property('id', ${id2})
+            .property('prop_text', 'value2')
+            .as('second')
+          .addE('created').from('first').to('second').property('tag', 'sample')`;
+        await client.executeGraph(addTraversal, null, { graphName });
+
+        const retrieveMapTraversal = `g.V().hasLabel('label_test').has('id', ${id1}).outE('created').elementMap()`;
+        let rs = await client.executeGraph(retrieveMapTraversal, null, { executionProfile: 'profile1' });
+        const map = rs.first();
+        assert.instanceOf(map, Map);
+        assert.equal(map.get('tag'), 'sample');
+        assert.equal(map.get(t.label), 'created');
+        const outMap = map.get(direction.out);
+        const inMap = map.get(direction.in);
+        assert.instanceOf(outMap, Map);
+        assert.equal(outMap.get(t.label), 'label_test');
+        assert.instanceOf(inMap, Map);
+        assert.equal(inMap.get(t.label), 'label_test2');
+
+        const retrieveEdgeTraversal = `g.V().hasLabel('label_test').has('id', ${id1}).outE('created')`;
+        rs = await client.executeGraph(retrieveEdgeTraversal, null, { executionProfile: 'profile1' });
+        const edge = rs.first();
+        assert.instanceOf(edge, Edge);
+        assert.equal(edge.label, 'created');
+        assert.equal(edge.outVLabel, 'label_test');
+        assert.equal(edge.inVLabel, 'label_test2');
+        assert.typeOf(edge.outV, 'string');
+      });
+
       it('should support named parameters', async () => {
         const id = schemaCounter++;
         const value = 'value2';

test/unit/api-tests.js

@@ -85,6 +85,17 @@ describe('API', function () {
       assert.equal(api.datastax.graph.t[name].toString(), name);
     });
 
+    [
+      'in',
+      'out',
+      'both'
+    ].forEach(name => {
+      assert.isObject(api.datastax.graph.direction[name]);
+      assert.equal(api.datastax.graph.direction[name].toString().toLowerCase(), name);
+    });
+
+    assert.equal(api.datastax.graph.direction['in_'].toString(), 'IN');
+
     checkConstructor(api.datastax.graph, 'UdtGraphWrapper');
     checkConstructor(api.datastax.graph, 'GraphTypeWrapper');
   });

test/unit/typescript/graph-tests.ts

@@ -39,4 +39,7 @@ async function myTest(client: Client): Promise<any> {
   let tokenString: string;
   tokenString = datastax.graph.t.id.toString();
   tokenString = datastax.graph.t.label.toString();
+  tokenString = datastax.graph.direction.in_.toString();
+  tokenString = datastax.graph.direction.out.toString();
+  tokenString = datastax.graph.direction.both.toString();
 }