gremlin 3.8.1 → 4.0.0-beta.2

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

@@ -1,142 +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 Jorge Bay Gondra
- */
-'use strict';
-
-const rcModule = require('./remote-connection');
-const RemoteConnection = rcModule.RemoteConnection;
-const RemoteTraversal = rcModule.RemoteTraversal;
-const utils = require('../utils');
-const Client = require('./client');
-const Bytecode = require('../process/bytecode');
-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.
-   * @param {Object} [options] The connection options.
-   * @param {Array} [options.ca] Trusted certificates.
-   * @param {String|Array|Buffer} [options.cert] The certificate key.
-   * @param {String} [options.mimeType] The mime type to use.
-   * @param {String|Buffer} [options.pfx] The private key, certificate, and CA certs.
-   * @param {GraphSONReader} [options.reader] The reader to use.
-   * @param {Boolean} [options.rejectUnauthorized] Determines whether to verify or not the server certificate.
-   * @param {String} [options.traversalSource] The traversal source. Defaults to: 'g'.
-   * @param {GraphSONWriter} [options.writer] The writer to use.
-   * @param {Authenticator} [options.authenticator] The authentication handler to use.
-   * @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 = {}) {
-    super(url, options);
-    this._client = new Client(url, options);
-  }
-
-  /** @override */
-  open() {
-    return this._client.open();
-  }
-
-  /** @override */
-  get isOpen() {
-    return this._client.isOpen;
-  }
-
-  /** @override */
-  submit(bytecode) {
-    const optionsStrategy = bytecode.sourceInstructions.find(
-      (i) => i[0] === 'withStrategies' && i[1] instanceof OptionsStrategy,
-    );
-    const allowedKeys = [
-      'evaluationTimeout',
-      'scriptEvaluationTimeout',
-      'batchSize',
-      'requestId',
-      'userAgent',
-      'materializeProperties',
-    ];
-
-    let requestOptions = undefined;
-    if (optionsStrategy !== undefined) {
-      requestOptions = {};
-      const conf = optionsStrategy[1].configuration;
-      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()));
-  }
-
-  /** @override */
-  createSession() {
-    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);
-    copiedOptions.session = utils.getUuid();
-    return new DriverRemoteConnection(this.url, copiedOptions);
-  }
-
-  /** @override */
-  get isSessionBound() {
-    return this.options.session;
-  }
-
-  /** @override */
-  commit() {
-    return this._client.submit(Bytecode.GraphOp.commit, null);
-  }
-
-  /** @override */
-  rollback() {
-    return this._client.submit(Bytecode.GraphOp.rollback, null);
-  }
-
-  /** @override */
-  close() {
-    return this._client.close();
-  }
-
-  /** @override */
-  addListener(...args) {
-    return this._client.addListener(...args);
-  }
-
-  /** @override */
-  removeListener(...args) {
-    return this._client.removeListener(...args);
-  }
-}
-
-module.exports = DriverRemoteConnection;

package/lib/driver/remote-connection.js

