rails-transactional-outbox 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd2d8339f85250e27d0ba1de331c1c29feb38b2521bd5f2f82b221f80722f5e5
-  data.tar.gz: 5c968efad34540cf5b0d02dab303d90fb492bdea617e25176880e7c50b1e6755
+  metadata.gz: 3e55a23c67288d7804bffc02cf8bfa1f36fc93562600f2002cce9393ca097b95
+  data.tar.gz: 64693c24b6affcf0357973f439aa0907636537c74ffd247b93ddf77984c0f6fa
 SHA512:
-  metadata.gz: 89643bbb880f86e8d2f9d92ba6f9c95cad1f1df505bf66af82f47a2fd65a11ed0be23a76aaf9b973dbb81101db34178fbee1b8c441e844fcf0ec07704db1207f
-  data.tar.gz: f9e45e9d83b6eb28e7f58b61e23868b50256546619f0b1dba4a16a388045d9842c69b361a865ed3c5a60dd02dc45353f3e6be7f8eda11b393dcf75e2bad87c0b
+  metadata.gz: 2ce32e65ec889efa9e3c56931c9a8146ffeff13178ab67aaf242b4dad72d22d33c9949bfde0d8609bbd610a1309d9fb26b5eef73be949b14ec9803444f181810
+  data.tar.gz: 1484e44ad3673815550375b95e78dfc08f235535dd47f519c7a26bf2ed38e781b16d9ff9e1acd69b8dfa029967e55f1308302d1989c36a03b97b37cb9fd077fd

data/CHANGELOG.md

@@ -1,12 +1,20 @@
 ## [Unreleased]
 
+## [0.3.1] - 2023-05-24
+
+- add config option whether to raise error when outbox entry record is not found
+
+## [0.3.0] - 2022-12-20
+
+- Move to file-based healthchecks, instead of using Redis-based ones.
+
 ## [0.2.1] - 2022-09-08
 
 - Simplify update to 0.2 (`causality_key` is not required if `outbox_entry_causality_key_resolver` is not used)
 
 ## [0.2.0] - 2022-09-08
 
-- Introduce `RailsTransactionalOutbox::OutboxEntriesProcessors::OrderedByCausalityKeyProcessor` 
+- Introduce `RailsTransactionalOutbox::OutboxEntriesProcessors::OrderedByCausalityKeyProcessor`
 
 ## [0.1.0] - 2022-08-23
 

data/Gemfile.lock

@@ -9,12 +9,12 @@ GIT
 PATH
   remote: .
   specs:
-    rails-transactional-outbox (0.2.1)
+    rails-transactional-outbox (0.3.1)
       activerecord (>= 5)
       activesupport (>= 3.2)
       concurrent-ruby
       dry-monitor
-      redis
+      file-based-healthcheck
       sigurd
       zeitwerk
 
@@ -40,21 +40,23 @@ GEM
       msgpack
     debase-ruby_core_source (0.10.16)
     diff-lcs (1.5.0)
-    dry-configurable (0.15.0)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-core (0.8.1)
+      zeitwerk (~> 2.6)
+    dry-events (1.0.1)
       concurrent-ruby (~> 1.0)
