gremlin 3.5.2 → 3.5.3

package/doc/driver_connection.js.html

@@ -51,19 +51,19 @@
 'use strict';
 
 const EventEmitter = require('events');
+const Stream = require('stream');
 const WebSocket = require('ws');
 const util = require('util');
 const utils = require('../utils');
 const serializer = require('../structure/io/graph-serializer');
 const ResultSet = require('./result-set');
 const ResponseError = require('./response-error');
-const Bytecode = require('../process/bytecode');
 
 const responseStatusCode = {
   success: 200,
   noContent: 204,
   partialContent: 206,
-  authenticationChallenge:  407,
+  authenticationChallenge: 407,
 };
 
 const defaultMimeType = 'application/vnd.gremlin-v3.0+json';
@@ -76,7 +76,6 @@ const pongTimeoutDelay = 30 * 1000;
  * Represents a single connection to a Gremlin Server.
  */
 class Connection extends EventEmitter {
-
   /**
    * Creates a new instance of {@link Connection}.
    * @param {String} url The resource uri.
@@ -120,7 +119,8 @@ class Connection extends EventEmitter {
     this._pingInterval = null;
     this._pongTimeout = null;
 
-    this._header = String.fromCharCode(this.mimeType.length) + this.mimeType;
+    this._header = String.fromCharCode(this.mimeType.length) + this.mimeType; // TODO: what if mimeType.length > 255
+    this._header_buf = Buffer.from(this._header);
     this.isOpen = false;
     this.traversalSource = options.traversalSource || 'g';
     this._authenticator = options.authenticator;
@@ -146,14 +146,14 @@ class Connection extends EventEmitter {
       return this._openPromise;
     }
 
-    this.emit('log', `ws open`);
+    this.emit('log', 'ws open');
 
     this._ws = new WebSocket(this.url, {
       headers: this.options.headers,
       ca: this.options.ca,
       cert: this.options.cert,
       pfx: this.options.pfx,
-      rejectUnauthorized: this.options.rejectUnauthorized
+      rejectUnauthorized: this.options.rejectUnauthorized,
     });
 
     this._ws.on('message', (data) => this._handleMessage(data));
@@ -171,7 +171,7 @@ class Connection extends EventEmitter {
       this._ws.pong();
     });
 
-    return this._openPromise = new Promise((resolve, reject) => {
+    return (this._openPromise = new Promise((resolve, reject) => {
       this._ws.on('open', () => {
         this.isOpen = true;
         if (this._pingEnabled) {
@@ -183,59 +183,79 @@ class Connection extends EventEmitter {
         this._handleError(err);
         reject(err);
       });
-    });
+    }));
   }
 
   /** @override */
   submit(processor, op, args, requestId) {
     const rid = requestId || utils.getUuid();
-    return this.open().then(() => new Promise((resolve, reject) => {
-      if (op !== 'authentication') {
-        this._responseHandlers[rid] = {
-          callback: (err, result) => err ? reject(err) : resolve(result),
-          result: null
+    return this.open().then(
+      () =>
+        new Promise((resolve, reject) => {
+          if (op !== 'authentication') {
+            this._responseHandlers[rid] = {
+              callback: (err, result) => (err ? reject(err) : resolve(result)),
+              result: null,
+            };
+          }
+
+          const request = {
+            requestId: rid,
+            op: op || 'bytecode',
+            // if using op eval need to ensure processor stays unset if caller didn't set it.
+            processor: !processor && op !== 'eval' ? 'traversal' : processor,
+            args: args || {},
+          };
+
+          const request_buf = this._writer.writeRequest(request);
+          const message = Buffer.concat([this._header_buf, request_buf], this._header_buf.length + request_buf.length);
+          this._ws.send(message);
+        }),
+    );
+  }
+
+  /** @override */
+  stream(processor, op, args, requestId) {
+    const rid = requestId || utils.getUuid();
+
+    const readableStream = new Stream.Readable({
+      objectMode: true,
+      read() {},
+    });
+
+    this._responseHandlers[rid] = {
+      callback: (err) => (err ? readableStream.destroy(err) : readableStream.push(null)),
+      result: readableStream,
+    };
+
+    this.open()
+      .then(() => {
+        const request = {
+          requestId: rid,
+          op: op || 'bytecode',
+          // if using op eval need to ensure processor stays unset if caller didn't set it.
+          processor: !processor && op !== 'eval' ? 'traversal' : processor,
+          args: args || {},
         };
-      }
 
-      const message = Buffer.from(this._header + JSON.stringify(this._getRequest(rid, op, args, processor)));
-      this._ws.send(message);
-    }));
+        const request_buf = this._writer.writeRequest(request);
+        const message = Buffer.concat([this._header_buf, request_buf], this._header_buf.length + request_buf.length);
+        this._ws.send(message);
+      })
+      .catch((err) => readableStream.destroy(err));
+
+    return readableStream;
   }
 
   _getDefaultReader(mimeType) {
-    return mimeType === graphSON2MimeType
-      ? new serializer.GraphSON2Reader()
-      : new serializer.GraphSONReader();
+    return mimeType === graphSON2MimeType ? new serializer.GraphSON2Reader() : new serializer.GraphSONReader();
   }
 
   _getDefaultWriter(mimeType) {
-    return mimeType === graphSON2MimeType
-      ? new serializer.GraphSON2Writer()
-      : new serializer.GraphSONWriter();
-  }
-
-  _getRequest(id, op, args, processor) {
-    if (args) {
-      args = this._adaptArgs(args, true);
-    } else {
-      args = {};
-    }
-
-    if (args['gremlin'] instanceof Bytecode) {
-      args['gremlin'] = this._writer.adaptObject(args['gremlin']);
-    }
-
-    return ({
-      'requestId': { '@type': 'g:UUID', '@value': id },
-      'op': op || 'bytecode',
-      // if using op eval need to ensure processor stays unset if caller didn't set it.
-      'processor': (!processor && op !== 'eval') ? 'traversal' : processor,
-      'args': args
-    });
+    return mimeType === graphSON2MimeType ? new serializer.GraphSON2Writer() : new serializer.GraphSONWriter();
   }
 
   _pingHeartbeat() {
-
     if (this._pingInterval) {
       clearInterval(this._pingInterval);
       this._pingInterval = null;
@@ -255,7 +275,6 @@ class Connection extends EventEmitter {
       }, this._pongTimeoutDelay);
 
       this._ws.ping();
-
     }, this._pingIntervalDelay);
   }
 
