event_sourcery 0.19.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19b0a0d9e68626a19ba4b628c0b0e835d5f400e0
-  data.tar.gz: 92b65ee0ca76d3044530c77e6a1c56fbb66cc03c
+SHA256:
+  metadata.gz: 61fe1c1886a98c249f210f252778de57849d7da3a2c1aafe7f503be3193399d4
+  data.tar.gz: 8b3da0d26b96b02f4f7230c74891f6e3cab1cf46062559d00f4b9405f00a49bd
 SHA512:
-  metadata.gz: 73c8044348497a991169477fd1075bf94bba46c02c686c8f8723bebf4b39f7f902fa38c1e79205520ffc0ed132e2a7cb7033d969de396d435eb1d94fa94645e2
-  data.tar.gz: c0184c613e7d89f4dee8d573913b3ddeda0df8b64a0bc490370a3c7c46be2f92db0f8d62357443af3bc32a7d550f212167d845bced0a6dd7c0d3920bd0b5850b
+  metadata.gz: 53ad37d18c358351946bec8901ca83359b937097b2fdd55bdf63ad630acdb5e201f786791af0ab2d4d009ac3a836da6cad128f049858eeb52f72767ccbefde52
+  data.tar.gz: 350b132bcaef85bd0a8f0bd4069bd48aae6a2111f2269a3cfa8b0886a38799a7c6228e88e863383bf47d49609e2e057db734193d02665ba970042fff3051cc22

data/CHANGELOG.md

