railbox 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e7c53ea3b3e9b5c1f7a67c19273456d4cedb978257834328db3b1a3e058e0bf
-  data.tar.gz: 2832aeeb9558208d4ba229828403459422fcd19ea765ac193b63067031746349
+  metadata.gz: 9bee1e734460ab0bc5d07c19cf133c1a46bde8e0e943b7a5e50a480d5fdce24f
+  data.tar.gz: 40b7b8f3e1c3ac79447dc56d0eb682ea58a2c82205481f6f13656319a6955803
 SHA512:
-  metadata.gz: 670dbf35a4f62c0c81a779bc5d1f2e4af414f13b6d72064fbfd0eedc1bfd5097617c7f6508b8bc2abe082dea5927e5da4dfa78a23dfca0e38dda92c9b77def7a
-  data.tar.gz: ffdd4cc4dd8bd242483ac8b61fecacb3a9b69104d3931c3cead162a6b0c7601e2dfa0381d74005facdf1967b533643b61c242b867029e8b6b6e04f5f3b33c10d
+  metadata.gz: 2c2b6dbde97ef2814a83b5b75149c9e7e0e0f43d1180aff131bf6b37cce3f6be6ded8f4d9257a5792ab93ad528602ec2525802180c75f302710e36fa2ef960c7
+  data.tar.gz: e5f8c61ec2fbd84a48301dd84bc608621a10a4ce493cd453c0a90b396dfb37914e81c709543d093ea4792f885f2bc809752869f08ddd2c186800990060e5c0f8

data/lib/generators/railbox/install/templates/migration.rb.tt

@@ -0,0 +1,21 @@
+class CreateTransactionalOutbox < ActiveRecord::Migration[7.0]
+  def change
+    create_table :transactional_outboxes do |t|
+      t.string :action_type, null: false
+      t.jsonb :action_data, null: false, default: {}
+      t.string :status, null: false
+      t.string :entity_type
+      t.integer :entity_id
+      t.jsonb :query, default: {}
+      t.jsonb :body, default: {}
+      t.jsonb :headers, default: {}
+      t.jsonb :meta, default: {}
+      t.integer :attempts, default: 0
+      t.datetime :retry_at
+      t.jsonb :failure_reasons, array: true, default: []
+      t.timestamps
+    end
+
+    add_index :transactional_outboxes, [:entity_type, :entity_id]
+  end
+end

data/lib/railbox/handler/handler.rb

@@ -28,6 +28,14 @@ module Railbox
       def enqueue(method: 'create', body: {}, **opts)
         HandlingQueue.enqueue(service: name, method: method, body: body, **opts)
       end
+
+      # Base failure hook:
+      # - can be safely called even if not overridden in the service;
+      # - does nothing by default;
+      # - when overridden, has access to `outbox_entity`.
+      def on_failure
+        # no-op by default
+      end
     end
   end
 end

data/lib/railbox/models/transactional_outbox.rb

@@ -32,6 +32,12 @@ module Railbox
     class TransactionalOutbox < ::ActiveRecord::Base
       belongs_to :relative_entity, polymorphic: true, foreign_key: :entity_id, foreign_type: :entity_type
 
+      enum :status, {in_progress: 'in_progress', failed: 'failed', completed: 'completed'}
+
+      def action_data
+        super&.deep_symbolize_keys || {}
+      end
+
       def in_group?
         group.present? || entity_group.present?
       end

data/lib/railbox/mutators/transactional_outbox_mutator.rb

@@ -10,7 +10,7 @@ module Railbox
         def update(record, attributes)
           record.assign_attributes(attributes)
 
-          if record.status == 'in_progress'
+          if record.in_progress?
             record.attempts += 1
 
             if record.attempts >= Railbox.configuration.max_attempts

data/lib/railbox/processors/handler_processor.rb

@@ -1,17 +1,34 @@
 module Railbox
   module Processors
     class HandlerProcessor
