grumlin 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb5b809483aeed3b56aeafc11e0f08919a68ce420a14ae918e3aecab791e266
-  data.tar.gz: e42c886a034faeb5ca512882811e78a39f1f5f386b697b0f4061c5be5d5a5f0b
+  metadata.gz: 4260297c3d75ec7bc1f987d8c7bad4efd75c81627814fdf984a0aaac0045332b
+  data.tar.gz: 1cb521906a08cf5390f058a28f380492a2999e55ef023c473fc6bae64533b53b
 SHA512:
-  metadata.gz: 2bd8e23cd4e6ab7526e2e4aaf92dddfa2b1e0dc51fd2e15e9e0a09541e9716c741673a8e6f85b077e5fd1a3a5f16519ae533748347b1aff0ba5de47a8394ed47
-  data.tar.gz: 673985aeb319810c061234e1d0964cf6e40b95363288423d7cda4e0932a7e271d51b957dccc5605a160e54e680d2a869bfa32769b393d19387e61e0ad15b7794
+  metadata.gz: 992d2192402f3fe282203a3fd0eff1e6c886470899cb37f00ca2abf1392e4d946c7391be0eb7d6560c9941f7a17a3552682a8a47f56273f4299c06551c1e9ffc
+  data.tar.gz: d8695e2485915cb7b4d37a755e42d20b6d7f575d906ae5a0aca5f508c01a104c08f7bb51a2285c9dac48a0091771882afeb405fd26e7802c4d48513274e2895f

data/.overcommit.yml

@@ -3,6 +3,3 @@ PreCommit:
     enabled: true
     on_warn: fail # Treat all warnings as failures
 
-PrePush:
-  RSpec:
-    enabled: true

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.5.1)
+    grumlin (0.7.0)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
 
@@ -70,7 +70,7 @@ GEM
       ast (~> 2.4.1)
     protocol-hpack (1.4.2)
     protocol-http (0.22.5)
-    protocol-http1 (0.14.1)
+    protocol-http1 (0.14.2)
       protocol-http (~> 0.22)
     protocol-http2 (0.14.2)
       protocol-hpack (~> 1.4)
@@ -166,4 +166,4 @@ DEPENDENCIES
   solargraph
 
 BUNDLED WITH
-   2.2.15
+   2.2.26

data/bin/console

@@ -10,7 +10,7 @@ Grumlin.configure do |config|
 end
 
 Async do
-  g = Grumlin::Traversal.new
+  include Grumlin::Sugar
 
   IRB.setup(nil)
   workspace = IRB::WorkSpace.new(binding)

data/lib/async/channel.rb

@@ -32,7 +32,7 @@ module Async
     end
 
     def close
-      raise(ChannelClosedError, "Cannot close a closed channel") if closed?
+      return if closed?
 
       @queue << [:close]
       @closed = true

data/lib/grumlin/anonymous_step.rb

@@ -4,23 +4,23 @@ module Grumlin
   class AnonymousStep
     attr_reader :name, :args
 
+    # TODO: add other steps
+    SUPPORTED_STEPS = %w[E V addE addV as by coalesce count dedup drop elementMap emit fold from group groupCount has
+                         hasId hasLabel hasNot in inV label limit not order out outE path project property repeat select
+                         to unfold valueMap values where].freeze
+
     def initialize(name, *args, previous_steps: [])
       @name = name
       @previous_steps = previous_steps
       @args = args
     end
 
-    %w[addV addE V E limit count drop property valueMap select from to as order by has hasLabel values hasNot
-       not outE groupCount label group in out fold unfold inV path dedup project coalesce repeat emit
-       elementMap where].each do |step|
+    SUPPORTED_STEPS.each do |step|
       define_method step do |*args|
         add_step(step, args, previous_steps: steps)
       end
     end
 
-    alias addVertex addV
-    alias addEdge addE
-
     def inspect
       @inspect ||= to_bytecode.to_s
     end

data/lib/grumlin/client.rb