-    dry-events (0.3.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-monitor (0.6.3)
-      dry-configurable (~> 0.13, >= 0.13.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-events (~> 0.2)
-      zeitwerk (~> 2.5)
+      dry-core (~> 1.0, < 2)
+    dry-monitor (1.0.1)
+      dry-configurable (~> 1.0, < 2)
+      dry-core (~> 1.0, < 2)
+      dry-events (~> 1.0, < 2)
     exponential-backoff (0.0.4)
     ffi (1.15.5)
+    file-based-healthcheck (0.2.0)
+      activesupport (>= 3.2)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
@@ -119,7 +121,7 @@ GEM
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   x86_64-darwin-18

data/README.md

@@ -29,21 +29,22 @@ Create the initializer with the following content:
 ``` rb
 Rails.application.config.to_prepare do
   RailsTransactionalOutbox.configure do |config|
-    config.database_connection_provider = ActiveRecord::Base # required 
+    config.database_connection_provider = ActiveRecord::Base # required
     config.transaction_provider = ActiveRecord::Base # required
     config.logger = Rails.logger # required
     config.outbox_model = OutboxEntry # required
-    config.error_handler = Sentry # non-required, but highly recommended, defaults to RailsTransactionalOutbox::ErrorHandlers::NullErrorHandler
-    
+    config.error_handler = Sentry # non-required, but highly recommended, defaults to RailsTransactionalOutbox::ErrorHandlers::NullErrorHandler. When using Sentry, you will probably want to exclude SignalException `config.excluded_exceptions += ["SignalException"]`.
+
     config.transactional_outbox_worker_sleep_seconds = 1 # optional, defaults to 0.5
-    config.transactional_outbox_worker_idle_delay_multiplier = 5 # optional, defaults to 1, if there are no outbox entries to be processed, then the sleep time for the thread will be equal to transactional_outbox_worker_idle_delay_multiplier * transactional_outbox_worker_sleep_seconds  
+    config.transactional_outbox_worker_idle_delay_multiplier = 5 # optional, defaults to 1, if there are no outbox entries to be processed, then the sleep time for the thread will be equal to transactional_outbox_worker_idle_delay_multiplier * transactional_outbox_worker_sleep_seconds
     config.outbox_batch_size = 100 # optional, defaults to 100
     config.add_record_processor(MyCustomOperationProcerssor) # optional, by default it contains only one processor for ActiveRecord, but you could add more
-    
+    config.raise_not_found_model_error = true # optional, defaults to true. Should the error be raised if outbox entry model is not found
+
     config.lock_client = Redlock::Client.new([ENV["REDIS_URL"]]) # required if you want to use RailsTransactionalOutbox::OutboxEntriesProcessors::OrderedByCausalityKeyProcessor, defaults to RailsTransactionalOutbox::NullLockClient. Check its interface and the interface of `redlock` gem. To cut the long story short, when the lock is acquired, a hash with the structure outlined in RailsTransactionalOutbox::NullLockClient should be yielded, if the lock is not acquired, a nil should be yielded.
     config.lock_expiry_time  = 10_000 # not required, defaults to 10_000, the unit is milliseconds
     config.outbox_entries_processor = `RailsTransactionalOutbox::OutboxEntriesProcessors::OrderedByCausalityKeyProcessor`.new # not required, defaults to RailsTransactionalOutbox::OutboxEntriesProcessors::NonOrderedProcessor.new
-    config.outbox_entry_causality_key_resolver = ->(model) { model.tenant_id } # not required, defaults to a lambda returning nil. Needed when using `outbox_entry_causality_key_resolver`  
+    config.outbox_entry_causality_key_resolver = ->(model) { model.tenant_id } # not required, defaults to a lambda returning nil. Needed when using `outbox_entry_causality_key_resolver`
   end
 end
 ```
@@ -53,7 +54,7 @@ Create OutboxEntry model (or use a different name, just make sure to adjust conf
 ``` rb
 class OutboxEntry < ApplicationRecord
   include RailsTransactionalOutbox::OutboxModel
-  
+
   # optional, if you want to use encryption
   crypt_keeper :changeset, :arguments, encryptor: :postgres_pgp, key: ENV.fetch("CRYPT_KEEPER_KEY"), encoding: "UTF-8"
   outbox_encrypt_json_for :changeset, :arguments
@@ -93,7 +94,7 @@ end
 
 Keep in mind that `arguments` and `changeset` are `text` columns here. If you don't want to use encryption, replace them with `jsonb` columns:
 
-```rb 
+```rb
 t.jsonb "arguments", null: false, default: {}
 t.jsonb "changeset", null: false, default: {}
 ```
@@ -105,7 +106,7 @@ As the last step, include `RailsTransactionalOutbox::ReliableModel` module in th
 ``` ruby
 class User < ActiveRecord::Base
   include RailsTransactionalOutbox::ReliableModel
-end 
+end
 ```
 
 Now, you can just replace `after_commit` callbacks with `reliable_after_commit`. The interface is going to be the same as for `after_commit`:
@@ -247,9 +248,8 @@ end
 
 ### Health Checks
 
-First, you need to set `REDIS_URL` ENV variable to provide the URL for Redis.
 
-Then, you need to explicitly enable the health check (e.g. in the initializer):
+Then, Uou need to explicitly enable the health check (e.g. in the initializer):
 
 ``` rb
 RailsTransactionalOutbox.enable_outbox_worker_healthcheck
@@ -261,8 +261,6 @@ To perform the actual health check, use `bin/rails_transactional_outbox_health_c
 bundle exec rails_transactional_outbox_health_check
 ```
 
-The logic is based on checking a special value in Redis that is set (and unset) for a given container when Outbox workers are initialized/stopped/processing messages.
-
 It works for both readiness and liveness checks.
 
 #### Events, hooks and monitors

data/lib/rails_transactional_outbox/configuration.rb

@@ -5,7 +5,8 @@ class RailsTransactionalOutbox
     attr_accessor :database_connection_provider, :logger, :outbox_model, :transaction_provider
     attr_writer :error_handler, :transactional_outbox_worker_sleep_seconds,
       :transactional_outbox_worker_idle_delay_multiplier, :outbox_batch_size, :outbox_entries_processor,
-      :lock_client, :lock_expiry_time, :outbox_entry_causality_key_resolver
+      :lock_client, :lock_expiry_time, :outbox_entry_causality_key_resolver,
+      :raise_not_found_model_error
 
     def error_handler
       @error_handler || RailsTransactionalOutbox::ErrorHandlers::NullErrorHandler
@@ -35,6 +36,14 @@ class RailsTransactionalOutbox
       @outbox_entries_processor ||= RailsTransactionalOutbox::OutboxEntriesProcessors::NonOrderedProcessor.new
     end
 
+    def raise_not_found_model_error
+      return @raise_not_found_model_error if defined?(@raise_not_found_model_error)
+
+      true
+    end
+
+    alias_method :raise_not_found_model_error?, :raise_not_found_model_error
+
     def lock_client
       @lock_client || RailsTransactionalOutbox::NullLockClient
     end

data/lib/rails_transactional_outbox/health_check.rb

@@ -1,46 +1,45 @@
 # frozen_string_literal: true
 
-require "redis"
-
 class RailsTransactionalOutbox
   class HealthCheck
     KEY_PREFIX = "__rails_transactional__outbox_worker__running__"
-    VALUE = "OK"
-    private_constant :KEY_PREFIX, :VALUE
+    TMP_DIR = "/tmp"
+    private_constant :KEY_PREFIX, :TMP_DIR
 
-    def self.check(redis_url: ENV.fetch("REDIS_URL", nil), hostname: ENV.fetch("HOSTNAME", nil),
-      expiry_time_in_seconds: 120)
-      new(redis_url: redis_url, hostname: hostname, expiry_time_in_seconds: expiry_time_in_seconds).check
+    def self.check(hostname: ENV.fetch("HOSTNAME", nil), expiry_time_in_seconds: 120)
+      new(hostname: hostname, expiry_time_in_seconds: expiry_time_in_seconds).check
     end
 
-    attr_reader :redis_client, :hostname, :expiry_time_in_seconds
+    attr_reader :hostname, :expiry_time_in_seconds
 
-    def initialize(redis_url: ENV.fetch("REDIS_URL", nil), hostname: ENV.fetch("HOSTNAME", nil),
-      expiry_time_in_seconds: 120)
-      @redis_client = Redis.new(url: redis_url)
+    def initialize(hostname: ENV.fetch("HOSTNAME", nil), expiry_time_in_seconds: 120)
       @hostname = hostname
       @expiry_time_in_seconds = expiry_time_in_seconds
     end
 
     def check
-      value = redis_client.get(key)
-      if value == VALUE
+      if healthcheck_storage.running?
         ""
       else
-        "[Rails Transactional Outbox Worker - expected #{VALUE} under #{key}, found: #{value}] "
+        "[Rails Transactional Outbox Worker healthcheck failed]"
       end
     end
 
     def register_heartbeat
-      redis_client.set(key, VALUE, ex: expiry_time_in_seconds)
+      healthcheck_storage.touch
     end
 
     def worker_stopped
-      redis_client.del(key)
+      healthcheck_storage.remove
     end
 
     private
 
+    def healthcheck_storage
+      @healthcheck_storage ||= FileBasedHealthcheck.new(directory: TMP_DIR, filename: key,
+        time_threshold: expiry_time_in_seconds)
+    end
+
     def key
       "#{KEY_PREFIX}#{hostname}"
     end

data/lib/rails_transactional_outbox/record_processors/active_record_processor.rb

@@ -15,7 +15,14 @@ class RailsTransactionalOutbox
       end
 
       def call(record)
-        model = record.infer_model or raise CouldNotFindModelError.new(record)
+        model = record.infer_model
+        if model.nil?
+          if RailsTransactionalOutbox.configuration.raise_not_found_model_error?
+            raise CouldNotFindModelError.new(record)
+          end
+
+          return
+        end
         model.previous_changes = record.transformed_changeset.with_indifferent_access
         model.reliable_after_commit_callbacks.for_event_type(record.event_type).each do |callback|
           callback.call(model)

data/lib/rails_transactional_outbox/version.rb

@@ -3,5 +3,5 @@
 class RailsTransactionalOutbox
   module Version
   end
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/rails_transactional_outbox.rb

@@ -5,6 +5,7 @@ require "logger"
 require "dry-monitor"
 require "sigurd"
 require "concurrent-ruby"
+require "file-based-healthcheck"
 
 class RailsTransactionalOutbox
   def self.loader

data/rails-transactional-outbox.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 3.2"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "dry-monitor"
-  spec.add_dependency "redis"
+  spec.add_dependency "file-based-healthcheck"
   spec.add_dependency "sigurd"
   spec.add_dependency "zeitwerk"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-transactional-outbox
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: file-based-healthcheck
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="