railway-ipc 0.1.3 → 0.1.4

data/lib/railway_ipc/rpc/rpc.rb

@@ -0,0 +1,2 @@
+require 'railway_ipc/rpc/client/client'
+require 'railway_ipc/rpc/server/server'

data/lib/railway_ipc/rpc/server/server.rb

@@ -0,0 +1,89 @@
+require 'railway_ipc/rpc/server/server_response_handlers'
+require 'railway_ipc/rpc/concerns/error_adapter_configurable'
+require 'railway_ipc/rpc/concerns/message_observation_configurable'
+
+module RailwayIpc
+  class Server
+    extend RailwayIpc::RPC::ErrorAdapterConfigurable
+    extend RailwayIpc::RPC::MessageObservationConfigurable
+    attr_reader :message, :responder
+
+    def self.respond_to(message_type, with:)
+      RailwayIpc::RPC::ServerResponseHandlers.instance.register(handler: with, message: message_type)
+    end
+
+    def initialize(opts = {automatic_recovery: true}, rabbit_adapter: RailwayIpc::Rabbitmq::Adapter)
+      @rabbit_connection = rabbit_adapter.new(
+        queue_name: self.class.queue_name,
+        exchange_name: self.class.exchange_name,
+        options: opts
+      )
+    end
+
+    def run
+      rabbit_connection
+        .connect
+        .create_exchange
+        .create_queue(durable: true)
+        .bind_queue_to_exchange
+      subscribe_to_queue
+    end
+
+    def work(payload)
+      decoded_payload = RailwayIpc::Rabbitmq::Payload.decode(payload)
+      case decoded_payload.type
+      when *registered_handlers
+        responder = get_responder(decoded_payload)
+        @message = get_message_class(decoded_payload).decode(decoded_payload.message)
+        responder.respond(message)
+      else
+        @message = LearnIpc::ErrorMessage.decode(decoded_payload.message)
+        raise RailwayIpc::UnhandledMessageError, "#{self.class} does not know how to handle #{decoded_payload.type}"
+      end
+    rescue StandardError => e
+      RailwayIpc.logger.log_exception(
+        feature: 'railway_consumer',
+        error: e.class,
+        error_message: e.message,
+        payload: payload
+      )
+      raise e
+    end
+
+    def handle_request(payload)
+      response = work(payload)
+    rescue StandardError => e
+      RailwayIpc.logger.error(message, "Error responding to message. Error: #{e.class}, #{e.message}")
+      response = self.class.rpc_error_adapter_class.error_message(e, message)
+    ensure
+      if response
+        rabbit_connection.reply(
+          RailwayIpc::Rabbitmq::Payload.encode(response), message.reply_to
+        )
+      end
+    end
+
+    private
+
+    attr_reader :rabbit_connection
+
+    def get_message_class(decoded_payload)
+      RailwayIpc::RPC::ServerResponseHandlers.instance.get(decoded_payload.type).message
+    end
+
+    def get_responder(decoded_payload)
+      RailwayIpc::RPC::ServerResponseHandlers.instance.get(decoded_payload.type).handler.new
+    end
+
+    def registered_handlers
+      RailwayIpc::RPC::ServerResponseHandlers.instance.registered
+    end
+
+    def subscribe_to_queue
+      rabbit_connection.subscribe do |_delivery_info, _metadata, payload|
+        handle_request(payload)
+      end
+    end
+
+  end
+end

data/lib/railway_ipc/rpc/server/server_response_handlers.rb

@@ -0,0 +1,17 @@
+require 'railway_ipc/handler_store'
+module RailwayIpc
+  module RPC
+    class ServerResponseHandlers
+      include Singleton
+      extend Forwardable
+
+      def_delegators :handler_store, :registered, :register, :get
+
+      private
+
+      def handler_store
+        @handler_store ||= RailwayIpc::HandlerStore.new
+      end
+    end
+  end
+end

data/lib/railway_ipc/tasks/generate_migrations.rake

@@ -0,0 +1,26 @@
+require 'fileutils'
+
+namespace :railway_ipc do
+  namespace :generate do
+    desc "Generates migrations to store Railway messages"
+    task :migrations do
+      if defined?(ActiveRecord::Base)
+        puts "generating Railway IPC table migrations"
+        seconds = 0
+        gem_path = Gem.loaded_specs['railway-ipc'].full_gem_path
+        folder_dest = "#{Rails.root.to_s}/db/migrate"
+        FileUtils.mkdir_p(folder_dest)
+
+        Dir.glob("#{gem_path}/priv/migrations/*.rb").each do |file_path|
+          file_name = File.basename(file_path)
+          migration_timestamp = (Time.now + seconds).utc.strftime("%Y%m%d%H%M%S") % "%.14d"
+          new_file_name = "#{migration_timestamp}_#{file_name}"
+          FileUtils.copy_file(file_path, "#{folder_dest}/#{new_file_name}")
+          seconds += 1
+        end
+      else
+        raise "Migration generation requires active record"
+      end
+    end
+  end
+end

