grumlin 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb67bbe2eff3a7fd02cce19c6052fa70e3f54f3ec2cb06102667f69e43d07e8d
-  data.tar.gz: 1ecf0285f60fab6fd93bd0b36bfe58c39b94eebf0ead055f6f3cc4f2e9f8b19d
+  metadata.gz: 95963424bb38728bb21c2d3746a93be60daf303b2c2897b24d99684fd1fb7bff
+  data.tar.gz: 809b4b589b2bc5fd8687f0f63a6f73f17aab82060990b3a5942164c2ac92ef83
 SHA512:
-  metadata.gz: '05263993fc271810fd493ae3d5fdd8d84b6b698a8d9a4e4a4c336b09858571b156971b6f3def4bdb2d9c3743b07bebeb40eb1c426e4c316a8aa4a87b264f15b5'
-  data.tar.gz: 78fc706c4694146ff2b5fedc75b1d0186dca152fc9f2731c1b6936ea906e6410077c95871fba8b4c302f375cc8b28afffa37ccb59097a88470e266c4f26e6c51
+  metadata.gz: b095f3958ebf4b70577e607a0b10e27fc073055fe08d6fe55787c71fd104e77cf78cdcd0a54d06e7881c9183cab479ef6e92e6117a1c1b418945d1ebb417655c
+  data.tar.gz: 0477a8ce8ccfc5ea1cc3b95b7b48501b05387207918478adc4eecb8e286e8495910b6bd718e1d5c00ab63e61e02ca6e89212913ec35d8df49b267cb75281e9eb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.21.0)
+    grumlin (0.21.1)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
       oj (~> 3.13)
@@ -21,11 +21,11 @@ GEM
       console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-http (0.56.6)
+    async-http (0.57.0)
       async (>= 1.25)
       async-io (>= 1.28)
       async-pool (>= 0.2)
-      protocol-http (~> 0.22.0)
+      protocol-http (~> 0.23.1)
       protocol-http1 (~> 0.14.0)
       protocol-http2 (~> 0.14.0)
       traces (~> 0.4.0)
@@ -37,7 +37,7 @@ GEM
       rspec (~> 3.0)
       rspec-files (~> 1.0)
       rspec-memory (~> 1.0)
-    async-websocket (0.19.0)
+    async-websocket (0.19.2)
       async-http (~> 0.54)
       async-io (~> 1.23)
       protocol-websocket (~> 0.7.0)
@@ -72,7 +72,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.13.6-x86_64-linux)
       racc (~> 1.4)
-    oj (3.13.18)
+    oj (3.13.20)
     overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -81,7 +81,7 @@ GEM
     parser (3.1.2.0)
       ast (~> 2.4.1)
     protocol-hpack (1.4.2)
-    protocol-http (0.22.6)
+    protocol-http (0.23.1)
     protocol-http1 (0.14.4)
       protocol-http (~> 0.22)
     protocol-http2 (0.14.2)

data/README.md

@@ -46,9 +46,33 @@ Or install it yourself as:
 ```ruby
 Grumlin.configure do |config|
   config.url = "ws://localhost:8182/gremlin"
+
+  # make sure you select right provider for better compatibility
+  config.provider = :tinkergraph
 end
 ```
 
+#### Providers
+
+Currently `Grumlin` supports 2 providers:
+- tinkergraph (default)
+- neptune
+
+As different providers may have or may have not support for specific features it's recommended to
+explicitly specify the provider you use.
+
+#### Provider features
+
+Every provider is described by a set of features. In the future `Grumlin` may decide to disable or enable 
+some parts of it's functionality to comply provider's supported features. Currently there is no difference
+in behaviour when working with different providers.
+
+To check current providers supported features use
+
+```ruby
+Grumlin.features
+```
+
 ### Traversing graphs
 
 **Warning**: Not all steps and expressions defined in the reference documentation are supported.

data/lib/grumlin/action.rb

@@ -4,14 +4,15 @@ module Grumlin
   class Action < Steppable
     attr_reader :name, :args, :params, :next_step, :configuration_steps, :previous_step, :shortcut
 
-    def initialize(name, args: [], params: {}, previous_step: nil, pool: nil)
-      super()
+    # client is only used when a traversal is a part of transaction
+    def initialize(name, args: [], params: {}, previous_step: nil, pool: Grumlin.default_pool, session_id: nil)
+      super(pool: pool, session_id: session_id)
+
       @name = name.to_sym
       @args = args # TODO: add recursive validation: only json types or Action
       @params = params # TODO: add recursive validation: only json types
       @previous_step = previous_step
       @shortcut = shortcuts[@name]
