eventboss 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b9d36bef316f4e179285276d2ce46ceddeb35ea23140de3d3b6fedfe3ef23a'
-  data.tar.gz: d2d949a45a3477c0869afb23286a0dda2d4f617a51e500a1e927f2b05f846065
+  metadata.gz: 80a0e305688c13f775cd4878f76541b9fa30a72d197ea0ea53c607dcc66b02db
+  data.tar.gz: 3078f03088605a062e5f703cfd36e3f76ca6028a6ca9c931eed951df5d05e8ed
 SHA512:
-  metadata.gz: dec3db6f0b38a14b33f216567e0f7d6621ee7055ad45c1c68a49a699a1bd8149a8fe067587ae701fcd20d9f9334d399ca508e9b58fd999be5349ac9ff79e3246
-  data.tar.gz: 30eb04a6f2d511624489e42afee250578a745efb084dfb1fd53ec791a8ee78a51134a3673044f63ecefb34d5de341c20cc280149019b1455a72f6cfd17a8e514
+  metadata.gz: e8a13d8d088551d1ed5065551cca08a8e1904df5c3ccdd129df96429c6bae94232e4d8077bd85f6555fdbfec2689642e129c3810de3f9088a8aaf3433faf9908
+  data.tar.gz: d4f4812f0b535a68846004020271a5a543e1e2d66b26235419382923e8898db4cf2b1ea8490b011a8245b66c0d2320c456ea51ffce0362e628b71e1805fd2797

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventboss (1.2.0)
+    eventboss (1.2.1)
       aws-sdk-sns (>= 1.1.0)
       aws-sdk-sqs (>= 1.3.0)
       dotenv (~> 2.1, >= 2.1.1)