@@ -5,8 +5,106 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.19.0] - 2018-06-06
+## [Unreleased]
+
+## [0.23.1] - 2020-10-02
+### Fixed
+- Upgrade development dependency Rake to version 13. This resolves
+  [CVE-2020-8130](https://github.com/advisories/GHSA-jppv-gw3r-w3q8).
+
+- Patch `ESPRunner` to gracefully handle terminating subprocesses it did
+  not start ([#223]).
+
+- Resolve warnings raised by Ruby 2.7 ([#225]).
+
+[#223]: https://github.com/envato/event_sourcery/pull/223
+[#225]: https://github.com/envato/event_sourcery/pull/225
+
+## [0.23.0] - 2019-07-11
+### Added
+- Add Ruby 2.6 to the CI test matrix.
+- `ESPRunner` supports an `after_subprocess_termination` hook. This optional
+  initializer argument will will be executed when each child process
+  terminates. This allows for monitoring and alerts to be configured.
+  For example, Rollbar:
+
+  ```ruby
+  EventSourcery::EventProcessing::ESPRunner.new(
+    event_processors: processors,
+    event_source: source,
+    after_subprocess_termination: proc do |processor:, runner:, exit_status:|
+      if exit_status != 0
+        Rollbar.error("Processor #{processor.processor_name} "\
+                      "terminated with exit status #{exit_status}")
+      end
+    end
+  ).start!
+  ```
+
+- `ESPRunner` exposes three new public methods `start_processor`, `shutdown`,
+  and `shutdown_requested?`. These provide options for handling subprocess
+  failure/termination. For example, shutting down the `ESPRunner`:
+
+  ```ruby
+  EventSourcery::EventProcessing::ESPRunner.new(
+    event_processors: processors,
+    event_source: source,
+    after_subprocess_termination: proc do |processor:, runner:, exit_status:|
+      runner.shutdown
+    end
+  ).start!
+  ```
+
+  Or restarting the event processor:
+
+  ```ruby
+  EventSourcery::EventProcessing::ESPRunner.new(
+    event_processors: processors,
+    event_source: source,
+    after_subprocess_termination: proc do |processor:, runner:, exit_status:|
+      runner.start_processor(processor) unless runner.shutdown_requested?
+    end
+  ).start!
+  ```
 
+- `ESPRunner` checks for dead child processes every second. This means we
+  shouldn't see `[ruby] <defunct>` in the process list (ps) when a processor
+  fails.
+- `ESPRunner` logs when child processes die.
+- `ESPRunner` logs when sending signals to child processes.
+
+### Removed
+- Remove Ruby 2.2 from the CI test matrix.
+
+## [0.22.0] - 2018-10-04
+### Added
+- Log critical exceptions to the application provided block via the new
+  configuration option ([#209](https://github.com/envato/event_sourcery/pull/209)):
+
+  ```ruby
+  config.on_event_processor_critical_error = proc do |exception, processor_name|
+    # report the death of this processor to an error reporting service like Rollbar.
+  end
+  ```
+
+## [0.21.0] - 2018-07-02
+### Added
+- Graceful shutdown interrupts poll-wait sleep for quicker quitting
+  ([#207](https://github.com/envato/event_sourcery/pull/207)).
+- Added `bug_tracker_uri`, `changelog_uri` and `source_code_uri` to project
+  metadata ([#205](https://github.com/envato/event_sourcery/pull/205)).
+
+### Changed
+- Fixed a bug where ESPRunner would raise an error under certain circumstances
+  ([#203](https://github.com/envato/event_sourcery/pull/203)).
+
+## [0.20.0] - 2018-06-21
+### Changed
+- Changed signature of `ESPProcess#initialize` to include a default value for `after_fork`. This prevents the
+`after_fork` change from 0.19.0 from being a breaking change to external creators of ESPProcess.
+- Added more logging when a fatal exception occurs in ESPProcess
+
+## [0.19.0] - 2018-06-06
 ### Added
 
 - Allow passing an `after_fork` lambda to `ESPRunner` that is called after each
@@ -136,10 +234,16 @@ moving all Postgres related code into a separate gem.
 - EventSourcery no longer depends on Virtus.
 - `Command` and `CommandHandler` have been removed.
 
-[Unreleased]: https://github.com/envato/event_sourcery/compare/v0.19.0...HEAD
+[Unreleased]: https://github.com/envato/event_sourcery/compare/v0.23.1...HEAD
+[0.23.1]: https://github.com/envato/event_sourcery/compare/v0.23.0...v0.23.1
+[0.23.0]: https://github.com/envato/event_sourcery/compare/v0.22.0...v0.23.0
+[0.22.0]: https://github.com/envato/event_sourcery/compare/v0.21.0...v0.22.0
+[0.21.0]: https://github.com/envato/event_sourcery/compare/v0.20.0...v0.21.0
+[0.20.0]: https://github.com/envato/event_sourcery/compare/v0.19.0...v0.20.0
 [0.19.0]: https://github.com/envato/event_sourcery/compare/v0.18.0...v0.19.0
 [0.18.0]: https://github.com/envato/event_sourcery/compare/v0.17.0...v0.18.0
 [0.17.0]: https://github.com/envato/event_sourcery/compare/v0.16.0...v0.17.0
+[0.16.1]: https://github.com/envato/event_sourcery/compare/v0.16.0...v0.16.1
 [0.16.0]: https://github.com/envato/event_sourcery/compare/v0.15.0...v0.16.0
 [0.15.0]: https://github.com/envato/event_sourcery/compare/v0.14.0...v0.15.0
 [0.14.0]: https://github.com/envato/event_sourcery/compare/v0.13.0...v0.14.0

data/README.md

@@ -67,6 +67,7 @@ EventSourcery.configure do |config|
   # Add custom reporting of errors occurring during event processing.
   # One might set up an error reporting service like Rollbar here.
   config.on_event_processor_error = proc { |exception, processor_name| … }
+  config.on_event_processor_critical_error = proc { |exception, processor_name| … }
 
   # Enable EventSourcery logging.
   config.logger = Logger.new('logs/my_event_sourcery_app.log')
@@ -103,8 +104,9 @@ bundle exec rspec
 To release a new version:
 
 1. Update the version number in `lib/event_sourcery/version.rb`
-2. Get this change onto master via the normal PR process
-3. Run `bundle exec rake release`, this will create a git tag for the
+2. Add the new version with release notes to CHANGELOG.md
+3. Get these changes onto master via the normal PR process
+4. Run `bundle exec rake release`, this will create a git tag for the
    version, push tags up to GitHub, and package the code in a `.gem` file.
 
 ## Core Concepts
@@ -216,7 +218,7 @@ The event store is a persistent store of events.
 
 EventSourcery currently supports a Postgres-based event store via the [event_sourcery-postgres gem](https://github.com/envato/event_sourcery-postgres).
 
-For more information about the `EventStore` API refer to [the postgres event store](https://github.com/envato/event_sourcery-postgres/blob/master/lib/event_sourcery/postgres/event_store.rb) or the [in memory event store in this repo](lib/event_sourcery/event_store/memory.rb)
+For more information about the `EventStore` API refer to [the postgres event store](https://github.com/envato/event_sourcery-postgres/blob/master/lib/event_sourcery/postgres/event_store.rb) or the [in memory event store in this repo](lib/event_sourcery/memory/event_store.rb)
 
 #### Storing Events
 

data/event_sourcery.gemspec

@@ -12,6 +12,11 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Event Sourcing Library'
   spec.description   = ''
   spec.homepage      = 'https://github.com/envato/event_sourcery'
+  spec.metadata      = {
+                         'bug_tracker_uri' => 'https://github.com/envato/event_sourcery/issues',
+                         'changelog_uri'   => 'https://github.com/envato/event_sourcery/blob/master/CHANGELOG.md',
+                         'source_code_uri' => 'https://github.com/envato/event_sourcery',
+                       }
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.|Gemfile|Rakefile|bin/|script/|spec/)}) }
   spec.bindir        = 'exe'
@@ -20,8 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'benchmark-ips'

data/lib/event_sourcery/config.rb

@@ -19,6 +19,14 @@ module EventSourcery
     # @return Proc
     attr_accessor :on_event_processor_error
 
+    # A Proc to be executed on an event processor critical error.
+    # App defined behaviour can be provided. This will be called
+    # if an exception causes an a event processor to die.
+    # i.e. report to an error reporting service like Rollbar.
+    #
+    # @return Proc
+    attr_accessor :on_event_processor_critical_error
+
     # @return EventStore::EventTypeSerializers::Underscored
     attr_accessor :event_type_serializer
 
@@ -40,6 +48,9 @@ module EventSourcery
       @on_event_processor_error = proc { |exception, processor_name|
         # app specific custom logic ie. report to an error reporting service like Rollbar.
       }
+      @on_event_processor_critical_error = proc { |exception, processor_name|
+        # app specific custom logic ie. report to an error reporting service like Rollbar.
+      }
       @event_builder = nil
       @event_type_serializer = EventStore::EventTypeSerializers::Underscored.new
       @error_handler_class = EventProcessing::ErrorHandlers::ConstantRetry
@@ -47,10 +58,10 @@ module EventSourcery
     end
 
     # Logger instance used by EventSourcery.
-    # By default EventSourcery will log to STDOUT with a log level of Logger::DEBUG
+    # By default EventSourcery will log to STDOUT with a log level of Logger::INFO
     def logger
       @logger ||= ::Logger.new(STDOUT).tap do |logger|
-        logger.level = Logger::DEBUG
+        logger.level = Logger::INFO
       end
     end
 

data/lib/event_sourcery/event_processing/esp_process.rb

@@ -6,7 +6,7 @@ module EventSourcery
       def initialize(event_processor:,
                      event_source:,
                      subscription_master: EventStore::SignalHandlingSubscriptionMaster.new,
-                     after_fork:)
+                     after_fork: nil)
         @event_processor = event_processor
         @event_source = event_source
         @subscription_master = subscription_master
@@ -21,10 +21,12 @@ module EventSourcery
         error_handler.with_error_handling do
           EventSourcery.logger.info("Starting #{processor_name}")
           subscribe_to_event_stream
-          EventSourcery.logger.info("Stopping #{@event_processor.processor_name}")
+          EventSourcery.logger.info("Stopping #{processor_name}")
         end
       rescue Exception => e
-        EventSourcery.logger.error(e)
+        EventSourcery.logger.fatal("An unhandled exception occurred in #{processor_name}")
+        EventSourcery.logger.fatal(e)
+        EventSourcery.config.on_event_processor_critical_error.call(e, processor_name)
         raise e
       end
 

data/lib/event_sourcery/event_processing/esp_runner.rb

@@ -7,14 +7,18 @@ module EventSourcery
                      event_source:,
                      max_seconds_for_processes_to_terminate: 30,
                      shutdown_requested: false,
-                     after_fork: nil)
+                     after_fork: nil,
+                     after_subprocess_termination: nil,
+                     logger: EventSourcery.logger)
         @event_processors = event_processors
         @event_source = event_source
-        @pids = []
+        @pids = {}
         @max_seconds_for_processes_to_terminate = max_seconds_for_processes_to_terminate
         @shutdown_requested = shutdown_requested
         @exit_status = true
         @after_fork = after_fork
+        @after_subprocess_termination = after_subprocess_termination
+        @logger = logger
       end
 
       # Start each Event Stream Processor in a new child process.
@@ -22,8 +26,9 @@ module EventSourcery
         with_logging do
           start_processes
           listen_for_shutdown_signals
-          wait_till_shutdown_requested
-          record_terminated_processes
+          while_waiting_for_shutdown do
+            record_terminated_processes
+          end
           terminate_remaining_processes
           until all_processes_terminated? || waited_long_enough?
             record_terminated_processes
@@ -34,25 +39,36 @@ module EventSourcery
         exit_indicating_status_of_processes
       end
 
+      def start_processor(event_processor)
+        process = ESPProcess.new(
+          event_processor: event_processor,
+          event_source: @event_source,
+          after_fork: @after_fork,
+        )
+        pid = Process.fork { process.start }
+        @pids[pid] = event_processor
+      end
+
+      def shutdown
+        @shutdown_requested = true
+      end
+
+      def shutdown_requested?
+        @shutdown_requested
+      end
+
       private
 
+      attr_reader :logger
+
       def with_logging
-        EventSourcery.logger.info { 'Forking ESP processes' }
+        logger.info('ESPRunner: Forking processes')
         yield
-        EventSourcery.logger.info { 'ESP processes shutdown' }
+        logger.info('ESPRunner: Processes shutdown')
       end
 
       def start_processes
-        @event_processors.each(&method(:start_process))
-      end
-
-      def start_process(event_processor)
-        process = ESPProcess.new(
-          event_processor: event_processor,
-          event_source: @event_source,
-          after_fork: @after_fork,
-        )
-        @pids << Process.fork { process.start }
+        @event_processors.each(&method(:start_processor))
       end
 
       def listen_for_shutdown_signals
@@ -61,12 +77,12 @@ module EventSourcery
         end
       end
 
-      def shutdown
-        @shutdown_requested = true
-      end
-
-      def wait_till_shutdown_requested
-        sleep(1) until @shutdown_requested
+      def while_waiting_for_shutdown
+        loop do
+          yield
+          break if shutdown_requested?
+          sleep(1)
+        end
       end
 
       def terminate_remaining_processes
@@ -77,19 +93,24 @@ module EventSourcery
         send_signal_to_remaining_processes(:KILL)
       end
 
-
       def send_signal_to_remaining_processes(signal)
-        Process.kill(signal, *@pids) unless all_processes_terminated?
+        return if all_processes_terminated?
+
+        logger.info("ESPRunner: Sending #{signal} to [#{@pids.values.map(&:processor_name).join(', ')}]")
+        Process.kill(signal, *@pids.keys)
       rescue Errno::ESRCH
         record_terminated_processes
         retry
       end
 
       def record_terminated_processes
-        until all_processes_terminated? ||
-              ((pid, status) = Process.wait2(-1, Process::WNOHANG)).nil?
-          @pids.delete(pid)
-          @exit_status &&= status.success?
+        until all_processes_terminated? || (pid, status = Process.wait2(-1, Process::WNOHANG)).nil?
+          event_processor = @pids.delete(pid)
+          logger.info("ESPRunner: Process #{event_processor&.processor_name || pid} " \
+                      "terminated with exit status: #{status.exitstatus.inspect}")
+          next unless event_processor
+          @exit_status &&= !!status.success?
+          @after_subprocess_termination&.call(processor: event_processor, runner: self, exit_status: status.exitstatus)
         end
       end
 

data/lib/event_sourcery/event_store/event_builder.rb

@@ -5,10 +5,10 @@ module EventSourcery
         @event_type_serializer = event_type_serializer
       end
 
-      def build(event_data)
+      def build(**event_data)
         type = event_data.fetch(:type)
         klass = event_type_serializer.deserialize(type)
-        upcast(klass.new(event_data))
+        upcast(klass.new(**event_data))
       end
 
       private

data/lib/event_sourcery/event_store/signal_handling_subscription_master.rb

@@ -21,7 +21,30 @@ module EventSourcery
 
       def setup_graceful_shutdown
         %i(TERM INT).each do |signal|
-          Signal.trap(signal) { @shutdown_requested = true }
+          Signal.trap(signal) do
+            @shutdown_requested = true
+            wakeup_main_thread
+          end
+        end
+      end
+
+      # If the main thread happens to be sleeping when we receive the
+      # interrupt, wake it up.
+      #
+      # Note: the main thread processes the signal trap, hence calling
+      # Thread.main.wakeup in the signal trap is a no-op as it's undoubtedly
+      # awake. Instead, we need to fork a new thread, which waits for the main
+      # thread to go back to sleep and then wakes it up.
+      def wakeup_main_thread
+        Thread.fork do
+          main_thread = Thread.main
+          10.times do
+            if main_thread.status == 'sleep'
+              main_thread.wakeup
+              break
+            end
+            sleep 0.01
+          end
         end
       end
     end

data/lib/event_sourcery/rspec/event_store_shared_examples.rb

@@ -212,9 +212,9 @@ RSpec.shared_examples 'an event store' do
       end
     end
 
-    def events_by_range(*args)
+    def events_by_range(from_event_id, to_event_id, **args)
       [].tap do |events|
-        event_store.each_by_range(*args) do |event|
+        event_store.each_by_range(from_event_id, to_event_id, **args) do |event|
           events << event
         end
       end

data/lib/event_sourcery/version.rb

@@ -1,4 +1,4 @@
 module EventSourcery
   # Defines the version
-  VERSION = '0.19.0'.freeze
+  VERSION = '0.23.1'.freeze
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Envato
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -125,8 +125,11 @@ files:
 - lib/event_sourcery/version.rb
 homepage: https://github.com/envato/event_sourcery
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/envato/event_sourcery/issues
+  changelog_uri: https://github.com/envato/event_sourcery/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/envato/event_sourcery
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,9 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Event Sourcing Library
 test_files: []