@@ -1,147 +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 Jorge Bay Gondra
- */
-'use strict';
-
-const t = require('../process/traversal');
-const TraversalStrategy = require('../process/traversal-strategy').TraversalStrategy;
-
-/**
- * Represents an abstraction of a "connection" to a "server" that is capable of processing a traversal and
- * returning results.
- */
-class RemoteConnection {
-  /**
-   * @param {String} url The resource uri.
-   * @param {Object} [options] The connection options.
-   */
-  constructor(url, options = {}) {
-    this.url = url;
-    this.options = options;
-  }
-
-  /**
-   * Opens the connection, if its not already opened.
-   * @returns {Promise}
-   */
-  open() {
-    throw new Error('open() must be implemented');
-  }
-
-  /**
-   * Returns true if connection is open
-   * @returns {Boolean}
-   */
-  get isOpen() {
-    throw new Error('isOpen() must be implemented');
-  }
-
-  /**
-   * Determines if the connection is already bound to a session. If so, this indicates that the
-   * <code>#createSession()</code> cannot be called so as to produce child sessions.
-   * @returns {boolean}
-   */
-  get isSessionBound() {
-    return false;
-  }
-
-  /**
-   * Submits the <code>Bytecode</code> provided and returns a <code>RemoteTraversal</code>.
-   * @abstract
-   * @param {Bytecode} bytecode
-   * @returns {Promise} Returns a <code>Promise</code> that resolves to a <code>RemoteTraversal</code>.
-   */
-  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.
-   * If the connection is already session bound then this function should throw an exception.
-   * @returns {RemoteConnection}
-   */
-  createSession() {
-    throw new Error('createSession() must be implemented');
-  }
-
-  /**
-   * Submits a <code>Bytecode.GraphOp.commit</code> to the server and closes the connection.
-   * @returns {Promise}
-   */
-  commit() {
-    throw new Error('commit() must be implemented');
-  }
-  /**
-   * Submits a <code>Bytecode.GraphOp.rollback</code> to the server and closes the connection.
-   * @returns {Promise}
-   */
-  rollback() {
-    throw new Error('rollback() must be implemented');
-  }
-
-  /**
-   * Closes the connection where open transactions will close according to the features of the graph provider.
-   * @returns {Promise}
-   */
-  close() {
-    throw new Error('close() must be implemented');
-  }
-}
-
-/**
- * Represents a traversal as a result of a {@link RemoteConnection} submission.
- */
-class RemoteTraversal extends t.Traversal {
-  constructor(traversers, sideEffects) {
-    super(null, null, null);
-    this.traversers = traversers;
-    this.sideEffects = sideEffects;
-  }
-}
-
-class RemoteStrategy extends TraversalStrategy {
-  /**
-   * Creates a new instance of RemoteStrategy.
-   * @param {RemoteConnection} connection
-   */
-  constructor(connection) {
-    // 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');
-    this.connection = connection;
-  }
-
-  /** @override */
-  apply(traversal) {
-    if (traversal.traversers) {
-      return Promise.resolve();
-    }
-
-    return this.connection.submit(traversal.getBytecode()).then(function (remoteTraversal) {
-      traversal.sideEffects = remoteTraversal.sideEffects;
-      traversal.traversers = remoteTraversal.traversers;
-    });
-  }
-}
-
-module.exports = { RemoteConnection, RemoteStrategy, RemoteTraversal };

package/lib/driver/result-set.js

@@ -1,83 +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 Jorge Bay Gondra
- */
-'use strict';
-
-const utils = require('../utils');
-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
-   * @param {Map} [attributes]
-   */
-  constructor(items, attributes) {
-    if (!Array.isArray(items)) {
-      throw new TypeError('items must be an Array instance');
-    }
-
-    this._items = items;
-
-    /**
-     * Gets a Map representing the attributes of the response.
-     * @type {Map}
-     */
-    this.attributes = attributes || emptyMap;
-
-    /**
-     * Gets the amount of items in the result.
-     * @type {Number}
-     */
-    this.length = items.length;
-  }
-
-  /**
-   * Gets the iterator associated with this instance.
-   * @returns {Iterator}
-   */
-  [Symbol.iterator]() {
-    return this._items[Symbol.iterator]();
-  }
-
-  /**
-   * Gets an array of result items.
-   * @returns {Array}
-   */
-  toArray() {
-    return this._items;
-  }
-
-  /**
-   * Returns the first item.
-   * @returns {Object|null}
-   */
-  first() {
-    const item = this._items[0];
-    return item !== undefined ? item : null;
-  }
-}
-
-module.exports = ResultSet;

package/lib/process/anonymous-traversal.js

