eventboss 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaa1906368e8751476a4df0ae1f274a8008735de72191a34867881b50b19492b
-  data.tar.gz: 20bfe9695bc682e801b5b6760b92b9d575d0f323218b4286196aaff6f702d30f
+  metadata.gz: 7d59c3796789baa9e13a8a2079b026909b2d37f426edeeed8936b83a1dfe97df
+  data.tar.gz: 2af186a964a87844ec33a5a625c21b847fe1c7782583bf760c30aa6037de592c
 SHA512:
-  metadata.gz: a1e03452ce05f49cd5cbc09875467145d41c9fe8e6239941f874394a9895c617a2a2843daa479833a498d8ccbed6e6ac64b85ca3dab8dc73f42e2f980ba99468
-  data.tar.gz: 6c8b23c2ace8d611e3a79f98dcf15a11a97dbba537a46ee97df970730ad0107eef117547697cdebbd2e4ab97404dd99dff388f6ccbfbccfcd9b5fdad9b68d5ae
+  metadata.gz: 8ff2e6aeaeb07d80a8e27a7609071a557ee2db659afa109035bbc7495f143e9bf9e504a48ac0358326583bab6ec1f670c241a2b35649c90b7adc2497396f7533
+  data.tar.gz: 514290d9f45c66124c433a33dd4f169719bec4d1a6141e1fe734c228e4363068199ab48962820cedbaff9299d30abeda497b3f31270ce4669bb2958b39e312b2

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.2)
+    eventboss (1.5.0)
       aws-sdk-sns (>= 1.1.0)
       aws-sdk-sqs (>= 1.3.0)
       dotenv (~> 2.1, >= 2.1.1)
@@ -9,25 +9,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.0.3)
-    aws-partitions (1.269.0)
-    aws-sdk-core (3.89.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.374.0)
+    aws-sdk-core (3.107.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.28.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.23.1)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sqs (1.33.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.1.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
     diff-lcs (1.3)
-    dotenv (2.7.5)
+    dotenv (2.7.6)
     jmespath (1.4.0)
-    rake (12.3.1)
+    rake (13.0.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)

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

@@ -34,6 +34,7 @@ module Eventboss
       defined_or_default('error_handlers') do
         [ErrorHandlers::Logger.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 +119,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/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,5 @@
 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'

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/railtie.rb

@@ -2,8 +2,9 @@ class Eventboss::Railtie < Rails::Railtie
   rake_tasks do
     load 'tasks/eventboss.rake'
 
-    # Load rails environment before executing reload.
+    # Load rails environment before executing reload and purge.
     # It makes sure to load configuration file.
     task 'eventboss:deadletter:reload': :environment
+    task 'eventboss:deadletter:purge': :environment
   end
 end

data/lib/eventboss/version.rb

@@ -1,3 +1,3 @@
 module Eventboss
-  VERSION = "1.3.2"
+  VERSION = "1.5.0"
 end

data/lib/eventboss/worker.rb

@@ -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
@@ -51,5 +57,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

@@ -7,7 +7,7 @@ namespace :eventboss do
       source_app = args[:source_app]
       event_name = args[:event_name]
 
-      # Zero means, fetch all messages
+      # Zero means: fetch all messages
       max_messages = args[:max_messages].to_i
 
       # Ensure we don't fetch more than 10 messages from SQS
@@ -15,13 +15,8 @@ namespace :eventboss do
 
       abort "[#{task.name}] At least event name should be passed as argument" unless event_name
 
-      queue_name = [
-        Eventboss.configuration.eventboss_app_name,
-        Eventboss.configuration.sns_sqs_name_infix,
-        source_app,
-        event_name,
-        Eventboss.env
-      ].compact.join('-')
+      queue_name = compose_queue_name(source_app, event_name)
+
       puts "[#{task.name}] Reloading #{queue_name}-deadletter (max: #{ max_messages }, batch: #{ batch_size })"
       queue = Eventboss::Queue.new("#{queue_name}-deadletter")
       send_queue = Eventboss::Queue.new(queue_name)
@@ -38,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)
 
@@ -49,5 +43,51 @@ namespace :eventboss do
         break if max_messages > 0 && total >= max_messages
       end
     end
+
+    desc 'Purge deadletter queue'
+    task :purge, [:event_name, :source_app, :max_messages] do |task, args|
+      source_app = args[:source_app]
+      event_name = args[:event_name]
+
+      # Zero means: fetch all messages
+      max_messages = args[:max_messages].to_i
+
+      # Ensure we don't fetch more than 10 messages from SQS
+      batch_size = max_messages == 0 ? 10 : [10, max_messages].min
+
+      abort "[#{task.name}] At least event name should be passed as argument" unless event_name
+
+      queue_name = compose_queue_name(source_app, event_name)
+
+      puts "[#{task.name}] Purging #{queue_name}-deadletter (max: #{ max_messages }, batch: #{ batch_size })"
+      queue = Eventboss::Queue.new("#{queue_name}-deadletter")
+      puts "[#{task.name}] #{queue.url}"
+
+      fetcher = Eventboss::Fetcher.new(Eventboss.configuration)
+      total = 0
+      loop do
+        messages = fetcher.fetch(queue, batch_size)
+        break if messages.count.zero?
+
+        messages.each do |message|
+          fetcher.delete(queue, message)
+
+          total += 1
+          break if max_messages > 0 && total >= max_messages
+        end
+
+        break if max_messages > 0 && total >= max_messages
+      end
+    end
+
+    def compose_queue_name(source_app, event_name)
+      [
+        Eventboss.configuration.eventboss_app_name,
+        Eventboss.configuration.sns_sqs_name_infix,
+        source_app,
+        event_name,
+        Eventboss.env
+      ].compact.join('-')
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventboss
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - AirHelp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -126,7 +126,9 @@ 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/rollbar.rb
 - lib/eventboss/extensions.rb
 - lib/eventboss/fetcher.rb
 - lib/eventboss/instrumentation.rb
@@ -134,6 +136,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 +150,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 +172,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.4
+signing_key:
 specification_version: 4
 summary: Eventboss Ruby Client.
 test_files: []