grumlin 0.22.4 → 1.0.0.rc1

data/lib/grumlin.rb

@@ -17,6 +17,7 @@ require "async/barrier"
 require "async/http/endpoint"
 require "async/websocket/client"
 
+require "middleware"
 require "retryable"
 
 require "zeitwerk"
@@ -34,6 +35,7 @@ module Grumlin
   class Error < StandardError; end
 
   class TransactionError < Error; end
+
   class Rollback < TransactionError; end
 
   class UnknownError < Error; end
@@ -99,15 +101,19 @@ module Grumlin
   end
 
   class VertexAlreadyExistsError < AlreadyExistsError; end
+
   class EdgeAlreadyExistsError < AlreadyExistsError; end
 
   class ConcurrentModificationError < ServerError; end
+
   class ConcurrentInsertFailedError < ConcurrentModificationError; end
 
   class ConcurrentVertexInsertFailedError < ConcurrentInsertFailedError; end
+
   class ConcurrentEdgeInsertFailedError < ConcurrentInsertFailedError; end
 
   class ConcurrentVertexPropertyInsertFailedError < ConcurrentInsertFailedError; end
+
   class ConcurrentEdgePropertyInsertFailedError < ConcurrentInsertFailedError; end
 
   class ServerSerializationError < ServerSideError; end
@@ -134,8 +140,6 @@ module Grumlin
 
   class WrongQueryResult < RepositoryError; end
 
-  @pool_mutex = Mutex.new
-
   class << self
     def configure
       yield config
@@ -147,6 +151,10 @@ module Grumlin
       @config ||= Config.new
     end
 
+    def default_middlewares
+      config.middlewares
+    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.
@@ -155,26 +163,22 @@ module Grumlin
     end
 
     def default_pool
-      if Thread.current.thread_variable_get(:grumlin_default_pool)
-        return Thread.current.thread_variable_get(:grumlin_default_pool)
-      end
-
-      @pool_mutex.synchronize do
-        Thread.current.thread_variable_set(:grumlin_default_pool,
-                                           Async::Pool::Controller.new(Grumlin::Client::PoolResource,
-                                                                       limit: config.pool_size))
-      end
+      t = Thread.current
+      return t.thread_variable_get(:grumlin_default_pool) if t.thread_variable_get(:grumlin_default_pool)
+
+      t.thread_variable_set(:grumlin_default_pool,
+                            Async::Pool::Controller.new(Grumlin::Client::PoolResource,
+                                                        limit: config.pool_size))
     end
 
     def close
-      return if Thread.current.thread_variable_get(:grumlin_default_pool).nil?
-
-      @pool_mutex.synchronize do
-        pool = Thread.current.thread_variable_get(:grumlin_default_pool)
-        pool.wait while pool.busy?
-        pool.close
-        Thread.current.thread_variable_set(:grumlin_default_pool, nil)
-      end
+      t = Thread.current
+      return if t.thread_variable_get(:grumlin_default_pool).nil?
+
+      pool = t.thread_variable_get(:grumlin_default_pool)
+      pool.wait while pool.busy?
+      pool.close
+      t.thread_variable_set(:grumlin_default_pool, nil)
     end
 
     def definitions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.22.4
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -44,6 +44,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: ibsciss-middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +124,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/middlewares.md
 - docker-compose.yml
 - gremlin_server/Dockerfile
 - gremlin_server/tinkergraph-empty.properties
@@ -119,7 +134,6 @@ files:
 - lib/async/channel.rb
 - lib/definitions.yml
 - lib/grumlin.rb
-- lib/grumlin/action.rb
 - lib/grumlin/benchmark/repository.rb
 - lib/grumlin/client.rb
 - lib/grumlin/config.rb
@@ -140,8 +154,20 @@ files:
 - lib/grumlin/features/feature_list.rb
 - lib/grumlin/features/neptune_features.rb
 - lib/grumlin/features/tinkergraph_features.rb
