gremlin 4.0.0-beta.2 → 4.0.0-beta.3

package/build/esm/structure/io/binary/internals/TreeSerializer.d.ts

@@ -0,0 +1,54 @@
+/**
+ * GraphBinary serializer for the Tree type (0x2b).
+ *
+ * Wire format (authoritative from Java TreeSerializer):
+ *   value = {int length} then length x ( {fully-qualified key} {bare child Tree} )
+ * A child Tree is written bare: just {int length}{entries...}, with no type-id
+ * and no value-flag, recursively. A leaf is length 0. The child is never null,
+ * but a key may be null.
+ */
+export default class TreeSerializer {
+    constructor(ioc: any);
+    ioc: any;
+    canBeUsedFor(value: any): value is Tree;
+    serialize(item: any, fullyQualifiedFormat?: boolean): any;
+    /**
+     * Serializes the bare value of a Tree: {int length} then, for each root key, a
+     * fully-qualified key followed by a bare child Tree (recursive).
+     *
+     * Uses only the public read API ({@link Tree#rootNodes} / {@link Tree#childAt})
+     * so it never touches the Tree's private backing. Keys returned by rootNodes()
+     * are already deduped, so each is written exactly once.
+     * @param {Tree} tree
+     * @returns {Buffer}
+     */
+    _serializeValue(tree: Tree): Buffer;
+    /**
+     * Async deserialization of tree value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<Tree>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<Tree>;
+    /**
+     * Reads a bare tree value: {int length} then length x ( fully-qualified key,
+     * bare child tree ). The child recursion reads bare values (no type_code,
+     * no value_flag).
+     *
+     * Duplicate sibling keys are collapsed via {@link Tree#getOrCreateChild} +
+     * {@link Tree#addTree} (a server emitting
+     * the same sibling key twice yields a single merged entry, not duplicates).
+     * @param {StreamReader} reader
+     * @returns {Promise<Tree>}
+     */
+    _readTreeValue(reader: StreamReader): Promise<Tree>;
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<Tree|null>}
+     */
+    deserialize(reader: StreamReader): Promise<Tree | null>;
+}
+import { Tree } from '../../../graph.js';
+import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/TreeSerializer.js

@@ -0,0 +1,136 @@
+/*
+ *  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.
+ */
+import { Buffer } from 'buffer';
+import { Tree } from '../../../graph.js';
+/**
+ * GraphBinary serializer for the Tree type (0x2b).
+ *
+ * Wire format (authoritative from Java TreeSerializer):
+ *   value = {int length} then length x ( {fully-qualified key} {bare child Tree} )
+ * A child Tree is written bare: just {int length}{entries...}, with no type-id
+ * and no value-flag, recursively. A leaf is length 0. The child is never null,
+ * but a key may be null.
+ */
+export default class TreeSerializer {
+    constructor(ioc) {
+        this.ioc = ioc;
+        this.ioc.serializers[ioc.DataType.TREE] = this;
+    }
+    canBeUsedFor(value) {
+        return value instanceof Tree;
+    }
+    serialize(item, fullyQualifiedFormat = true) {
+        if (item === undefined || item === null) {
+            if (fullyQualifiedFormat) {
+                return Buffer.from([this.ioc.DataType.TREE, 0x01]);
+            }
+            // bare null -> empty tree (length 0)
+            return this.ioc.intSerializer.serialize(0, false);
+        }
+        const bufs = [];
+        if (fullyQualifiedFormat) {
+            bufs.push(Buffer.from([this.ioc.DataType.TREE, 0x00]));
+        }
+        bufs.push(this._serializeValue(item));
+        return Buffer.concat(bufs);
+    }
+    /**
+     * Serializes the bare value of a Tree: {int length} then, for each root key, a
+     * fully-qualified key followed by a bare child Tree (recursive).
+     *
+     * Uses only the public read API ({@link Tree#rootNodes} / {@link Tree#childAt})
+     * so it never touches the Tree's private backing. Keys returned by rootNodes()
+     * are already deduped, so each is written exactly once.
+     * @param {Tree} tree
+     * @returns {Buffer}
+     */
+    _serializeValue(tree) {
+        const keys = tree.rootNodes();
+        let length = keys.length;
+        if (length < 0) {
+            length = 0;
+        }
+        else if (length > this.ioc.intSerializer.INT32_MAX) {
+            length = this.ioc.intSerializer.INT32_MAX;
+        }
+        const bufs = [this.ioc.intSerializer.serialize(length, false)];
+        for (let i = 0; i < length; i++) {
+            const key = keys[i];
+            // fully-qualified key
+            bufs.push(this.ioc.anySerializer.serialize(key));
+            // bare child tree (no type_code, no value_flag)
+            bufs.push(this._serializeValue(tree.childAt(key)));
+        }
+        return Buffer.concat(bufs);
+    }
+    /**
+     * Async deserialization of tree value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<Tree>}
+     */
+    async deserializeValue(reader, valueFlag, typeCode) {
+        return await this._readTreeValue(reader);
+    }
+    /**
+     * Reads a bare tree value: {int length} then length x ( fully-qualified key,
+     * bare child tree ). The child recursion reads bare values (no type_code,
+     * no value_flag).
+     *
+     * Duplicate sibling keys are collapsed via {@link Tree#getOrCreateChild} +
+     * {@link Tree#addTree} (a server emitting
+     * the same sibling key twice yields a single merged entry, not duplicates).
+     * @param {StreamReader} reader
+     * @returns {Promise<Tree>}
+     */
+    async _readTreeValue(reader) {
+        const length = await this.ioc.intSerializer.deserializeBare(reader);
+        const tree = new Tree();
+        for (let i = 0; i < length; i++) {
+            // {fully-qualified key} - read with type_code + value_flag.
+            const key = await this.ioc.anySerializer.deserialize(reader);
+            // {bare child tree} - never null, no type_code / value_flag
+            const child = await this._readTreeValue(reader);
+            // Merge into any existing entry for this key so duplicate sibling keys
+            // collapse into a single entry.
+            tree.getOrCreateChild(key).addTree(child);
+        }
+        return tree;
+    }
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<Tree|null>}
+     */
+    async deserialize(reader) {
+        const type_code = await reader.readUInt8();
+        if (type_code !== this.ioc.DataType.TREE) {
+            throw new Error(`TreeSerializer: unexpected {type_code}=0x${type_code.toString(16)}`);
+        }
+        const value_flag = await reader.readUInt8();
+        if (value_flag === 0x01) {
+            return null;
+        }
+        if (value_flag !== 0x00) {
+            throw new Error(`TreeSerializer: unexpected {value_flag}=0x${value_flag.toString(16)}`);
+        }
+        return this.deserializeValue(reader, value_flag, type_code);
+    }
+}