@@ -10,17 +10,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     aws-eventstream (1.0.3)
-    aws-partitions (1.215.0)
-    aws-sdk-core (3.68.0)
+    aws-partitions (1.228.0)
+    aws-sdk-core (3.72.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
-      aws-partitions (~> 1.0)
+      aws-partitions (~> 1, >= 1.228.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-sns (1.19.0)
-      aws-sdk-core (~> 3, >= 3.61.1)
+    aws-sdk-sns (1.20.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.22.0)
-      aws-sdk-core (~> 3, >= 3.61.1)
+    aws-sdk-sqs (1.23.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
       aws-eventstream (~> 1.0, >= 1.0.2)

data/README.md

@@ -118,6 +118,23 @@ end
 task 'eventboss:deadletter:reload': :environment
 ```
 
+Using eventboss.yml:
+```yaml
+concurrency: 10
+listeners:
+  # It doesn't make much sense to use both include and exclude.
+  include:
+    - MyListener # It will run only listed listeners (MyListener). If MyListener was listed in exclude it would be omitted as well.
+  exclude:
+    - OtherListener # When include option is not set it will run all listeners except listed here (OtherListener). When include is set it will run only included (but not excluded) listeners.
+```
+Yml config is optional and by default is loaded from `'./config/eventboss.yml'`.
+You can also pass config path as an argument:
+```bash
+eventboss -C my/custom/path/to/config.yml
+```
+Yml config content is merged to configuration last, which means it overwrites ENVs and `.configure`.
+
 ### Logging and error handling
 To have more verbose logging, set `log_level` in configuration (default is `info`).
 

data/bin/eventboss

@@ -1,55 +1,13 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'dotenv'
-require 'eventboss'
-require 'optparse'
-
-Dotenv.load
-
-STDOUT.sync = true
-options = {}
-
-OptionParser.new do |parser|
-  parser.on('-r', '--require LIBRARY', 'Require custom app entrypoint') do |lib|
-    options[:require] = lib
-  end
-end.parse!
+require 'eventboss/cli'
 
 begin
-  require 'rails'
-  if ::Rails::VERSION::MAJOR < 4
-    require File.expand_path('config/environment.rb')
-  else
-    require File.expand_path('config/application.rb')
-    require File.expand_path('config/environment.rb')
-  end
-
-  logger = Eventboss.logger
-  logger.debug('Loaded rails...')
-  # Due to a changes introduced in Rails 6 regarding autoloading
-  # we need to determine how to perform eager_load
-  # @see https://weblog.rubyonrails.org/2019/2/22/zeitwerk-integration-in-rails-6-beta-2/
-  if ::Rails.try(:autoloaders).try(:zeitwerk_enabled?)
-    ::Zeitwerk::Loader.eager_load_all
-  else
-    ::Rails.application.eager_load!
-  end
-rescue LoadError
-  logger = Eventboss.logger
-  logger.debug('Seems like not a Rails app')
-
-  if options[:require].nil?
-    logger.warn('Please use -r to load a custom app entrypoint')
-    exit(0)
-  else
-    logger.debug("Loading #{options[:require]}")
-    require File.expand_path(options[:require])
-  end
+  cli = Eventboss::CLI.instance
+  cli.parse
+  cli.run
+rescue => e
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
 end
-
-logger.info('Starting eventboss...')
-logger.info('Active Listeners:')
-logger.info(Eventboss::QueueListener.list.to_s)
-
-Eventboss.launch

data/lib/eventboss/cli.rb

@@ -0,0 +1,148 @@
+require 'rubygems'
+require 'dotenv'
+require 'optparse'
+require 'yaml'
+require 'erb'
+require 'singleton'
+require_relative '../eventboss'
+
+module Eventboss
+  class CLI
+    include Singleton
+
+    attr_accessor :options
+
+    DEFAULT_OPTIONS = {
+      require: '.'
+    }
+
+    def initialize
+      self.options = DEFAULT_OPTIONS.dup
+    end
+
+    def parse(args = ARGV)
+      parse_options(args)
+      load_config_file
+    end
+
+    def run
+      boot_system
+
+      Eventboss.logger.info('Starting eventboss...')
+
+      Eventboss.launch
+    end
+
+    private
+
+    def boot_system
+      Dotenv.load
+
+      require 'rails'
+      if ::Rails::VERSION::MAJOR < 4
+        require File.expand_path('config/environment.rb')
+      else
+        require File.expand_path('config/application.rb')
+        require File.expand_path('config/environment.rb')
+      end
+
+      Eventboss.logger.debug('Loaded rails...')
+      # Due to a changes introduced in Rails 6 regarding autoloading
+      # we need to determine how to perform eager_load
+      # @see https://weblog.rubyonrails.org/2019/2/22/zeitwerk-integration-in-rails-6-beta-2/
+      if ::Rails.try(:autoloaders).try(:zeitwerk_enabled?)
+        ::Zeitwerk::Loader.eager_load_all
+      else
+        ::Rails.application.eager_load!
+      end
+    rescue LoadError
+      Eventboss.logger.debug('Seems like not a Rails app')
+
+      if options[:require].nil?
+        Eventboss.logger.warn('Please use -r to load a custom app entrypoint')
+        exit(0)
+      else
+        Eventboss.logger.debug("Loading #{options[:require]}")
+        require File.expand_path(options[:require])
+      end
+    end
+
+    def parse_options(args)
+      option_parser(options).parse!(args)
+
+      options
+    end
+
+    def load_config_file
+      # check config file presence
+      if options[:config]
+        raise ArgumentError, "No such file #{options[:config]}" unless File.exist?(options[:config])
+      else
+        config_dir = if File.directory?(options[:require].to_s)
+                       File.join(options[:require], 'config')
+                     else
+                       File.join(DEFAULT_OPTIONS[:require], 'config')
+                     end
+
+        %w[eventboss.yml eventboss.yml.erb].each do |config_file|
+          path = File.join(config_dir, config_file)
+          options[:config] ||= path if File.exist?(path)
+        end
+      end
+
+      # parse config file options
+      if options[:config]
+        opts = parse_config(options[:config])
+
+        opts.each do |option_name, option|
+          if Eventboss::Configuration::OPTS_ALLOWED_IN_CONFIG_FILE.include?(option_name)
+            Eventboss.configuration.public_send("#{option_name}=", option)
+          else
+            Eventboss.logger.error("Not supported option (#{option_name}) provided in config file.")
+            exit(1)
+          end
+        end
+      end
+    end
+
+    def parse_config(path)
+      opts = YAML.load(ERB.new(File.read(path)).result) || {}
+
+      if opts.respond_to? :deep_symbolize_keys!
+        opts.deep_symbolize_keys!
+      else
+        symbolize_keys_deep!(opts)
+      end
+
+      opts
+    end
+
+    def symbolize_keys_deep!(hash)
+      hash.keys.each do |k|
+        symkey = k.respond_to?(:to_sym) ? k.to_sym : k
+        hash[symkey] = hash.delete k
+        symbolize_keys_deep! hash[symkey] if hash[symkey].is_a? Hash
+      end
+    end
+
+    def option_parser(opts)
+      parser = OptionParser.new do |parser|
+        parser.on('-r', '--require LIBRARY', 'Require custom app entrypoint') do |lib|
+          opts[:require] = lib
+        end
+
+        parser.on('-C', '--config PATH', 'Config file path') do |config|
+          opts[:config] = config
+        end
+      end
+
+      parser.banner = "Eventboss [options]"
+      parser.on_tail "-h", "--help", "Show help" do
+        Eventboss.logger.info parser
+        exit 1
+      end
+
+      parser
+    end
+  end
+end

data/lib/eventboss/configuration.rb

@@ -1,5 +1,11 @@
 module Eventboss
   class Configuration
+    OPTS_ALLOWED_IN_CONFIG_FILE = %i[
+      concurrency
+      sns_sqs_name_infix
+      listeners
+    ]
+
     attr_writer :raise_on_missing_configuration,
                 :error_handlers,
                 :concurrency,
@@ -14,7 +20,9 @@ module Eventboss
                 :aws_secret_access_key,
                 :aws_sns_endpoint,
                 :aws_sqs_endpoint,
-                :sns_sqs_name_infix
+                :sns_sqs_name_infix,
+                :listeners
+
 
     def raise_on_missing_configuration
       defined_or_default('raise_on_missing_configuration') { ENV['EVENTBUS_RAISE_ON_MISSING_CONFIGURATION']&.downcase == 'true' }
@@ -95,6 +103,10 @@ module Eventboss
       defined_or_default('sns_sqs_name_infix') { ENV['EVENTBUS_SQS_SNS_NAME_INFIX'] || 'eventboss' }
     end
 
+    def listeners
+      defined_or_default('listeners') { {} }
+    end
+
     private
 
     def defined_or_default(variable_name)

data/lib/eventboss/queue_listener.rb

@@ -1,9 +1,30 @@
 module Eventboss
   class QueueListener
     class << self
+      def select(include:, exclude:)
+        listeners = list.values.map(&:name)
+
+        listeners &= include if include
+        listeners -= exclude if exclude
+
+        list.select { |_queue, listener| listeners.include?(listener.name) }
+      end
+
+      private
+
       def list
         Hash[Eventboss::Listener::ACTIVE_LISTENERS.map do |src_app_event, listener|
-          [Eventboss::Queue.new("#{Eventboss.configuration.eventboss_app_name}-#{Eventboss.configuration.sns_sqs_name_infix}-#{src_app_event}-#{Eventboss.env}"), listener]
+          [
+            Eventboss::Queue.new(
+              [
+                Eventboss.configuration.eventboss_app_name,
+                Eventboss.configuration.sns_sqs_name_infix,
+                src_app_event,
+                Eventboss.env
+              ].join('-')
+            ),
+            listener
+          ]
         end]
       end
     end

data/lib/eventboss/runner.rb

@@ -4,7 +4,10 @@ module Eventboss
 
     class << self
       def launch
-        queues = Eventboss::QueueListener.list
+        queues = Eventboss::QueueListener.select(
+          include: Eventboss.configuration.listeners[:include],
+          exclude: Eventboss.configuration.listeners[:exclude]
+        )
         client = Eventboss.configuration.sqs_client
         config = Eventboss.configuration
 
@@ -14,6 +17,8 @@ module Eventboss
 
         self_read = setup_signals([:SIGTERM])
 
+        logger.info('Active Listeners:')
+        logger.info(queues.to_s)
         begin
           launcher.start
           handle_signals(self_read, launcher)

data/lib/eventboss/version.rb

@@ -1,3 +1,3 @@
 module Eventboss
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventboss
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - AirHelp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -121,6 +121,7 @@ files:
 - bin/eventboss
 - eventboss.gemspec
 - lib/eventboss.rb
+- lib/eventboss/cli.rb
 - lib/eventboss/configuration.rb
 - lib/eventboss/error_handlers/airbrake.rb
 - lib/eventboss/error_handlers/db_connection_drop_handler.rb