rails_event_store 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 961b6916b6be373dc20de369d54d11923cfa30d239c2e10bd12e4eb8c44d45b8
-  data.tar.gz: 37dc7daf235cf6daaf473ac1b0ca0b863d864a87e4d279ba7a6dd625e67e44f5
+  metadata.gz: f1fa1cf3a596ceaec4a25af51d2b58c5512c23db3ca384e354e346936ca7d9c2
+  data.tar.gz: 464e699f8ede102e3f3fb283a371e83daeeac3a1767c0650a7d4979d43788248
 SHA512:
-  metadata.gz: a882bfda0aa706b2c7122920046876af2d8c15f344e2e0bfc82fa4fd01a869b8f8eea72ba5d1bdf9495be3947a1ef3def6e51ac935be6e10595658de8aa6cf6b
-  data.tar.gz: 7d6a3651f4bb068d8641ae609ceaa7c14fd3b51ef68cd74f5eef891f28970a784a7b43788c59c5466885ec355371b90bf655fd5cf537e42e2b701326ae908501
+  metadata.gz: 42bc69755c4dcdf516d72f21a637153ac2459d76ce29bd58374e33642dc474a47358cd3cbfc5414445025ba73a38fe430ff15847ef97af2b4237df633faced0f
+  data.tar.gz: 5d9fb85db8a5141ffeedc2b79fd28b91b25546c6f4e9816ce8853bf0c38f43d919145367af67bd0dcb84d09b6e4d0577ed3ae9ddfa400f72b2ebdffa9f29f7d2

data/lib/generators/rails_event_store/browser_views_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "ruby_event_store/browser"
+
+module RailsEventStore
+  module Generators
+    class BrowserViewsGenerator < Rails::Generators::Base
+      source_root RubyEventStore::Browser::Renderer::VIEWS_ROOT
+
+      def copy_views
+        directory ".", "app/views/ruby_event_store_browser"
+      end
+
+      def instructions
+        say "Browser picks these views up automatically. Delete the files you do not customize - " \
+              "anything missing falls back to the views built into the gem."
+      end
+    end
+  end
+end

data/lib/rails_event_store/active_job_bulk_scheduler.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_job"
+
+module RailsEventStore
+  class ActiveJobBulkScheduler < ActiveJobScheduler
+    include BulkEnqueue
+  end
+end

data/lib/rails_event_store/active_job_id_only_bulk_scheduler.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_job"
+
+module RailsEventStore
+  class ActiveJobIdOnlyBulkScheduler < ActiveJobIdOnlyScheduler
+    include BulkEnqueue
+  end
+end

data/lib/rails_event_store/active_job_id_only_scheduler.rb

@@ -5,11 +5,17 @@ require "active_job"
 module RailsEventStore
   class ActiveJobIdOnlyScheduler
     def call(klass, record)
-      klass.perform_later({ "event_id" => record.event_id })
+      klass.perform_later(payload_for(record))
     end
 
     def verify(subscriber)
       Class === subscriber && !!(subscriber < ActiveJob::Base)
     end
+
+    private
+
+    def payload_for(record)
+      { "event_id" => record.event_id }
+    end
   end
 end

data/lib/rails_event_store/active_job_scheduler.rb

@@ -9,7 +9,7 @@ module RailsEventStore
     end
 
     def call(klass, record)
-      klass.perform_later(record.serialize(serializer).to_h.transform_keys(&:to_s))
+      klass.perform_later(payload_for(record))
     end
 
     def verify(subscriber)
@@ -22,6 +22,10 @@ module RailsEventStore
 
     private
 
+    def payload_for(record)
+      record.serialize(serializer).to_h.transform_keys(&:to_s)
+    end
+
     attr_reader :serializer
   end
 end

data/lib/rails_event_store/after_commit_dispatcher.rb

@@ -2,8 +2,16 @@
 
 module RailsEventStore
   class AfterCommitDispatcher
-    def initialize(scheduler:)
+    # Flushing a buffering scheduler leans on Transaction#after_commit, which
+    # ActiveRecord grew in 7.2.
+    MINIMUM_RAILS_VERSION = Gem::Version.new("7.2")
+
+    def initialize(scheduler:, transaction_owner: ActiveRecord::Base)
       @scheduler = scheduler
+      @transaction_owner = transaction_owner
+      if buffering_scheduler? && !supported_rails_version?
+        raise "#{scheduler.class} requires Rails #{MINIMUM_RAILS_VERSION} or newer"
+      end
     end
 
     def call(subscriber, _, record)
@@ -11,12 +19,14 @@ module RailsEventStore
     end
 
     def run(&schedule_proc)
-      transaction = ActiveRecord::Base.connection.current_transaction
+      transaction = current_transaction
 
       if transaction.joinable?
         transaction.add_record(async_record(schedule_proc))
+        transaction.after_commit { @scheduler.flush } if buffering_scheduler?
       else
         yield
+        @scheduler.flush if buffering_scheduler?
       end
     end
 
@@ -48,5 +58,20 @@ module RailsEventStore
 
       attr_reader :schedule_proc
     end