@@ -1,87 +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.
- */
-
-'use strict';
-
-const graphTraversalModule = require('./graph-traversal');
-const remote = require('../driver/remote-connection');
-const TraversalStrategies = require('./traversal-strategy').TraversalStrategies;
-const GraphTraversalSource = graphTraversalModule.GraphTraversalSource;
-const GraphTraversal = graphTraversalModule.GraphTraversal;
-const Bytecode = require('./bytecode');
-const Graph = require('../structure/graph').Graph;
-
-/**
- * Provides a unified way to construct a <code>TraversalSource</code> from the perspective of the traversal. In this
- * syntax the user is creating the source and binding it to a reference which is either an existing <code>Graph</code>
- * instance or a <code>RemoteConnection</code>.
- */
-class AnonymousTraversalSource {
-  /**
-   * Creates a new instance of {@code AnonymousTraversalSource}.
-   * @param {Function} [traversalSourceClass] Optional {@code GraphTraversalSource} constructor.
-   * @param {Function} [traversalClass] Optional {@code GraphTraversal} constructor.
-   */
-  constructor(traversalSourceClass, traversalClass) {
-    this.traversalSourceClass = traversalSourceClass;
-    this.traversalClass = traversalClass;
-  }
-
-  /**
-   * Constructs an {@code AnonymousTraversalSource} which will then be configured to spawn a
-   * {@link GraphTraversalSource}.
-   * @param {Function} [traversalSourceClass] Optional {@code GraphTraversalSource} constructor.
-   * @param {Function} [traversalClass] Optional {@code GraphTraversalSource} constructor.
-   * @returns {AnonymousTraversalSource}.
-   */
-  static traversal(traversalSourceClass, traversalClass) {
-    return new AnonymousTraversalSource(traversalSourceClass || GraphTraversalSource, traversalClass || GraphTraversal);
-  }
-
-  /**
-   * Creates a {@link GraphTraversalSource} binding a {@link RemoteConnection} to a remote {@link Graph} instances as its
-   * reference so that traversals spawned from it will execute over that reference.
-   * @param {RemoteConnection} connection
-   * @return {GraphTraversalSource}
-   */
-  with_(connection) {
-    const traversalStrategies = new TraversalStrategies();
-    traversalStrategies.addStrategy(new remote.RemoteStrategy(connection));
-    return new this.traversalSourceClass(
-      new Graph(),
-      traversalStrategies,
-      new Bytecode(),
-      this.traversalSourceClass,
-      this.traversalClass,
-    );
-  }
-
-  /**
-   * Creates a {@link GraphTraversalSource} binding a {@link RemoteConnection} to a remote {@link Graph} instances as its
-   * reference so that traversals spawned from it will execute over that reference.
-   * @param {RemoteConnection} remoteConnection
-   * @return {GraphTraversalSource}
-   * @deprecated As of release 3.8.0, prefer {@link with_}.
-   */
-  withRemote(remoteConnection) {
-    return this.with_(remoteConnection);
-  }
-}
-
-module.exports = AnonymousTraversalSource;

package/lib/process/bytecode.js

@@ -1,124 +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 Jorge Bay Gondra
- */
-'use strict';
-
-const { Traversal } = require('./traversal');
-
-class Bytecode {
-  /**
-   * Creates a new instance of Bytecode
-   * @param {Bytecode} [toClone]
-   */
-  constructor(toClone) {
-    if (!toClone) {
-      this.sourceInstructions = [];
-      this.stepInstructions = [];
-    } else {
-      this.sourceInstructions = [...toClone.sourceInstructions];
-      this.stepInstructions = [...toClone.stepInstructions];
-    }
-  }
-
-  /**
-   * Adds a new source instructions
-   * @param {String} name
-   * @param {Array} values
-   * @returns {Bytecode}
-   */
-  addSource(name, values) {
-    if (name === undefined) {
-      throw new Error('Name is not defined');
-    }
-    const instruction = new Array(values.length + 1);
-    instruction[0] = name;
-    for (let i = 0; i < values.length; ++i) {
-      instruction[i + 1] = values[i];
-    }
-    this.sourceInstructions.push(Bytecode._generateInstruction(name, values));
-    return this;
-  }
-
-  /**
-   * Adds a new step instructions
-   * @param {String} name
-   * @param {Array} values
-   * @returns {Bytecode}
-   */
-  addStep(name, values) {
-    if (name === undefined) {
-      throw new Error('Name is not defined');
-    }
-    this.stepInstructions.push(Bytecode._generateInstruction(name, values));
-    return this;
-  }
-
-  static _generateInstruction(name, values) {
-    const length = (values ? values.length : 0) + 1;
-    const instruction = new Array(length);
-    instruction[0] = name;
-    for (let i = 1; i < length; i++) {
-      const val = values[i - 1];
-      if (val instanceof Traversal && val.graph != null) {
-        throw new Error(
-          `The child traversal of ${val} was not spawned anonymously - use ` +
-            'the __ class rather than a TraversalSource to construct the child traversal',
-        );
-      }
-      instruction[i] = val;
-    }
-    return instruction;
-  }
-
-  /**
-   * Returns the JSON representation of the source and step instructions
-   * @returns {String}
-   */
-  toString() {
-    return JSON.stringify([this.sourceInstructions, this.stepInstructions]);
-  }
-
-  /**
-   * Adds a new source instructions
-   * @param {String} name
-   * @param {Array} values
-   * @returns {Bytecode}
-   */
-  static _createGraphOp(name, values) {
-    const bc = new Bytecode();
-    bc.addSource(name, values);
-    return bc;
-  }
-
-  /**
-   * Gets the <code>Bytecode</code> that is meant to be sent as "graph operations" to the server.
-   * @returns {{rollback: Bytecode, commit: Bytecode}}
-   */
-  static get GraphOp() {
-    return {
-      commit: Bytecode._createGraphOp('tx', ['commit']),
-      rollback: Bytecode._createGraphOp('tx', ['rollback']),
-    };
-  }
-}
-
-module.exports = Bytecode;