@@ -275,22 +294,30 @@ class Connection extends EventEmitter {
   }
 
   _handleMessage(data) {
-    const response = this._reader.read(JSON.parse(data.toString()));
+    const response = this._reader.readResponse(data);
     if (response.requestId === null || response.requestId === undefined) {
       // There was a serialization issue on the server that prevented the parsing of the request id
       // We invoke any of the pending handlers with an error
-      Object.keys(this._responseHandlers).forEach(requestId => {
+      Object.keys(this._responseHandlers).forEach((requestId) => {
         const handler = this._responseHandlers[requestId];
         this._clearHandler(requestId);
         if (response.status !== undefined && response.status.message) {
           return handler.callback(
             // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
-            new ResponseError(util.format(
-              'Server error (no request information): %s (%d)', response.status.message, response.status.code), response.status));
-        } else {
-           // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
-          return handler.callback(new ResponseError(util.format('Server error (no request information): %j', response), response.status));
+            new ResponseError(
+              util.format(
+                'Server error (no request information): %s (%d)',
+                response.status.message,
+                response.status.code,
+              ),
+              response.status,
+            ),
+          );
         }
+        // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
+        return handler.callback(
+          new ResponseError(util.format('Server error (no request information): %j', response), response.status),
+        );
       });
       return;
     }
@@ -304,31 +331,49 @@ class Connection extends EventEmitter {
     }
 
     if (response.status.code === responseStatusCode.authenticationChallenge && this._authenticator) {
-      this._authenticator.evaluateChallenge(response.result.data).then(res => {
-        return this.submit(undefined, 'authentication', res, response.requestId);
-      }).catch(handler.callback);
+      this._authenticator
+        .evaluateChallenge(response.result.data)
+        .then((res) => this.submit(undefined, 'authentication', res, response.requestId))
+        .catch(handler.callback);
 
       return;
-    }
-    else if (response.status.code >= 400) {
+    } else if (response.status.code >= 400) {
       // 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
-        new ResponseError(util.format('Server error: %s (%d)', response.status.message, response.status.code), response.status));
+        new ResponseError(
+          util.format('Server error: %s (%d)', response.status.message, response.status.code),
+          response.status,
+        ),
+      );
     }
