gremlin 3.7.2 → 3.7.4

package/lib/driver/connection.js

@@ -65,6 +65,7 @@ class Connection extends EventEmitter {
    * @param {Object} [options.headers] An associative array containing the additional header key/values for the initial request.
    * @param {Boolean} [options.enableUserAgentOnConnect] Determines if a user agent will be sent during connection handshake. Defaults to: true
    * @param {http.Agent} [options.agent] The http.Agent implementation to use.
+   * @param {Boolean} [options.enableCompression] Enable per-message deflate compression. Defaults to: false.
    * @constructor
    */
   constructor(url, options) {
@@ -94,6 +95,7 @@ class Connection extends EventEmitter {
     this.traversalSource = options.traversalSource || 'g';
     this._authenticator = options.authenticator;
     this._enableUserAgentOnConnect = options.enableUserAgentOnConnect !== false;
+    this._enableCompression = this.options.enableCompression || false;
   }
 
   /**
@@ -122,12 +124,27 @@ class Connection extends EventEmitter {
         headers[utils.getUserAgentHeader()] = await utils.getUserAgent();
       }
     }
-
-    const WebSocket = globalThis.WebSocket ?? (await import('ws')).default;
+    // All these options are available to the `ws` package's constructor, but not the global WebSocket class
+    const wsSpecificOptions = new Set([
+      'headers',
+      'ca',
+      'cert',
+      'pfx',
+      'rejectUnauthorized',
+      'agent',
+      'perMessageDeflate',
+    ]);
+    // Check if any `ws` specific options are provided and are non-null / non-undefined
+    const hasWsSpecificOptions = Object.entries(this.options).some(
+      ([key, value]) => wsSpecificOptions.has(key) && ![null, undefined].includes(value),
+    );
+    // Only use the global websocket if we don't have any unsupported options
+    const useGlobalWebSocket = !hasWsSpecificOptions && globalThis.WebSocket;
+    const WebSocket = useGlobalWebSocket || (await import('ws')).default;
 
     this._ws = new WebSocket(
       this.url,
-      globalThis.WebSocket === undefined
+      !useGlobalWebSocket
         ? {
             headers: headers,
             ca: this.options.ca,
@@ -135,6 +152,7 @@ class Connection extends EventEmitter {
             pfx: this.options.pfx,
             rejectUnauthorized: this.options.rejectUnauthorized,
             agent: this.options.agent,
+            perMessageDeflate: this._enableCompression,
           }
         : undefined,
     );
@@ -145,6 +163,7 @@ class Connection extends EventEmitter {
 
     this._ws.addEventListener('open', this.#handleOpen);
     this._ws.addEventListener('error', this.#handleError);
+    this._ws.on('unexpected-response', this.#handleUnexpectedResponse);
     this._ws.addEventListener('message', this.#handleMessage);
     this._ws.addEventListener('close', this.#handleClose);
 
@@ -242,6 +261,32 @@ class Connection extends EventEmitter {
     this.isOpen = true;
   };
 
+  /**
+   * @param {ClientRequest} _req
+   * @param {IncomingMessage} res
+   */
+  #handleUnexpectedResponse = async (_req, res) => {
+    const body = await new Promise((resolve, reject) => {
+      const chunks = [];
+      res.on('data', (data) => {
+        chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+      });
+      res.on('end', () => {
+        resolve(chunks.length ? Buffer.concat(chunks) : null);
+      });
+      res.on('error', reject);
+    });
+    const statusCodeErrorMessage = `Unexpected server response code ${res.statusCode}`;
+    const errorMessage = body ? `${statusCodeErrorMessage} with body:\n${body.toString()}` : statusCodeErrorMessage;
+    const error = new Error(errorMessage);
+    this.#handleError({
+      error,
+      message: errorMessage,
+      type: 'unexpected-response',
+      target: this._ws,
+    });
+  };
+
   /**
    * @param {Event} event
    */
