outboxable 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6289db937af7c6072908dce5da1a44a5145c9a4065bcd3705f847ea39e6c7c57
-  data.tar.gz: 89a5d2581f353528fd78e0c19443163d625d2981fa443b5db99a31554001e93d
+  metadata.gz: 7ff24c145223dcc558818028a2866583266372e1a52cbb0dc63661fdad5f94ea
+  data.tar.gz: 64e19fa685b3f77a85c10bc60f9754a32bbe8534b9aaa5cb153253aefb5bbcb1
 SHA512:
-  metadata.gz: dcefad48f356f8d18e44ac7431464f3b1687505fa6241e4d472ad67f215a00e0b5d0da5f690b028aae34c97564d60c5db1c331a37151b02c69d5b60823c029e9
-  data.tar.gz: 810dd5e03320ddc4812e5f15db86521fe3e29f4dc69bb92d64dbff822cceddccb71c25e99573edf8cf6d191aa8992d58e7a8fd144a28598def81b63e6614c567
+  metadata.gz: 9dca7a575abbc63e9b033e3726229ce8abe6254ea049f220f66c9b675c4395efbfdac1a12da0dc5c31f50a65bfdab939ee23809c24d9e2182864fdd0b703754f
+  data.tar.gz: 6673eabf79e2daa9b36bd93c84589dc68f796a22c8b82cf93d035cd9eaaa1b3ba523ee16c9c121c719befe9b1527b3bf32a6c2467ee023b9bfd527b209575ef3

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    outboxable (1.0.0)
+    outboxable (1.0.2)
       bunny (>= 2.19.0)
       connection_pool (~> 2.3.0)
-      simple_enum (>= 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -85,8 +84,6 @@ GEM
       fugit (~> 1.8)
       globalid (>= 1.0.1)
       sidekiq (>= 6)
-    simple_enum (2.3.2)
-      activesupport (>= 4.0.0)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)

data/lib/generators/outboxable/install_generator.rb

@@ -5,8 +5,8 @@ module Outboxable
     source_root File.expand_path('../../templates', __dir__)
     class_option :orm, type: :string, default: 'activerecord'
 
-    def initialize
-      super
+    def initialize(*)
+      super(*)
 
       @orm = options[:orm] || 'activerecord'
       %w[activerecord mongoid].include?(@orm) || raise(ArgumentError, 'Invalid ORM. Only ActiveRecord and Mongoid are supported.')

data/lib/outboxable/configuration.rb

@@ -6,6 +6,12 @@ module Outboxable
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
+
+    # In accordance to sidekiq-cron README: https://github.com/sidekiq-cron/sidekiq-cron#under-the-hood
+    Sidekiq::Options[:cron_poll_interval] = 5
+
+    # Create the cron job for the polling publisher
+    Sidekiq::Cron::Job.create(name: 'OutboxablePollingPublisher', cron: '*/5 * * * * *', class: 'Outboxable::PollingPublisherWorker', args: [{ orm: configuration.orm }])
   end
 
   class Configuration
@@ -26,12 +32,6 @@ module Outboxable
       raise Error, 'Outboxable Gem only supports Rails but you application does not seem to be a Rails app' unless Object.const_defined?('Rails')
       raise Error, 'Outboxable Gem only support Rails version 7 and newer' if Rails::VERSION::MAJOR < 7
       raise Error, 'Outboxable Gem uses the sidekiq-cron Gem. Make sure you add it to your project' unless Object.const_defined?('Sidekiq::Cron')
-
-      # In accordance to sidekiq-cron README: https://github.com/sidekiq-cron/sidekiq-cron#under-the-hood
-      Sidekiq::Options[:cron_poll_interval] = 5
-
-      # Create the cron job for the polling publisher
-      Sidekiq::Cron::Job.create(name: 'OutboxablePollingPublisher', cron: '*/5 * * * * *', class: 'Outboxable::PollingPublisherWorker')
     end
 
     def message_broker=(message_broker)

data/lib/outboxable/polling_publisher_worker.rb

@@ -3,24 +3,25 @@ module Outboxable
     include Sidekiq::Job
     sidekiq_options queue: 'critical'
 
-    def perform
-      Outboxable.configuration.orm == :mongoid ? perform_mongoid : perform_activerecord
+    def perform(args)
+      orm = args['orm']
+      orm == 'mongoid' ? perform_mongoid(orm) : perform_activerecord(orm)
     end
 
-    def perform_activerecord
+    def perform_activerecord(orm)
       Outbox.pending.where(last_attempted_at: [..Time.zone.now, nil]).find_in_batches(batch_size: 100).each do |batch|
         batch.each do |outbox|
           # This is to prevent a job from being retried too many times. Worst-case scenario is 1 minute delay in jobs.
-          Outboxable::Worker.perform_async(outbox.id)
+          Outboxable::Worker.perform_async(outbox.id, orm)
           outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
         end
       end
     end
 
