gremlin 3.8.0 → 4.0.0-beta.2

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

@@ -1,101 +0,0 @@
-/*
- *  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 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

@@ -1,82 +0,0 @@
-/*
- *  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');
-
-/**
- * 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

@@ -1,85 +0,0 @@
-/*
- *  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');
-
-/**
- * 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,
-    */
-  }
-};

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

@@ -1,114 +0,0 @@
-/*
- *  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 IntSerializer {
-  get INT32_MIN() {
-    return -2147483648;
-  }
-  get INT32_MAX() {
-    return 2147483647;
-  }
-
-  constructor(ioc) {
-    this.ioc = ioc;
-    this.ioc.serializers[ioc.DataType.INT] = this;
-  }
-
-  canBeUsedFor(value) {
-    if (typeof value !== 'number') {
-      return false;
-    }
-    if (value < this.INT32_MIN || value > this.INT32_MAX) {
-      return false;
-    }
-    return true;
-  }
-
-  serialize(item, fullyQualifiedFormat = true) {
-    if (item === undefined || item === null) {
-      if (fullyQualifiedFormat) {
-        return Buffer.from([this.ioc.DataType.INT, 0x01]);
-      }
-      return Buffer.from([0x00, 0x00, 0x00, 0x00]);
-    }
-
-    const bufs = [];
-    if (fullyQualifiedFormat) {
-      bufs.push(Buffer.from([this.ioc.DataType.INT, 0x00]));
-    }
-    const v = Buffer.alloc(4);
-    v.writeInt32BE(item); // if item is not within int32 limits writeInt32BE will error
-    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.INT) {
-          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.readInt32BE();
-      return { v, len };
-    } catch (err) {
-      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
-    }
-  }
-};

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

@@ -1,71 +0,0 @@
-/*
- *  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');
-const { valueKey, LambdaSerializer: GraphsonLambdaSerializer } = require('../../type-serializers');
-
-module.exports = class LambdaSerializer {
-  constructor(ioc) {
-    this.ioc = ioc;
-    // this.ioc.serializers[ioc.DataType.LAMBDA] = this; // it's not expected to be deserialized
-    this.graphsonLambdaSerializer = new GraphsonLambdaSerializer();
-  }
-
-  canBeUsedFor(value) {
-    return this.graphsonLambdaSerializer.canBeUsedFor(value);
-  }
-
-  serialize(item, fullyQualifiedFormat = true) {
-    if (item === undefined || item === null) {
-      if (fullyQualifiedFormat) {
-        return Buffer.from([this.ioc.DataType.LAMBDA, 0x01]);
-      }
-      const language = [0x00, 0x00, 0x00, 0x00]; // ''
-      const script = [0x00, 0x00, 0x00, 0x00]; // ''
-      const arguments_length = [0x00, 0x00, 0x00, 0x00]; // 0
-      return Buffer.from([...language, ...script, ...arguments_length]);
-    }
-
-    const bufs = [];
-    if (fullyQualifiedFormat) {
-      bufs.push(Buffer.from([this.ioc.DataType.LAMBDA, 0x00]));
-    }
-
-    const graphson = this.graphsonLambdaSerializer.serialize(item);
-    const language = graphson[valueKey].language;
-    const script = graphson[valueKey].script;
-    const arguments_ = graphson[valueKey]['arguments'];
-
-    // {language}
-    bufs.push(this.ioc.stringSerializer.serialize(language, false));
-
-    // {script}
-    bufs.push(this.ioc.stringSerializer.serialize(script, false));
-
-    // {arguments_length}
-    bufs.push(this.ioc.intSerializer.serialize(arguments_, false));
-
-    return Buffer.concat(bufs);
-  }
-};

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

@@ -1,109 +0,0 @@
-/*
- *  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 LongSerializer {
-  constructor(ioc) {
-    this.ioc = ioc;
-    this.ioc.serializers[ioc.DataType.LONG] = this;
-  }
-
-  canBeUsedFor() {
-    // it's not expected to be used, see NumberSerializationStrategy
-  }
-
-  serialize(item, fullyQualifiedFormat = true) {
-    if (item === undefined || item === null) {
-      if (fullyQualifiedFormat) {
-        return Buffer.from([this.ioc.DataType.LONG, 0x01]);
-      }
-      return Buffer.from([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
-    }
-
-    const bufs = [];
-    if (fullyQualifiedFormat) {
-      bufs.push(Buffer.from([this.ioc.DataType.LONG, 0x00]));
-    }
-    const v = Buffer.alloc(8);
-    v.writeBigInt64BE(BigInt(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.LONG) {
-          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 < 8) {
-        throw new Error('unexpected {value} length');
-      }
-      len += 8;
-
-      let v = cursor.readBigInt64BE();
-      if (v < Number.MIN_SAFE_INTEGER || v > Number.MAX_SAFE_INTEGER) {
-        // TODO: It tries to keep the same contract as GraphSON LongSerializer provides.
-        // Is it still appropriate to do so? Should we consider LongSerializerNg?
-        v = parseFloat(v.toString());
-      } else {
-        v = Number(v);
-      }
-
-      return { v, len };
-    } catch (err) {
-      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
-    }
-  }
-};

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

@@ -1,104 +0,0 @@
-/*
- *  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');
-
-// TODO: it's based on BigInt native JavaScript type to completely support
-// 64 bits integers, but for backward compatibility with current GraphSON
-// implementation we do not use this for now. Consider its removal.
-module.exports = class LongSerializerNg {
-  constructor(ioc) {
-    this.ioc = ioc;
-    // this.ioc.serializers[ioc.DataType.LONG] = this; // disabled, see AnySerializer.deserialize()
-  }
-
-  canBeUsedFor() {
-    // it's not expected to be used
-  }
-
-  serialize(item, fullyQualifiedFormat = true) {
-    if (item === undefined || item === null) {
-      if (fullyQualifiedFormat) {
-        return Buffer.from([this.ioc.DataType.LONG, 0x01]);
-      }
-      return Buffer.from([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
-    }
-
-    const bufs = [];
-    if (fullyQualifiedFormat) {
-      bufs.push(Buffer.from([this.ioc.DataType.LONG, 0x00]));
-    }
-    const v = Buffer.alloc(8);
-    v.writeBigInt64BE(BigInt(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.LONG) {
-          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 < 8) {
-        throw new Error('unexpected {value} length');
-      }
-      len += 8;
-
-      const v = cursor.readBigInt64BE();
-      return { v, len };
-    } catch (err) {
-      throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
-    }
-  }
-};