outboxable 0.1.8 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab43c50794ab0059ec940956619219fc78cfc1fdc2f2e21e78bd7ac5f24f43dd
-  data.tar.gz: 7d1f9ac4e934f92b5c257cd1489ee2f9f316998a3b60b6ba8a9d3af18b9baf41
+  metadata.gz: 7ff24c145223dcc558818028a2866583266372e1a52cbb0dc63661fdad5f94ea
+  data.tar.gz: 64e19fa685b3f77a85c10bc60f9754a32bbe8534b9aaa5cb153253aefb5bbcb1
 SHA512:
-  metadata.gz: 5811e8e889c56840cff9d4911853f8929cc11b8959e204965bbfff384c7bc914a32daee6d175563921f0332419ab6201528839b548921e24d70d8428b51c23aa
-  data.tar.gz: 6f1b34031671e1cf047642d86a37a44e1bf26d9ec0d5a8929923a188d95177f24df264e9dfb0e8c8bf30522308325441d4a192f198daea1a063e606dd4804126
+  metadata.gz: 9dca7a575abbc63e9b033e3726229ce8abe6254ea049f220f66c9b675c4395efbfdac1a12da0dc5c31f50a65bfdab939ee23809c24d9e2182864fdd0b703754f
+  data.tar.gz: 6673eabf79e2daa9b36bd93c84589dc68f796a22c8b82cf93d035cd9eaaa1b3ba523ee16c9c121c719befe9b1527b3bf32a6c2467ee023b9bfd527b209575ef3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    outboxable (0.1.8)
+    outboxable (1.0.2)
       bunny (>= 2.19.0)
       connection_pool (~> 2.3.0)
 

data/lib/generators/outboxable/install_generator.rb

@@ -3,24 +3,37 @@ module Outboxable
     include Rails::Generators::Migration
 
     source_root File.expand_path('../../templates', __dir__)
+    class_option :orm, type: :string, default: 'activerecord'
+
+    def initialize(*)
+      super(*)
+
+      @orm = options[:orm] || 'activerecord'
+      %w[activerecord mongoid].include?(@orm) || raise(ArgumentError, 'Invalid ORM. Only ActiveRecord and Mongoid are supported.')
+    end
 
     # Copy initializer into user app
     def copy_initializer
-      copy_file('initializer.rb', 'config/initializers/z_outboxable.rb')
+      copy_file('activerecod_initializer.rb', 'config/initializers/z_outboxable.rb') if @orm == 'activerecord'
+      copy_file('mongoid_initializer.rb', 'config/initializers/z_outboxable.rb') if @orm == 'mongoid'
     end
 
     # Copy user information (model & Migrations) into user app
     def create_user_model
       target_path = 'app/models/outbox.rb'
+
       if Rails.root.join(target_path).exist?
         say_status('skipped', 'Model outbox already exists')
       else
-        template('outbox.rb', target_path)
+        template('activerecrod_outbox.rb', target_path) if @orm == 'activerecord'
+        template('mongoid_outbox.rb', target_path) if @orm == 'mongoid'
       end
     end
 
     # Copy migrations
     def copy_migrations
+      return if @orm == 'mongoid'
+
       if self.class.migration_exists?('db/migrate', 'create_outboxable_outboxes')
         say_status('skipped', 'Migration create_outboxable_outboxes already exists')
       else

data/lib/outboxable/configuration.rb

@@ -6,11 +6,17 @@ 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
     ALLOWED_MESSAGE_BROKERS = %i[rabbitmq].freeze
-    ALLOWED_ORMS = %i[activerecord].freeze
+    ALLOWED_ORMS = %i[activerecord mongoid].freeze
 
     attr_accessor :rabbitmq_host,
                   :rabbitmq_port,
@@ -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,14 +3,27 @@ module Outboxable
     include Sidekiq::Job
     sidekiq_options queue: 'critical'
 
