gremlin 3.8.0 → 4.0.0-beta.2

package/lib/process/transaction.js

@@ -1,100 +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 remote = require('../driver/remote-connection');
-const Bytecode = require('./bytecode');
-const { TraversalStrategies } = require('./traversal-strategy');
-
-/**
- * A controller for a remote transaction that is constructed from <code>g.tx()</code>. Calling <code>begin()</code>
- * on this object will produce a new <code>GraphTraversalSource</code> that is bound to a remote transaction over which
- * multiple traversals may be executed in that context. Calling <code>commit()</code> or <code>rollback()</code> will
- * then close the transaction and thus, the session. This feature only works with transaction enabled graphs.
- */
-class Transaction {
-  constructor(g) {
-    this._g = g;
-    this._sessionBasedConnection = undefined;
-  }
-
-  /**
-   * Spawns a <code>GraphTraversalSource</code> that is bound to a remote session which enables a transaction.
-   * @returns {*}
-   */
-  begin() {
-    if (this._sessionBasedConnection) {
-      throw new Error('Transaction already started on this object');
-    }
-
-    this._sessionBasedConnection = this._g.remoteConnection.createSession();
-    const traversalStrategy = new TraversalStrategies();
-    traversalStrategy.addStrategy(new remote.RemoteStrategy(this._sessionBasedConnection));
-    return new this._g.graphTraversalSourceClass(
-      this._g.graph,
-      traversalStrategy,
-      new Bytecode(this._g.bytecode),
-      this._g.graphTraversalSourceClass,
-      this._g.graphTraversalClass,
-    );
-  }
-
-  /**
-   * @returns {Promise}
-   */
-  commit() {
-    if (!this._sessionBasedConnection) {
-      throw new Error('Cannot commit a transaction that is not started');
-    }
-
-    return this._sessionBasedConnection.commit().finally(() => this.close());
-  }
-
-  /**
-   * @returns {Promise}
-   */
-  rollback() {
-    if (!this._sessionBasedConnection) {
-      throw new Error('Cannot rollback a transaction that is not started');
-    }
-
-    return this._sessionBasedConnection.rollback().finally(() => this.close());
-  }
-
-  /**
-   * Returns true if transaction is open.
-   * @returns {Boolean}
-   */
-  get isOpen() {
-    return this._sessionBasedConnection.isOpen;
-  }
-
-  /**
-   * @returns {Promise}
-   */
-  close() {
-    if (this._sessionBasedConnection) {
-      this._sessionBasedConnection.close();
-    }
-  }
-}
-
-module.exports = {
-  Transaction,
-};

package/lib/process/translator.js

@@ -1,121 +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 Traversal = require('./traversal').Traversal;
-const Bytecode = require('./bytecode');
-
-/**
- * Class to translate glv bytecode steps into executable Gremlin-Groovy script
- */
-class Translator {
-  constructor(traversalSource) {
-    this._traversalSource = traversalSource;
-  }
-
-  getTraversalSource() {
-    return this._traversalSource;
-  }
-
-  getTargetLanguage() {
-    return 'gremlin-groovy';
-  }
-
-  of(traversalSource) {
-    this._traversalSource = traversalSource;
-  }
-
-  /**
-   * Returns a script representation of the given bytecode instructions.
-   * @param {Object} bytecodeOrTraversal The traversal or bytecode of a traversal containing step instructions.
-   * @param {boolean} child Determines if a traversal object should be treated as an anonymous child or if it is a spawn from "g"
-   * @returns {string} Gremlin-Groovy script
-   */
-  translate(bytecodeOrTraversal, child = false) {
-    let script = child ? '__' : this._traversalSource;
-    const bc = bytecodeOrTraversal instanceof Bytecode ? bytecodeOrTraversal : bytecodeOrTraversal.getBytecode();
-
-    const instructions = bc.stepInstructions;
-
-    // build the script from the glv instructions.
-    for (let i = 0; i < instructions.length; i++) {
-      const params = instructions[i].slice(1);
-      script += '.' + instructions[i][0] + '(';
-
-      if (params.length) {
-        for (let k = 0; k < params.length; k++) {
-          if (k > 0) {
-            script += ', ';
-          }
-
-          script += this.convert(params[k]);
-        }
-      }
-
-      script += ')';
-    }
-
-    return script;
-  }
-
-  /**
-   * Converts an object to a Gremlin script representation.
-   * @param {Object} anyObject The object to convert to a script representation
-   * @returns {string} The Gremlin script representation
-   */
-  convert(anyObject) {
-    let script = '';
-    if (Object(anyObject) === anyObject) {
-      if (anyObject instanceof Traversal) {
-        script += this.translate(anyObject.getBytecode(), true);
-      } else if (anyObject.toString() === '[object Object]') {
-        Object.keys(anyObject).forEach(function (key, index) {
-          if (index > 0) {
-            script += ', ';
-          }
-          script += `('${key}', `;
-          if (anyObject[key] instanceof String || typeof anyObject[key] === 'string') {
-            script += `'${`${anyObject[key]}`.replaceAll("'", "\\'")}'`; // eslint-disable-line quotes
-          } else {
-            script += anyObject[key];
-          }
-          script += ')';
-        });
-      } else if (Array.isArray(anyObject)) {
-        const parts = [];
-        for (const item of anyObject) {
-          parts.push(this.convert(item));
-        }
-        script += '[' + parts.join(', ') + ']';
-      } else {
-        script += anyObject.toString();
-      }
-    } else if (anyObject === undefined || anyObject === null) {
-      script += 'null';
-    } else if (typeof anyObject === 'number' || typeof anyObject === 'boolean') {
-      script += anyObject;
-    } else {
-      script += `'${`${anyObject}`.replaceAll("'", "\\'")}'`; // eslint-disable-line quotes
-    }
-
-    return script;
-  }
-}
-
-module.exports = Translator;