@@ -13,6 +13,7 @@ module Grumlin
       def initialize(url, client_factory:, concurrency: 1, parent: Async::Task.current)
         super(concurrency)
         @client = client_factory.call(url, parent).tap(&:connect)
+        @parent = parent
       end
 
       def closed?
@@ -25,34 +26,67 @@ module Grumlin
 
       def write(*args)
         @client.write(*args)
+      ensure
+        @count += 1
+      end
+
+      def viable?
+        !closed?
+      end
+
+      def reusable?
+        !closed?
       end
     end
 
+    include Console
+
+    # Client is not reusable. Once closed should be recreated.
     def initialize(url, parent: Async::Task.current, **client_options)
       @url = url
       @client_options = client_options
       @parent = parent
-      reset!
+      @request_dispatcher = nil
+      @transport = nil
     end
 
     def connect
+      raise "ClientClosed" if @closed
+
       @transport = build_transport
       response_channel = @transport.connect
       @request_dispatcher = RequestDispatcher.new
-      @parent.async do
+      @response_task = @parent.async do
         response_channel.each do |response|
           @request_dispatcher.add_response(response)
         end
-      rescue StandardError
-        close
+      rescue Async::Stop, Async::TimeoutError, StandardError
+        close(check_requests: false)
       end
+      logger.debug(self, "Connected")
     end
 
-    def close
-      @transport.close
-      raise ResourceLeakError, "Request list is not empty: #{requests}" if @request_dispatcher.requests.any?
+    # Before calling close the user must ensure that:
+    # 1) There are no ongoing requests
+    # 2) There will be no new writes after
+    def close(check_requests: true) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      return if @closed
+
+      @closed = true
 
-      reset!
+      @transport&.close
+      @transport&.wait
+
+      @response_task&.stop
+      @response_task&.wait
+
+      return if @request_dispatcher&.requests&.empty?
+
+      @request_dispatcher.clear unless check_requests
+
+      raise ResourceLeakError, "Request list is not empty: #{@request_dispatcher.requests}" if check_requests
+    ensure
+      logger.debug(self, "Closed")
     end
 
     def connected?
@@ -70,9 +104,9 @@ module Grumlin
 
       begin
         channel.dequeue.flat_map { |item| Typing.cast(item) }
-      rescue Async::Stop
-        retry if @request_dispatcher.ongoing_request?(request_id)
-        raise Grumlin::UnknownRequestStoppedError, "#{request_id} is not in the ongoing requests list"
+      rescue Async::Stop, Async::TimeoutError
+        close(check_requests: false)
+        raise
       end
     end
 
@@ -96,11 +130,6 @@ module Grumlin
       }
     end
 
-    def reset!
-      @request_dispatcher = nil
-      @transport = nil
-    end
-
     def build_transport
       Transport.new(@url, parent: @parent, **@client_options)
     end

data/lib/grumlin/order.rb

@@ -2,16 +2,15 @@
 
 module Grumlin
   module Order
+    # TODO: share the code?
     class << self
-      DESC = { "@type": "g:Order", "@value": "desc" }.freeze
-      ASC = { "@type": "g:Order", "@value": "asc" }.freeze
+      %i[asc desc].each do |step|
+        define_method step do
+          name = "@#{step}"
+          return instance_variable_get(name) if instance_variable_defined?(name)
 
-      def asc
-        ASC
-      end
-
-      def desc
-        DESC
+          instance_variable_set(name, TypedValue.new("Order", step))
+        end
       end
     end
   end

data/lib/grumlin/p.rb

@@ -5,7 +5,7 @@ module Grumlin
     module P
       %w[within].each do |step|
         define_method step do |*args|
