outboxer 0.1.11 → 1.0.0.pre.beta

data/Rakefile

@@ -1,12 +0,0 @@
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "pry"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
-
-load "lib/tasks/gem.rake"

data/generators/outboxer/templates/bin/publisher.rb

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative "../config/environment"
-
-Outboxer::Publisher.publish do |message:, logger:|
-  logger.info("[#{message.id}] publishing")
-
-  HardJob.perform_async({ "message_id" => message.id })
-
-  logger.info("[#{message.id}] published")
-end

data/generators/outboxer/templates/migrations/create_outboxer_exceptions.rb

@@ -1,15 +0,0 @@
-class CreateOutboxerExceptions < ActiveRecord::Migration[6.1]
-  def change
-    create_table :outboxer_exceptions do |t|
-      t.references :message, null: false, foreign_key: { to_table: :outboxer_messages }
-
-      t.text :class_name, null: false
-      t.text :message_text, null: false
-      t.column :backtrace, :text, array: true
-
-      t.timestamps
-    end
-
-    remove_column :outboxer_exceptions, :updated_at
-  end
-end

data/generators/outboxer/templates/migrations/create_outboxer_messages.rb

@@ -1,13 +0,0 @@
-class CreateOutboxerMessages < ActiveRecord::Migration[6.1]
-  def change
-    create_table :outboxer_messages do |t|
-      t.references :message, polymorphic: true, null: false
-      t.text :status, null: false
-
-      t.timestamps
-    end
-
-    add_index :outboxer_messages, %i[status created_at]
-    add_index :outboxer_messages, %i[message_type message_id], unique: true
-  end
-end

data/lib/outboxer/exception.rb

@@ -1,9 +0,0 @@
-require "active_record"
-
-module Outboxer
-  class Exception < ::ActiveRecord::Base
-    self.table_name = :outboxer_exceptions
-
-    belongs_to :message, class_name: "::Outboxer::Message"
-  end
-end

data/lib/outboxer/outboxable.rb

@@ -1,21 +0,0 @@
-module Outboxer
-  module Outboxable
-    def self.included(base)
-      base.extend ClassMethods
-
-      base.class_eval do
-        has_one :message, class_name: "::Outboxer::Message", as: :outbox_message,
-                          dependent: :destroy
-
-        after_create :create_outbox_message!
-      end
-    end
-
-    def create_outbox_message!
-      Message.create!(message: self, status: Message::STATUS[:unpublished])
-    end
-
-    module ClassMethods
-    end
-  end
-end

data/lib/outboxer/publisher.rb

@@ -1,149 +0,0 @@
-require "logger"
-
-module Outboxer
-  module Publisher
-    module_function
-
-    @publishing = false
-    @logger = Logger.new($stdout)
-
-    # Publishes messages from the Outboxer queue.
-    #
-    # This method will continue to publish messages from the queue as long
-    # as @publishing is set to true. It uses an ActiveRecord connection to
-    # handle database interactions.
-    #
-    # @param poll [Integer] the interval (in seconds) at which the method
-    #   should poll the database for new messages.
-    # @param backoff [Proc] a callable object that defines how to increase the
-    #   backoff time when an error occurs. It should accept the current backoff
-    #   time as a parameter and return the new backoff time.
-    #
-    # @yield [Hash] once a message is dequeued, the method yields a hash to
-    #   the given block. The hash contains the :message (the dequeued message)
-    #   and :logger (the logger object).
-    #
-    # @yieldparam message [Message] the dequeued message from the Outboxer queue.
-    # @yieldparam logger [Logger] the logger instance to log any information or errors.
-    #
-    # @raise [StandardError] if an error occurs during the yield, it is rescued,
-    #   logged, and then the failed method is invoked to handle the error. The
-    #   method then moves on to the next message in the queue.
-    #
-    # @return [void] This method does not have a meaningful return value.
-    #
-    # @example Basic usage
-    #   Outboxer::Publisher.publish(poll: 1) do |hash|
-    #     puts hash[:message]
-    #     puts hash[:logger]
-    #   end
-    def publish(poll: 1, backoff: ->(current_backoff) { [current_backoff * 2, 5 * 60].min })
-      @publishing = true
-
-      ActiveRecord::Base.connection_pool.with_connection do
-        while @publishing
-          outboxer_message = dequeue(backoff: backoff)
-
-          if outboxer_message.nil?
-            sleep poll
-
-            next
-          end
-
-          begin
-            yield message: outboxer_message.message, logger: @logger
-          rescue StandardError => exception
-            failed(
-              outboxer_message: outboxer_message,
-              backoff: backoff,
-              exception: exception)
-
-            next
-          end
-
-          published(
-            outboxer_message: outboxer_message,
-            backoff: backoff)
-        end
-      end
-    end
-
-    def dequeue(backoff:)
-      retry_on_error(backoff: backoff) do
-        ActiveRecord::Base.transaction do
-          message = Message
-            .where(status: Message::STATUS[:unpublished])
-            .order(created_at: :asc)
-            .limit(1)
-            .lock("FOR UPDATE SKIP LOCKED")
-            .first
-
-          message&.update!(status: Message::STATUS[:publishing])
-
-          message
-        end
-      end
-    end
-
-    def published(outboxer_message:, backoff:)
-      retry_on_error(backoff: backoff) do
-        outboxer_message.destroy!
-      end
-    end
-
-    def failed(outboxer_message:, exception:, backoff:)
-      @logger.error(
-        "Exception raised: #{exception.class}: #{exception.message}\n" \
-        "#{exception.backtrace.join("\n")}")
-
-      retry_on_error(backoff: backoff) do
-        ActiveRecord::Base.transaction do
-          outboxer_message.update!(status: Message::STATUS[:failed])
-
-          outboxer_message.exceptions.create!(
-            class_name: exception.class.name,
-            message_text: exception.message,
-            backtrace: exception.backtrace)
-        end
-      end
-    end
-
-    def retry_on_error(backoff:, &block)
-      current_backoff = 1
-
-      begin
-        block.call
-      rescue StandardError => exception
-        @logger.fatal(
-          "Exception raised: #{exception.class}: #{exception.message}\n" \
-          "#{exception.backtrace.join("\n")}")
-
-        raise exception unless @publishing
-
-        sleep current_backoff
-
-        current_backoff = backoff.call(current_backoff)
-
-        retry
-      end
-    end
-
-    # Stops the publishing process.
-    #
-    # @note This method will stop the current message publishing process
-    #       It is a safe way to interrupt the publishing process at any point.
-    #
-    # @return [void]
-    def stop
-      @publishing = false
-    end
-
-    Signal.trap("TERM") do
-      @logger.info("Received SIGTERM, stopping...")
-
-      stop
-    end
-
-    private_class_method :retry_on_error, :dequeue, :published, :failed
-  end
-end

