eventboss 1.3.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75049f48f1c8433cfa188e43b2b01aa1362460f14e54cf86147dddea8f37b554
-  data.tar.gz: 22828a987f1b8d6e3eaa3b1c6944a515e379729ab19190c99c232277d0f71463
+  metadata.gz: 8b837d9db4a587bec35fc7d31765551263011c2bd33559944c7de34ffa885c3b
+  data.tar.gz: 3b0f1808873bf4a8d2b5407b82de0ced2f86a2bd5f67775f4f3c73493dfe1bd7
 SHA512:
-  metadata.gz: 9f11ff92660d9eb27d1d5d6b0fb7c778887c5fccf7e133d6f0d27679d751aa078c93e7e5b0f90fc259a0c86a2a17e82480ffb985ec0ecead9c2fedb0779f5fa1
-  data.tar.gz: e2b5673cfce08d06ffef4ef74ab742765e45b03905ebaad2cbd32495c0b0b28ec3b4c7620c0180c8e0e9662b9992ea115a4621397040f98dbd3535d852978db8
+  metadata.gz: d7c7a8696654ccefd5d25596a9f439c8fbbd8ca41a71525f195010fbb0f469db5f6937632e0b6c46a67cb774b67fc3aeec174e507e649f46c2ab76e55ea56dee
+  data.tar.gz: 4d7c2b81fc401f5d7890ad1144ee87cd933a34470110a50b7d94e6d88fbcf5792f938777f7b93b3ec37280dc09d5b7c17f2e2b9ac9dc34f50f0c8ed4075af8ed

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2020-04-18
+
+- Introduce server middlewares (#31)
+
 ## [1.1.0] - 2019-07-16
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventboss (1.3.3)
+    eventboss (1.7.0)
       aws-sdk-sns (>= 1.1.0)
       aws-sdk-sqs (>= 1.3.0)
       dotenv (~> 2.1, >= 2.1.1)
@@ -9,23 +9,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.0.3)
-    aws-partitions (1.281.0)
-    aws-sdk-core (3.90.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.432.0)
+    aws-sdk-core (3.113.0)
+      aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-sns (1.21.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sns (1.37.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.23.1)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sqs (1.35.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.1.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-sigv4 (1.2.3)
+      aws-eventstream (~> 1, >= 1.0.2)
     diff-lcs (1.3)
-    dotenv (2.7.5)
+    dotenv (2.7.6)
     jmespath (1.4.0)
     rake (13.0.1)
     rspec (3.7.0)
@@ -52,4 +52,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -151,20 +151,52 @@ Eventboss.configure do |config|
 end
 ```
 
-## Development mode 
+### Middlewares
+
+Server middlewares intercept the execution of your `Listeners`. You can use to extract and run common functions on every message received.
+
+Define a middleware in the following way:
+
+```ruby
+class LogMiddleware < Eventboss::Middleware::Base
+  def call(_work)
+    yield
+    logger.debug 'finished with success'
+  rescue StandardError => _error
+    logger.error 'finished with error'
+    raise
+  end
+
+  private
+
+  def logger
+    @logger ||= @options.fetch(:logger)
+  end
+end
+```
+
+And configure your logger as such:
+
+```ruby
+Eventboss.configure do |config|
+  config.server_middleware.add LogMiddleware, logger: Logger.new
+end
+```
+
+## Development mode
 
 In the _development mode_ you don't need to create the infrastructure required by the application - Eventboss will take care of this.
 
 It works on AWS and [localstack](https://github.com/localstack/localstack).
 
-Following resources are created: 
+Following resources are created:
 * SNS topics - created when application starts and when message is published
 * SQS queues (with SendMessage policy) - created when application starts
 * subscriptions for topics and queues - created when application starts
 
 Just enable it via environment variable...
 ```
-EVENTBUS_DEVELOPMENT_MODE=true
+EVENTBOSS_DEVELOPMENT_MODE=true
 ```
 use fixed account ID for localstack setup...
 ```
@@ -206,4 +238,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/AirHel
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/eventboss.rb

@@ -13,6 +13,7 @@ require 'eventboss/logging'
 require 'eventboss/safe_thread'
 require 'eventboss/launcher'
 require 'eventboss/long_poller'
+require 'eventboss/middleware'
 require 'eventboss/unit_of_work'
 require 'eventboss/worker'
 require 'eventboss/fetcher'

data/lib/eventboss/configuration.rb

@@ -25,15 +25,15 @@ module Eventboss
       :sns_sqs_name_infix,
       :listeners
 
-
     def raise_on_missing_configuration
       defined_or_default('raise_on_missing_configuration') { (ENV['EVENTBOSS_RAISE_ON_MISSING_CONFIGURATION'] || ENV['EVENTBUS_RAISE_ON_MISSING_CONFIGURATION'])&.downcase == 'true' }
     end
 
     def error_handlers
       defined_or_default('error_handlers') do
-        [ErrorHandlers::Logger.new].tap do |handlers|
+        [ErrorHandlers::Logger.new, ErrorHandlers::NonExistentQueueHandler.new].tap do |handlers|
           handlers << ErrorHandlers::DbConnectionDropHandler.new if defined?(::ActiveRecord::StatementInvalid)
+          handlers << ErrorHandlers::DbConnectionNotEstablishedHandler.new if defined?(::ActiveRecord::ConnectionNotEstablished)
         end
       end
     end
@@ -118,6 +118,10 @@ module Eventboss
       end
     end
 
+    def server_middleware
+      @server_middleware ||= Middleware::Chain.new
+    end
+
     private
 
     def defined_or_default(variable_name)

data/lib/eventboss/error_handlers/db_connection_not_established_handler.rb

@@ -0,0 +1,11 @@
+module Eventboss
+  module ErrorHandlers
+    class DbConnectionNotEstablishedHandler
+      def call(exception, _context = {})
+        if exception.class == ::ActiveRecord::ConnectionNotEstablished
+          ::ActiveRecord::Base.connection.reconnect!
+        end
+      end
+    end
+  end
+end

data/lib/eventboss/error_handlers/non_existent_queue_handler.rb

@@ -0,0 +1,12 @@
+module Eventboss
+  module ErrorHandlers
+    class NonExistentQueueHandler
+      def call(exception, context = {})
+        if exception.class == ::Aws::SQS::Errors::NonExistentQueue
+          queue = context.fetch(:poller_id, "").sub('poller-', '')
+          Eventboss.logger.error("Queue  doesn't exist: " + queue)
+        end
+      end
+    end
+  end
+end

data/lib/eventboss/error_handlers/rollbar.rb

@@ -0,0 +1,11 @@
+module Eventboss
+  module ErrorHandlers
+    class Rollbar
+      def call(exception, context = {})
+        eventboss_context = { component: 'eventboss' }
+        eventboss_context[:action] = context[:processor].class.to_s if context[:processor]
+        ::Rollbar.error(exception, eventboss_context.merge(context))
+      end
+    end
+  end
+end

data/lib/eventboss/extensions.rb

@@ -1,3 +1,6 @@
 require 'eventboss/error_handlers/logger'
 require 'eventboss/error_handlers/airbrake'
+require 'eventboss/error_handlers/rollbar'
 require 'eventboss/error_handlers/db_connection_drop_handler'
+require 'eventboss/error_handlers/db_connection_not_established_handler'
+require 'eventboss/error_handlers/non_existent_queue_handler'

data/lib/eventboss/launcher.rb

@@ -34,6 +34,7 @@ module Eventboss
       @bus.clear
       @pollers.each(&:terminate)
       @workers.each(&:terminate)
+      @bus.close
 
       wait_for_shutdown
       hard_shutdown
@@ -70,7 +71,7 @@ module Eventboss
     end
 
     def new_worker(id)
-      Worker.new(self, id, @bus)
+      Worker.new(self, "worker-#{id}", @bus)
     end
 
     def new_poller(queue, listener)

data/lib/eventboss/long_poller.rb

@@ -45,6 +45,8 @@ module Eventboss
       fetch_messages.each do |message|
         logger.debug(id) { "enqueueing message #{message.message_id}" }
         @bus << UnitOfWork.new(@client, queue, listener, message)
+      rescue ClosedQueueError
+        logger.info(id) { "skip message #{message.message_id} enqueuing due to closed queue" }
       end
     end
 
@@ -53,6 +55,9 @@ module Eventboss
       @launcher.poller_stopped(self)
     rescue Eventboss::Shutdown
       @launcher.poller_stopped(self)
+    rescue Aws::SQS::Errors::NonExistentQueue
+      handle_exception(exception, poller_id: id)
+      @launcher.poller_stopped(self)
     rescue StandardError => exception
       handle_exception(exception, poller_id: id)
       # Give a chance for temporary AWS errors to be resolved

data/lib/eventboss/middleware.rb

@@ -0,0 +1,57 @@
+module Eventboss
+  module Middleware
+    class Chain
+      attr_reader :entries
+
+      def initialize
+        @entries = []
+      end
+
+      def add(klass, options = {})
+        @entries << Entry.new(klass, options)
+      end
+
+      def invoke(*args)
+        chain = @entries.map(&:build).reverse!
+
+        invoke_lambda = lambda do
+          if (mid = chain.pop)
+            mid.call(*args, &invoke_lambda)
+          else
+            yield
+          end
+        end
+        invoke_lambda.call
+      end
+
+      def clear
+        @entries.clear
+      end
+    end
+
+    class Base
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def call
+        raise 'Not implemented'
+      end
+    end
+
+    class Entry
+      attr_reader :klass, :options
+
+      def initialize(klass, options)
+        @klass = klass
+        @options = options
+      end
+
+      def build
+        @klass.new(options)
+      end
+    end
+  end
+end

data/lib/eventboss/version.rb

@@ -1,3 +1,3 @@
 module Eventboss
-  VERSION = "1.3.3"
+  VERSION = "1.7.0"
 end

data/lib/eventboss/worker.rb

@@ -7,7 +7,7 @@ module Eventboss
     attr_reader :id
 
     def initialize(launcher, id, bus, restart_on: [Exception])
-      @id = "worker-#{id}"
+      @id = id
       @launcher = launcher
       @bus = bus
       @thread = nil
@@ -20,7 +20,7 @@ module Eventboss
 
     def run
       while (work = @bus.pop)
-        work.run
+        run_work(work)
       end
       @launcher.worker_stopped(self)
     rescue Eventboss::Shutdown
@@ -32,6 +32,12 @@ module Eventboss
       @launcher.worker_stopped(self, restart: true)
     end
 
+    def run_work(work)
+      server_middleware.invoke(work) do
+        work.run
+      end
+    end
+
     def terminate(wait = false)
       stop_token
       return unless @thread
@@ -39,7 +45,6 @@ module Eventboss
     end
 
     def kill(wait = false)
-      stop_token
       return unless @thread
       @thread.raise Eventboss::Shutdown
       @thread.value if wait
@@ -51,5 +56,9 @@ module Eventboss
     def stop_token
       @bus << nil
     end
+
+    def server_middleware
+      Eventboss.configuration.server_middleware
+    end
   end
 end

data/lib/generators/eventboss/listener/eventboss_listener.rb.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class <%= event_name.camelize %>Listener
+  include Eventboss::Listener
+
+  eventboss_options event_name: '<%= event_name %>'<%= source_app ? ", source_app: '#{ source_app }'" : "" %>
+
+  def receive(payload)
+    Rails.logger.tagged(jid) { Rails.logger.info("payload: #{ payload }") }
+  end
+end

data/lib/generators/eventboss/listener/listener_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Creates the Eventboss listener scaffold
+#
+# @example Invocation from terminal
+#   rails generate eventboss:listener get_well air-helper
+#
+module Eventboss
+  class ListenerGenerator < Rails::Generators::Base
+    source_root File.expand_path(__dir__)
+
+    argument :event_name, required: true
+    argument :source_app, required: false
+
+    desc 'Creates the Eventboss listener scaffold'
+    def create_listener_scaffold
+      template 'eventboss_listener.rb.erb', "app/listeners/#{ event_name }_listener.rb"
+    end
+  end
+end

data/lib/tasks/eventboss.rake

@@ -33,7 +33,6 @@ namespace :eventboss do
         break if messages.count.zero?
 
         messages.each do |message|
-          puts "[#{task.name}] Publishing message: #{message.body}"
           client.send_message(queue_url: send_queue.url, message_body: message.body)
           fetcher.delete(queue, message)
 
@@ -71,7 +70,6 @@ namespace :eventboss do
         break if messages.count.zero?
 
         messages.each do |message|
-          puts "[#{task.name}] Deleting message: #{message.body}"
           fetcher.delete(queue, message)
 
           total += 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventboss
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.7.0
 platform: ruby
 authors:
 - AirHelp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -126,7 +126,10 @@ files:
 - lib/eventboss/development_mode.rb
 - lib/eventboss/error_handlers/airbrake.rb
 - lib/eventboss/error_handlers/db_connection_drop_handler.rb
+- lib/eventboss/error_handlers/db_connection_not_established_handler.rb
 - lib/eventboss/error_handlers/logger.rb
+- lib/eventboss/error_handlers/non_existent_queue_handler.rb
+- lib/eventboss/error_handlers/rollbar.rb
 - lib/eventboss/extensions.rb
 - lib/eventboss/fetcher.rb
 - lib/eventboss/instrumentation.rb
@@ -134,6 +137,7 @@ files:
 - lib/eventboss/listener.rb
 - lib/eventboss/logging.rb
 - lib/eventboss/long_poller.rb
+- lib/eventboss/middleware.rb
 - lib/eventboss/publisher.rb
 - lib/eventboss/queue.rb
 - lib/eventboss/queue_listener.rb
@@ -147,12 +151,14 @@ files:
 - lib/eventboss/unit_of_work.rb
 - lib/eventboss/version.rb
 - lib/eventboss/worker.rb
+- lib/generators/eventboss/listener/eventboss_listener.rb.erb
+- lib/generators/eventboss/listener/listener_generator.rb
 - lib/tasks/eventboss.rake
 homepage: https://github.com/AirHelp/eventboss
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Eventboss Ruby Client.
 test_files: []