-      @pool = pool || Grumlin.default_pool
     end
 
     def configuration_step?
@@ -73,14 +74,18 @@ module Grumlin
     end
 
     def toList
-      @pool.acquire do |client|
-        client.write(bytecode)
-      end
+      client_write(bytecode)
     end
 
     def iterate
+      client_write(bytecode(no_return: true))
+    end
+
+    private
+
+    def client_write(payload)
       @pool.acquire do |client|
-        client.write(bytecode(no_return: true))
+        client.write(payload, session_id: @session_id)
       end
     end
   end

data/lib/grumlin/client.rb

@@ -24,8 +24,14 @@ module Grumlin
         @client.close
       end
 
-      def write(bytecode)
-        @client.write(bytecode)
+      def write(bytecode, session_id: nil)
+        @client.write(bytecode, session_id: session_id)
+      ensure
+        @count += 1
+      end
+
+      def finalize_tx(action, session_id)
+        @client.finalize_tx(action, session_id)
       ensure
         @count += 1
       end
@@ -94,19 +100,19 @@ module Grumlin
     end
 
     # TODO: support yielding
-    def write(bytecode)
+    def write(bytecode, session_id: nil)
       raise NotConnectedError unless connected?
 
-      request = to_query(bytecode)
-      channel = @request_dispatcher.add_request(request)
-      @transport.write(request)
+      request = to_query(bytecode, session_id: session_id)
+      submit_request(request)
+    end
 
-      begin
-        channel.dequeue.flat_map { |item| Typing.cast(item) }
-      rescue Async::Stop, Async::TimeoutError
-        close(check_requests: false)
-        raise
-      end
+    def finalize_tx(action, session_id)
+      raise NotConnectedError unless connected?
+      raise ArgumentError, "session_id cannot be nil" if session_id.nil?
+
+      request = finalize_tx_query(action, session_id)
+      submit_request(request)
     end
 
     def inspect
@@ -119,20 +125,52 @@ module Grumlin
 
     private
 
+    def submit_request(request)
+      channel = @request_dispatcher.add_request(request)
+      @transport.write(request)
+
+      begin
+        channel.dequeue.flat_map { |item| Typing.cast(item) }
+      rescue Async::Stop, Async::TimeoutError
+        close(check_requests: false)
+        raise
+      end
+    end
+
     # This might be overridden in successors
     def build_transport
       Transport.new(@url, parent: @parent, **@client_options)
     end
 
-    def to_query(bytecode)
+    def to_query(bytecode, session_id:)
+      {
+        requestId: SecureRandom.uuid,
+        op: :bytecode,
+        processor: session_id ? :session : :traversal,
+        args: {
+          gremlin: {
+            :@type => "g:Bytecode",
+            :@value => bytecode.serialize
+          },
+          aliases: { g: :g },
+          session: session_id
+        }.compact
+      }
+    end
+
+    def finalize_tx_query(action, session_id)
       {
         requestId: SecureRandom.uuid,
-        op: "bytecode",
-        processor: "traversal",
+        op: :bytecode,
+        processor: session_id ? :session : :traversal,
         args: {
-          gremlin: { :@type => "g:Bytecode", :@value => bytecode.serialize },
-          aliases: { g: :g }
-        }
+          gremlin: {
+            :@type => "g:Bytecode",
+            :@value => { source: [[:tx, action]] }
+          },
+          aliases: { g: :g },
+          session: session_id
+        }.compact
       }
     end
   end

data/lib/grumlin/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Config
+    attr_accessor :url, :pool_size, :client_concurrency, :client_factory, :provider
+
+    SUPPORTED_PROVIDERS = %i[neptune tinkergraph].freeze
+
+    class ConfigurationError < Grumlin::Error; end
+
+    class UnknownProviderError < ConfigurationError; end
+
+    def initialize
+      @pool_size = 10
+      @client_concurrency = 5
+      @provider = :tinkergraph
+      @client_factory = ->(url, parent) { Grumlin::Client.new(url, parent: parent) }
+    end
+
+    def validate!
+      return if SUPPORTED_PROVIDERS.include?(provider.to_sym)
+
+      raise UnknownProviderError, "provider '#{provider}' is unknown. Supported providers: #{SUPPORTED_PROVIDERS}"
+    end
+  end
+end