-    def perform
+    def perform(args)
+      orm = args['orm']
+      orm == 'mongoid' ? perform_mongoid(orm) : perform_activerecord(orm)
+    end
+
+    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(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.idempotency_key, orm)
+        outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
+      end
+    end
   end
 end

data/lib/outboxable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Outboxable
-  VERSION = '0.1.8'
+  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/outboxable.rb

@@ -20,7 +20,7 @@ module Outboxable
     after_create :instantiate_outbox_for_create, if: proc { |object| object.check_outbox_condition(object:, operation: :create) }
     after_update :instantiate_outbox_for_update, if: proc { |object| object.check_outbox_condition(object:, operation: :update) }
 
-    has_many :outboxes, as: :outboxable, autosave: false
+    has_many :outboxes, as: :outboxable, dependent: :destroy
 
     def instantiate_outbox(routing_key:)
       outboxes.new(

data/lib/templates/{outbox.rb → 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

@@ -0,0 +1,36 @@
+# 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
+  module RabbitMq
+    class Publisher
+      # Override this method to customize the message format that you publish to your broker
+      # DO NOT CHANGE THE METHOD SIGNATURE
+      def to_envelope(resource:)
+        {
+          id: resource.id,
+          source: 'http://localhost:3000',
+          specversion: '1.0',
+          type: resource.routing_key,
+          datacontenttype: 'application/json',
+          data: resource.payload
+        }.to_json
+      end
+    end
+  end
+end
+
+Outboxable.configure do |config|
+  # Specify the ORM you are using. For now, only ActiveRecord is supported.
+  config.orm = :mongoid
+
+  # Specify the message broker you are using. For now, only RabbitMQ is supported.
+  config.message_broker = :rabbitmq
+
+  # RabbitMQ configurations
+  config.rabbitmq_host = ENV.fetch('RABBITMQ__HOST')
+  config.rabbitmq_port = ENV.fetch('RABBITMQ__PORT', 5672)
+  config.rabbitmq_user = ENV.fetch('RABBITMQ__USERNAME')
+  config.rabbitmq_password = ENV.fetch('RABBITMQ__PASSWORD')
+  config.rabbitmq_vhost = ENV.fetch('RABBITMQ__VHOST')
+  config.rabbitmq_event_bus_exchange = ENV.fetch('EVENTBUS__EXCHANGE_NAME')
+end

data/lib/templates/mongoid_outbox.rb

@@ -0,0 +1,71 @@
+class Outbox
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  attr_writer :allow_publish
+
+  # Fields
+  field :status, type: String, default: 'pending'
+  field :size,   type: String, default: 'single'
+
+  field :exchange, type: String, default: ''
+  field :routing_key, type: String, default: ''
+
+  field :attempts, type: Integer, default: 0
+
+  field :last_attempted_at, type: DateTime, default: nil
+
+  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_save :publish, if: :allow_publish
+
+  # Validations
+  validates :payload, :exchange, :routing_key, presence: true
+
+  # Associations
+  belongs_to :outboxable, polymorphic: true, optional: true
+
+  def set_last_attempted_at
+    self.last_attempted_at = 10.seconds.from_now
+  end
+
+  def publish
+    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
+    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: 0.1.8
+  version: 1.0.2
 platform: ruby
 authors:
 - Brusk Awat
@@ -64,9 +64,11 @@ files:
 - lib/outboxable/rabbitmq/publisher.rb
 - lib/outboxable/version.rb
 - lib/outboxable/worker.rb
+- lib/templates/activerecord_initializer.rb
+- lib/templates/activerecrod_outbox.rb
 - lib/templates/create_outboxable_outboxes.rb
-- lib/templates/initializer.rb
-- lib/templates/outbox.rb
+- lib/templates/mongoid_initializer.rb
+- lib/templates/mongoid_outbox.rb
 - sig/outboxable.rbs
 homepage: https://github.com/broosk1993/outboxable
 licenses: