trabox 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44bcd5a8b174aa887c7cdbd415aeeba5f1af25a11e10a8a23543967ba2f4fd84
+  data.tar.gz: 0b2d81b7a826f457dd24763bf5eb39278d14061293cf75f225b54639e13057e4
+SHA512:
+  metadata.gz: 02b16217802b7beaa2c2f87e6bf60681556554c458f839c34ed7cfc049c80107be7a5646b2ae2d42de76159e4973776701cb4020987d9d2462dcad75e4183f14
+  data.tar.gz: 3b45467e241f3339de38f6502121347bc569d3b0ac9f29ff286befbbcd9d4866dd348c6a650e4fa63d901c6ba0eb3c8bfe90244bd7b812568c498366c82d4dcb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Trabox
+
+Transactional-Outbox for Rails.
+
+## Usage
+
+How to use my plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trabox'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install trabox
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/exe/trabox

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'trabox/command'
+
+$stdout.sync = true
+$stderr.sync = true
+
+begin
+  command_parser = Trabox::Command::Parser.new
+  command = command_parser.parse!
+
+  Trabox::Command.invoke command
+rescue StandardError => e
+  warn e.backtrace
+  warn e.message
+  warn ''
+  warn command_parser.usage
+  exit 1
+end
+
+# vim:ft=ruby:

data/lib/generators/trabox/configure/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate init Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/trabox/configure/configure_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trabox
+  class ConfigureGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_initializer
+      copy_file 'initializer.rb', 'config/initializers/trabox.rb'
+    end
+  end
+end

data/lib/generators/trabox/configure/templates/initializer.rb

@@ -0,0 +1,44 @@
+# Trabox::Metric.setup unless Rails.env.test?
+
+Trabox::Command::Relay.configure do |config|
+  config.limit = 10
+
+  # ref: https://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html#method-i-lock-21
+  config.lock = true
+  config.interval = 5
+  config.log_level = :info
+
+  # String or Proc
+  ordering_key = Trabox::Publisher::Google::Cloud::PubSub::OrderingKey.new ->(event) { event.model_name.name }
+
+  config.publisher = Trabox::Publisher::Google::Cloud::PubSub.new(
+    'trabox',
+    message_ordering: true,
+    ordering_key: ordering_key
+  )
+end
+
+Trabox::Command::Subscribe.configure do |config|
+  config.log_level = :info
+
+  before_listen_acknowledge_callbacks = []
+  before_listen_acknowledge_callbacks << lambda do |received_message|
+    Rails.logger.info "id=#{received_message.message_id} message=#{received_message.data} ordering_key=#{received_message.ordering_key}"
+  end
+
+  # after_listen_acknowledge_callbacks = []
+  # after_listen_acknowledge_callbacks << lambda do |_received_message|
+  # end
+
+  # error_listen_callbacks = []
+  # error_listen_callbacks << lambda do |_exception|
+  # end
+
+  config.subscriber = Trabox::Subscriber::Google::Cloud::PubSub.new(
+    'trabox-sub',
+    listen_options: {},
+    before_listen_acknowledge_callbacks: before_listen_acknowledge_callbacks,
+    after_listen_acknowledge_callbacks: [],
+    error_listen_callbacks: []
+  )
+end

data/lib/generators/trabox/model/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate trabox:model Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/trabox/model/model_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/active_record/model/model_generator'
+
+module Trabox
+  class ModelGenerator < ActiveRecord::Generators::ModelGenerator
+    source_root "#{base_root}/active_record/model/templates"
+
+    class_option :polymorphic, type: :string, desc: 'add polymorphic column.'
+
+    def initialize(*args)
+      super
+
+      add_attribute "#{options[:polymorphic]}:references{polymorphic}" if options[:polymorphic].present?
+
+      add_attribute 'event_data:binary'
+      add_attribute 'message_id:string'
+      add_attribute 'published_at:datetime'
+    end
+
+    def insert_include
+      inject_into_class File.join('app/models', class_path, "#{file_name}.rb"), class_name do
+        "  include Trabox::Relay::Relayable\n"
+      end
+    end
+
+    private
+
+    def add_attribute(attribute)
+      attributes << Rails::Generators::GeneratedAttribute.parse(attribute)
+    end
+  end
+end

data/lib/tasks/trabox_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :trabox do
+#   # Task goes here
+# end

