rabbitek 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: abffed1ec6fb3e1837dc3f75bd819742e1350935
-  data.tar.gz: 72f165622c0f6346dfacb2666db46e2a0cc787b1
+SHA256:
+  metadata.gz: 61812d7a27d392ac1fd654f0a181972b716be920d0e8d0579537f685d1d16d42
+  data.tar.gz: 800b02c54302fcd9c380ebb3effb63e38f28f85f4bfeb6e4731eb11385a92bbc
 SHA512:
-  metadata.gz: a228c331c23fe8e80d9ace1a4c7847521b79a562cc14f01f413ea419337afb08e979f1673508b247dabb2e0565571f6e2b2ae0113d6fc60e51f50fa1cd29c00f
-  data.tar.gz: ce5ad374f81f11b23345f6105261af2204ad4c19421d97c6345e35ba8f4d3ccb169697212e02ef866c057865a64aa3d2f42950ffea6f198cef54337e7569a72a
+  metadata.gz: 736fd9459b74ab310078f10be4835b600acdec3c8e04093c6d5fa5c90a364a5f1de0f17f6ae4de56cdea56237e63fd0012773732b3a6501970aa55539d826727
+  data.tar.gz: 6c5d6d0a9b429cc88b0c844c78c3de40e0aacad2d98464c4897cfbecbba2b6b745d4823e2739b2fc995953c9273a32b1434052b0ce63d8929cbe4d767448d1b3

data/.travis.yml

@@ -1,7 +1,6 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.3.0
-  - 2.4.0
-  - 2.5.1
+  - 2.6.1
 before_install: gem install bundler -N

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.3.0
+
+Improvements:
+* Handle AR connections correctly (hook in Rails < 5, reloader implementation in Rails >= 5)
+* Allow to specify Rails app folder to require
+
+New features:
+* Add sentry integration
+
 ## v0.2.0
 
 ### Breaking changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rabbitek (0.1.2)
+    rabbitek (0.3.0)
       activesupport (> 3.0)
       bunny (~> 2.11.0)
       oj (~> 3.6)
@@ -11,27 +11,114 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.2.2)
+      actionpack (= 5.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.2)
+      activesupport (= 5.2.2)
+      globalid (>= 0.3.6)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activestorage (5.2.2)
+      actionpack (= 5.2.2)
+      activerecord (= 5.2.2)
+      marcel (~> 0.3.1)
     activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     amq-protocol (2.3.0)
+    arel (9.0.0)
     ast (2.4.0)
+    builder (3.2.3)
     bunny (2.11.0)
       amq-protocol (~> 2.3.0)
-    concurrent-ruby (1.1.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
     diff-lcs (1.3)
-    i18n (1.1.1)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.5.2)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
-    oj (3.7.4)
-    opentracing (0.4.3)
+    nio4r (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    oj (3.8.1)
+    opentracing (0.5.0)
     parallel (1.12.1)
     parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.2)
+      actioncable (= 5.2.2)
+      actionmailer (= 5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      activemodel (= 5.2.2)
+      activerecord (= 5.2.2)
+      activestorage (= 5.2.2)
+      activesupport (= 5.2.2)
+      bundler (>= 1.3.0)
+      railties (= 5.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
@@ -56,21 +143,34 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.10.0)
-    slop (4.6.2)
+    slop (4.7.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.0)
+  pry
   rabbitek!
+  rails (~> 5)
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.58.0)
 
 BUNDLED WITH
-   1.17.1
+   2.0.1

data/README.md

@@ -10,6 +10,7 @@ High performance, easy to use background job processing library for Ruby using R
 * Client & Server hooks
 * OpenTracing (http://opentracing.io/) instrumentation
 * NewRelic instrumentation for sending errors
+* Sentry instrumentation for sending errors
 
 ## Installation
 

data/Rakefile

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
 task default: :spec

data/lib/rabbitek.rb

@@ -14,8 +14,14 @@ require 'active_support/core_ext/string/inflections'
 
 current_dir = File.dirname(__FILE__)
 
-Dir.glob("#{current_dir}/rabbitek/*.rb").each { |file| require file }
-Dir.glob("#{current_dir}/rabbitek/**/*.rb").each { |file| require file }
+require 'rabbitek/bunny_connection'
+require 'rabbitek/cli'
+require 'rabbitek/config'
+require 'rabbitek/loggable'
+Dir.glob("#{current_dir}/rabbitek/cli/**/*.rb").each { |file| require file }
+Dir.glob("#{current_dir}/rabbitek/client/**/*.rb").each { |file| require file }
+Dir.glob("#{current_dir}/rabbitek/server/**/*.rb").each { |file| require file }
+Dir.glob("#{current_dir}/rabbitek/utils/**/*.rb").each { |file| require file }
 
 ##
 # High performance background job processing using RabbitMQ
@@ -28,6 +34,10 @@ module Rabbitek
     yield(config)
   end
 
+  def self.reloader
+    config.reloader
+  end
+
   def self.logger
     @config.logger
   end

data/lib/rabbitek/cli.rb

@@ -46,8 +46,8 @@ module Rabbitek
     def opts
       @opts ||= Slop.parse do |o|
         o.string '-c', '--config', 'config file path. Default: "config/rabbitek.yaml"', default: 'config/rabbitek.yml'
-        o.string '-r', '--require', 'file to require while booting. Default: "config/environment.rb"',
-                 default: 'config/environment.rb'
+        o.string '-r', '--require', 'rails app location or file to require while booting. Default: "."',
+                 default: '.'
         o.on '--version', 'print the version' do
           puts VERSION
           exit
@@ -64,7 +64,12 @@ module Rabbitek
     end
 
     def require_application
-      require File.expand_path(opts[:require])
+      require File.expand_path(opts[:require]) unless File.directory?(opts[:require])
+
+      # Rails application provided
+      require 'rails'
+      require 'rabbitek/rails'
+      require File.expand_path("#{opts[:require]}/config/environment.rb")
     end
 
     def map_consumer_workers!

data/lib/rabbitek/config.rb

@@ -8,7 +8,9 @@ module Rabbitek
       bunny_configuration: { hosts: 'localhost:5672', vhost: '/' },
       log_format: 'json',
       enable_newrelic: true,
-      logger: Logger.new(STDOUT)
+      enable_sentry: true,
+      logger: Logger.new(STDOUT),
+      reloader: proc { |&block| block.call }
     }.freeze
 
     attr_accessor(*DEFAULTS.keys)