+
+    const isStreamingResponse = handler.result instanceof Stream.Readable;
+
     switch (response.status.code) {
       case responseStatusCode.noContent:
         this._clearHandler(response.requestId);
+        if (isStreamingResponse) {
+          handler.result.push(new ResultSet(utils.emptyArray, response.status.attributes));
+          return handler.callback(null);
+        }
         return handler.callback(null, new ResultSet(utils.emptyArray, response.status.attributes));
       case responseStatusCode.partialContent:
+        if (isStreamingResponse) {
+          handler.result.push(new ResultSet(response.result.data, response.status.attributes));
+          break;
+        }
         handler.result = handler.result || [];
         handler.result.push.apply(handler.result, response.result.data);
         break;
       default:
+        if (isStreamingResponse) {
+          handler.result.push(new ResultSet(response.result.data, response.status.attributes));
+          return handler.callback(null);
+        }
         if (handler.result) {
           handler.result.push.apply(handler.result, response.result.data);
-        }
-        else {
+        } else {
           handler.result = response.result.data;
         }
         this._clearHandler(response.requestId);
@@ -364,32 +409,6 @@ class Connection extends EventEmitter {
     delete this._responseHandlers[requestId];
   }
 
-  /**
-   * Takes the given args map and ensures all arguments are passed through to _write.adaptObject
-   * @param {Object} args Map of arguments to process.
-   * @param {Boolean} protocolLevel Determines whether it's a protocol level binding.
-   * @returns {Object}
-   * @private
-   */
-  _adaptArgs(args, protocolLevel) {
-    if (args instanceof Object) {
-      let newObj = {};
-      Object.keys(args).forEach((key) => {
-        // bindings key (at the protocol-level needs special handling. without this, it wraps the generated Map
-        // in another map for types like EnumValue. Could be a nicer way to do this but for now it's solving the
-        // problem with script submission of non JSON native types
-        if (protocolLevel && key === 'bindings')
-          newObj[key] = this._adaptArgs(args[key], false);
-        else
-          newObj[key] = this._writer.adaptObject(args[key]);
-      });
-
-      return newObj;
-    }
-
-    return args;
-  }
-
   /**
    * Closes the Connection.
    * @return {Promise}
@@ -399,7 +418,7 @@ class Connection extends EventEmitter {
       return Promise.resolve();
     }
     if (!this._closePromise) {
-      this._closePromise = new Promise(resolve => {
+      this._closePromise = new Promise((resolve) => {
         this._closeCallback = resolve;
         this._ws.close();
       });
@@ -425,7 +444,7 @@ module.exports = Connection;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/driver_driver-remote-connection.js.html

@@ -62,7 +62,6 @@ const OptionsStrategy = require('../process/traversal-strategy').OptionsStrategy
  * Represents the default {@link RemoteConnection} implementation.
  */
 class DriverRemoteConnection extends RemoteConnection {
-
   /**
    * Creates a new instance of {@link DriverRemoteConnection}.
    * @param {String} url The resource uri.
@@ -96,28 +95,30 @@ class DriverRemoteConnection extends RemoteConnection {
 
   /** @override */
   submit(bytecode) {
-    let optionsStrategy = bytecode.sourceInstructions.find(
-        i => i[0] === "withStrategies" && i[1] instanceof OptionsStrategy);
+    const optionsStrategy = bytecode.sourceInstructions.find(
+      (i) => i[0] === 'withStrategies' && i[1] instanceof OptionsStrategy,
+    );
     const allowedKeys = ['evaluationTimeout', 'scriptEvaluationTimeout', 'batchSize', 'requestId', 'userAgent'];
 
     let requestOptions = undefined;
     if (optionsStrategy !== undefined) {
       requestOptions = {};
       const conf = optionsStrategy[1].configuration;
-      for (let key in conf) {
+      for (const key in conf) {
         if (conf.hasOwnProperty(key) && allowedKeys.indexOf(key) > -1) {
           requestOptions[key] = conf[key];
         }
       }
     }
 
-    return this._client.submit(bytecode, null, requestOptions).then(result => new RemoteTraversal(result.toArray()));
+    return this._client.submit(bytecode, null, requestOptions).then((result) => new RemoteTraversal(result.toArray()));
   }
 
   /** @override */
   createSession() {
-    if (this.isSessionBound)
-      throw new Error("Connection is already bound to a session - child sessions are not allowed");
+    if (this.isSessionBound) {
+      throw new Error('Connection is already bound to a session - child sessions are not allowed');
+    }
 
     // make sure a fresh session is used when starting a new transaction
     const copiedOptions = Object.assign({}, this.options);
@@ -132,12 +133,12 @@ class DriverRemoteConnection extends RemoteConnection {
 
   /** @override */
   commit() {
-    return this._client.submit(Bytecode.GraphOp.commit, null)
+    return this._client.submit(Bytecode.GraphOp.commit, null);
   }
 
   /** @override */
   rollback() {
-    return this._client.submit(Bytecode.GraphOp.rollback, null)
+    return this._client.submit(Bytecode.GraphOp.rollback, null);
   }
 
   /** @override */
@@ -173,7 +174,7 @@ module.exports = DriverRemoteConnection;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/driver_remote-connection.js.html

@@ -58,7 +58,6 @@ const TraversalStrategy = require('../process/traversal-strategy').TraversalStra
  * returning results.
  */
 class RemoteConnection {
-
   /**
    * @param {String} url The resource uri.
    * @param {Object} [options] The connection options.
@@ -101,7 +100,7 @@ class RemoteConnection {
    */
   submit(bytecode) {
     throw new Error('submit() must be implemented');
-  };
+  }
 
   /**
    * Create a new <code>RemoteConnection</code> that is bound to a session using the configuration from this one.
@@ -156,7 +155,7 @@ class RemoteStrategy extends TraversalStrategy {
     // gave this a fqcn that has a local "js:" prefix since this strategy isn't sent as bytecode to the server.
     // this is a sort of local-only strategy that actually executes client side. not sure if this prefix is the
     // right way to name this or not, but it should have a name to identify it.
-    super("js:RemoteStrategy");
+    super('js:RemoteStrategy');
     this.connection = connection;
   }
 
@@ -190,7 +189,7 @@ module.exports = { RemoteConnection, RemoteStrategy, RemoteTraversal };
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/driver_response-error.js.html

@@ -53,7 +53,7 @@
 class ResponseError extends Error {
   constructor(message, responseStatus) {
     super(message);
-    this.name = "ResponseError";
+    this.name = 'ResponseError';
 
     /**
      * Gets the server status code.
@@ -72,7 +72,8 @@ class ResponseError extends Error {
   }
 }
 
-module.exports = ResponseError;</code></pre>
+module.exports = ResponseError;
+</code></pre>
         </article>
     </section>
 
@@ -88,7 +89,7 @@ module.exports = ResponseError;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/driver_result-set.js.html

@@ -59,7 +59,6 @@ const emptyMap = Object.freeze(new utils.ImmutableMap());
  * Represents the response returned from the execution of a Gremlin traversal or script.
  */
 class ResultSet {
-
   /**
    * Creates a new instance of {@link ResultSet}.
    * @param {Array} items
@@ -118,7 +117,8 @@ class ResultSet {
   }
 }
 
-module.exports = ResultSet;</code></pre>
+module.exports = ResultSet;
+</code></pre>
         </article>
     </section>
 
@@ -134,7 +134,7 @@ module.exports = ResultSet;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>