package/build/esm/structure/io/binary/internals/UnspecifiedNullSerializer.d.ts

@@ -3,9 +3,11 @@ export default class UnspecifiedNullSerializer {
     ioc: any;
     canBeUsedFor(value: any): boolean;
     serialize(item: any): Buffer<ArrayBuffer>;
-    deserialize(buffer: any, ...args: any[]): {
-        v: null;
-        len: number;
-    };
+    /**
+     * @param {StreamReader} reader
+     * @param {number} valueFlag - already consumed by AnySerializer (always 0x01 for null)
+     * @returns {Promise<null>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number): Promise<null>;
 }
 import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/UnspecifiedNullSerializer.js

@@ -32,36 +32,13 @@ export default class UnspecifiedNullSerializer {
         // fullyQualifiedFormat always is true
         return Buffer.from([this.ioc.DataType.UNSPECIFIED_NULL, 0x01]);
     }
-    deserialize(buffer) {
-        // fullyQualifiedFormat always is 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');
-            }
-            const type_code = cursor.readUInt8();
-            len++;
-            if (type_code !== this.ioc.DataType.UNSPECIFIED_NULL) {
-                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) {
-                throw new Error('unexpected {value_flag}');
-            }
-            cursor = cursor.slice(1);
-            return { v: null, len };
-        }
-        catch (err) {
-            throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
-        }
+    /**
+     * @param {StreamReader} reader
+     * @param {number} valueFlag - already consumed by AnySerializer (always 0x01 for null)
+     * @returns {Promise<null>}
+     */
+    // eslint-disable-next-line require-await
+    async deserializeValue(reader, valueFlag) {
+        throw new Error('UnspecifiedNull should always have value_flag=0x01');
     }
 }

package/build/esm/structure/io/binary/internals/UuidSerializer.d.ts

@@ -3,12 +3,17 @@ export default class UuidSerializer {
     ioc: any;
     canBeUsedFor(value: any): void;
     serialize(item: any, fullyQualifiedFormat?: boolean): Buffer<ArrayBuffer>;
-    deserialize(buffer: any, fullyQualifiedFormat?: boolean, nullable?: boolean, ...args: any[]): {
-        v: null;
-        len: number;
-    } | {
-        v: string;
-        len: number;
-    };
+    /**
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<string>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<string>;
+    /**
+     * @param {StreamReader} reader
+     * @returns {Promise<string|null>}
+     */
+    deserialize(reader: StreamReader): Promise<string | null>;
 }
 import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/UuidSerializer.js

@@ -51,56 +51,40 @@ export default class UuidSerializer {
         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 };
