msgr 1.2.0 → 1.3.0

data/lib/msgr.rb

@@ -26,6 +26,7 @@ require 'msgr/railtie' if defined? Rails
 module Msgr
   class << self
     attr_writer :client, :config
+
     delegate :publish, to: :client
 
     def config

data/lib/msgr/binding.rb

@@ -4,7 +4,14 @@ module Msgr
   class Binding
     include Logging
 
-    attr_reader :queue, :subscription, :connection, :channel, :route, :dispatcher
+    attr_reader(
+      :channel,
+      :connection,
+      :dispatcher,
+      :queue,
+      :route,
+      :subscription
+    )
 
     def initialize(connection, route, dispatcher)
       @connection = connection
@@ -43,13 +50,11 @@ module Msgr
 
     def subscribe
       @subscription = queue.subscribe(manual_ack: true) do |*args|
-        begin
-          dispatcher.call Message.new(channel, *args, route)
-        rescue => err
-          log(:error) do
-            "Rescued error from subscribe: #{err.class.name}: " \
-            "#{err}\n#{err.backtrace.join("\n")}"
-          end
+        dispatcher.call Message.new(channel, *args, route)
+      rescue StandardError => e
+        log(:error) do
+          "Rescued error from subscribe: #{e.class.name}: " \
+          "#{e}\n#{e.backtrace.join("\n")}"
         end
       end
     end

data/lib/msgr/channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Msgr
   class Channel
     include Logging
@@ -26,8 +28,8 @@ module Msgr
       end
     end
 
-    def queue(name)
-      @channel.queue(prefix(name), durable: true).tap do |queue|
+    def queue(name, **opts)
+      @channel.queue(prefix(name), durable: true, **opts).tap do |queue|
         log(:debug) do
           "Create queue #{queue.name} (durable: #{queue.durable?}, " \
           "auto_delete: #{queue.auto_delete?})"
@@ -62,4 +64,4 @@ module Msgr
       @channel.close if @channel.open?
     end
   end
-end
+end

data/lib/msgr/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optionparser'
 
 module Msgr
@@ -8,7 +10,8 @@ module Msgr
       @options = options
 
       if !File.exist?(options[:require]) ||