-    def perform_mongoid
+    def perform_mongoid(orm)
       Outbox.pending.where(last_attempted_at: [..Time.zone.now, nil]).each do |outbox|
         # This is to prevent a job from being retried too many times. Worst-case scenario is 1 minute delay in jobs.
-        Outboxable::Worker.perform_async(outbox.id)
+        Outboxable::Worker.perform_async(outbox.idempotency_key, orm)
         outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
       end
     end

data/lib/outboxable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Outboxable
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/outboxable/worker.rb

@@ -4,8 +4,9 @@ module Outboxable
   class Worker
     include ::Sidekiq::Job
 
-    def perform(outbox_id)
-      Outboxable::PublishingManager.publish(resource: Outbox.find(outbox_id))
+    def perform(outbox_id, orm)
+      Outboxable::PublishingManager.publish(resource: Outbox.find(outbox_id)) if orm == 'activerecord'
+      Outboxable::PublishingManager.publish(resource: Outbox.find_by!(idempotency_key: outbox_id)) if orm == 'mongoid'
     end
   end
 end

data/lib/templates/activerecrod_outbox.rb

@@ -4,7 +4,7 @@ class Outbox < ApplicationRecord
   before_save :check_publishing
   # Callbacks
   before_create :set_last_attempted_at
-  after_commit :publish, if: :allow_publish?
+  after_save :publish, if: :allow_publish
   # Enums
   enum status: { pending: 0, processing: 1, published: 2, failed: 3 }
   enum size: { single: 0, batch: 1 }

data/lib/templates/{mongoid_initializer..rb → mongoid_initializer.rb}

@@ -1,5 +1,3 @@
-require 'simple_enum/mongoid'
-
 # This monkey patch allows you to customize the message format that you publish to your broker.
 # By default, Outboxable publishes a CloudEvent message to your broker.
 module Outboxable

data/lib/templates/mongoid_outbox.rb

@@ -1,13 +1,12 @@
 class Outbox
   include Mongoid::Document
   include Mongoid::Timestamps
-  include SimpleEnum::Mongoid
 
-  attr_accessor :allow_publish
+  attr_writer :allow_publish
 
   # Fields
   field :status, type: String, default: 'pending'
-  field :size, type: String, default: 'single'
+  field :size,   type: String, default: 'single'
 
   field :exchange, type: String, default: ''
   field :routing_key, type: String, default: ''
@@ -18,18 +17,19 @@ class Outbox
 
   field :retry_at, type: DateTime, default: nil
 
+  field :idempotency_key, type: String
+
   field :payload, type: Hash, default: {}
   field :headers, type: Hash, default: {}
 
+  index({ idempotency_key: 1 }, { unique: true, name: 'idempotency_key_unique_index' })
+
   before_save :check_publishing
+  before_create :set_idempotency_key
 
   # Callbacks
   before_create :set_last_attempted_at
-  after_commit :publish, if: :allow_publish?
-
-  # Enums
-  as_enum :status, { pending: 0, processing: 1, published: 2, failed: 3 }, pluralize_scopes: false, map: :string
-  as_enum :size, { single: 0, batch: 1 }, pluralize_scopes: false, map: :string
+  after_save :publish, if: :allow_publish
 
   # Validations
   validates :payload, :exchange, :routing_key, presence: true
@@ -42,15 +42,30 @@ class Outbox
   end
 
   def publish
-    Outboxable::Worker.perform_async(id)
+    Outboxable::Worker.perform_async(idempotency_key)
     update(status: :processing, last_attempted_at: 1.minute.from_now, allow_publish: false)
   end
 
+  def set_idempotency_key
+    self.idempotency_key = SecureRandom.uuid if idempotency_key.blank?
+  end
+
   def check_publishing
     self.allow_publish = false if published?
   end
 
   def allow_publish
-    @allow_publish || true
+    return true if @allow_publish.nil?
+
+    @allow_publish
+  end
+
+  %w[pending processing published failed].each do |status|
+    define_method "#{status}?" do
+      self.status == status
+    end
+
+    # define scope
+    scope status, -> { where(status:) }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outboxable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Brusk Awat
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
-- !ruby/object:Gem::Dependency
-  name: simple_enum
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.3'
 description: The Outboxable Gem is tailored for Rails applications to implement the
   transactional outbox pattern. It currently only supports ActiveRecord.
 email:
@@ -81,7 +67,7 @@ files:
 - lib/templates/activerecord_initializer.rb
 - lib/templates/activerecrod_outbox.rb
 - lib/templates/create_outboxable_outboxes.rb
-- lib/templates/mongoid_initializer..rb
+- lib/templates/mongoid_initializer.rb
 - lib/templates/mongoid_outbox.rb
 - sig/outboxable.rbs
 homepage: https://github.com/broosk1993/outboxable