gremlin 3.6.0 → 3.6.2

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

@@ -0,0 +1,215 @@
+/*
+ *  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 EdgeSerializer {
+  constructor(ioc) {
+    this.ioc = ioc;
+    this.ioc.serializers[ioc.DataType.EDGE] = this;
+  }
+
+  canBeUsedFor(value) {
+    return value instanceof g.Edge;
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    if (item === undefined || item === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([this.ioc.DataType.EDGE, 0x01]);
+      }
+      const id = [0x03, 0x00, 0x00, 0x00, 0x00, 0x00]; // String ''
+      const label = [0x00, 0x00, 0x00, 0x00]; // ''
+      const inVId = [0x03, 0x00, 0x00, 0x00, 0x00, 0x00]; // String ''
+      const inVLabel = [0x00, 0x00, 0x00, 0x00]; // ''
+      const outVId = [0x03, 0x00, 0x00, 0x00, 0x00, 0x00]; // String ''
+      const outVLabel = [0x00, 0x00, 0x00, 0x00]; // ''
+      const parent = [0xfe, 0x01]; // null
+      const properties = [0xfe, 0x01]; // null
+      return Buffer.from([...id, ...label, ...inVId, ...inVLabel, ...outVId, ...outVLabel, ...parent, ...properties]);
+    }
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([this.ioc.DataType.EDGE, 0x00]));
+    }
+
+    // {id}
+    bufs.push(this.ioc.anySerializer.serialize(item.id));
+
+    // {label}
+    bufs.push(this.ioc.stringSerializer.serialize(item.label, false));
+
+    // {inVId}
+    const inVId = item.inV && item.inV.id;
+    bufs.push(this.ioc.anySerializer.serialize(inVId));
+
+    // {inVLabel}
+    const inVLabel = item.inV && item.inV.label;
+    bufs.push(this.ioc.stringSerializer.serialize(inVLabel, false));
+
+    // {outVId}
+    const outVId = item.outV && item.outV.id;
+    bufs.push(this.ioc.anySerializer.serialize(outVId));
+
+    // {outVLabel}
+    const outVLabel = item.outV && item.outV.label;
+    bufs.push(this.ioc.stringSerializer.serialize(outVLabel, false));
+
+    // {parent}
+    bufs.push(this.ioc.unspecifiedNullSerializer.serialize(null));
+
+    // {properties}
+    bufs.push(this.ioc.unspecifiedNullSerializer.serialize(null));
+
+    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.EDGE) {
+          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 inVId, inVId_len;
+      try {
+        ({ v: inVId, len: inVId_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += inVId_len;
+      } catch (err) {
+        err.message = '{inVId}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(inVId_len);
+
+      let inVLabel, inVLabel_len;
+      try {
+        ({ v: inVLabel, len: inVLabel_len } = this.ioc.stringSerializer.deserialize(cursor, false));
+        len += inVLabel_len;
+      } catch (err) {
+        err.message = '{inVLabel}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(inVLabel_len);
+
+      let outVId, outVId_len;
+      try {
+        ({ v: outVId, len: outVId_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += outVId_len;
+      } catch (err) {
+        err.message = '{outVId}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(outVId_len);
+
+      let outVLabel, outVLabel_len;
+      try {
+        ({ v: outVLabel, len: outVLabel_len } = this.ioc.stringSerializer.deserialize(cursor, false));
+        len += outVLabel_len;
+      } catch (err) {
+        err.message = '{outVLabel}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(outVLabel_len);
+
+      let parent_len;
+      try {
+        ({ len: parent_len } = this.ioc.anySerializer.deserialize(cursor));
+        len += parent_len;
+      } catch (err) {
+        err.message = '{parent}: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(parent_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.Edge(
+        id,
+        new g.Vertex(outVId, outVLabel, null),
+        label,
+        new g.Vertex(inVId, inVLabel, null),
+        properties,
+      );
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

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

@@ -0,0 +1,149 @@
+/*
+ *  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 t = require('../../../../process/traversal');
+
+module.exports = class EnumSerializer {
+  constructor(ioc) {
+    this.ioc = ioc;
+
+    const to_orig_enum = (obj) => {
+      // process/traversal.js:toEnum() changes original element name (e.g. OUT => out) for end users' convenience
+      // but we need original mapping as is w/o additional time spent on case-insensititive comparison
+      const r = {};
+      Object.values(obj).forEach((e) => (r[e.elementName] = e));
+      return r;
+    };
+    const DT = ioc.DataType;
+    this.types = [
+      { name: 'Barrier', code: DT.BARRIER, enum: to_orig_enum(t.barrier) },
+      { name: 'Cardinality', code: DT.CARDINALITY, enum: to_orig_enum(t.cardinality) },
+      { name: 'Column', code: DT.COLUMN, enum: to_orig_enum(t.column) },
+      { name: 'Direction', code: DT.DIRECTION, enum: to_orig_enum(t.direction) },
+      { name: 'Merge', code: DT.MERGE, enum: to_orig_enum(t.merge) },
+      { name: 'Operator', code: DT.OPERATOR, enum: to_orig_enum(t.operator) },
+      { name: 'Order', code: DT.ORDER, enum: to_orig_enum(t.order) },
+      { name: 'Pick', code: DT.PICK, enum: to_orig_enum(t.pick) },
+      { name: 'Pop', code: DT.POP, enum: to_orig_enum(t.pop) },
+      { name: 'Scope', code: DT.SCOPE, enum: to_orig_enum(t.scope) },
+      { name: 'T', code: DT.T, enum: to_orig_enum(t.t) },
+    ];
+    this.byname = {};
+    this.bycode = {};
+    for (const type of this.types) {
+      this.ioc.serializers[type.code] = this;
+      this.byname[type.name] = type;
+      this.bycode[type.code] = type;
+    }
+  }
+
+  canBeUsedFor(value) {
+    if (!(value instanceof t.EnumValue)) {
+      return false;
+    }
+    if (!this.byname[value.typeName]) {
+      throw new Error(`EnumSerializer.serialize: typeName=${value.typeName} is not supported.`);
+    }
+
+    return true;
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    const type = this.byname[item.typeName];
+    if (item.elementName === undefined || item.elementName === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([type.code, 0x01]);
+      }
+      return Buffer.from([this.ioc.DataType.STRING, 0x00, 0x00, 0x00, 0x00, 0x00]);
+    }
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([type.code, 0x00]));
+    }
+
+    bufs.push(this.ioc.stringSerializer.serialize(item.elementName, true));
+
+    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');
+      }
+
+      let type = undefined;
+      if (fullyQualifiedFormat) {
+        const type_code = cursor.readUInt8();
+        len++;
+        type = this.bycode[type_code];
+        if (!type) {
+          throw new Error(`unexpected {type_code}=${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 elementName, elementName_len;
+      try {
+        ({ v: elementName, len: elementName_len } = this.ioc.stringSerializer.deserialize(cursor, true));
+        len += elementName_len;
+      } catch (err) {
+        err.message = 'elementName: ' + err.message;
+        throw err;
+      }
+      cursor = cursor.slice(elementName_len);
+
+      let v;
+      if (!type) {
+        v = new t.EnumValue(undefined, elementName);
+      } else {
+        v = type.enum[elementName]; // users are expected to work with maps like Map.get(T.id), i.e. it must be exactly the same object
+      }
+
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

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

@@ -0,0 +1,99 @@
+/*
+ *  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 FloatSerializer {
+  constructor(ioc) {
+    this.ioc = ioc;
+    this.ioc.serializers[ioc.DataType.FLOAT] = this;
+  }
+
+  canBeUsedFor(value) {
+    // it's not expected to be used
+  }
+
+  serialize(item, fullyQualifiedFormat = true) {
+    if (item === undefined || item === null) {
+      if (fullyQualifiedFormat) {
+        return Buffer.from([this.ioc.DataType.FLOAT, 0x01]);
+      }
+      return Buffer.from([0x00, 0x00, 0x00, 0x00]);
+    }
+
+    const bufs = [];
+    if (fullyQualifiedFormat) {
+      bufs.push(Buffer.from([this.ioc.DataType.FLOAT, 0x00]));
+    }
+    const v = Buffer.alloc(4);
+    v.writeFloatBE(item);
+    bufs.push(v);
+
+    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.FLOAT) {
+          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);
+      }
+
+      if (cursor.length < 4) {
+        throw new Error('unexpected {value} length');
+      }
+      len += 4;
+
+      const v = cursor.readFloatBE();
+      return { v, len };
+    } catch (err) {
+      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+    }
+  }
+};

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

@@ -0,0 +1,80 @@
+/*
+ *  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';
+
+/**
+ * GraphBinary reader.
+ */
+module.exports = class GraphBinaryReader {
+  constructor(ioc) {
+    this.ioc = ioc;
+  }
+
+  readResponse(buffer) {
+    if (buffer === undefined || buffer === null) {
+      throw new Error('Buffer is missing.');
+    }
+    if (!(buffer instanceof Buffer)) {
+      throw new Error('Not an instance of Buffer.');
+    }
+    if (buffer.length < 1) {
+      throw new Error('Buffer is empty.');
+    }
+
+    const response = { status: {}, result: {} };
+    let cursor = buffer;
+    let len;
+
+    // {version} is a Byte representing the protocol version
+    const version = cursor[0];
+    if (version !== 0x81) {
+      throw new Error(`Unsupported version '${version}'.`);
+    }
+    cursor = cursor.slice(1); // skip version
+
+    // {request_id} is a nullable UUID
+    ({ v: response.requestId, len } = this.ioc.uuidSerializer.deserialize(cursor, false, true));
+    cursor = cursor.slice(len);
+
+    // {status_code} is an Int
+    ({ v: response.status.code, len } = this.ioc.intSerializer.deserialize(cursor, false));
+    cursor = cursor.slice(len);
+
+    // {status_message} is a nullable String
+    ({ v: response.status.message, len } = this.ioc.stringSerializer.deserialize(cursor, false, true));
+    cursor = cursor.slice(len);
+
+    // {status_attributes} is a Map
+    ({ v: response.status.attributes, len } = this.ioc.mapSerializer.deserialize(cursor, false));
+    cursor = cursor.slice(len);
+
+    // {result_meta} is a Map
+    ({ v: response.result.meta, len } = this.ioc.mapSerializer.deserialize(cursor, false));
+    cursor = cursor.slice(len);
+
+    // {result_data} is a fully qualified typed value composed of {type_code}{type_info}{value_flag}{value}
+    ({ v: response.result.data } = this.ioc.anySerializer.deserialize(cursor));
+
+    return response;
+  }
+};

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

