event_sourcery 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf46fcd5b486df9da0777cf5a9753ef95a64ff7d3b983a26a5c1254453a6c967
-  data.tar.gz: e55d8cba2288e2498eae24f5fb31d8617d50b64349deecd083244089a104475a
+  metadata.gz: 99bf8987da0772344a41fc64908adbeaf61ec6586e7ca0598c0b64f46660c925
+  data.tar.gz: 0a19dcd0e8daf8522cbbbf713f712f688eceab25b18d8137cf3a0059cb030937
 SHA512:
-  metadata.gz: de46a745146463e05e3c0bf60e8c046edfcb7387aca6729fea77ed995dc5347cf4a229f6618f4bd6e701d7243e155e30a46d9f2febd29cce660dad0926bab782
-  data.tar.gz: 22e7a7a521f1bcc9923337203533a589930630f172cc931bdcf98545eb4090ee6ce5bb069bdec8f43a65a835c1d0ab7fc325d3c076b60909baeece0d85e6fcc4
+  metadata.gz: 22cd971647408e0231de73e1a35d78bcd64f9ab396d147b6d7f1ab4e9757cdd5728705b6e10fe9c57547e2de6f5ee12662effc16570b5f62d5c10d08cbba913d
+  data.tar.gz: a13edee936cd4fa5dd203ee4758128d0c6342306c5d9028ee3868293e490d872f0fd27c92b087a24c65f7cab11b3d8ab949c29785873b0efff85c2ec3d448d9c

data/CHANGELOG.md

@@ -5,6 +5,64 @@ 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/).
 
+## [Unreleased]
+
+## [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
@@ -29,7 +87,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.20.0] - 2018-06-21
 ### Changed
-- Changed signature of `ESPProcess#initialize` to include a default value for `after_fork`. This prevents the 
+- 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
 
@@ -163,7 +221,8 @@ 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.22.0...HEAD
+[Unreleased]: https://github.com/envato/event_sourcery/compare/v0.23.0...HEAD
+[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

data/README.md

@@ -218,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

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'

data/lib/event_sourcery/config.rb

@@ -58,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_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,22 @@ 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)
+        until all_processes_terminated? || (pid, status = Process.wait2(-1, Process::WNOHANG)).nil?
+          event_processor = @pids.delete(pid)
           @exit_status &&= !!status.success?
+          logger.info("ESPRunner: Process #{event_processor.processor_name} terminated with exit status: #{status.exitstatus.inspect}")
+          @after_subprocess_termination&.call(processor: event_processor, runner: self, exit_status: status.exitstatus)
         end
       end
 

data/lib/event_sourcery/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Envato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2019-07-11 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
@@ -144,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Event Sourcing Library