skein 0.3.7 → 0.8.1

data/lib/skein/context.rb

@@ -33,12 +33,15 @@ class Skein::Context
   end
 
   def exception!(*args)
-    @reporter and @reporter.exception!(*args)
+    @reporter&.exception!(*args)
   end
 
   def trap
     yield
-  rescue => e
+
+  rescue SystemExit
+    raise
+  rescue Object => e
     self.exception!(e)
   end
 end

data/lib/skein/handler/async.rb

@@ -2,8 +2,12 @@ class Skein::Handler::Async < Skein::Handler
   # == Instance Methods =====================================================
 
   def delegate(*args)
-    @target.send(*args) do |response, error|
-      yield(response, error)
+    fiber = Fiber.new do
+      @target.send(*args) do |*response|
+        Fiber.yield(*response)
+      end
     end
+
+    yield(fiber.resume)
   end
 end

data/lib/skein/handler.rb

@@ -3,6 +3,12 @@ class Skein::Handler
 
   attr_reader :context
 
+  # == Constants ============================================================
+
+  RPC_BASE = {
+    jsonrpc: '2.0'
+  }.freeze
+
   # == Class Methods ========================================================
 
   def self.for(target)
@@ -18,10 +24,19 @@ class Skein::Handler
 
   def initialize(target, context = nil)
     @target = target
-    @context = context
+    @context = context || target.context
+  end
+
+  def json_rpc(contents)
+    JSON.dump(RPC_BASE.merge(contents))
   end
 
-  def handle(message_json)
+  def handle(message_json, metrics, state)
+    state[:started] = Time.now
+    state[:finished] = nil
+    state[:thread] = Thread.current
+    state[:method] = :handle
+
     request =
       begin
         JSON.load(message_json)
@@ -29,9 +44,16 @@ class Skein::Handler
       rescue Object => e
         @context and @context.exception!(e, message_json)
 