data/lib/trabox/command/parser.rb

@@ -0,0 +1,40 @@
+require 'optparse'
+
+module Trabox
+  module Command
+    class Parser
+      def initialize
+        @parser = OptionParser.new(nil, 20) do |o|
+          o.version = VERSION
+          o.banner = "\e[1mUsage: #{o.program_name}\e[0m <COMMAND> [OPTIONS]"
+          o.on_tail('-h', '--help', 'Print help information') do
+            $stdout.puts usage
+            exit 0
+          end
+
+          o.on_tail('-v', '--version', 'Print version information')
+        end
+      end
+
+      def parse!
+        @parser.order!
+
+        command = ARGV.shift
+
+        return command unless command.nil?
+
+        warn usage
+        exit 1
+      end
+
+      def usage
+        <<~USAGE
+          #{@parser.help}
+          \e[1mCommands\e[0m:
+              r, relay            Relay events
+              s, subscribe        Subscribe events
+        USAGE
+      end
+    end
+  end
+end

data/lib/trabox/command.rb

@@ -0,0 +1,19 @@
+require 'trabox/command/parser'
+require 'trabox/commands/relay'
+require 'trabox/commands/subscribe'
+
+module Trabox
+  module Command
+    # @param command [String]
+    def self.invoke(command)
+      case command
+      when 'r', 'relay'
+        Trabox::Command::Relay.perform
+      when 's', 'subscribe'
+        Trabox::Command::Subscribe.perform
+      else
+        raise "no such command: #{command}"
+      end
+    end
+  end
+end

data/lib/trabox/commands/common/configuration.rb

@@ -0,0 +1,14 @@
+module Trabox
+  module Command
+    class Configuration
+      DEFAULT_LOG_LEVEL = :info
+      # @!attribute [rw] log_level
+      #   @return [Symbol]
+      attr_accessor :log_level
+
+      def initialize
+        @log_level = ENV['TRABOX_LOG_LEVEL']&.downcase&.to_sym || DEFAULT_LOG_LEVEL
+      end
+    end
+  end
+end

data/lib/trabox/commands/common/runner.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trabox
+  module Command
+    module Runner
+      RAILS_ROOT = ENV['RAILS_ROOT'] || '.'
+      APP_PATH ||= "#{RAILS_ROOT}/config/application"
+
+      def self.load_runner
+        require "#{RAILS_ROOT}/config/boot"
+
+        require APP_PATH
+        Rails.application.require_environment!
+        Rails.application.load_runner
+      end
+    end
+  end
+end

data/lib/trabox/commands/relay/argument_parser.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+require_relative './configuration'
+
+module Trabox
+  module Command
+    module Relay
+      class ArgumentParser
+        def self.parse!
+          new
+        end
+
+        def initialize
+          opts = parse!
+
+          config_overwrite(opts)
+        end
+
+        private
+
+        def parse!
+          opts = {}
+
+          @parser = OptionParser.new do |o|
+            o.banner = <<~BANNER
+              \e[1mUsage\e[0m: \e[1mtrabox relay\e[0m [OPTIONS]
+
+              Overwrite configuration
+
+            BANNER
+
+            o.on('-l NUM', '--limit', Integer)
+            o.on('-i SEC', '--interval', Integer)
+            o.on('-L', '--[no-]lock', TrueClass)
+            o.on('--log-level LEVEL', String) { |v| v.downcase.to_sym }
+          end
+
+          @parser.parse!(into: opts)
+
+          opts.transform_keys { |k| k.to_s.underscore.to_sym }
+        end
+
+        def config_overwrite(opts)
+          opts.each do |attr, val|
+            next if val.nil?
+
+            Relay.config.send("#{attr}=", val)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trabox/commands/relay/configuration.rb

@@ -0,0 +1,63 @@
+require_relative '../common/configuration'
+
+module Trabox
+  module Command
+    module Relay
+      class << self
+        attr_accessor :active
+        alias active? active
+
+        def configure
+          return unless active?
+
+          yield config
+        end
+
+        def config
+          @config ||= Configuration.new
+        end
+
+        def config_activate
+          @active = true
+        end
+      end
+
+      class Configuration < Command::Configuration
+        DEFAULT_SELECT_LIMIT = 3
+        DEFAULT_INTERVAL = 5
+        DEFAULT_LOCK = true
+
+        # @!attribute [rw] limit
+        #   @return [Integer]
+        # @!attribute [rw] interval
+        #   @return [Integer]
+        # @!attribute [rw] lock
+        #   @return [Boolean, String]
+        # @!attribute [rw] publisher
+        #   @return [Trabox::Publisher, Class]
+        attr_accessor :limit,
+                      :interval,
+                      :lock,
+                      :publisher
+
+        def initialize
+          @limit = ENV['TRABOX_RELAYER_LIMIT'] || DEFAULT_SELECT_LIMIT
+          @interval = ENV['TRABOX_RELAYER_INTERVAL'] || DEFAULT_INTERVAL
+          @lock = ENV['TRABOX_RELAYER_LOCK'] || DEFAULT_LOCK
+
+          super
+        end
+
+        def interval=(interval)
+          @interval = interval.to_i
+        end
+
+        def check
+          return if @publisher.respond_to?(:publish)
+
+          raise 'Relay Configuration: config.publisher must be have :publish method.'
+        end
+      end
+    end
+  end
+end

data/lib/trabox/commands/relay.rb

@@ -0,0 +1,51 @@
+require_relative './relay/argument_parser'
+require_relative './relay/configuration'
+require_relative './common/runner'
+
+module Trabox
+  module Command
+    module Relay
+      class << self
+        def prepare
+          config_activate
+
+          Runner.load_runner
+
+          ArgumentParser.parse!
+
+          config.check
+
+          Rails.logger.level = config.log_level
+        end
+      end
+
+      def self.perform
+        prepare
+
+        relayer = Trabox::Relay::Relayer.new(
+          config.publisher,
+          limit: config.limit,
+          lock: config.lock
+        )
+
+        interval = config.interval
+
+        loop do
+          begin
+            relayer.perform
+
+            Metric.service_check('relay.service.check', Metric::SERVICE_OK)
+          rescue StandardError => e
+            Rails.logger.error e
+
+            ActiveRecord::Base.clear_all_connections!
+
+            Metric.service_check('relay.service.check', Metric::SERVICE_CRITICAL)
+          end
+
+          sleep interval
+        end
+      end
+    end
+  end
+end

data/lib/trabox/commands/subscribe/argument_parser.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+require_relative './configuration'
+
+module Trabox
+  module Command
+    module Subscribe
+      class ArgumentParser
+        def self.parse!
+          new
+        end
+
+        def initialize
+          opts = parse!
+
+          config_overwrite(opts)
+        end
+
+        private
+
+        def parse!
+          opts = {}
+
+          @parser = OptionParser.new do |o|
+            o.banner = <<~BANNER
+              \e[1mUsage\e[0m: \e[1mtrabox subscribe\e[0m [OPTIONS]
+
+              Overwrite configuration
+
+            BANNER
+
+            o.on('--log-level LEVEL', String) { |v| v.downcase.to_sym }
+          end
+
+          @parser.parse!(into: opts)
+
+          opts.transform_keys { |k| k.to_s.underscore.to_sym }
+        end
+
+        def config_overwrite(opts)
+          opts.each do |attr, val|
+            next if val.nil?
+
+            Subscribe.config.send("#{attr}=", val)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trabox/commands/subscribe/configuration.rb

@@ -0,0 +1,38 @@
+require_relative '../common/configuration'
+
+module Trabox
+  module Command
+    module Subscribe
+      class << self
+        attr_accessor :active
+        alias active? active
+
+        def configure
+          return unless active?
+
+          yield config
+        end
+
+        def config
+          @config ||= Configuration.new
+        end
+
+        def config_activate
+          @active = true
+        end
+      end
+
+      class Configuration < Command::Configuration
+        # @!attribute [rw] subscriber
+        #   @return [Trabox::Subscriber, Class]
+        attr_accessor :subscriber
+
+        def check
+          return if @subscriber.respond_to?(:subscribe)
+
+          raise 'Subscribe Configuration: config.subscriber must be have :subscribe method.'
+        end
+      end
+    end
+  end
+end

data/lib/trabox/commands/subscribe.rb

@@ -0,0 +1,39 @@
+require_relative './subscribe/argument_parser'
+require_relative './subscribe/configuration'
+require_relative './common/runner'
+
+module Trabox
+  module Command
+    module Subscribe
+      class << self
+        def prepare
+          config_activate
+
+          Runner.load_runner
+
+          ArgumentParser.parse!
+
+          config.check
+
+          Rails.logger.level = config.log_level
+        end
+      end
+
+      def self.perform
+        prepare
+
+        subscriber = config.subscriber
+
+        Metric.service_check('subscribe.service.check', Metric::SERVICE_OK)
+
+        begin
+          subscriber.subscribe
+        rescue StandardError => e
+          Rails.logger.error e
+
+          Metric.service_check('subscribe.service.check', Metric::SERVICE_CRITICAL)
+        end
+      end
+    end
+  end
+end

data/lib/trabox/metric.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'datadog/statsd'
+
+module Trabox
+  # Traboxのメトリクス
+  #
+  # - unpublished_event_count: パブリッシュするイベント数
+  # - published_event_count: パブリッシュしたイベント数
+  # - find_events_error_count: パブリッシュするイベントの取得に失敗した数
+  # - publish_event_error_count: イベントのパブリッシュに失敗した数
+  # - update_event_record_error_count: パブリッシュしたイベントのカラム更新に失敗した数
+  module Metric
+    NAMESPACE = ENV.fetch('METRIC_NAMESPACE', 'trabox')
+    LOG_PREFIX = '[metric]'
+    SERVICE_OK = Datadog::Statsd::OK
+    SERVICE_CRITICAL = Datadog::Statsd::CRITICAL
+
+    class << self
+      attr_reader :statsd
+
+      # Datadog::Statsd.new arguments
+      def setup(*args, **kwargs)
+        @statsd = Datadog::Statsd.new(*args, **kwargs)
+      end
+
+      def service_check(name, status, opts = {})
+        name = metric_name(name)
+
+        @statsd&.service_check(name, status, opts)
+
+        status = case status
+                 when SERVICE_OK
+                   'ok'
+                 when SERVICE_CRITICAL
+                   'critical'
+                 else
+                   'undefined'
+                 end
+
+        Rails.logger.debug "#{LOG_PREFIX} type=service_check name=#{name} status=#{status} opts=#{opts}"
+      end
+
+      def count(name, count, opts = {})
+        name = metric_name(name)
+
+        @statsd&.count(name, count, opts)
+
+        Rails.logger.debug "#{LOG_PREFIX} type=count name=#{name} count=#{count} opts=#{opts}"
+      end
+
+      def increment(name, opts = {})
+        count name, 1, opts
+      end
+
+      def decrement(name, opts = {})
+        count name, -1, opts
+      end
+
+      def distribution(name, value, opts = {})
+        name = metric_name(name)
+
+        @statsd&.distribution name, value, opts
+
+        Rails.logger.debug "#{LOG_PREFIX} type=distribution name=#{name} value=#{value} opts=#{opts}"
+      end
+
+      def distribution_time(name, opts = {}, &block)
+        name = metric_name(name)
+
+        @statsd&.distribution_time name, opts, &block
+
+        Rails.logger.debug "#{LOG_PREFIX} type=distribution_time name=#{name} opts=#{opts}"
+      end
+
+      def event(title, text, opts = {})
+        @statsd&.event title, text, opts
+
+        Rails.logger.debug "#{LOG_PREFIX} type=event title=#{title} opts=#{opts}"
+      end
+
+      def gauge(name, value, opts = {})
+        name = metric_name(name)
+
+        @statsd&.gauge name, value, opts
+
+        Rails.logger.debug "#{LOG_PREFIX} type=gauge name=#{name} value=#{value} opts=#{opts}"
+      end
+
+      def histogram(name, value, opts = {})
+        name = metric_name(name)
+
+        @statsd&.histogram name, value, opts
+
+        Rails.logger.debug "#{LOG_PREFIX} type=histogram name=#{name} value=#{value} opts=#{opts}"
+      end
+
+      def set(name, value, opts = {})
+        name = metric_name(name)
+
+        @statsd&.set name, value, opts
+
+        Rails.logger.debug "#{LOG_PREFIX} type=set name=#{name} value=#{value} opts=#{opts}"
+      end
+
+      def time(name, opts = {}, &block)
+        name = metric_name(name)
+
+        @statsd&.time name, opts, &block
+
+        Rails.logger.debug "#{LOG_PREFIX} type=time name=#{name} opts=#{opts}"
+      end
+
+      def timing(name, ms, opts = {})
+        name = metric_name(name)
+
+        @statsd&.timing name, ms, opts
+
+        Rails.logger.debug "#{LOG_PREFIX} type=timing name=#{name} ms=#{ms} opts=#{opts}"
+      end
+
+      def batch
+        yield self
+      end
+
+      def close(**kwargs)
+        @statsd&.close(**kwargs)
+
+        Rails.logger.debug "#{LOG_PREFIX} type=close opts=#{kwargs}"
+      end
+
+      def flush(**kwargs)
+        @statsd&.flush(**kwargs)
+
+        Rails.logger.debug "#{LOG_PREFIX} type=flush opts=#{kwargs}"
+      end
+
+      private
+
+      def metric_name(name)
+        "#{NAMESPACE}.#{name}"
+      end
+    end
+  end
+end

data/lib/trabox/publisher/google/cloud_pubsub.rb

@@ -0,0 +1,89 @@
+require 'google/cloud/pubsub'
+
+# Google::Cloud::PubSub::Topicのラッパー
+module Trabox
+  module Publisher
+    module Google
+      module Cloud
+        class PubSub
+          include Trabox::Publisher
+
+          LOG_PREFIX = '[google pubsub]'.freeze
+
+          class OrderingKey
+            # @param key [Proc(ActiveRecord), String]
+            def initialize(key)
+              @key = if key.is_a?(Proc)
+                       key
+                     elsif key.instance_of?(String)
+                       ->(*) { key }
+                     else
+                       raise ArgumentError, 'OrderingKey.new should be set to Proc or String.'
+                     end
+            end
+
+            # @return [String]
+            def call(*args)
+              key = @key.call(*args)
+
+              raise 'OrderingKey#call should be returned String type.' unless key.instance_of?(String)
+
+              key
+            end
+          end
+
+          # @param topic_id [String]
+          # @param message_ordering [Boolean] enable_message_ordering
+          # @param ordering_key [OrderingKey]
+          def initialize(topic_id, message_ordering: true, ordering_key: nil)
+            raise ArgumentError, 'topic_id must be specified.' if topic_id.blank?
+
+            unless ordering_key.nil? || ordering_key.is_a?(OrderingKey)
+              raise ArgumentError,
+                    'ordering_key must be specified OrderingKey class or nil.'
+            end
+
+            # @type [Google::Cloud::PubSub::Project]
+            @pubsub = ::Google::Cloud::PubSub.new
+
+            # @type [Google::Cloud::PubSub::Topic]
+            @topic = @pubsub.topic topic_id
+
+            @ordering_key = ordering_key
+
+            raise "Topic-ID='#{topic_id}' does not exist." if @topic.nil?
+
+            @topic.enable_message_ordering! if message_ordering
+          rescue StandardError => e
+            Rails.logger.error "#{LOG_PREFIX} #{e.message}"
+            raise
+          end
+
+          # @param event [ActiveRecord] publishするイベント
+          # @return message_id [String]
+          def publish(event)
+            raise ArgumentError, 'event should be set to trabox:model' unless event.respond_to?(:event_data)
+
+            message = event.event_data
+
+            raise ArgumentError, 'published message must not be blank' if message.blank?
+
+            published_message = if @ordering_key
+                                  @topic.publish message, ordering_key: @ordering_key.call(event)
+                                else
+                                  @topic.publish message
+                                end
+
+            Rails.logger.debug "#{LOG_PREFIX} message published. " \
+              "message_id=#{published_message.message_id} ordering_key=#{published_message.ordering_key}"
+
+            published_message.message_id
+          rescue StandardError => e
+            Rails.logger.error "#{LOG_PREFIX} #{e.message}"
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trabox/publisher.rb

@@ -0,0 +1,8 @@
+require 'trabox/publisher/google/cloud_pubsub'
+
+module Trabox
+  module Publisher
+    # @param event [ActiveRecord] publishするイベント
+    def publish(event); end
+  end
+end

data/lib/trabox/railtie.rb

@@ -0,0 +1,4 @@
+module Trabox
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/trabox/relay/relayable.rb

@@ -0,0 +1,27 @@
+# 未publishなレコードやpublish完了時のレコード操作を追加するためのモジュール
+module Trabox
+  module Relay
+    module Relayable
+      extend ActiveSupport::Concern
+
+      included do
+        # @param limit [Integer]
+        scope :unpublished, lambda { |limit: DEFAULT_SELECT_LIMIT|
+          where(published_at: nil).limit(limit).order(created_at: :asc)
+        }
+      end
+
+      # message_idとpublished_atを更新する
+      # publishした結果からpublishした時間を取得できないため、Timeクラスを使用する
+      #
+      # @param message_id [String]
+      def published_done!(message_id)
+        raise ArgumentError if message_id.blank?
+
+        update!(message_id: message_id, published_at: Time.current.to_formatted_s(:iso8601))
+
+        Rails.logger.debug "Event record updated. message_id=#{message_id}"
+      end
+    end
+  end
+end

data/lib/trabox/relay/relayable_models.rb

@@ -0,0 +1,34 @@
+# Relayableモジュールをincludeしているモデル一覧を取得するモジュール
+module Trabox
+  module Relay
+    module RelayableModels
+      # @return [Array<Class>]
+      def self.list
+        if @models.nil?
+          load_models
+
+          @models = ApplicationRecord.descendants.filter do |klass|
+            klass.ancestors.include?(Relayable)
+          end
+        end
+
+        Rails.logger.debug "Relayed event models: #{@models.map { |model| model.name.underscore }}"
+
+        @models
+      end
+
+      def self.load_models
+        return if Rails.application.config.eager_load
+
+        # test, developmentモードは遅延読み込みのためmodelsをロードする
+        Rails.logger.debug 'Load models'
+
+        Dir["#{Rails.root}/app/models/**/*.rb"].each do |file|
+          require_dependency file
+        end
+      end
+
+      private_class_method :load_models
+    end
+  end
+end

data/lib/trabox/relay/relayer.rb

@@ -0,0 +1,62 @@
+module Trabox
+  module Relay
+    class Relayer
+      # @param publisher [Trabox::PubSub::Publisher]
+      # @param limit [Integer] SELECT文のLIMIT
+      # @param lock [Boolean, String] ActiveRecord lock argument
+      def initialize(publisher, limit: DEFAULT_SELECT_LIMIT, lock: true)
+        raise ArgumentError unless publisher.respond_to?(:publish)
+
+        @publisher = publisher
+        @limit = limit
+        @lock = lock
+      end
+
+      def perform
+        RelayableModels.list.each do |model|
+          model.transaction do
+            unpublished_events = begin
+              model.lock(@lock).unpublished limit: @limit
+            rescue StandardError
+              Metric.increment('find_events_error_count',
+                               tags: ["event-type:#{model.name.underscore}"])
+              raise
+            end
+
+            unpublished_events.each do |event|
+              Metric.increment('unpublished_event_count',
+                               tags: ["event-type:#{event.class.name.underscore}", "event-id:#{event.id}"])
+
+              publish_and_commit(event)
+
+              Metric.increment('published_event_count',
+                               tags: ["event-type:#{event.class.name.underscore}", "event-id:#{event.id}"])
+            end
+
+            Rails.logger.info "Published events. (#{model.name.underscore}=#{unpublished_events.size})"
+          end
+        end
+      end
+
+      private
+
+      def publish_and_commit(event)
+        begin
+          message_id = @publisher.publish event
+        rescue StandardError
+          Metric.increment('published_event_error_count',
+                           tags: ["event-type:#{event.class.name.underscore}", "event-id:#{event.id}"])
+          raise
+        end
+
+        begin
+          event.published_done! message_id
+        rescue StandardError
+          Metric.increment('update_event_record_error_count',
+                           tags: ["event-type:#{event.class.name.underscore}", "event-id:#{event.id}"])
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/trabox/relay.rb

@@ -0,0 +1,9 @@
+require 'trabox/relay/relayable'
+require 'trabox/relay/relayer'
+require 'trabox/relay/relayable_models'
+
+module Trabox
+  module Relay
+    DEFAULT_SELECT_LIMIT = 3
+  end
+end

data/lib/trabox/subscriber/google/cloud_pubsub.rb

@@ -0,0 +1,63 @@
+module Trabox
+  module Subscriber
+    module Google
+      module Cloud
+        class PubSub
+          include Subscriber
+
+          # @param subscription_id [String]
+          # @param listen_options [Hash] listen method options
+          # @param before_listen_acknowledge_callbacks [Array<Proc>]
+          # @param after_listen_acknowledge_callbacks [Array<Proc>]
+          # @param error_listen_callbacks [Array<Proc>]
+          def initialize(subscription_id,
+                         listen_options: {},
+                         before_listen_acknowledge_callbacks: [],
+                         after_listen_acknowledge_callbacks: [],
+                         error_listen_callbacks: [])
+
+            @listen_options = listen_options
+            @before_listen_acknowledge_callbacks = before_listen_acknowledge_callbacks
+            @after_listen_acknowledge_callbacks = after_listen_acknowledge_callbacks
+            @error_listen_callbacks = error_listen_callbacks
+
+            @pubsub = ::Google::Cloud::PubSub.new
+
+            @subscription = @pubsub.subscription subscription_id
+
+            raise "Subscription-ID='#{subscription_id}' does not exist." if @subscription.nil?
+
+            Rails.logger.info "Subscription '#{subscription_id}': message ordering is #{@subscription.message_ordering?}."
+          end
+
+          def subscribe
+            subscriber = @subscription.listen(**@listen_options) do |received_message|
+              @before_listen_acknowledge_callbacks.each do |cb|
+                cb.call(received_message)
+              end
+
+              received_message.acknowledge!
+
+              @after_listen_acknowledge_callbacks.each do |cb|
+                cb.call(received_message)
+              end
+
+              Metric.service_check('subscribe.service.check', Metric::SERVICE_OK)
+            end
+
+            subscriber.on_error do |_|
+              Metric.service_check('subscribe.service.check', Metric::SERVICE_CRITICAL)
+            end
+
+            @error_listen_callbacks.each do |cb|
+              subscriber.on_error(&cb)
+            end
+
+            Rails.logger.info 'Listening subscrition...'
+            subscriber.start.wait!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trabox/subscriber.rb

@@ -0,0 +1,7 @@
+require 'trabox/subscriber/google/cloud_pubsub'
+
+module Trabox
+  module Subscriber
+    def subscribe; end
+  end
+end

data/lib/trabox/version.rb

@@ -0,0 +1,3 @@
+module Trabox
+  VERSION = '0.1.1'
+end

data/lib/trabox.rb

@@ -0,0 +1,8 @@
+require 'trabox/version'
+require 'trabox/railtie'
+
+require 'trabox/metric'
+require 'trabox/relay'
+require 'trabox/publisher'
+require 'trabox/subscriber'
+require 'trabox/command'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: trabox
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- kosay
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Transactional-Outbox for Rails
+email:
+- ekr59uv25@gmail.com
+executables:
+- trabox
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- exe/trabox
+- lib/generators/trabox/configure/USAGE
+- lib/generators/trabox/configure/configure_generator.rb
+- lib/generators/trabox/configure/templates/initializer.rb
+- lib/generators/trabox/model/USAGE
+- lib/generators/trabox/model/model_generator.rb
+- lib/tasks/trabox_tasks.rake
+- lib/trabox.rb
+- lib/trabox/command.rb
+- lib/trabox/command/parser.rb
+- lib/trabox/commands/common/configuration.rb
+- lib/trabox/commands/common/runner.rb
+- lib/trabox/commands/relay.rb
+- lib/trabox/commands/relay/argument_parser.rb
+- lib/trabox/commands/relay/configuration.rb
+- lib/trabox/commands/subscribe.rb
+- lib/trabox/commands/subscribe/argument_parser.rb
+- lib/trabox/commands/subscribe/configuration.rb
+- lib/trabox/metric.rb
+- lib/trabox/publisher.rb
+- lib/trabox/publisher/google/cloud_pubsub.rb
+- lib/trabox/railtie.rb
+- lib/trabox/relay.rb
+- lib/trabox/relay/relayable.rb
+- lib/trabox/relay/relayable_models.rb
+- lib/trabox/relay/relayer.rb
+- lib/trabox/subscriber.rb
+- lib/trabox/subscriber/google/cloud_pubsub.rb
+- lib/trabox/version.rb
+homepage: https://github.com/sarub0b0/trabox
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Transactional-Outbox for Rails
+test_files: []