@@ -312,6 +357,7 @@ class Connection extends EventEmitter {
 
       return;
     } else if (response.status.code >= 400) {
+      this.#clearHandler(response.requestId);
       // callback in error
       return handler.callback(
         // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
@@ -369,6 +415,7 @@ class Connection extends EventEmitter {
     });
     this._ws.removeEventListener('open', this.#handleOpen);
     this._ws.removeEventListener('error', this.#handleError);
+    this._ws.off('unexpected-response', this.#handleUnexpectedResponse);
     this._ws.removeEventListener('message', this.#handleMessage);
     this._ws.removeEventListener('close', this.#handleClose);
     this._openPromise = null;

package/lib/driver/driver-remote-connection.js

@@ -50,6 +50,7 @@ class DriverRemoteConnection extends RemoteConnection {
    * @param {Object} [options.headers] An associative array containing the additional header key/values for the initial request.
    * @param {Boolean} [options.enableUserAgentOnConnect] Determines if a user agent will be sent during connection handshake. Defaults to: true
    * @param {http.Agent} [options.agent] The http.Agent implementation to use.
+   * @param {Boolean} [options.enableCompression] Enable per-message deflate compression. Defaults to: false.
    * @constructor
    */
   constructor(url, options = {}) {

package/lib/process/graph-traversal.js

@@ -1780,6 +1780,7 @@ const statics = {
   dateAdd: (...args) => callOnEmptyTraversal('dateAdd', args),
   dateDiff: (...args) => callOnEmptyTraversal('dateDiff', args),
   dedup: (...args) => callOnEmptyTraversal('dedup', args),
+  disjunct: (...args) => callOnEmptyTraversal('disjunct', args),
   drop: (...args) => callOnEmptyTraversal('drop', args),
   element: (...args) => callOnEmptyTraversal('element', args),
   elementMap: (...args) => callOnEmptyTraversal('elementMap', args),
@@ -1820,6 +1821,7 @@ const statics = {
   mergeE: (...args) => callOnEmptyTraversal('mergeE', args),
   mergeV: (...args) => callOnEmptyTraversal('mergeV', args),
   min: (...args) => callOnEmptyTraversal('min', args),
+  none: (...args) => callOnEmptyTraversal('none', args),
   not: (...args) => callOnEmptyTraversal('not', args),
   optional: (...args) => callOnEmptyTraversal('optional', args),
   or: (...args) => callOnEmptyTraversal('or', args),

package/lib/process/translator.js

@@ -91,7 +91,7 @@ class Translator {
           }
           script += `('${key}', `;
           if (anyObject[key] instanceof String || typeof anyObject[key] === 'string') {
-            script += `'${anyObject[key]}'`;
+            script += `'${`${anyObject[key]}`.replaceAll("'", "\\'")}'`; // eslint-disable-line quotes
           } else {
             script += anyObject[key];
           }
@@ -106,12 +106,12 @@ class Translator {
       } else {
         script += anyObject.toString();
       }
-    } else if (anyObject === undefined) {
-      script += '';
+    } else if (anyObject === undefined || anyObject === null) {
+      script += 'null';
     } else if (typeof anyObject === 'number' || typeof anyObject === 'boolean') {
       script += anyObject;
     } else {
-      script += `'${anyObject}'`;
+      script += `'${`${anyObject}`.replaceAll("'", "\\'")}'`; // eslint-disable-line quotes
     }
 
     return script;

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

@@ -164,7 +164,10 @@ module.exports = class VertexPropertySerializer {
       // TODO: should we verify that properties is null?
       cursor = cursor.slice(properties_len);
 
-      const v = new g.VertexProperty(id, label, value, properties);
+      // null properties are deserialized into empty lists
+      const vp_props = properties ? properties : [];
+
+      const v = new g.VertexProperty(id, label, value, vp_props);
       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

@@ -127,7 +127,10 @@ module.exports = class VertexSerializer {
       }
       cursor = cursor.slice(properties_len);
 
-      const v = new g.Vertex(id, label, properties);
+      // null properties are deserialized into empty lists
+      const vertex_props = properties ? properties : [];
+
+      const v = new g.Vertex(id, label, vertex_props);
       return { v, len };
     } catch (err) {
       throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });

package/lib/utils.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gremlin",
-  "version": "3.7.2",
+  "version": "3.7.4",
   "description": "JavaScript Gremlin Language Variant",
   "author": "Apache TinkerPop team",
   "keywords": [
@@ -21,16 +21,16 @@
     "ws": "^8.16.0"
   },
   "devDependencies": {
-    "chai": "~4.4.1",
+    "chai": "~4.5.0",
     "chai-string": "~1.5.0",
     "colors": "1.4.0",
     "cross-env": "^7.0.3",
     "cucumber": "~6.0.7",
     "eslint": "^8.42.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.0.0",
     "grunt": "^1.5.3",
-    "grunt-cli": "~1.4.3",
+    "grunt-cli": "~1.5.0",
     "grunt-jsdoc": "~2.4.1",
     "mocha": "^10.2.0",
     "prettier": "^3.0.0"
@@ -59,6 +59,6 @@
     "lint": "eslint --ext .js ."
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }

package/doc/DataType.js.html

@@ -1,149 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: DataType.js</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Source: DataType.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>/*
- *  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
- */
-
-/**
- * Represents a GraphBinary data type.
- *
- * See org.apache.tinkerpop.gremlin.structure.io.binary.DataType Java class.
- */
-const DataType = {
-  INT: 0x01,
-  LONG: 0x02,
-  STRING: 0x03,
-  DATE: 0x04,
-  TIMESTAMP: 0x05,
-  CLASS: 0x06,
-  DOUBLE: 0x07,
-  FLOAT: 0x08,
-  LIST: 0x09,
-  MAP: 0x0a,
-  SET: 0x0b,
-  UUID: 0x0c,
-  EDGE: 0x0d,
-  PATH: 0x0e,
-  PROPERTY: 0x0f,
-  GRAPH: 0x10,
-  VERTEX: 0x11,
-  VERTEXPROPERTY: 0x12,
-  BARRIER: 0x13,
-  BINDING: 0x14,
-  BYTECODE: 0x15,
-  CARDINALITY: 0x16,
-  COLUMN: 0x17,
-  DIRECTION: 0x18,
-  OPERATOR: 0x19,
-  ORDER: 0x1a,
-  PICK: 0x1b,
-  POP: 0x1c,
-  LAMBDA: 0x1d,
-  P: 0x1e,
-  SCOPE: 0x1f,
-  T: 0x20,
-  TRAVERSER: 0x21,
-  BIGDECIMAL: 0x22,
-  BIGINTEGER: 0x23,
-  BYTE: 0x24,
-  BYTEBUFFER: 0x25,
-  SHORT: 0x26,
-  BOOLEAN: 0x27,
-  TEXTP: 0x28,
-  TRAVERSALSTRATEGY: 0x29,
-  BULKSET: 0x2a,
-  TREE: 0x2b,
-  METRICS: 0x2c,
-  TRAVERSALMETRICS: 0x2d,
-  MERGE: 0x2e,
-  DT: 0x2f,
-
-  CHAR: 0x80,
-  DURATION: 0x81,
-  INETADDRESS: 0x82,
-  INSTANT: 0x83,
-  LOCALDATE: 0x84,
-  LOCALDATETIME: 0x85,
-  LOCALTIME: 0x86,
-  MONTHDAY: 0x87,
-  OFFSETDATETIME: 0x88,
-  OFFSETTIME: 0x89,
-  PERIOD: 0x8a,
-  YEAR: 0x8b,
-  YEARMONTH: 0x8c,
-  ZONEDATETIME: 0x8d,
-  ZONEOFFSET: 0x8e,
-
-  CUSTOM: 0,
-  UNSPECIFIED_NULL: 0xfe,
-};
-
-export default DataType;
-</code></pre>
-        </article>
-    </section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 08 2024 22:33:46 GMT-0700 (Pacific Daylight Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

package/doc/GraphBinaryReader.js.html

@@ -1,132 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: GraphBinaryReader.js</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Source: GraphBinaryReader.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>/*
- *  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
- */
-
-import { Buffer } from 'buffer';
-
-/**
- * GraphBinary reader.
- */
-export default 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 &lt; 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;
-  }
-}
-</code></pre>
-        </article>
-    </section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 08 2024 22:33:46 GMT-0700 (Pacific Daylight Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

package/doc/GraphBinaryWriter.js.html

@@ -1,135 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: GraphBinaryWriter.js</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Source: GraphBinaryWriter.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>/*
- *  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
- */
-
-import { Buffer } from 'buffer';
-
-/**
- * GraphBinary writer.
- */
-export default 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,
-    */
-  }
-}
-</code></pre>
-        </article>
-    </section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 08 2024 22:33:46 GMT-0700 (Pacific Daylight Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>