-        return yield(JSON.dump(
-          result: nil,
-          error: '[%s] %s' % [ e.class, e ],
+        metrics[:failed] += 1
+        metrics[:errors][:parsing] += 1
+        metrics[:time] += state[:finished] - state[:started]
+        state[:method] = nil
+
+        return yield(rpc_json(
+          error: {
+            code: -32700,
+            message: 'Parse error'
+          },
           id: nil
         ))
       end
@@ -40,9 +62,16 @@ class Skein::Handler
     when Hash
       # Acceptable
     else
-      return yield(JSON.dump(
-        result: nil,
-        error: 'Request does not conform to the JSON-RPC format.',
+      metrics[:failed] += 1
+      metrics[:errors][:non_jsonrpc] += 1
+      metrics[:time] += state[:finished] - state[:started]
+      state[:method] = nil
+
+      return yield(json_rpc(
+        error: {
+          code: -32600,
+          message: 'Request does not conform to the JSON-RPC format.'
+        },
         id: nil
       ))
     end
@@ -58,27 +87,109 @@ class Skein::Handler
       end
 
     unless (request['method'] and request['method'].is_a?(String) and request['method'].match(/\S/))
-      return yield(JSON.dump(
-        result: nil,
-        error: 'Request does not conform to the JSON-RPC format, missing valid method.',
+      metrics[:failed] += 1
+      metrics[:errors][:no_method_property] += 1
+      metrics[:time] += state[:finished] - state[:started]
+      state[:method] = nil
+
+      return yield(json_rpc(
+        error: {
+          code: -32600,
+          message: 'Request does not conform to the JSON-RPC format, missing valid method.'
+        },
         id: request['id']
       ))
     end
 
     begin
-      delegate(request['method'], *request['params']) do |result, error = nil|
-        yield(JSON.dump(
-          result: result,
-          error: error,
-          id: request['id']
-        ))
+      method_name = request['method'].to_sym
+      @target.before_execution(method_name)
+      state[:method] = method_name
+
+      delegate(method_name, *request['params']) do |result|
+        @target.after_execution(method_name)
+        state[:finished] = Time.now
+        metrics[:time] += state[:finished] - state[:started]
+        state[:method] = nil
+
+        case (result)
+        when Exception
+          metrics[:failed] += 1
+          metrics[:errors][:exception] += 1
+
+          yield(json_rpc(
+            error: {
+              code: -32603,
+              message: result.to_s
+            },
+            id: request['id']
+          ))
+        else
+          metrics[:succeeded] += 1
+
+          yield(json_rpc(
+            result: result,
+            id: request['id']
+          ))
+        end
       end
+
+    rescue ArgumentError => e
+      # REFACTOR: Make these exception catchers only trap immediate errors,
+      #           not those that occur within the delegated code.
+      @context and @context.exception!(e, message_json)
+
+      metrics[:failed] += 1
+      metrics[:errors][:invalid_arguments] += 1
+      state[:finished] = Time.now
+      metrics[:time] += state[:finished] - state[:started]
+      state[:method] = nil
+
+      yield(json_rpc(
+        error: {
+          code: -32602,
+          message: 'Invalid params',
+          data: {
+            method: request['method'],
+            params: request['params'],
+            message: e.to_s
+          }
+        },
+        id: request['id']
+      ))
+    rescue NoMethodError => e
+      @context and @context.exception!(e, message_json)
+
+      metrics[:failed] += 1
+      metrics[:errors][:invalid_arguments] += 1
+      state[:finished] = Time.now
+      metrics[:time] += state[:finished] - state[:started]
+      state[:method] = nil
+
+      yield(json_rpc(
+        error: {
+          code: -32601,
+          message: e.to_s,
+          data: {
+            method: request['method']
+          }
+        },
+        id: request['id']
+      ))
     rescue Object => e
       @context and @context.exception!(e, message_json)
 
-      yield(JSON.dump(
-        result: nil,
-        error: '[%s] %s' % [ e.class, e ],
+      metrics[:failed] += 1
+      metrics[:errors][:exception] += 1
+      state[:finished] = Time.now
+      metrics[:time] += state[:finished] - state[:started]
+      state[:method] = nil
+
+      yield(json_rpc(
+        error: {
+          code: -32063, 
+          message: '[%s] %s' % [ e.class, e ]
+        },
         id: request['id']
       ))
     end

data/lib/skein/rabbitmq.rb

@@ -23,6 +23,7 @@ module Skein::RabbitMQ
     end
   end
 
+  # REFACTOR: These should be moved to an abstract adapter
   def self.connect(config = nil)
     config ||= Skein.config
 

data/lib/skein/timeout_queue.rb

@@ -0,0 +1,43 @@
+class Skein::TimeoutQueue
+  # == Instance Methods =====================================================
+
+  def initialize(blocking: true, timeout: nil)
+    @response = [ ]
+    @blocking = blocking
+    @timeout = timeout&.to_f
+    @mutex = Mutex.new
+    @cond_var = ConditionVariable.new
+  end
+
+  def <<(result)
+    @mutex.synchronize do
+      @response << result
+
+      @cond_var.signal
+    end
+  end
+
+  def pop
+    @mutex.synchronize do
+      if (@blocking)
+        if (@timeout)
+          timeout_time = Time.now.to_f + @timeout
+
+          while (@response.empty? and (remaining_time = timeout_time - Time.now.to_f) > 0)
+            @cond_var.wait(@mutex, remaining_time)
+          end
+        else
+          while (@response.empty?)
+            @cond_var.wait(@mutex)
+          end
+        end
+      end
+
+      if (@response.empty?)
+        raise Skein::TimeoutException, 'Queue Empty: Time Out'
+      end
+
+      @response.shift
+    end
+  end
+end

data/lib/skein.rb

@@ -1,12 +1,28 @@
 require 'json'
 
 module Skein
-  VERSION = File.read(File.expand_path('../VERSION', File.dirname(__FILE__))).chomp.freeze
+  # == Constants ============================================================
+
+  VERSION = File.read(File.expand_path('../VERSION', __dir__)).chomp.freeze
+
+  # == Exceptions ===========================================================
+
+  class Exception < ::StandardError
+  end
+
+  class TimeoutException < Exception
+  end
+
+  # == Module Methods =======================================================
 
   def self.version
     VERSION
   end
 
+  def self.config=(config)
+    @config = config
+  end
+
   def self.config
     @config ||= Skein::Config.new
   end
@@ -21,5 +37,5 @@ require_relative './skein/context'
 require_relative './skein/handler'
 require_relative './skein/rabbitmq'
 require_relative './skein/reporter'
-require_relative './skein/rpc'
 require_relative './skein/support'
+require_relative './skein/timeout_queue'

data/skein.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: skein 0.3.7 ruby lib
+# stub: skein 0.8.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "skein".freeze
-  s.version = "0.3.7"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Scott Tadman".freeze]
-  s.date = "2017-03-20"
+  s.date = "2020-03-04"
   s.description = "Wrapper for RabbitMQ that makes blocking RPC calls and handles pub-sub broadcasts.".freeze
   s.email = "tadman@postageapp.com".freeze
   s.executables = ["skein".freeze]
@@ -30,6 +30,8 @@ Gem::Specification.new do |s|
     "bin/skein",
     "config/.gitignore",
     "config/skein.yml.example",
+    "examples/echo",
+    "examples/echo-server",
     "lib/skein.rb",
     "lib/skein/adapter.rb",
     "lib/skein/client.rb",
@@ -45,52 +47,47 @@ Gem::Specification.new do |s|
     "lib/skein/handler/threaded.rb",
     "lib/skein/rabbitmq.rb",
     "lib/skein/reporter.rb",
-    "lib/skein/rpc.rb",
-    "lib/skein/rpc/base.rb",
-    "lib/skein/rpc/error.rb",
-    "lib/skein/rpc/notification.rb",
-    "lib/skein/rpc/request.rb",
-    "lib/skein/rpc/response.rb",
     "lib/skein/support.rb",
+    "lib/skein/timeout_queue.rb",
     "skein.gemspec",
     "test/data/sample_config.yml",
     "test/helper.rb",
     "test/script/em_example",
     "test/unit/test_skein_client.rb",
     "test/unit/test_skein_client_publisher.rb",
+    "test/unit/test_skein_client_rpc.rb",
     "test/unit/test_skein_client_subscriber.rb",
     "test/unit/test_skein_client_worker.rb",
     "test/unit/test_skein_config.rb",
+    "test/unit/test_skein_connected.rb",
     "test/unit/test_skein_context.rb",
     "test/unit/test_skein_rabbitmq.rb",
     "test/unit/test_skein_reporter.rb",
-    "test/unit/test_skein_rpc_error.rb",
-    "test/unit/test_skein_rpc_request.rb",
+    "test/unit/test_skein_rpc_timeout.rb",
     "test/unit/test_skein_support.rb",
     "test/unit/test_skein_worker.rb",
     "tmp/.gitignore"
   ]
   s.homepage = "http://github.com/postageapp/skein".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.5.2".freeze
+  s.rubygems_version = "3.1.2".freeze
   s.summary = "RabbitMQ RPC/PubSub Library".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<birling>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
-      s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<birling>.freeze, [">= 0"])
-      s.add_dependency(%q<rake>.freeze, [">= 0"])
-      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
-      s.add_dependency(%q<test-unit>.freeze, [">= 0"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<birling>.freeze, [">= 0.2.0"])
+    s.add_development_dependency(%q<bunny>.freeze, [">= 0"])
+    s.add_development_dependency(%q<march_hare>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rake>.freeze, [">= 0"])
+    s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
   else
-    s.add_dependency(%q<birling>.freeze, [">= 0"])
+    s.add_dependency(%q<birling>.freeze, [">= 0.2.0"])
+    s.add_dependency(%q<bunny>.freeze, [">= 0"])
+    s.add_dependency(%q<march_hare>.freeze, [">= 0"])
     s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<jeweler>.freeze, [">= 0"])
     s.add_dependency(%q<test-unit>.freeze, [">= 0"])

data/test/helper.rb

@@ -39,4 +39,33 @@ class Test::Unit::TestCase
   def data_path(name)
     File.expand_path(File.join('data', name), File.dirname(__FILE__))
   end
+
+  def wait_for(timeout = 1.0, message = nil)
+    sleep_interval = 0.001
+    start_time = Time.now
+
+    while ((Time.now - start_time) < timeout)
+      return if (yield)
+
+      sleep(sleep_interval)
+    end
+
+    fail(message || 'Timed out waiting for condition (%.1fms elapsed)' % [ (Time.now - start_time) * 1000 ])
+  end
+
+  def in_thread
+    Thread.new do
+      Thread.abort_on_exception = true
+
+      begin
+        yield
+
+      rescue => e
+        $stderr.puts("[%s] %s", [ e.class, e ])
+        $stderr.puts(e.backtrace.join("\n"))
+
+        raise e
+      end
+    end
+  end
 end