data/lib/tasks/gem.rake

@@ -1,58 +0,0 @@
-require "rake/packagetask"
-
-namespace :gem do
-  desc "Bump version number"
-  task :bump, [:type] do |_t, args|
-    args.with_defaults(type: "patch")
-
-    unless %w[major minor patch].include?(args[:type])
-      raise "Invalid version type - choose from major/minor/patch"
-    end
-
-    version_file = File.expand_path("../../lib/outboxer/version.rb", __dir__)
-    version = ""
-    File.open(version_file, "r") do |file|
-      version = file.read.match(/VERSION = "(.*)"/)[1]
-    end
-
-    version_parts = version.split(".").map(&:to_i)
-    case args[:type]
-    when "major"
-      version_parts[0] += 1
-      version_parts[1] = 0
-      version_parts[2] = 0
-    when "minor"
-      version_parts[1] += 1
-      version_parts[2] = 0
-    when "patch"
-      version_parts[2] += 1
-    end
-
-    new_version = version_parts.join(".")
-    File.write(version_file, "module Outboxer\n  VERSION = \"#{new_version}\".freeze\nend\n")
-
-    puts "Gem version bumped to #{new_version}"
-  end
-
-  desc "Build the gem"
-  task :build do
-    Outboxer.send(:remove_const, :VERSION) if Outboxer.const_defined?(:VERSION)
-    load "lib/outboxer/version.rb"
-    sh "gem build outboxer.gemspec"
-
-    puts "Gem built successfully."
-  end
-
-  desc "Push the gem to RubyGems"
-  task :push do
-    Outboxer.send(:remove_const, :VERSION) if Outboxer.const_defined?(:VERSION)
-    load "lib/outboxer/version.rb"
-    version = Outboxer::VERSION
-    sh "gem push outboxer-#{version}.gem"
-
-    puts "Gem pushed to RubyGems."
-  end
-
-  desc "Bump, build and push the gem to RubyGems"
-  task release: %i[bump build push]
-end

data/outboxer.gemspec

@@ -1,33 +0,0 @@
-# rubocop:disable Layout/LineLength
-require_relative "lib/outboxer/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "outboxer"
-  spec.version = Outboxer::VERSION
-  spec.authors = ["Adam Mikulasev"]
-  spec.email = ["adam@fastprogrammer.co"]
-
-  spec.summary = "Transactional outbox implementation for event driven Ruby on Rails applications that use SQL"
-  spec.homepage = "https://github.com/fast-programmer/outboxer"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/fast-programmer/outboxer"
-  spec.metadata["documentation_uri"] = "https://rubydoc.info/github/fast-programmer/outboxer/master"
-  spec.metadata["changelog_uri"] = "https://github.com/fast-programmer/outboxer/blob/master/CHANGELOG.md"
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activerecord", "~> 7.0"
-end
-# rubocop:enable Layout/LineLength

data/sig/outboxer.rbs

@@ -1,19 +0,0 @@
-module Outboxer
-  VERSION: String
-  
-  module Publisher
-    class Args
-      attr_reader message: untyped
-      attr_reader logger: Logger
-      
-      def initialize: (untyped message, Logger logger) -> void
-    end
-  
-    def self.publish: (?Integer poll, ?Proc[Integer, Integer] backoff) { (Args) -> untyped } -> void
-    def self.dequeue: ({ backoff: Proc[Integer, Integer] }) -> untyped
-    def self.published: ({ outboxer_message: untyped, backoff: Proc[Integer, Integer] }) -> void
-    def self.failed: ({ outboxer_message: untyped, exception: Exception, backoff: Proc[Integer, Integer] }) -> void
-    def self.retry_on_error: ({ backoff: Proc[Integer, Integer] }) { () -> untyped } -> untyped
-    def self.stop: () -> void
-  end
-end