@@ -20,12 +22,12 @@ module Rabbitek
       @server_hooks_config = []
     end
 
-    def add_client_hook(hook_object)
-      @client_hooks_config << hook_object
+    def add_client_hook(hook_object, position = @client_hooks_config.size)
+      @client_hooks_config.insert(position, hook_object)
     end
 
-    def add_server_hook(hook_object)
-      @server_hooks_config << hook_object
+    def add_server_hook(hook_object, position = @server_hooks_config.size)
+      @server_hooks_config.insert(position, hook_object)
     end
 
     def client_hooks

data/lib/rabbitek/loggable.rb

@@ -15,6 +15,7 @@ module Rabbitek
     def error(msg)
       log_msg(:error, msg)
       NewRelic::Agent.notice_error(msg) if Rabbitek.config.enable_newrelic && Object.const_defined?('NewRelic')
+      Raven.capture_exception(msg) if Rabbitek.config.enable_sentry && Object.const_defined?('Raven')
       true
     end
 

data/lib/rabbitek/rails.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Rabbitek
+  ##
+  # Rails extensions
+  class Rails < ::Rails::Engine
+    include Loggable
+
+    config.before_configuration do
+      if ::Rails::VERSION::MAJOR < 5 && defined?(::ActiveRecord)
+        info 'Adding Rabbitek::Server::Hooks::ActiveRecordConnectionReset hook'
+
+        Rabbitek.configure do |c|
+          c.add_server_hook(Rabbitek::Server::Hooks::ActiveRecordConnectionReset.new, 0)
+        end
+      end
+    end
+
+    config.after_initialize do
+      if ::Rails::VERSION::MAJOR >= 5
+        info 'Using Rails code reloader'
+
+        Rabbitek.configure { |c| c.reloader = RailsReloader.new }
+      end
+    end
+
+    ##
+    # Implementation of reloader for Rails
+    class RailsReloader
+      def initialize
+        @app = ::Rails.application
+      end
+
+      def call
+        @app.reloader.wrap { yield }
+      end
+
+      def inspect
+        "#<Rabbitek::Rails::RailsReloader @app=#{@app.class.name}>"
+      end
+    end
+  end
+end

data/lib/rabbitek/server/hooks/active_record_connection_reset.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../server_hook'
+
+module Rabbitek
+  module Server
+    module Hooks
+      ##
+      # Active record connection reset to maintain correct connection state
+      # Used only in Rails < 5
+      class ActiveRecordConnectionReset < Rabbitek::ServerHook
+        def initialize
+          raise ArgumentError, 'Use AR connection reset only in Rails < 5!' unless should_allow_hook?
+        end
+
+        def call(consumer, message)
+          ::ActiveRecord::Base.establish_connection unless ::ActiveRecord::Base.connection.active?
+
+          super
+        ensure
+          ::ActiveRecord::Base.clear_active_connections!
+        end
+
+        private
+
+        def should_allow_hook?
+          defined?(::Rails) && ::Rails::VERSION::MAJOR < 5
+        end
+      end
+    end
+  end
+end

data/lib/rabbitek/server/starter.rb

@@ -18,7 +18,7 @@ module Rabbitek
 
       work_queue.subscribe(manual_ack: true) do |delivery_info, properties, payload|
         message = Message.new(delivery_info: delivery_info, properties: properties, payload: payload)
-        on_message_received(message)
+        Rabbitek.reloader.call { on_message_received(message) }
       end
     end
 

data/lib/rabbitek/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rabbitek
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/rabbitek.gemspec

@@ -29,7 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'opentracing', '~> 0.4'
   spec.add_dependency 'slop', '~> 4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rails', '~> 5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.58.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbitek
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Boostcom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,14 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -168,8 +196,10 @@ files:
 - lib/rabbitek/client/publisher.rb
 - lib/rabbitek/config.rb
 - lib/rabbitek/loggable.rb
+- lib/rabbitek/rails.rb
 - lib/rabbitek/server/batcher.rb
 - lib/rabbitek/server/consumer.rb
+- lib/rabbitek/server/hooks/active_record_connection_reset.rb
 - lib/rabbitek/server/hooks/opentracing.rb
 - lib/rabbitek/server/hooks/retry.rb
 - lib/rabbitek/server/hooks/time_tracker.rb
@@ -202,8 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: High performance background job processing