@@ -0,0 +1,83 @@
+/*
+ *  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';
+
+/**
+ * GraphBinary writer.
+ */
+module.exports = class GraphBinaryWriter {
+  constructor(ioc) {
+    this.ioc = ioc;
+  }
+
+  writeRequest({ requestId, op, processor, args }) {
+    const bufs = [
+      // {version} 1 byte
+      Buffer.from([0x81]),
+      // {request_id} UUID
+      this.ioc.uuidSerializer.serialize(requestId, false),
+      // {op} String
+      this.ioc.stringSerializer.serialize(op, false),
+      // {processor} String
+      this.ioc.stringSerializer.serialize(processor, false),
+      // {args} Map
+      this.ioc.mapSerializer.serialize(args, false),
+    ];
+    return Buffer.concat(bufs);
+
+    /*// Detailed example for a quick reference:
+      // {version}
+      0x81,
+      // {request_id} UUID
+      0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,0x0F,
+      // {op} String
+      0x00,0x00,0x00,0x08,  ...Buffer.from('bytecode'),
+      // {processor} String
+      0x00,0x00,0x00,0x09,  ...Buffer.from('traversal'),
+      // {args} Map
+      0x00,0x00,0x00,0x02,
+        // 1.
+        // args.aliases key String
+        0x03,0x00,  0x00,0x00,0x00,0x07,  ...Buffer.from('aliases'),
+        // args.aliases value Map
+        0x0A,0x00,  0x00,0x00,0x00,0x01,
+          // aliases.g key String
+          0x03,0x00,  0x00,0x00,0x00,0x01,  ...Buffer.from('g'),
+          // aliases.g value String
+          0x03,0x00,  0x00,0x00,0x00,0x01,  ...Buffer.from('g'),
+        // 2.
+        // args.gremlin key String
+        0x03,0x00,  0x00,0x00,0x00,0x07,  ...Buffer.from('gremlin'),
+        // args.gremlin value Bytecode
+        0x15,0x00,
+          // {steps_length}
+          0x00,0x00,0x00,0x01,
+            // step 1 - {name} String
+            0x00,0x00,0x00,0x01,  ...Buffer.from('V'),
+            // step 1 - {values_length} Int
+            0x00,0x00,0x00,0x00,
+          // {sources_length}
+          0x00,0x00,0x00,0x00,
+    */
+  }
+};