-          (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
+         (File.directory?(options[:require]) &&
+         !File.exist?("#{options[:require]}/config/application.rb"))
         raise <<~ERR
           Rails application or required ruby file not found: #{options[:require]}
         ERR
@@ -22,15 +25,13 @@ module Msgr
         require 'rails'
         if ::Rails::VERSION::MAJOR == 4
           require File.expand_path("#{options[:require]}/config/application.rb")
-          ::Rails::Application.initializer "msgr.eager_load" do
+          ::Rails::Application.initializer 'msgr.eager_load' do
             ::Rails.application.config.eager_load = true
           end
-          require 'msgr/railtie'
-          require File.expand_path("#{options[:require]}/config/environment.rb")
-        else
-          require 'msgr/railtie'
-          require File.expand_path("#{options[:require]}/config/environment.rb")
         end
+
+        require 'msgr/railtie'
+        require File.expand_path("#{options[:require]}/config/environment.rb")
       else
         require(options[:require])
       end
@@ -43,7 +44,7 @@ module Msgr
       Msgr.logger = Logger.new(STDOUT)
       Msgr.client.start
 
-      while readable = IO.select([r])
+      while (readable = IO.select([r]))
         case readable.first[0].gets.strip
           when 'INT', 'TERM'
             Msgr.client.stop
@@ -61,18 +62,24 @@ module Msgr
 
       private
 
-      def parse(argv)
+      def parse(_argv)
         options = {
           require: Dir.pwd,
           environment: 'development'
         }
 
         OptionParser.new do |o|
-          o.on '-r', '--require [PATH|DIR]', 'Location of Rails application (default to current directory)' do |arg|
+          o.on(
+            '-r', '--require [PATH|DIR]',
+            'Location of Rails application (default to current directory)'
+          ) do |arg|
             options[:require] = arg
           end
 
-          o.on '-e', '--environment [env]', 'Rails environment (default to development)' do |arg|
+          o.on(
+            '-e', '--environment [env]',
+            'Rails environment (default to development)'
+          ) do |arg|
             options[:environment] = arg
           end
         end.parse!

data/lib/msgr/client.rb

@@ -2,15 +2,14 @@
 
 require 'uri'
 require 'cgi'
+require 'json'
 
 module Msgr
-  # rubocop:disable Metrics/ClassLength
   class Client
     include Logging
 
     attr_reader :config
 
-    # rubocop:disable MethodLength
     def initialize(config = {})
       @config = {
         host: '127.0.0.1',
@@ -18,7 +17,7 @@ module Msgr
         max: 2
       }
 
-      @config.merge! parse(config.delete(:uri)) if config.key?(:uri)
+      @config.merge! parse(config.delete(:uri)) if config[:uri]
       @config.merge! config.symbolize_keys
 
       @mutex  = ::Mutex.new
@@ -27,12 +26,7 @@ module Msgr
 
       log(:debug) { "Created new client on process ##{@pid}..." }
     end
-    # rubocop:enable all
 
-    # rubocop:disable AbcSize
-    # rubocop:disable MethodLength
-    # rubocop:disable PerceivedComplexity
-    # rubocop:disable CyclomaticComplexity
     def uri
       @uri = begin
         uri = ::URI.parse('amqp://localhost')
@@ -50,7 +44,6 @@ module Msgr
         uri
       end
     end
-    # rubocop:enable all
 
     def running?
       mutex.synchronize do
@@ -59,7 +52,6 @@ module Msgr
       end
     end
 
-    # rubocop:disable AbcSize
     def start
       mutex.synchronize do
         check_process!
@@ -72,7 +64,6 @@ module Msgr
         connection.bind(@routes)
       end
     end
-    # rubocop:enable all
 
     def connect
       mutex.synchronize do
@@ -85,7 +76,6 @@ module Msgr
       end
     end
 
-    # rubocop:disable AbcSize
     def stop(opts = {})
       mutex.synchronize do
         check_process!
@@ -100,7 +90,6 @@ module Msgr
         reset
       end
     end
-    # rubocop:enable all
 
     def purge(release: false)
       mutex.synchronize do
@@ -112,6 +101,15 @@ module Msgr
       end
     end
 
+    ##
+    # Purge all queues known to Msgr, if they exist.
+    #
+    def drain
+      @routes.each do |route|
+        connection.purge_queue(route.name)
+      end
+    end
+
     def publish(payload, opts = {})
       mutex.synchronize do
         check_process!
@@ -149,6 +147,7 @@ module Msgr
 
     def check_process!
       return if ::Process.pid == @pid
+
       log(:warn) do
         "Fork detected. Reset internal state. (Old PID: #{@pid} / " \
         "New PID: #{::Process.pid}"
@@ -178,22 +177,20 @@ module Msgr
       @dispatcher = nil
     end
 
-    # rubocop:disable AbcSize
     def parse(uri)
       # Legacy parsing of URI configuration; does not follow usual
       # AMQP vhost encoding but used regular URL path
       uri = ::URI.parse(uri)
 
       config = {}
-      config[:user]  ||= uri.user     if uri.user
-      config[:pass]  ||= uri.password if uri.password
-      config[:host]  ||= uri.host     if uri.host
-      config[:port]  ||= uri.port     if uri.port
-      config[:vhost] ||= uri.path     unless uri.path.empty?
+      config[:user] ||= uri.user if uri.user
+      config[:pass] ||= uri.password if uri.password
+      config[:host] ||= uri.host     if uri.host
+      config[:port] ||= uri.port     if uri.port
+      config[:vhost] ||= uri.path unless uri.path.empty?
       config[:ssl]   ||= uri.scheme.casecmp('amqps').zero?
 
       config
     end
-    # rubocop:enable all
   end
 end

data/lib/msgr/connection.rb

@@ -3,7 +3,6 @@
 require 'bunny'
 
 module Msgr
-  # rubocop:disable Metrics/ClassLength
   class Connection
     include Logging
 
@@ -49,6 +48,7 @@ module Msgr
 
     def release
       return if bindings.empty?
+
       log(:debug) { "Release bindings (#{bindings.size})..." }
 
       bindings.each(&:release)
@@ -56,6 +56,7 @@ module Msgr
 
     def delete
       return if bindings.empty?
+
       log(:debug) { "Delete bindings (#{bindings.size})..." }
 
       bindings.each(&:delete)
@@ -63,11 +64,22 @@ module Msgr
 
     def purge(**kwargs)
       return if bindings.empty?
+
       log(:debug) { "Purge bindings (#{bindings.size})..." }
 
       bindings.each {|b| b.purge(**kwargs) }
     end
 
+    def purge_queue(name)
+      # Creating the queue in passive mode ensures that queues that do not exist
+      # won't be created just to purge them.
+      # That requires creating a new channel every time, as exceptions (on
+      # missing queues) invalidate the channel.
+      channel.queue(name, passive: true).purge
+    rescue Bunny::NotFound
+      nil
+    end
+
     def bindings
       @bindings ||= []
     end

data/lib/msgr/consumer.rb

@@ -5,6 +5,7 @@ module Msgr
     include Logging
 
     attr_reader :message
+
     delegate :payload, to: :@message
     delegate :action, to: :'@message.route'
     delegate :consumer, to: :'@message.consumer'
@@ -14,9 +15,7 @@ module Msgr
         @auto_ack || @auto_ack.nil?
       end
 
-      def auto_ack=(val)
-        @auto_ack = val
-      end
+      attr_writer :auto_ack
     end
 
     def dispatch(message)

data/lib/msgr/dispatcher.rb

@@ -27,9 +27,6 @@ module Msgr
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/CyclomaticComplexity
     def dispatch(message)
       consumer_class = Object.const_get message.route.consumer
 
@@ -37,17 +34,18 @@ module Msgr
 
       consumer_class.new.dispatch message
 
-      # Acknowledge message unless it is already acknowledged or auto_ack is disabled.
-      message.ack unless message.acked? or not consumer_class.auto_ack?
-    rescue => error
+      # Acknowledge message only if it is not already acknowledged and auto
+      # acknowledgment is enabled.
+      message.ack unless message.acked? || !consumer_class.auto_ack?
+    rescue StandardError => e
       message.nack unless message.acked?
 
       log(:error) do
-        "Dispatcher error: #{error.class.name}: #{error}\n" +
-          error.backtrace.join("\n")
+        "Dispatcher error: #{e.class.name}: #{e}\n" +
+          e.backtrace.join("\n")
       end
 
-      raise error if config[:raise_exceptions]
+      raise e if config[:raise_exceptions]
     ensure
       if defined?(ActiveRecord) &&
          ActiveRecord::Base.connection_pool.active_connection?

data/lib/msgr/logging.rb

@@ -3,7 +3,9 @@
 module Msgr
   module Logging
     def log(level)
+      # rubocop:disable Style/SafeNavigation - Msgr.logger can be false
       Msgr.logger.send(level) { "#{log_name} #{yield}" } if Msgr.logger
+      # rubocop:enable all
     end
 
     def log_name

data/lib/msgr/message.rb

@@ -11,8 +11,7 @@ module Msgr
       @payload       = payload
       @route         = route
 
-      # rubocop:disable Style/GuardClause
-      if content_type == 'application/json'
+      if content_type == 'application/json' # rubocop:disable Style/GuardClause
         @payload = JSON.parse(payload)
         @payload.symbolize_keys! if @payload.respond_to? :symbolize_keys!
       end

data/lib/msgr/railtie.rb

@@ -4,6 +4,11 @@ module Msgr
   class Railtie < ::Rails::Railtie
     config.msgr = ActiveSupport::OrderedOptions.new
 
+    DEFAULT_OPTIONS = {
+      checkcredentials: true,
+      routing_file: "#{Rails.root}/config/msgr.rb"
+    }.freeze
+
     if File.exist?("#{Rails.root}/app/consumers")
       config.autoload_paths << File.expand_path("#{Rails.root}/app/consumers")
     end
@@ -12,84 +17,24 @@ module Msgr
       app.config.msgr.logger ||= Rails.logger
     end
 
-    # Start msgr
     initializer 'msgr.start' do
       config.after_initialize do |app|
         Msgr.logger = app.config.msgr.logger
 
-        self.class.load app.config.msgr
+        self.class.load(app.config_for(:rabbitmq))
       end
     end
 
-    class << self
-      def load(rails_config)
-        cfg = parse_config load_config rails_config
-        return unless cfg # no config given -> does not load Msgr
-
-        Msgr.config = cfg
-        Msgr.client.connect if cfg[:checkcredentials]
-        Msgr.start if cfg[:autostart]
-      end
-
-      def parse_config(cfg)
-        unless cfg.is_a? Hash
-          Rails.logger.warn '[Msgr] Could not load rabbitmq config: Config must be a Hash'
-          return nil
-        end
-
-        unless cfg[Rails.env].is_a?(Hash)
-          Rails.logger.warn "Could not load rabbitmq config for environment \"#{Rails.env}\": is not a Hash"
-          return nil
-        end
-
-        cfg = HashWithIndifferentAccess.new cfg[Rails.env]
-        unless cfg[:uri]
-          raise ArgumentError.new('Could not load rabbitmq environment config: URI missing.')
-        end
-
-        case cfg[:autostart]
-          when true, 'true', 'enabled'
-            cfg[:autostart] = true
-          when false, 'false', 'disabled', nil
-            cfg[:autostart] = false
-          else
-            raise ArgumentError.new("Invalid value for rabbitmq config autostart: \"#{cfg[:autostart]}\"")
-        end
-
-        case cfg[:checkcredentials]
-          when true, 'true', 'enabled', nil
-            cfg[:checkcredentials] = true
-          when false, 'false', 'disabled'
-            cfg[:checkcredentials] = false
-          else
-            raise ArgumentError.new("Invalid value for rabbitmq config checkcredentials: \"#{cfg[:checkcredentials]}\"")
-        end
-
-        case cfg[:raise_exceptions]
-          when true, 'true', 'enabled'
-            cfg[:raise_exceptions] = true
-          when false, 'false', 'disabled', nil
-            cfg[:raise_exceptions] = false
-          else
-            raise ArgumentError.new("Invalid value for rabbitmq config raise_exceptions: \"#{cfg[:raise_exceptions]}\"")
-        end
-
-        cfg[:routing_file] ||= Rails.root.join('config/msgr.rb').to_s
-        cfg
-      end
-
-      def load_config(options)
-        if options.rabbitmq_config || !Rails.application.respond_to?(:config_for)
-          load_file options.rabbitmq_config || Rails.root.join('config', 'rabbitmq.yml')
-        else
-          conf = Rails.application.config_for :rabbitmq
+    rake_tasks do
+      load File.expand_path('tasks/msgr/drain.rake', __dir__)
+    end
 
-          {Rails.env.to_s => conf}
-        end
-      end
+    class << self
+      def load(config)
+        config = DEFAULT_OPTIONS.merge(config)
 
-      def load_file(path)
-        YAML.safe_load ERB.new(File.read(path)).result
+        Msgr.config = config
+        Msgr.client.connect if config.fetch(:checkcredentials)
       end
     end
   end