data/lib/grumlin/features/feature_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Features
+    class FeatureList
+      def user_supplied_ids?
+        raise(NotImplementedError) if @user_supplied_ids.nil?
+
+        @user_supplied_ids
+      end
+
+      def supports_transactions?
+        raise(NotImplementedError) if @supports_transactions.nil?
+
+        @supports_transactions
+      end
+    end
+  end
+end

data/lib/grumlin/features/neptune_features.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Features
+    class NeptuneFeatures < FeatureList
+      def initialize
+        super
+        @user_supplied_ids = true
+        @supports_transactions = true
+      end
+    end
+  end
+end

data/lib/grumlin/features/tinkergraph_features.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Features
+    class TinkergraphFeatures < FeatureList
+      def initialize
+        super
+        @user_supplied_ids = true
+        @supports_transactions = false
+      end
+    end
+  end
+end

data/lib/grumlin/features.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Features
+    class << self
+      FEATURES = {
+        neptune: NeptuneFeatures.new,
+        tinkergraph: TinkergraphFeatures.new
+      }.freeze
+
+      def for(provider)
+        FEATURES[provider]
+      end
+    end
+  end
+end

data/lib/grumlin/repository/instance_methods.rb

@@ -8,7 +8,7 @@ module Grumlin
       extend Forwardable
 
       UPSERT_RETRY_PARAMS = {
-        on: [Grumlin::AlreadyExistsError, Grumlin::ConcurrentInsertFailedError],
+        on: [Grumlin::AlreadyExistsError, Grumlin::ConcurrentModificationError],
         sleep_method: ->(n) { Async::Task.current.sleep(n) },
         tries: 3,
         sleep: ->(n) { (n**2) + 1 + rand }

data/lib/grumlin/request_dispatcher.rb

@@ -10,23 +10,6 @@ module Grumlin
       206 => :partial_content
     }.freeze
 
-    ERRORS = {
-      499 => InvalidRequestArgumentsError,
-      500 => ServerError,
-      597 => ScriptEvaluationError,
-      599 => ServerSerializationError,
-      598 => ServerTimeoutError,
-
-      401 => ClientSideError,
-      407 => ClientSideError,
-      498 => ClientSideError
-    }.freeze
-
-    VERTEX_ALREADY_EXISTS = "Vertex with id already exists:"
-    EDGE_ALREADY_EXISTS = "Edge with id already exists:"
-    CONCURRENT_VERTEX_INSERT_FAILED = "Failed to complete Insert operation for a Vertex due to conflicting concurrent"
-    CONCURRENT_EDGE_INSERT_FAILED = "Failed to complete Insert operation for an Edge due to conflicting concurrent"
-
     class DispatcherError < Grumlin::Error; end
 
     class RequestAlreadyAddedError < DispatcherError; end
@@ -47,14 +30,16 @@ module Grumlin
 
     # builds a response object, when it's ready sends it to the client via a channel
     # TODO: sometimes response does not include requestID, no idea how to handle it so far.
-    def add_response(response) # rubocop:disable Metrics/AbcSize
+    def add_response(response) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       request_id = response[:requestId]
       raise UnknownRequestError unless ongoing_request?(request_id)
 
       begin
         request = @requests[request_id]
 
-        check_errors!(response[:status], request[:request])
+        RequestErrorFactory.build(request, response).tap do |err|
+          raise err unless err.nil?
+        end
 
         case SUCCESS[response.dig(:status, :code)]
         when :success
@@ -91,29 +76,5 @@ module Grumlin
       request = @requests.delete(request_id)
       request[:channel].close
     end
-
-    def check_errors!(status, query)
-      if (error = ERRORS[status[:code]])
-        raise (
-          already_exists_error(status) ||
-          concurrent_insert_error(status) ||
-          error
-        ).new(status, query)
-      end
-
-      return unless SUCCESS[status[:code]].nil?
-
-      raise(UnknownResponseStatus, status)
-    end
-
-    def already_exists_error(status)
-      return VertexAlreadyExistsError if status[:message]&.include?(VERTEX_ALREADY_EXISTS)
-      return EdgeAlreadyExistsError if status[:message]&.include?(EDGE_ALREADY_EXISTS)
-    end
-
-    def concurrent_insert_error(status)
-      return ConcurrentVertexInsertFailedError if status[:message]&.include?(CONCURRENT_VERTEX_INSERT_FAILED)
-      return ConcurrentEdgeInsertFailedError if status[:message]&.include?(CONCURRENT_EDGE_INSERT_FAILED)
-    end
   end
 end

