gremlin 3.7.4 → 3.8.0

package/lib/structure/io/binary/internals/SetSerializer.js

@@ -0,0 +1,134 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+/**
+ * @author Igor Ostapenko
+ */
+'use strict';
+
+const { Buffer } = require('buffer');
+module.exports = class SetSerializer {
+  constructor(ioc, ID) {
+    this.ioc = ioc;
+    this.ID = ID;
+    this.ioc.serializers[ID] = this;
+  }
+
+  canBeUsedFor(value) {
+    return value instanceof Set;
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    if (item === undefined || item === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([this.ID, 0x01]);
+      }
+      return Buffer.from([0x00, 0x00, 0x00, 0x00]); // {length} = 0
+    }
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([this.ID, 0x00]));
+    }
+
+    // {length}
+    let length = item.size;
+    if (length < 0) {
+      length = 0;
+    }
+    if (length > this.ioc.intSerializer.INT32_MAX) {
+      throw new Error(`Set length=${length} is greater than supported max_length=${this.ioc.intSerializer.INT32_MAX}.`);
+    }
+    bufs.push(this.ioc.intSerializer.serialize(length, false));
+
+    // {item_0}...{item_n}
+    for (const i of item) {
+      bufs.push(this.ioc.anySerializer.serialize(i));
+    }
+
+    return Buffer.concat(bufs);
+  }
+
+  deserialize(buffer, fullyQualifiedFormat = true) {
+    let len = 0;
+    let cursor = buffer;
+
+    try {
+      if (buffer === undefined || buffer === null || !(buffer instanceof Buffer)) {
+        throw new Error('buffer is missing');
+      }
+      if (buffer.length < 1) {
+        throw new Error('buffer is empty');
+      }
+
+      if (fullyQualifiedFormat) {
+        const typeCode = cursor.readUInt8();
+        len++;
+        if (typeCode !== this.ID) {
+          throw new Error('unexpected {type_code}');
+        }
+        cursor = cursor.slice(1);
+
+        if (cursor.length < 1) {
+          throw new Error('{value_flag} is missing');
+        }
+        const valueFlag = cursor.readUInt8();
+        len++;
+        if (valueFlag === 1) {
+          return { v: null, len };
+        }
+        if (valueFlag !== 0) {
+          throw new Error('unexpected {value_flag}');
+        }
+        cursor = cursor.slice(1);
+      }
+
+      let length, lengthLen;
+      try {
+        ({ v: length, len: lengthLen } = this.ioc.intSerializer.deserialize(cursor, false));
+        len += lengthLen;
+      } catch (err) {
+        err.message = '{length}: ' + err.message;
+        throw err;
+      }
+      if (length < 0) {
+        throw new Error('{length} is less than zero');
+      }
+      cursor = cursor.slice(lengthLen);
+
+      const v = new Set();
+      for (let i = 0; i < length; i++) {
+        let value, valueLen;
+        try {
+          ({ v: value, len: valueLen } = this.ioc.anySerializer.deserialize(cursor));
+          len += valueLen;
+        } catch (err) {
+          err.message = `{item_${i}}: ` + err.message;
+          throw err;
+        }
+        cursor = cursor.slice(valueLen);
+        v.add(value);
+      }
+
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

package/lib/structure/io/binary/internals/TraversalStrategySerializer.js

@@ -29,7 +29,6 @@ const { TraversalStrategySerializer: GraphsonTraversalStrategySerializer } = req
 module.exports = class TraversalStrategySerializer {
   constructor(ioc) {
     this.ioc = ioc;
-    // this.ioc.serializers[ioc.DataType.TRAVERSALSTRATEGY] = this; // TODO: it's not expected to be deserialized
     this.graphsonTraversalStrategySerializer = new GraphsonTraversalStrategySerializer();
   }
 
@@ -45,8 +44,6 @@ module.exports = class TraversalStrategySerializer {
       const strategy_class = [0x00, 0x00, 0x00, 0x00]; // ''
       const configuration = [0x00, 0x00, 0x00, 0x00]; // {}
       return Buffer.from([...strategy_class, ...configuration]);
-      // TODO: should we delegate these to respective serializers like classSerializer.serialize(undefined, false) ?
-      // Consider to make it the same way for all other serializers
     }
 
     const bufs = [];
@@ -54,8 +51,6 @@ module.exports = class TraversalStrategySerializer {
       bufs.push(Buffer.from([this.ioc.DataType.TRAVERSALSTRATEGY, 0x00]));
     }
 
-    // let's repeat the logic of Graphson's TraversalStrategySerializer:
-    const strategy_class = item.fqcn;
     const conf = {};
     for (const k in item.configuration) {
       if (item.configuration.hasOwnProperty(k)) {
@@ -64,7 +59,7 @@ module.exports = class TraversalStrategySerializer {
     }
 
     // {strategy_class}
-    bufs.push(this.ioc.classSerializer.serialize(strategy_class, false));
+    bufs.push(this.ioc.classSerializer.serialize(item.constructor, false));
 
     // {configuration}
     bufs.push(this.ioc.mapSerializer.serialize(conf, false));

package/lib/structure/io/graph-serializer.js

@@ -253,6 +253,7 @@ const graphSON2Deserializers = {
   'g:Float': typeSerializers.NumberSerializer,
   'g:Double': typeSerializers.NumberSerializer,
   'g:Date': typeSerializers.DateSerializer,
+  'gx:OffsetDateTime': typeSerializers.OffsetDateTimeSerializer,
   'g:Direction': typeSerializers.DirectionSerializer,
   'g:Vertex': typeSerializers.VertexSerializer,
   'g:Edge': typeSerializers.EdgeSerializer,
@@ -272,12 +273,13 @@ const graphSON3Deserializers = Object.assign({}, graphSON2Deserializers, {
 
 const graphSON2Serializers = [
   typeSerializers.NumberSerializer,
-  typeSerializers.DateSerializer,
+  typeSerializers.OffsetDateTimeSerializer,
   typeSerializers.BytecodeSerializer,
   typeSerializers.TraverserSerializer,
   typeSerializers.TraversalStrategySerializer,
   typeSerializers.PSerializer,
   typeSerializers.TextPSerializer,
+  typeSerializers.ClassSerializer,
   typeSerializers.LambdaSerializer,
   typeSerializers.EnumSerializer,
   typeSerializers.VertexSerializer,

package/lib/structure/io/type-serializers.js

@@ -87,10 +87,18 @@ class NumberSerializer extends TypeSerializer {
 }
 
 class DateSerializer extends TypeSerializer {
+  // only deserialize g:Date objects
+  deserialize(obj) {
+    return new Date(obj[valueKey]);
+  }
+}
+
+class OffsetDateTimeSerializer extends TypeSerializer {
+  // Date objects are serialized as OffsetDateTime by default
   serialize(item) {
     return {
-      [typeKey]: 'g:Date',
-      [valueKey]: item.getTime(),
+      [typeKey]: 'gx:OffsetDateTime',
+      [valueKey]: item.toISOString(),
     };
   }
 
@@ -103,6 +111,24 @@ class DateSerializer extends TypeSerializer {
   }
 }
 
+class ClassSerializer extends TypeSerializer {
+  serialize(item) {
+    return {
+      [typeKey]: 'g:Class',
+      [valueKey]: new item().fqcn,
+    };
+  }
+
+  canBeUsedFor(value) {
+    return (
+      typeof value === 'function' &&
+      !!value.prototype &&
+      !!value.prototype.constructor.name &&
+      new value() instanceof ts.TraversalStrategy
+    );
+  }
+}
+
 class LongSerializer extends TypeSerializer {
   serialize(item) {
     return {
@@ -276,7 +302,7 @@ class TraversalStrategySerializer extends TypeSerializer {
 
     return {
       [typeKey]: 'g:' + item.constructor.name,
-      [valueKey]: conf,
+      [valueKey]: { ['fqcn']: item.fqcn, ['conf']: conf },
     };
   }
 
@@ -285,10 +311,29 @@ class TraversalStrategySerializer extends TypeSerializer {
   }
 }
 
+/**
+ * Helper function to deserialize properties into arrays of VertexProperty or Property according to graphSONV3.
+ */
+function deserializeProperties(value, reader) {
+  let properties = [];
+  if ('properties' in value) {
+    const props = reader.read(value['properties']);
+    if (props !== null && props !== undefined) {
+      properties = Object.entries(props).flatMap(([key, values]) => {
+        if (Array.isArray(values) && values.length > 0 && values[0] instanceof g.VertexProperty) {
+          return values; // Flatten VertexProperty arrays
+        }
+        return values instanceof g.Property ? values : new g.Property(key, values); // create Property object when needed
+      });
+    }
+  }
+  return properties;
+}
+
 class VertexSerializer extends TypeSerializer {
   deserialize(obj) {
     const value = obj[valueKey];
-    return new g.Vertex(this.reader.read(value['id']), value['label'], this.reader.read(value['properties']));
+    return new g.Vertex(this.reader.read(value['id']), value['label'], deserializeProperties(value, this.reader));
   }
 
   /** @param {Vertex} item */
@@ -314,7 +359,7 @@ class VertexPropertySerializer extends TypeSerializer {
       this.reader.read(value['id']),
       value['label'],
       this.reader.read(value['value']),
-      this.reader.read(value['properties']),
+      deserializeProperties(value, this.reader),
     );
   }
 }
@@ -334,7 +379,7 @@ class EdgeSerializer extends TypeSerializer {
       new g.Vertex(this.reader.read(value['outV']), this.reader.read(value['outVLabel'])),
       value['label'],
       new g.Vertex(this.reader.read(value['inV']), this.reader.read(value['inVLabel'])),
-      this.reader.read(value['properties']),
+      deserializeProperties(value, this.reader),
     );
   }
 
@@ -474,12 +519,29 @@ class SetSerializer extends ArraySerializer {
   constructor() {
     super('g:Set');
   }
+
+  deserialize(obj) {
+    return new Set(super.deserialize(obj));
+  }
+
+  serialize(item) {
+    return {
+      [typeKey]: this.typeKey,
+      [valueKey]: [...item].map((x) => this.writer.adaptObject(x)),
+    };
+  }
+
+  canBeUsedFor(value) {
+    return value instanceof Set;
+  }
 }
 
 module.exports = {
   BulkSetSerializer,
   BytecodeSerializer,
+  ClassSerializer,
   DateSerializer,
+  OffsetDateTimeSerializer,
   DirectionSerializer,
   EdgeSerializer,
   EnumSerializer,

package/lib/utils.js

@@ -25,7 +25,7 @@
 
 const uuid = require('uuid');
 
-const gremlinVersion = '3.7.4'; // DO NOT MODIFY - Configured automatically by Maven Replacer Plugin
+const gremlinVersion = '3.8.0'; // DO NOT MODIFY - Configured automatically by Maven Replacer Plugin
 
 exports.toLong = function toLong(value) {
   return new Long(value);

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "gremlin",
-  "version": "3.7.4",
+  "version": "3.8.0",
   "description": "JavaScript Gremlin Language Variant",
-  "author": "Apache TinkerPop team",
+  "author": {
+    "name": "Apache TinkerPop team"
+  },
   "keywords": [
     "graph",
     "gremlin",
     "tinkerpop",
+    "apache-tinkerpop",
     "connection",
     "glv",
     "driver",
+    "database",
     "graphdb"
   ],
   "license": "Apache-2.0",
@@ -51,11 +55,11 @@
     "integration-test-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' ./node_modules/mocha/bin/mocha.js test/integration -t 5000",
     "TODO": "# test other mime types like graphbinary stringd",
     "features": "npm run features-graphson30 && npm run features-graphbinary",
-    "features-graphson30": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' cucumber-js --require test/cucumber ../../../../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
-    "features-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --require test/cucumber ../../../../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
+    "features-graphson30": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' cucumber-js --tags \"not @DataUUID and not @DataLong\" --require test/cucumber ../../../../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
+    "features-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --tags \"not @DataBigDecimal and not @DataBigInt and not @DataUUID and not @DataLong\" --require test/cucumber ../../../../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
     "features-docker": "npm run features-graphson30-docker && npm run features-graphbinary-docker",
-    "features-graphson30-docker": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' cucumber-js --require test/cucumber ../gremlin-test/",
-    "features-graphbinary-docker": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --require test/cucumber ../gremlin-test/",
+    "features-graphson30-docker": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' cucumber-js --tags \"not @DataUUID and not @DataLong\" --require test/cucumber ../gremlin-test/",
+    "features-graphbinary-docker": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --tags \"not @DataBigDecimal and not @DataBigInt and not @DataUUID and not @DataLong\" --require test/cucumber ../gremlin-test/",
     "lint": "eslint --ext .js ."
   },
   "engines": {