+
+    private
+
+    def buffering_scheduler?
+      BufferingScheduler === @scheduler
+    end
+
+    def supported_rails_version?
+      ActiveRecord.gem_version >= MINIMUM_RAILS_VERSION
+    end
+
+    def current_transaction
+      connection = @transaction_owner.try(:lease_connection) || @transaction_owner.connection
+      connection.current_transaction
+    end
   end
 end

data/lib/rails_event_store/all.rb

@@ -4,8 +4,12 @@ require "ruby_event_store"
 require_relative "async_handler_helpers"
 require_relative "link_by_metadata"
 require_relative "after_commit_dispatcher"
+require_relative "buffering_scheduler"
+require_relative "bulk_enqueue"
 require_relative "active_job_scheduler"
+require_relative "active_job_bulk_scheduler"
 require_relative "active_job_id_only_scheduler"
+require_relative "active_job_id_only_bulk_scheduler"
 require_relative "client"
 require_relative "json_client"
 require_relative "version"

data/lib/rails_event_store/browser.rb

@@ -5,7 +5,14 @@ require "rails/engine"
 
 module RailsEventStore
   class Browser < Rails::Engine
-    endpoint RubyEventStore::Browser::App.for(event_store_locator: -> { Rails.configuration.event_store })
+    endpoint(
+      lambda do |env|
+        RubyEventStore::Browser::App.for(
+          event_store_locator: -> { Rails.configuration.event_store },
+          views_root: Rails.root.join("app/views/ruby_event_store_browser"),
+        ).call(env)
+      end
+    )
 
     railtie_name "ruby_event_store_browser_app"
   end

data/lib/rails_event_store/buffering_scheduler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RailsEventStore
+  module BufferingScheduler
+    BUFFER_KEY = :rails_event_store_scheduler_buffers
+
+    def flush
+      entries = buffers.delete(self) || []
+      return if entries.empty?
+
+      ship(entries)
+    end
+
+    private
+
+    def buffer
+      buffers[self] ||= []
+    end
+
+    # Keyed by thread as well as by scheduler identity, because #call and #flush
+    # run on the same thread inside commit_records, and two schedulers sharing a
+    # dispatcher must not drain each other's entries.
+    def buffers
+      Thread.current[BUFFER_KEY] ||= {}.compare_by_identity
+    end
+  end
+end

data/lib/rails_event_store/bulk_enqueue.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "active_job"
+
+module RailsEventStore
+  module BulkEnqueue
+    include BufferingScheduler
+
+    def call(klass, record)
+      payload = payload_for(record)
+
+      if klass.instance_of?(ActiveJob::ConfiguredJob)
+        flush
+        klass.perform_later(payload)
+      else
+        buffer << klass.new(payload)
+      end
+    end
+
+    private
+
+    def ship(jobs)
+      ActiveJob.perform_all_later(jobs)
+    end
+  end
+end

data/lib/rails_event_store/spec/buffering_scheduler_lint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "buffering scheduler" do |scheduler|
+  specify "declares itself buffering" do
+    expect(RailsEventStore::BufferingScheduler === scheduler).to be(true)
+  end
+
+  specify "#ship" do
+    expect(scheduler.respond_to?(:ship, true)).to be(true)
+  end
+end

data/lib/rails_event_store/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsEventStore
-  VERSION = "3.0.1"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_event_store
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Arkency
@@ -15,56 +15,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: ruby_event_store-browser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: ruby_event_store-active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: aggregate_root
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/generators/rails_event_store/bounded_context_generator.rb
+- lib/generators/rails_event_store/browser_views_generator.rb
 - lib/generators/rails_event_store/rspec_generator.rb
 - lib/generators/rails_event_store/test_unit_generator.rb
 - lib/generators/templates/bc_spec.erb
@@ -142,17 +143,22 @@ files:
 - lib/generators/templates/spec_helper.erb
 - lib/generators/templates/test_helper.erb
 - lib/rails_event_store.rb
+- lib/rails_event_store/active_job_bulk_scheduler.rb
+- lib/rails_event_store/active_job_id_only_bulk_scheduler.rb
 - lib/rails_event_store/active_job_id_only_scheduler.rb
 - lib/rails_event_store/active_job_scheduler.rb
 - lib/rails_event_store/after_commit_dispatcher.rb
 - lib/rails_event_store/all.rb
 - lib/rails_event_store/async_handler_helpers.rb
 - lib/rails_event_store/browser.rb
+- lib/rails_event_store/buffering_scheduler.rb
+- lib/rails_event_store/bulk_enqueue.rb
 - lib/rails_event_store/client.rb
 - lib/rails_event_store/json_client.rb
 - lib/rails_event_store/link_by_metadata.rb
 - lib/rails_event_store/middleware.rb
 - lib/rails_event_store/railtie.rb
+- lib/rails_event_store/spec/buffering_scheduler_lint.rb
 - lib/rails_event_store/version.rb
 homepage: https://railseventstore.org
 licenses:
@@ -170,14 +176,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Rails wrapper for RubyEventStore with batteries included
 test_files: []