data/lib/railway_ipc/version.rb

@@ -1,3 +1,3 @@
 module RailwayIpc
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/priv/migrations/add_railway_ipc_consumed_messages.rb

@@ -0,0 +1,19 @@
+class AddRailwayIpcConsumedMessages < ActiveRecord::Migration
+  def change
+    create_table :railway_ipc_consumed_messages, id: false do | t |
+      t.uuid :uuid, null: false
+      t.string :message_type
+      t.uuid :user_uuid
+      t.uuid :correlation_id
+      t.text :encoded_message
+      t.string :status, null: false
+      t.string :queue
+      t.string :exchange
+
+      t.datetime :updated_at
+      t.datetime :inserted_at
+    end
+
+    add_index :railway_ipc_consumed_messages, :uuid, unique: true
+  end
+end

data/priv/migrations/add_railway_ipc_published_messages.rb

@@ -0,0 +1,18 @@
+class AddRailwayIpcPublishedMessages < ActiveRecord::Migration
+  def change
+    create_table :railway_ipc_published_messages, id: false do | t |
+      t.uuid :uuid, null: false
+      t.string :message_type
+      t.uuid :user_uuid
+      t.uuid :correlation_id
+      t.text :encoded_message
+      t.string :status, null: false
+      t.string :exchange
+
+      t.datetime :updated_at
+      t.datetime :inserted_at
+    end
+
+    add_index :railway_ipc_published_messages, :uuid, unique: true
+  end
+end

data/railway_ipc.gemspec

@@ -3,15 +3,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "railway_ipc/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "railway-ipc"
-  spec.version       = RailwayIpc::VERSION
-  spec.authors       = ""
-  spec.email         = ""
+  spec.name = "railway-ipc"
+  spec.version = RailwayIpc::VERSION
+  spec.authors = ""
+  spec.email = ""
 
-  spec.summary       = %q{IPC components for Rails}
-  spec.description   = %q{IPC components for Rails}
-  spec.homepage      = "http://learn.co"
-  spec.license       = "MIT"
+  spec.summary = %q{IPC components for Rails}
+  spec.description = %q{IPC components for Rails}
+  spec.homepage = "http://learn.co"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -19,23 +19,32 @@ Gem::Specification.new do |spec|
     spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+          "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rake", ">= 10.0.0"
   spec.add_development_dependency "bundler", "2.0.1"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry-byebug", '3.4.2'
-  spec.add_development_dependency 'google-protobuf', '~> 3.9'
-  spec.add_dependency 'sneakers', '~> 2.3.5'
-  spec.add_dependency 'bunny', '~> 2.2.0'
+  spec.add_development_dependency "factory_bot", "~> 5.1"
+  spec.add_development_dependency "pry-byebug", "3.4.2"
+  spec.add_development_dependency "google-protobuf", "~> 3.9"
+  spec.add_dependency "sneakers", "~> 2.3.5"
+  spec.add_dependency "bunny", "~> 2.2.0"
+
+  # Setup for testing Rails type code within mock Rails app
+  spec.add_development_dependency "rails", "~> 5.0.7"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "pg", "~> 0.18"
+  spec.add_development_dependency "shoulda-matchers", "~> 4.2"
+  spec.add_development_dependency "database_cleaner", "~> 1.7"
+  spec.add_development_dependency "listen", "~> 3.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railway-ipc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.7
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.5
 description: IPC components for Rails
 email: ''
 executables: []
@@ -116,6 +214,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -127,24 +226,40 @@ files:
 - bin/setup
 - lib/railway_ipc.rb
 - lib/railway_ipc/Rakefile
-- lib/railway_ipc/client.rb
-- lib/railway_ipc/concerns/message_handling.rb
-- lib/railway_ipc/consumer.rb
+- lib/railway_ipc/base_message.pb.rb
+- lib/railway_ipc/consumer/consumer.rb
+- lib/railway_ipc/consumer/consumer_response_handlers.rb
+- lib/railway_ipc/errors.rb
 - lib/railway_ipc/handler.rb
+- lib/railway_ipc/handler_manifest.rb
+- lib/railway_ipc/handler_store.rb
 - lib/railway_ipc/logger.rb