data/lib/grumlin/request_error_factory.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class RequestErrorFactory
+    ERRORS = {
+      499 => InvalidRequestArgumentsError,
+      500 => ServerError,
+      597 => ScriptEvaluationError,
+      599 => ServerSerializationError,
+      598 => ServerTimeoutError,
+
+      401 => ClientSideError,
+      407 => ClientSideError,
+      498 => ClientSideError
+    }.freeze
+
+    # Neptune presumably returns message as a JSON string of format
+    # {"detailedMessage":"",
+    #  "requestId":"UUID",
+    #  "code":"ConcurrentModificationException"}
+    # Currencly we simply search for substings to identify the exact error
+    # TODO: parse json and use `code` instead
+    VERTEX_ALREADY_EXISTS = "Vertex with id already exists:"
+    EDGE_ALREADY_EXISTS = "Edge with id already exists:"
+    CONCURRENT_VERTEX_INSERT_FAILED = "Failed to complete Insert operation for a Vertex due to conflicting concurrent"
+    CONCURRENT_EDGE_INSERT_FAILED = "Failed to complete Insert operation for an Edge due to conflicting concurrent"
+    CONCURRENCT_MODIFICATION_FAILED = "Failed to complete operation due to conflicting concurrent"
+
+    class << self
+      def build(request, response)
+        status = response[:status]
+        query = request[:request]
+
+        if (error = ERRORS[status[:code]])
+          return (
+            already_exists_error(status) ||
+            concurrent_modification_error(status) ||
+            error
+          ).new(status, query)
+        end
+
+        return unless RequestDispatcher::SUCCESS[status[:code]].nil?
+
+        UnknownResponseStatus.new(status)
+      end
+
+      def already_exists_error(status)
+        return VertexAlreadyExistsError if status[:message]&.include?(VERTEX_ALREADY_EXISTS)
+        return EdgeAlreadyExistsError if status[:message]&.include?(EDGE_ALREADY_EXISTS)
+      end
+
+      def concurrent_modification_error(status)
+        return ConcurrentVertexInsertFailedError if status[:message]&.include?(CONCURRENT_VERTEX_INSERT_FAILED)
+        return ConcurrentEdgeInsertFailedError if status[:message]&.include?(CONCURRENT_EDGE_INSERT_FAILED)
+        return ConcurrentModificationError if status[:message]&.include?(CONCURRENCT_MODIFICATION_FAILED)
+      end
+    end
+  end
+end

data/lib/grumlin/steppable.rb

@@ -4,13 +4,18 @@ module Grumlin
   class Steppable
     extend Forwardable
 
+    attr_reader :session_id
+
     START_STEPS = Grumlin.definitions.dig(:steps, :start).map(&:to_sym).freeze
     REGULAR_STEPS = Grumlin.definitions.dig(:steps, :regular).map(&:to_sym).freeze
     CONFIGURATION_STEPS = Grumlin.definitions.dig(:steps, :configuration).map(&:to_sym).freeze
 
     ALL_STEPS = START_STEPS + CONFIGURATION_STEPS + REGULAR_STEPS
 
-    def initialize
+    def initialize(pool: Grumlin.default_pool, session_id: nil)
+      @pool = pool
+      @session_id = session_id
+
       return if respond_to?(:shortcuts)
 
       raise "steppable must not be initialized directly, use Grumlin::Shortcuts::Storage#g or #__ instead"
@@ -18,12 +23,12 @@ module Grumlin
 
     ALL_STEPS.each do |step|
       define_method step do |*args, **params|
-        shortcuts.action_class.new(step, args: args, params: params, previous_step: self)
+        shortcuts.action_class.new(step, args: args, params: params, previous_step: self, session_id: @session_id)
       end
     end
 
     def step(name, *args, **params)
-      shortcuts.action_class.new(name, args: args, params: params, previous_step: self)
+      shortcuts.action_class.new(name, args: args, params: params, previous_step: self, session_id: @session_id)
     end
 
     def_delegator :shortcuts, :__