package/lib/process/traversal-strategy.js

@@ -1,415 +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').Traversal;
-
-class TraversalStrategies {
-  /**
-   * Creates a new instance of TraversalStrategies.
-   * @param {TraversalStrategies} [parent] The parent strategies from where to clone the values from.
-   * @constructor
-   */
-  constructor(parent) {
-    if (parent) {
-      // Clone the strategies
-      this.strategies = [...parent.strategies];
-    } else {
-      this.strategies = [];
-    }
-  }
-
-  /** @param {TraversalStrategy} strategy */
-  addStrategy(strategy) {
-    this.strategies.push(strategy);
-  }
-
-  /** @param {TraversalStrategy} strategy */
-  removeStrategy(strategy) {
-    const idx = this.strategies.findIndex((s) => s.fqcn === strategy.fqcn);
-    if (idx !== -1) {
-      return this.strategies.splice(idx, 1)[0];
-    }
-
-    return undefined;
-  }
-
-  /**
-   * @param {Traversal} traversal
-   * @returns {Promise}
-   */
-  applyStrategies(traversal) {
-    // Apply all strategies serially
-    return this.strategies.reduce(
-      (promise, strategy) => promise.then(() => strategy.apply(traversal)),
-      Promise.resolve(),
-    );
-  }
-}
-
-/** @abstract */
-class TraversalStrategy {
-  /**
-   * @param {String} fqcn fully qualified class name in Java of the strategy
-   * @param {Object} configuration for the strategy
-   */
-  constructor(fqcn, configuration = {}) {
-    this.fqcn = fqcn;
-    this.configuration = configuration;
-  }
-
-  /**
-   * @abstract
-   * @param {Traversal} traversal
-   * @returns {Promise}
-   */
-  apply(traversal) {}
-}
-
-class ConnectiveStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.ConnectiveStrategy');
-  }
-}
-
-class ElementIdStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.ElementIdStrategy');
-  }
-}
-
-class HaltedTraverserStrategy extends TraversalStrategy {
-  /**
-   * @param {String} haltedTraverserFactory full qualified class name in Java of a {@code HaltedTraverserFactory} implementation
-   */
-  constructor({ haltedTraverserFactory } = {}) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.HaltedTraverserStrategy');
-    if (haltedTraverserFactory !== undefined) {
-      this.configuration['haltedTraverserFactory'] = haltedTraverserFactory;
-    }
-  }
-}
-
-class MessagePassingReductionStrategy extends TraversalStrategy {
-  constructor() {
-    super(
-      'org.apache.tinkerpop.gremlin.process.computer.traversal.strategy.optimization.MessagePassingReductionStrategy',
-    );
-  }
-}
-
-class OptionsStrategy extends TraversalStrategy {
-  constructor(options) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.OptionsStrategy');
-    if (options !== undefined) {
-      this.configuration = options;
-    }
-  }
-}
-
-class PartitionStrategy extends TraversalStrategy {
-  /**
-   * @param {Object} [options]
-   * @param {String} [options.partitionKey] name of the property key to partition by
-   * @param {String} [options.writePartition] the value of the currently write partition
-   * @param {Array<String>} [options.readPartitions] list of strings representing the partitions to include for reads
-   * @param {boolean} [options.includeMetaProperties] determines if meta-properties should be included in partitioning defaulting to false
-   */
-  constructor(options) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.PartitionStrategy', options);
-  }
-}
-
-class ProfileStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.finalization.ProfileStrategy');
-  }
-}
-
-class SeedStrategy extends TraversalStrategy {
-  /**
-   * @param {Object} [options]
-   * @param {number} [options.seed] the seed to provide to the random number generator for the traversal
-   */
-  constructor(options) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.SeedStrategy', {
-      seed: options?.seed,
-    });
-  }
-}
-
-class SubgraphStrategy extends TraversalStrategy {
-  /**
-   * @param {Object} [options]
-   * @param {GraphTraversal} [options.vertices] name of the property key to partition by
-   * @param {GraphTraversal} [options.edges] the value of the currently write partition
-   * @param {GraphTraversal} [options.vertexProperties] list of strings representing the partitions to include for reads
-   * @param {boolean} [options.checkAdjacentVertices] enables the strategy to apply the {@code vertices} filter to the adjacent vertices of an edge.
-   */
-  constructor(options) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.SubgraphStrategy', options);
-    if (this.configuration.vertices instanceof Traversal) {
-      this.configuration.vertices = this.configuration.vertices.bytecode;
-    }
-    if (this.configuration.edges instanceof Traversal) {
-      this.configuration.edges = this.configuration.edges.bytecode;
-    }
-    if (this.configuration.vertexProperties instanceof Traversal) {
-      this.configuration.vertexProperties = this.configuration.vertexProperties.bytecode;
-    }
-  }
-}
-
-class ReferenceElementStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.finalization.ReferenceElementStrategy');
-  }
-}
-
-class VertexProgramStrategy extends TraversalStrategy {
-  constructor(options) {
-    super('org.apache.tinkerpop.gremlin.process.computer.traversal.strategy.decoration.VertexProgramStrategy', options);
-  }
-}
-
-class MatchAlgorithmStrategy extends TraversalStrategy {
-  /**
-   * @param matchAlgorithm
-   */
-  constructor({ matchAlgorithm } = {}) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.finalization.MatchAlgorithmStrategy');
-    if (matchAlgorithm !== undefined) {
-      this.configuration['matchAlgorithm'] = matchAlgorithm;
-    }
-  }
-}
-
-class ComputerFinalizationStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.computer.traversal.strategy.finalization.ComputerFinalizationStrategy');
-  }
-}
-
-class AdjacentToIncidentStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.AdjacentToIncidentStrategy');
-  }
-}
-
-class ByModulatorOptimizationStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.ByModulatorOptimizationStrategy');
-  }
-}
-
-class FilterRankingStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.FilterRankingStrategy');
-  }
-}
-
-class IdentityRemovalStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.IdentityRemovalStrategy');
-  }
-}
-
-class IncidentToAdjacentStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.IncidentToAdjacentStrategy');
-  }
-}
-
-class InlineFilterStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.InlineFilterStrategy');
-  }
-}
-
-class LazyBarrierStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.LazyBarrierStrategy');
-  }
-}
-
-class MatchPredicateStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.MatchPredicateStrategy');
-  }
-}
-
-class OrderLimitStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.OrderLimitStrategy');
-  }
-}
-
-class PathProcessorStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.PathProcessorStrategy');
-  }
-}
-
-class PathRetractionStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.PathRetractionStrategy');
-  }
-}
-
-class ProductiveByStrategy extends TraversalStrategy {
-  /**
-   * @param {Object} [options]
-   * @param {Array<String>} productiveKeys set of keys that will always be productive
-   */
-  constructor({ productiveKeys = [] } = {}) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.ProductiveByStrategy');
-    this.configuration['productiveKeys'] = productiveKeys;
-  }
-}
-
-class CountStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.CountStrategy');
-  }
-}
-
-class RepeatUnrollStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.RepeatUnrollStrategy');
-  }
-}
-
-class GraphFilterStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.computer.traversal.strategy.optimization.GraphFilterStrategy');
-  }
-}
-
-class EarlyLimitStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.optimization.EarlyLimitStrategy');
-  }
-}
-
-class ComputerVerificationStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ComputerVerificationStrategy');
-  }
-}
-
-class LambdaRestrictionStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.LambdaRestrictionStrategy');
-  }
-}
-
-class ReadOnlyStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReadOnlyStrategy');
-  }
-}
-
-class EdgeLabelVerificationStrategy extends TraversalStrategy {
-  /**
-   * @param {boolean} logWarnings determines if warnings should be written to the logger when verification fails
-   * @param {boolean} throwException determines if exceptions should be thrown when verifications fails
-   */
-  constructor({ logWarnings = false, throwException = false } = {}) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.EdgeLabelVerificationStrategy');
-    this.configuration['logWarnings'] = logWarnings;
-    this.configuration['throwException'] = throwException;
-  }
-}
-
-class ReservedKeysVerificationStrategy extends TraversalStrategy {
-  /**
-   * @param {boolean} logWarnings determines if warnings should be written to the logger when verification fails
-   * @param {boolean} throwException determines if exceptions should be thrown when verifications fails
-   * @param {Array<String>} keys the list of reserved keys to verify
-   */
-  constructor({ logWarnings = false, throwException = false, keys = ['id', 'label'] } = {}) {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReservedKeysVerificationStrategy');
-    this.configuration['logWarnings'] = logWarnings;
-    this.configuration['throwException'] = throwException;
-    this.configuration['keys'] = keys;
-  }
-}
-
-class VertexProgramRestrictionStrategy extends TraversalStrategy {
-  constructor() {
-    super(
-      'org.apache.tinkerpop.gremlin.process.computer.traversal.strategy.verification.VertexProgramRestrictionStrategy',
-    );
-  }
-}
-
-class StandardVerificationStrategy extends TraversalStrategy {
-  constructor() {
-    super('org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.StandardVerificationStrategy');
-  }
-}
-
-module.exports = {
-  TraversalStrategies: TraversalStrategies,
-  TraversalStrategy: TraversalStrategy,
-  // decoration
-  ComputerFinalizationStrategy: ComputerFinalizationStrategy,
-  ConnectiveStrategy: ConnectiveStrategy,
-  ElementIdStrategy: ElementIdStrategy,
-  HaltedTraverserStrategy: HaltedTraverserStrategy,
-  MessagePassingReductionStrategy: MessagePassingReductionStrategy,
-  OptionsStrategy: OptionsStrategy,
-  PartitionStrategy: PartitionStrategy,
-  ProfileStrategy: ProfileStrategy,
-  ReferenceElementStrategy: ReferenceElementStrategy,
-  SeedStrategy: SeedStrategy,
-  SubgraphStrategy: SubgraphStrategy,
-  VertexProgramStrategy: VertexProgramStrategy,
-  // finalization
-  MatchAlgorithmStrategy: MatchAlgorithmStrategy,
-  // optimization
-  AdjacentToIncidentStrategy: AdjacentToIncidentStrategy,
-  ByModulatorOptimizationStrategy: ByModulatorOptimizationStrategy,
-  FilterRankingStrategy: FilterRankingStrategy,
-  IdentityRemovalStrategy: IdentityRemovalStrategy,
-  IncidentToAdjacentStrategy: IncidentToAdjacentStrategy,
-  InlineFilterStrategy: InlineFilterStrategy,
-  LazyBarrierStrategy: LazyBarrierStrategy,
-  MatchPredicateStrategy: MatchPredicateStrategy,
-  OrderLimitStrategy: OrderLimitStrategy,
-  PathProcessorStrategy: PathProcessorStrategy,
-  PathRetractionStrategy: PathRetractionStrategy,
-  ProductiveByStrategy: ProductiveByStrategy,
-  CountStrategy: CountStrategy,
-  RepeatUnrollStrategy: RepeatUnrollStrategy,
-  GraphFilterStrategy: GraphFilterStrategy,
-  EarlyLimitStrategy: EarlyLimitStrategy,
-  // verification
-  ComputerVerificationStrategy: ComputerVerificationStrategy,
-  EdgeLabelVerificationStrategy: EdgeLabelVerificationStrategy,
-  LambdaRestrictionStrategy: LambdaRestrictionStrategy,
-  ReadOnlyStrategy: ReadOnlyStrategy,
-  ReservedKeysVerificationStrategy: ReservedKeysVerificationStrategy,
-  StandardVerificationStrategy: StandardVerificationStrategy,
-  VertexProgramRestrictionStrategy: VertexProgramRestrictionStrategy,
-};