-          { # TODO: replace with a class?
+          { # TODO: replace with a TypedValue?
             "@type": "g:P",
             "@value": { predicate: "within", value: { "@type": "g:List", "@value": args } }
           }

data/lib/grumlin/pop.rb

@@ -2,26 +2,15 @@
 
 module Grumlin
   module Pop
+    # TODO: share the code?
     class << self
-      FIRST = { "@type": "g:Pop", "@value": "first" }.freeze
-      LAST = { "@type": "g:Pop", "@value": "last" }.freeze
-      ALL = { "@type": "g:Pop", "@value": "all" }.freeze
-      MIXED = { "@type": "g:Pop", "@value": "mixed" }.freeze
+      %i[first last all mixed].each do |step|
+        define_method step do
+          name = "@#{step}"
+          return instance_variable_get(name) if instance_variable_defined?(name)
 
-      def first
-        FIRST
-      end
-
-      def last
-        LAST
-      end
-
-      def all
-        ALL
-      end
-
-      def mixed
-        MIXED
+          instance_variable_set(name, TypedValue.new("Pop", step))
+        end
       end
     end
   end

data/lib/grumlin/request_dispatcher.rb

@@ -22,6 +22,8 @@ module Grumlin
       498 => ClientSideError
     }.freeze
 
+    include Console
+
     def initialize
       @requests = {}
     end
@@ -69,6 +71,10 @@ module Grumlin
       @requests.key?(request_id)
     end
 
+    def clear
+      @requests.clear
+    end
+
     private
 
     def check_errors!(status)

data/lib/grumlin/t.rb

@@ -2,16 +2,15 @@
 
 module Grumlin
   module T
+    # TODO: share the code?
     class << self
-      T_ID = { :@type => "g:T", :@value => "id" }.freeze # TODO: replace with a class?
-      T_LABEL = { :@type => "g:T", :@value => "label" }.freeze # TODO: replace with a class?
+      %i[id label].each do |step|
+        define_method step do
+          name = "@#{step}"
+          return instance_variable_get(name) if instance_variable_defined?(name)
 
-      def id
-        T_ID
-      end
-
-      def label
-        T_LABEL
+          instance_variable_set(name, TypedValue.new("T", step))
+        end
       end
     end
   end

data/lib/grumlin/translator.rb

@@ -20,6 +20,7 @@ module Grumlin
       private
 
       def arg_to_bytecode(arg)
+        return arg.to_bytecode if arg.is_a?(TypedValue)
         return arg unless arg.is_a?(AnonymousStep)
 
         args = arg.args.flatten.map do |a|
@@ -30,8 +31,11 @@ module Grumlin
 
       def arg_to_query_bytecode(arg)
         return ["none"] if arg.nil?
+        return arg.to_bytecode if arg.is_a?(TypedValue)
         return arg unless arg.is_a?(AnonymousStep)
 
+        # return arg.to_bytecode if arg.is_a?(TypedValue)
+
         args = arg.args.flatten.map do |a|
           a.instance_of?(AnonymousStep) ? Typing.to_bytecode(to_bytecode(a.steps)) : arg_to_query_bytecode(a)
         end

data/lib/grumlin/transport.rb

@@ -5,47 +5,33 @@ module Grumlin
     # A transport based on https://github.com/socketry/async
     # and https://github.com/socketry/async-websocket
 
+    include Console
+
     attr_reader :url
 
+    # Transport is not reusable. Once closed should be recreated.
     def initialize(url, parent: Async::Task.current, **client_options)
       @url = url
       @parent = parent
       @client_options = client_options
       @request_channel = Async::Channel.new
       @response_channel = Async::Channel.new
-      reset!
     end
 
     def connected?
-      @connected
+      !@connection.nil?
     end
 
-    def connect # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def connect
+      raise "ClientClosed" if @closed
       raise AlreadyConnectedError if connected?
 
       @connection = Async::WebSocket::Client.connect(Async::HTTP::Endpoint.parse(@url), **@client_options)
+      logger.debug(self) { "Connected to #{@url}." }
 
-      @response_task = @parent.async do
-        loop do
-          data = @connection.read
-          @response_channel << data
-        end
-      rescue Async::Stop
-        @response_channel.close
-      rescue StandardError => e
-        @response_channel.exception(e)
-      end
+      @response_task = @parent.async { run_response_task }
 
-      @request_task = @parent.async do
-        @request_channel.each do |message|
-          @connection.write(message)
-          @connection.flush
-        end
-      rescue StandardError => e
-        @response_channel.exception(e)
-      end
-
-      @connected = true
+      @request_task = @parent.async { run_request_task }
 
       @response_channel
     end