+      extend ActiveSupport::Concern
+
       class << self
 
         def process(record)
-          interface             = Railbox::TransactionalOutboxInterface.new(record)
-          action_data           = record.action_data.deep_symbolize_keys!
-          handler               = Object.const_get(action_data[:class_name])
-          handler.outbox_entity = interface
+          with_handler(record) do |handler, action_data|
+            handler.public_send(action_data[:method_name])
+          end
+        end
+
+        def on_failure(record)
+          with_handler(record) do |handler, _action_data|
+            handler.on_failure
+          end
+        end
+
+        private
 
-          handler.public_send(action_data[:method_name])
+        def with_handler(record)
+          interface   = Railbox::TransactionalOutboxInterface.new(record)
+          action_data = record.action_data
+          handler     = Object.const_get(action_data[:class_name])
+
+          handler.outbox_entity = interface
 
-          handler.outbox_entity = nil
+          yield(handler, action_data)
+        ensure
+          handler.outbox_entity = nil if handler
         end
       end
     end

data/lib/railbox/processors/http_processor.rb

@@ -4,7 +4,7 @@ module Railbox
       class << self
 
         def process(record)
-          action_data = record.action_data.deep_symbolize_keys!
+          action_data = record.action_data
 
           Railbox::HttpClient::Faraday.request(action_data[:method_name],
                                                action_data[:url],
@@ -12,6 +12,9 @@ module Railbox
                                                record.body,
                                                record.headers)
         end
+
+        def on_failure(record)
+        end
       end
     end
   end

data/lib/railbox/workers/process_queue_worker.rb

@@ -12,11 +12,7 @@ module Railbox
             group.each do |record|
               process_record(record)
             rescue => e
-              TransactionalOutboxMutator.update(record, {failure_reasons: record.failure_reasons << { message: e.message, backtrace: e.backtrace&.take(3), at: DateTime.current}})
-              raise e if record.in_group? || record.action_type == 'handler'
-
-              Rails.logger.error("RailboxWorker error: #{e.message}\n #{e.backtrace&.take(3)&.join("\n")}")
-
+              on_failure(e, record)
               next
             end
           rescue => e
@@ -71,23 +67,34 @@ module Railbox
           all_group_records = scope.order(:created_at).to_a
 
           group_records if all_group_records.first&.id.in?(group_records.map(&:id))
-        end.compact.reject { |_k, v| v.blank? }
+        end.compact_blank
       end
 
       def process_record(record)
         Rails.logger.info("Start process with transactional outbox ID #{record.id}")
-        processor = PROCESSORS[record.action_type]
-
-        if processor
-          processor.process(record)
-        else
-          raise Railbox::QueueError, "Unknown action_type=#{record.action_type} for outbox #{record.id}"
-        end
+        take_processor(record).process(record)
 
         TransactionalOutboxMutator.update(record, {status: 'completed'})
 
         Rails.logger.info("Finish process with transactional outbox ID #{record.id}")
       end
+
+      def on_failure(error, record)
+        record = TransactionalOutboxMutator.update(record, {failure_reasons: record.failure_reasons << {message: error.message, backtrace: error.backtrace&.take(3), at: DateTime.current}})
+        take_processor(record).on_failure(record) if record.failed?
+
+        raise error if record.in_group? || record.action_type == 'handler'
+
+        Rails.logger.error("RailboxWorker error: #{error.message}\n #{error.backtrace&.take(3)&.join("\n")}")
+      end
+
+      def take_processor(record)
+        processor = PROCESSORS[record.action_type]
+
+        raise Railbox::QueueError, "Unknown action_type=#{record.action_type} for outbox #{record.id}" unless processor
+
+        processor
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Egor Beresnev
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/generators/railbox/install/install_generator.rb
+- lib/generators/railbox/install/templates/migration.rb.tt
 - lib/railbox.rb
 - lib/railbox/exceptions/queue_error.rb
 - lib/railbox/exceptions/validation_error.rb