gremlin 3.5.3 → 3.5.4

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

@@ -0,0 +1,119 @@
+/*
+ *  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';
+
+module.exports = class UuidSerializer {
+  constructor(ioc) {
+    this.ioc = ioc;
+    this.ioc.serializers[ioc.DataType.UUID] = this;
+  }
+
+  canBeUsedFor(value) {
+    // TODO: any idea to support UUID automatic serialization via AnySerializer in future?
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    if (item === undefined || item === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([this.ioc.DataType.UUID, 0x01]);
+      }
+      return Buffer.from([
+        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      ]);
+    }
+
+    const uuid_str = String(item)
+      .replace(/^urn:uuid:/, '')
+      .replace(/[{}-]/g, '');
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([this.ioc.DataType.UUID, 0x00]));
+    }
+
+    const v = Buffer.alloc(16, 0);
+    for (let i = 0; i < 16 && i * 2 < uuid_str.length; i++) {
+      v[i] = parseInt(uuid_str.slice(i * 2, i * 2 + 2), 16);
+    }
+    bufs.push(v);
+
+    return Buffer.concat(bufs);
+  }
+
+  deserialize(buffer, fullyQualifiedFormat = true, nullable = false) {
+    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 type_code = cursor.readUInt8();
+        len++;
+        if (type_code !== this.ioc.DataType.UUID) {
+          throw new Error('unexpected {type_code}');
+        }
+        cursor = cursor.slice(1);
+      }
+      if (fullyQualifiedFormat || nullable) {
+        if (cursor.length < 1) {
+          throw new Error('{value_flag} is missing');
+        }
+        const value_flag = cursor.readUInt8();
+        len++;
+        if (value_flag === 1) {
+          return { v: null, len };
+        }
+        if (value_flag !== 0) {
+          throw new Error('unexpected {value_flag}');
+        }
+        cursor = cursor.slice(1);
+      }
+
+      if (cursor.length < 16) {
+        throw new Error('unexpected {value} length');
+      }
+      len += 16;
+
+      // Example: 2075278D-F624-4B2B-960D-25D374D57C04
+      const v =
+        cursor.slice(0, 4).toString('hex') +
+        '-' +
+        cursor.slice(4, 6).toString('hex') +
+        '-' +
+        cursor.slice(6, 8).toString('hex') +
+        '-' +
+        cursor.slice(8, 10).toString('hex') +
+        '-' +
+        cursor.slice(10, 16).toString('hex');
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

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

@@ -0,0 +1,172 @@
+/*
+ *  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 g = require('../../../graph');
+
+module.exports = class VertexPropertySerializer {
+  constructor(ioc) {
+    this.ioc = ioc;
+    this.ioc.serializers[ioc.DataType.VERTEXPROPERTY] = this;
+  }
+
+  canBeUsedFor(value) {
+    return value instanceof g.VertexProperty;
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    if (item === undefined || item === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([this.ioc.DataType.VERTEXPROPERTY, 0x01]);
+      }
+      return Buffer.concat([
+        this.ioc.unspecifiedNullSerializer.serialize(null), // {id}=null
+        this.ioc.stringSerializer.serialize('', false), // {label}=''
+        this.ioc.unspecifiedNullSerializer.serialize(null), // {value}=null
+        this.ioc.unspecifiedNullSerializer.serialize(null), // {parent}=null
+        this.ioc.unspecifiedNullSerializer.serialize(null), // {properties}=null
+      ]);
+    }
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([this.ioc.DataType.VERTEXPROPERTY, 0x00]));
+    }
+
+    // {id}
+    bufs.push(this.ioc.anySerializer.serialize(item.id));
+
+    // {label}
+    bufs.push(this.ioc.stringSerializer.serialize(item.label, false));
+
+    // {value}
+    bufs.push(this.ioc.anySerializer.serialize(item.value));
+
+    // {parent}
+    bufs.push(this.ioc.unspecifiedNullSerializer.serialize(null));
+
+    // {properties}
+    bufs.push(this.ioc.anySerializer.serialize(item.properties));
+
+    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 type_code = cursor.readUInt8();
+        len++;
+        if (type_code !== this.ioc.DataType.VERTEXPROPERTY) {
+          throw new Error('unexpected {type_code}');
+        }
+        cursor = cursor.slice(1);
+
+        if (cursor.length < 1) {
+          throw new Error('{value_flag} is missing');
+        }
+        const value_flag = cursor.readUInt8();
+        len++;
+        if (value_flag === 1) {
+          return { v: null, len };
+        }
+        if (value_flag !== 0) {
+          throw new Error('unexpected {value_flag}');
+        }
+        cursor = cursor.slice(1);
+      }
+
+      // {id} is a fully qualified typed value composed of {type_code}{type_info}{value_flag}{value}
+      let id, id_len;
+      try {
+        ({ v: id, len: id_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += id_len;
+      } catch (err) {
+        err.message = '{id}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(id_len);
+
+      // {label} is a String value
+      let label, label_len;
+      try {
+        ({ v: label, len: label_len } = this.ioc.stringSerializer.deserialize(cursor, false));
+        len += label_len;
+      } catch (err) {
+        err.message = '{label}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(label_len);
+
+      // {value} is a fully qualified typed value composed of {type_code}{type_info}{value_flag}{value}
+      let value, value_len;
+      try {
+        ({ v: value, len: value_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += value_len;
+      } catch (err) {
+        err.message = '{value}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(value_len);
+
+      // {parent} is a fully qualified typed value composed of {type_code}{type_info}{value_flag}{value} which contains the parent Vertex.
+      // Note that as TinkerPop currently send "references" only, this value will always be null.
+      let parent_len;
+      try {
+        ({ len: parent_len } = this.ioc.unspecifiedNullSerializer.deserialize(cursor));
+        len += parent_len;
+      } catch (err) {
+        err.message = '{parent}: ' + err.message;
+        throw err;
+      }
+      // TODO: should we verify that parent is null?
+      cursor = cursor.slice(parent_len);
+
+      // {properties} is a fully qualified typed value composed of {type_code}{type_info}{value_flag}{value} which contains properties. Note that as TinkerPop currently send "references" only, this value will always be null.
+      let properties, properties_len;
+      try {
+        ({ v: properties, len: properties_len } = this.ioc.unspecifiedNullSerializer.deserialize(cursor));
+        len += properties_len;
+      } catch (err) {
+        err.message = '{properties}: ' + err.message;
+        throw err;
+      }
+      // TODO: should we verify that properties is null?
+      cursor = cursor.slice(properties_len);
+
+      const v = new g.VertexProperty(id, label, value, properties);
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

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

@@ -0,0 +1,135 @@
+/*
+ *  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 g = require('../../../graph');
+
+module.exports = class VertexSerializer {
+  constructor(ioc) {
+    this.ioc = ioc;
+    this.ioc.serializers[ioc.DataType.VERTEX] = this;
+  }
+
+  canBeUsedFor(value) {
+    return value instanceof g.Vertex;
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    if (item === undefined || item === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([this.ioc.DataType.VERTEX, 0x01]);
+      }
+      const id = [0x03, 0x00, 0x00, 0x00, 0x00, 0x00]; // String ''
+      const label = [0x00, 0x00, 0x00, 0x00]; // ''
+      const properties = [0xfe, 0x01]; // null
+      return Buffer.from([...id, ...label, ...properties]);
+    }
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([this.ioc.DataType.VERTEX, 0x00]));
+    }
+
+    // {id}
+    bufs.push(this.ioc.anySerializer.serialize(item.id));
+
+    // {label}
+    bufs.push(this.ioc.stringSerializer.serialize(item.label, false));
+
+    // {properties}
+    bufs.push(this.ioc.anySerializer.serialize(item.properties));
+
+    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 type_code = cursor.readUInt8();
+        len++;
+        if (type_code !== this.ioc.DataType.VERTEX) {
+          throw new Error('unexpected {type_code}');
+        }
+        cursor = cursor.slice(1);
+
+        if (cursor.length < 1) {
+          throw new Error('{value_flag} is missing');
+        }
+        const value_flag = cursor.readUInt8();
+        len++;
+        if (value_flag === 1) {
+          return { v: null, len };
+        }
+        if (value_flag !== 0) {
+          throw new Error('unexpected {value_flag}');
+        }
+        cursor = cursor.slice(1);
+      }
+
+      let id, id_len;
+      try {
+        ({ v: id, len: id_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += id_len;
+      } catch (err) {
+        err.message = '{id}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(id_len);
+
+      let label, label_len;
+      try {
+        ({ v: label, len: label_len } = this.ioc.stringSerializer.deserialize(cursor, false));
+        len += label_len;
+      } catch (err) {
+        err.message = '{label}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(label_len);
+
+      let properties, properties_len;
+      try {
+        ({ v: properties, len: properties_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += properties_len;
+      } catch (err) {
+        err.message = '{properties}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(properties_len);
+
+      const v = new g.Vertex(id, label, properties);
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

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

@@ -0,0 +1,59 @@
+/*
+ *  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';
+
+/*
+ * Deserialization error general constructor.
+ */
+const des_error = ({ serializer, args, cursor, err }) => {
+  if (cursor === undefined) {
+    cursor = args[0]; // buffer
+  }
+  let cursor_tail = '';
+  if (cursor instanceof Buffer) {
+    if (cursor.length > 32) {
+      cursor_tail = '...';
+    }
+    cursor = cursor.slice(0, 32).toString('hex');
+  }
+
+  const fullyQualifiedFormat = args[1];
+  const nullable = args[2];
+
+  let m = `${serializer.constructor.name}.deserialize(cursor=${cursor}${cursor_tail}`;
+  if (fullyQualifiedFormat !== undefined) {
+    m += `, fullyQualifiedFormat=${fullyQualifiedFormat}`;
+  }
+  if (nullable !== undefined) {
+    m += `, nullable=${nullable}`;
+  }
+  m += `): ${err.message.replace(/\.$/, '')}.`;
+
+  err.message = m;
+
+  return err;
+};
+
+module.exports = {
+  des_error,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gremlin",
-  "version": "3.5.3",
+  "version": "3.5.4",
   "description": "JavaScript Gremlin Language Variant",
   "author": "Apache TinkerPop team",
   "keywords": [
@@ -17,17 +17,18 @@
     "ws": "^6.2.2"
   },
   "devDependencies": {
-    "chai": "~4.1.2",
+    "chai": "~4.3.6",
     "colors": "1.4.0",
+    "cross-env": "^7.0.3",
     "cucumber": "~4.2.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
     "grunt": "^1.4.1",
-    "grunt-cli": "~1.3.2",
+    "grunt-cli": "~1.4.3",
     "grunt-jsdoc": "~2.4.1",
     "mocha": "^9.2.2",
-    "prettier": "^2.5.1"
+    "prettier": "^2.6.2"
   },
   "repository": {
     "type": "git",
@@ -38,9 +39,15 @@
     "url": "https://issues.apache.org/jira/browse/TINKERPOP"
   },
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha test/unit test/integration -t 5000",
-    "features": "./node_modules/.bin/cucumber-js --require test/cucumber ../../../../../gremlin-test/features/",
-    "unit-test": "./node_modules/mocha/bin/mocha test/unit",
+    "test": "npm run unit-test && npm run integration-test",
+    "unit-test": "mocha test/unit/*",
+    "integration-test": "npm run integration-test-graphson30 && npm run integration-test-graphbinary",
+    "integration-test-graphson30": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' ./node_modules/mocha/bin/mocha test/integration -t 5000",
+    "integration-test-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' ./node_modules/mocha/bin/mocha 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/features/",
+    "features-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --require test/cucumber ../../../../../gremlin-test/features/",
     "lint": "eslint --ext .js ."
   },
   "engines": {