@@ -57,30 +43,59 @@ module Grumlin
     end
 
     def close
-      return unless connected?
+      return if @closed
 
-      @request_channel.close
-      @request_task.wait
+      @closed = true
 
-      @response_task.stop
-      @response_task.wait
+      @request_channel.close
+      @response_channel.close
 
       begin
         @connection.close
-      rescue Errno::EPIPE
+      rescue StandardError
         nil
       end
+      @connection = nil
+
+      @request_task&.stop(true)
+      @response_task&.stop(true)
+    end
 
-      reset!
+    def wait
+      @request_task.wait
+      @response_task.wait
     end
 
     private
 
-    def reset!
-      @connected = false
-      @connection = nil
-      @response_task = nil
-      @request_task = nil
+    def run_response_task
+      with_guard do
+        loop do
+          data = @connection.read
+          @response_channel << data
+        end
+      end
+    end
+
+    def run_request_task
+      with_guard do
+        @request_channel.each do |message|
+          @connection.write(message)
+          @connection.flush
+        end
+      end
+    end
+
+    def with_guard
+      yield
+    rescue Async::Stop, Async::TimeoutError, StandardError => e
+      logger.debug(self) { "Guard error, closing." }
+      begin
+        @response_channel.exception(e)
+      rescue Async::Channel::ChannelClosedError
+        nil
+      end
+      close
     end
   end
 end

data/lib/grumlin/traversal.rb

@@ -4,18 +4,17 @@ module Grumlin
   class Traversal
     attr_reader :connection
 
+    # TODO: add other start steps
+    SUPPORTED_START_STEPS = %w[E V addE addV].freeze
+
     def initialize(pool = Grumlin.config.default_pool)
       @pool = pool
     end
 
-    # TODO: add other start steps
-    %w[addV addE V E].each do |step|
+    SUPPORTED_START_STEPS.each do |step|
       define_method step do |*args|
         Step.new(@pool, step, *args)
       end
     end
-
-    alias addVertex addV
-    alias addEdge addE
   end
 end

data/lib/grumlin/typed_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Grumlin
+  # TODO: find a better name
+  class TypedValue
+    def initialize(type, value)
+      @type = type
+      @value = value
+    end
+
+    def inspect(*)
+      "#{@type}.#{@value}"
+    end
+
+    def to_bytecode
+      @to_bytecode ||= { "@type": "g:#{@type}", "@value": @value }
+    end
+  end
+end

data/lib/grumlin/u.rb

@@ -2,8 +2,11 @@
 
 module Grumlin
   module U
+    # TODO: add other start steps
+    SUPPORTED_START_STEPS = %w[V addV count has out unfold values].freeze
+
     class << self
-      %w[addV V has count out values unfold].each do |step|
+      SUPPORTED_START_STEPS.each do |step|
         define_method step do |*args|
           AnonymousStep.new(step, *args)
         end

data/lib/grumlin/version.rb

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

data/lib/grumlin.rb

@@ -19,6 +19,7 @@ require_relative "grumlin/exceptions"
 
 require_relative "grumlin/transport"
 require_relative "grumlin/client"
+require_relative "grumlin/typed_value"
 
 require_relative "grumlin/vertex"
 require_relative "grumlin/edge"
@@ -42,10 +43,9 @@ module Grumlin
   class Config
     attr_accessor :url, :pool_size, :client_concurrency, :client_factory
 
-    # For some reason, client_concurrency must be greater than pool_size
     def initialize
       @pool_size = 10
-      @client_concurrency = 20
+      @client_concurrency = 5
       @client_factory = ->(url, parent) { Grumlin::Client.new(url, parent: parent) }
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -50,6 +50,7 @@ files:
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -82,6 +83,7 @@ files:
 - lib/grumlin/translator.rb
 - lib/grumlin/transport.rb
 - lib/grumlin/traversal.rb
+- lib/grumlin/typed_value.rb
 - lib/grumlin/typing.rb
 - lib/grumlin/u.rb
 - lib/grumlin/version.rb