data/lib/grumlin/transaction.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Transaction
+    attr_reader :uuid
+
+    include Console
+
+    def initialize(traversal_start_class, pool: Grumlin.default_pool)
+      @traversal_start_class = traversal_start_class
+      @pool = pool
+
+      if supported?
+        @uuid = SecureRandom.uuid
+        return
+      end
+
+      logger.info(self) do
+        "#{Grumlin.config.provider} does not support transactions. commit and rollback are ignored, data will be saved"
+      end
+    end
+
+    def supported?
+      Grumlin.features.supports_transactions?
+    end
+
+    def begin
+      @traversal_start_class.new(session_id: @uuid)
+    end
+
+    def commit
+      return unless supported?
+
+      finalize(:commit)
+    end
+
+    def rollback
+      return unless supported?
+
+      finalize(:rollback)
+    end
+
+    private
+
+    def finalize(action)
+      @pool.acquire do |client|
+        client.finalize_tx(action, @uuid)
+      end
+    end
+  end
+end

data/lib/grumlin/traversal_start.rb

@@ -4,6 +4,15 @@ module Grumlin
   class TraversalStart < Steppable
     include WithExtension
 
+    class TraversalError < Grumlin::Error; end
+    class AlreadyBoundToTransationError < TraversalError; end
+
+    def tx
+      raise AlreadyBoundToTransationError if @session_id
+
+      Transaction.new(self.class, pool: @pool)
+    end
+
     def to_s(*)
       self.class.to_s
     end

data/lib/grumlin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Grumlin
-  VERSION = "0.21.0"
+  VERSION = "0.21.1"
 end

data/lib/grumlin.rb

@@ -98,7 +98,8 @@ module Grumlin
   class VertexAlreadyExistsError < AlreadyExistsError; end
   class EdgeAlreadyExistsError < AlreadyExistsError; end
 
-  class ConcurrentInsertFailedError < ServerError; end
+  class ConcurrentModificationError < ServerError; end
+  class ConcurrentInsertFailedError < ConcurrentModificationError; end
 
   class ConcurrentVertexInsertFailedError < ConcurrentInsertFailedError; end
   class ConcurrentEdgeInsertFailedError < ConcurrentInsertFailedError; end
@@ -127,27 +128,26 @@ module Grumlin
 
   class WrongQueryResult < RepositoryError; end
 
-  class Config
-    attr_accessor :url, :pool_size, :client_concurrency, :client_factory
-
-    def initialize
-      @pool_size = 10
-      @client_concurrency = 5
-      @client_factory = ->(url, parent) { Grumlin::Client.new(url, parent: parent) }
-    end
-  end
-
   @pool_mutex = Mutex.new
 
   class << self
     def configure
       yield config
+
+      config.validate!
     end
 
     def config
       @config ||= Config.new
     end
 
+    # returns a subset of features for currently configured backend.
+    # The features lists are hardcoded as there is no way to get them
+    # from the remote server.
+    def features
+      Features.for(config.provider) # no memoization as provider may be changed
+    end
+
     def default_pool
       if Thread.current.thread_variable_get(:grumlin_default_pool)
         return Thread.current.thread_variable_get(:grumlin_default_pool)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -116,6 +116,7 @@ files:
 - lib/grumlin/action.rb
 - lib/grumlin/benchmark/repository.rb
 - lib/grumlin/client.rb
+- lib/grumlin/config.rb
 - lib/grumlin/edge.rb
 - lib/grumlin/expressions/cardinality.rb
 - lib/grumlin/expressions/column.rb
@@ -128,12 +129,17 @@ files:
 - lib/grumlin/expressions/t.rb
 - lib/grumlin/expressions/text_p.rb
 - lib/grumlin/expressions/with_options.rb
+- lib/grumlin/features.rb
+- lib/grumlin/features/feature_list.rb
+- lib/grumlin/features/neptune_features.rb
+- lib/grumlin/features/tinkergraph_features.rb
 - lib/grumlin/path.rb
 - lib/grumlin/property.rb
 - lib/grumlin/repository.rb
 - lib/grumlin/repository/error_handling_strategy.rb
 - lib/grumlin/repository/instance_methods.rb
 - lib/grumlin/request_dispatcher.rb
+- lib/grumlin/request_error_factory.rb
 - lib/grumlin/shortcut.rb
 - lib/grumlin/shortcuts.rb
 - lib/grumlin/shortcuts/properties.rb
@@ -151,6 +157,7 @@ files:
 - lib/grumlin/test/rspec.rb
 - lib/grumlin/test/rspec/db_cleaner_context.rb
 - lib/grumlin/test/rspec/gremlin_context.rb
+- lib/grumlin/transaction.rb
 - lib/grumlin/transport.rb
 - lib/grumlin/traversal_start.rb
 - lib/grumlin/traversal_strategies/options_strategy.rb