+    /**
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<string>}
+     */
+    async deserializeValue(reader, valueFlag, typeCode) {
+        const bytes = await reader.readBytes(16);
+        return (bytes.subarray(0, 4).toString('hex') +
+            '-' +
+            bytes.subarray(4, 6).toString('hex') +
+            '-' +
+            bytes.subarray(6, 8).toString('hex') +
+            '-' +
+            bytes.subarray(8, 10).toString('hex') +
+            '-' +
+            bytes.subarray(10, 16).toString('hex'));
+    }
+    /**
+     * @param {StreamReader} reader
+     * @returns {Promise<string|null>}
+     */
+    async deserialize(reader) {
+        const type_code = await reader.readUInt8();
+        if (type_code !== this.ioc.DataType.UUID) {
+            throw new Error(`UuidSerializer: unexpected {type_code}=0x${type_code.toString(16)}`);
+        }
+        const value_flag = await reader.readUInt8();
+        if (value_flag === 0x01) {
+            return null;
         }
-        catch (err) {
-            throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+        if (value_flag !== 0x00) {
+            throw new Error(`UuidSerializer: unexpected {value_flag}=0x${value_flag.toString(16)}`);
         }
+        return this.deserializeValue(reader, value_flag, type_code);
     }
 }

package/build/esm/structure/io/binary/internals/VertexPropertySerializer.d.ts

@@ -3,13 +3,20 @@ export default class VertexPropertySerializer {
     ioc: any;
     canBeUsedFor(value: any): value is VertexProperty<any, any, any, any>;
     serialize(item: any, fullyQualifiedFormat?: boolean): Buffer<ArrayBuffer>;
-    deserialize(buffer: any, fullyQualifiedFormat?: boolean, ...args: any[]): {
-        v: null;
-        len: number;
-    } | {
-        v: VertexProperty<any, any, Record<string, any>, any>;
-        len: number;
-    };
+    /**
+     * Async deserialization of vertex property value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<VertexProperty>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<VertexProperty>;
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<VertexProperty|null>}
+     */
+    deserialize(reader: StreamReader): Promise<VertexProperty | null>;
 }
 import { VertexProperty } from '../../../graph.js';
 import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/VertexPropertySerializer.js

@@ -59,102 +59,44 @@ export default class VertexPropertySerializer {
         bufs.push(this.ioc.listSerializer.serialize([], 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');
-            }
-            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 List value
-            let label, label_len;
-            try {
-                ({ v: label, len: label_len } = this.ioc.listSerializer.deserialize(cursor, false));
-                label = Array.isArray(label) && label.length > 0 ? label[0] : label;
-                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.anySerializer.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);
-            // null properties are deserialized into empty lists
-            const vp_props = properties ? properties : [];
-            const v = new VertexProperty(id, label, value, vp_props);
-            return { v, len };
+    /**
+     * Async deserialization of vertex property value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<VertexProperty>}
+     */
+    async deserializeValue(reader, valueFlag, typeCode) {
+        // {id} fully qualified
+        const id = await this.ioc.anySerializer.deserialize(reader);
+        // {label} bare list, extract first element
+        const labelList = await this.ioc.listSerializer.deserializeValue(reader, 0x00, this.ioc.DataType.LIST);
+        const label = Array.isArray(labelList) && labelList.length > 0 ? labelList[0] : labelList;
+        // {value} fully qualified
+        const value = await this.ioc.anySerializer.deserialize(reader);
+        // {parent} fully qualified (always null in current TinkerPop)
+        await this.ioc.anySerializer.deserialize(reader);
+        // {properties} fully qualified
+        const properties = await this.ioc.anySerializer.deserialize(reader);
+        return new VertexProperty(id, label, value, properties || []);
+    }
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<VertexProperty|null>}
+     */
+    async deserialize(reader) {
+        const type_code = await reader.readUInt8();
+        if (type_code !== this.ioc.DataType.VERTEXPROPERTY) {
+            throw new Error(`VertexPropertySerializer: unexpected {type_code}=0x${type_code.toString(16)}`);
+        }
+        const value_flag = await reader.readUInt8();
+        if (value_flag === 0x01) {
+            return null;
         }
-        catch (err) {
-            throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+        if (value_flag !== 0x00) {
+            throw new Error(`VertexPropertySerializer: unexpected {value_flag}=0x${value_flag.toString(16)}`);
         }
+        return this.deserializeValue(reader, value_flag, type_code);
     }
 }

package/build/esm/structure/io/binary/internals/VertexSerializer.d.ts

@@ -3,15 +3,20 @@ export default class VertexSerializer {
     ioc: any;
     canBeUsedFor(value: any): value is Vertex<any, any, any, any>;
     serialize(item: any, fullyQualifiedFormat?: boolean): Buffer<ArrayBuffer>;
-    deserialize(buffer: any, fullyQualifiedFormat?: boolean, ...args: any[]): {
-        v: null;
-        len: number;
-    } | {
-        v: Vertex<any, Record<string, any>, any, {
-            [x: string]: [import("../../../graph.js").VertexProperty<string, any, Record<string, any>, any>, ...import("../../../graph.js").VertexProperty<string, any, Record<string, any>, any>[]];
-        }>;
-        len: number;
-    };
+    /**
+     * Async deserialization of vertex value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<Vertex>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<Vertex>;
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<Vertex|null>}
+     */
+    deserialize(reader: StreamReader): Promise<Vertex | null>;
 }
 import { Vertex } from '../../../graph.js';
 import { Buffer } from 'buffer';