+- lib/grumlin/middlewares/apply_shortcuts.rb
+- lib/grumlin/middlewares/build_query.rb
+- lib/grumlin/middlewares/builder.rb
+- lib/grumlin/middlewares/cast_results.rb
+- lib/grumlin/middlewares/find_blocklisted_steps.rb
+- lib/grumlin/middlewares/find_mutating_steps.rb
+- lib/grumlin/middlewares/middleware.rb
+- lib/grumlin/middlewares/run_query.rb
+- lib/grumlin/middlewares/serialize_to_bytecode.rb
+- lib/grumlin/middlewares/serialize_to_steps.rb
 - lib/grumlin/path.rb
 - lib/grumlin/property.rb
+- lib/grumlin/query_validators/blocklisted_steps_validator.rb
+- lib/grumlin/query_validators/validator.rb
 - lib/grumlin/repository.rb
 - lib/grumlin/repository/error_handling_strategy.rb
 - lib/grumlin/repository/instance_methods.rb
@@ -153,6 +179,7 @@ files:
 - lib/grumlin/shortcuts/storage.rb
 - lib/grumlin/shortcuts/upserts.rb
 - lib/grumlin/shortcuts_applyer.rb
+- lib/grumlin/step.rb
 - lib/grumlin/step_data.rb
 - lib/grumlin/steppable.rb
 - lib/grumlin/steps.rb
@@ -160,7 +187,6 @@ files:
 - lib/grumlin/steps_serializers/human_readable_bytecode.rb
 - lib/grumlin/steps_serializers/serializer.rb
 - lib/grumlin/steps_serializers/string.rb
-- lib/grumlin/sugar.rb
 - lib/grumlin/test/rspec.rb
 - lib/grumlin/test/rspec/db_cleaner_context.rb
 - lib/grumlin/test/rspec/gremlin_context.rb
@@ -195,9 +221,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.33
 signing_key: 

data/lib/grumlin/action.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  class Action < Steppable
-    attr_reader :name, :args, :params, :next_step, :configuration_steps, :previous_step, :shortcut
-
-    # 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]
-    end
-
-    def configuration_step?
-      CONFIGURATION_STEPS.include?(@name) || name.to_sym == :tx
-    end
-
-    def start_step?
-      START_STEPS.include?(@name)
-    end
-
-    def regular_step?
-      REGULAR_STEPS.include?(@name)
-    end
-
-    def supported_step?
-      ALL_STEPS.include?(@name)
-    end
-
-    def ==(other)
-      self.class == other.class &&
-        @name == other.name &&
-        @args == other.args &&
-        @params == other.params &&
-        @previous_step == other.previous_step &&
-        shortcuts == other.shortcuts
-    end
-
-    def steps
-      @steps ||= Steps.from(self)
-    end
-
-    def to_s(**params)
-      StepsSerializers::String.new(steps, **params).serialize
-    end
-
-    # TODO: add human readable mode
-    def inspect
-      conf_steps, regular_steps = StepsSerializers::HumanReadableBytecode.new(steps).serialize
-      "#{conf_steps.any? ? conf_steps : nil}#{regular_steps}"
-    end
-
-    def bytecode(no_return: false)
-      StepsSerializers::Bytecode.new(steps, no_return: no_return)
-    end
-
-    def next
-      to_enum.next
-    end
-
-    def hasNext # rubocop:disable Naming/MethodName
-      to_enum.peek
-      true
-    rescue StopIteration
-      false
-    end
-
-    def to_enum
-      @to_enum ||= toList.to_enum
-    end
-
-    def toList
-      client_write(bytecode)
-    end
-
-    def iterate
-      client_write(bytecode(no_return: true))
-    end
-
-    private
-
-    def client_write(payload)
-      @pool.acquire do |client|
-        client.write(payload, session_id: @session_id)
-      end
-    end
-  end
-end

data/lib/grumlin/sugar.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  module Sugar
-    def self.included(base)
-      base.include(Grumlin::Expressions)
-    end
-
-    %i[__ g].each do |name|
-      define_method name do |cuts = Shortcuts::Storage.empty|
-        cuts.send(name)
-      end
-    end
-  end
-end