+- lib/railway_ipc/models/consumed_message.rb
+- lib/railway_ipc/models/published_message.rb
 - lib/railway_ipc/null_handler.rb
 - lib/railway_ipc/null_message.rb
 - lib/railway_ipc/publisher.rb
-- lib/railway_ipc/rabbitmq/connection.rb
+- lib/railway_ipc/rabbitmq/adapter.rb
 - lib/railway_ipc/rabbitmq/payload.rb
 - lib/railway_ipc/railtie.rb
 - lib/railway_ipc/responder.rb
 - lib/railway_ipc/response.rb
-- lib/railway_ipc/server.rb
+- lib/railway_ipc/rpc/client/client.rb
+- lib/railway_ipc/rpc/client/client_response_handlers.rb
+- lib/railway_ipc/rpc/client/errors/timeout_error.rb
+- lib/railway_ipc/rpc/concerns/error_adapter_configurable.rb
+- lib/railway_ipc/rpc/concerns/message_observation_configurable.rb
+- lib/railway_ipc/rpc/concerns/publish_location_configurable.rb
+- lib/railway_ipc/rpc/rpc.rb
+- lib/railway_ipc/rpc/server/server.rb
+- lib/railway_ipc/rpc/server/server_response_handlers.rb
+- lib/railway_ipc/tasks/generate_migrations.rake
 - lib/railway_ipc/tasks/start_consumers.rake
 - lib/railway_ipc/tasks/start_servers.rake
 - lib/railway_ipc/unhandled_message_error.rb
 - lib/railway_ipc/version.rb
+- priv/migrations/add_railway_ipc_consumed_messages.rb
+- priv/migrations/add_railway_ipc_published_messages.rb
 - railway_ipc.gemspec
 homepage: http://learn.co
 licenses:
@@ -167,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: IPC components for Rails

data/lib/railway_ipc/client.rb

@@ -1,87 +0,0 @@
-require "railway_ipc/rabbitmq/connection"
-require "railway_ipc/concerns/message_handling"
-
-module RailwayIpc
-  class Client
-    include RailwayIpc::Rabbitmq::Connection
-    include RailwayIpc::Concerns::MessageHandling
-
-    class TimeoutError < StandardError; end
-
-    attr_accessor :call_id, :response, :lock, :condition, :reply_queue, :request_message
-
-    def self.request(message)
-      new.request(message)
-    end
-
-    def self.publish_to(queue:, exchange:)
-      queue(queue)
-      exchange(exchange)
-    end
-
-    def initialize(queue=nil, pool=nil, opts={automatic_recovery: false})
-      super
-      setup_exchange
-    end
-
-    def request(request_message, timeout=10)
-      @request_message = request_message
-      setup_reply_queue
-      publish_message
-      poll_for_message(timeout)
-      build_timeout_response unless response
-      response
-    end
-
-    private
-
-    def setup_exchange
-      @exchange = Bunny::Exchange.new(channel, :fanout, self.class.exchange_name, durable: true)
-      channel.queue(self.class.queue_name, durable: true).bind(exchange)
-    end
-
-    def setup_reply_queue
-      @reply_queue = channel.queue('', auto_delete: true, exclusive: true)
-      @call_id = request_message.correlation_id
-      request_message.reply_to = reply_queue.name
-    end
-
-    def publish_message
-      RailwayIpc.logger.info(request_message, "Sending request")
-      exchange.publish(RailwayIpc::Rabbitmq::Payload.encode(request_message), routing_key: '')
-    end
-
-    def poll_for_message(timeout)
-      count = 0
-      until response || count >= timeout do
-        delivery_info, properties, payload = reply_queue.pop
-        handle_response(payload) if payload
-        count+= 1
-        sleep(1)
-      end
-    end
-
-    def build_timeout_response
-      error = TimeoutError.new("Client timed out")
-      response_message = rpc_error_adapter.error_message(error, request_message)
-      self.response = RailwayIpc::Response.new(response_message, success: false)
-      self.stop
-    end
-
-    def handle_response(payload)
-      begin
-        response_message = work(payload)
-        if response_message.correlation_id == self.call_id
-          RailwayIpc.logger.info(response_message, "Handling response")
-          self.response = RailwayIpc::Response.new(response_message, success: true)
-          self.stop
-        end
-      rescue StandardError => e
-        RailwayIpc.logger.error(message, "Error handling response. Error #{e.class}, message: #{e.message}")
-        response_message = rpc_error_adapter.error_message(e, message)
-        self.response = RailwayIpc::Response.new(response_message, success: false)
-        self.stop
-      end
-    end
-  end
-end