mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
659dea9601
* Prevent AR middleware and reloader clash The ActiveRecord middleware releases any current ActiveRecord connections before the reloader has a chance to clear their query caches. We can just remove this middleware because the reloader takes care of clearing active connections, too. * Make sure folks haven't added the middleware manually * Fix the conditional * Mention that the reloader also clears connections * Move it all back into a single method * Typos * Pull all rails setup into railtie * Set the middleware even earlier Also clarify exactly when these hooks are run. * Only check ActiveRecord reloader/middleware sanity at boot
89 lines
3 KiB
Ruby
89 lines
3 KiB
Ruby
# frozen_string_literal: true
|
|
module Sidekiq
|
|
def self.hook_rails!
|
|
return if defined?(@delay_removed)
|
|
|
|
ActiveSupport.on_load(:active_record) do
|
|
include Sidekiq::Extensions::ActiveRecord
|
|
end
|
|
|
|
ActiveSupport.on_load(:action_mailer) do
|
|
extend Sidekiq::Extensions::ActionMailer
|
|
end
|
|
|
|
Module.__send__(:include, Sidekiq::Extensions::Klass)
|
|
end
|
|
|
|
# Removes the generic aliases which MAY clash with names of already
|
|
# created methods by other applications. The methods `sidekiq_delay`,
|
|
# `sidekiq_delay_for` and `sidekiq_delay_until` can be used instead.
|
|
def self.remove_delay!
|
|
@delay_removed = true
|
|
|
|
[Extensions::ActiveRecord,
|
|
Extensions::ActionMailer,
|
|
Extensions::Klass].each do |mod|
|
|
mod.module_eval do
|
|
remove_method :delay if respond_to?(:delay)
|
|
remove_method :delay_for if respond_to?(:delay_for)
|
|
remove_method :delay_until if respond_to?(:delay_until)
|
|
end
|
|
end
|
|
end
|
|
|
|
class Rails < ::Rails::Engine
|
|
# We need to setup this up before any application configuration which might
|
|
# change Sidekiq middleware.
|
|
#
|
|
# This hook happens after `Rails::Application` is inherited within
|
|
# config/application.rb and before config is touched, usually within the
|
|
# class block. Definitely before config/environments/*.rb and
|
|
# config/initializers/*.rb.
|
|
config.before_configuration do
|
|
if ::Rails::VERSION::MAJOR < 5 && defined?(::ActiveRecord)
|
|
Sidekiq.server_middleware do |chain|
|
|
require 'sidekiq/middleware/server/active_record'
|
|
chain.add Sidekiq::Middleware::Server::ActiveRecord
|
|
end
|
|
end
|
|
end
|
|
|
|
initializer 'sidekiq' do
|
|
Sidekiq.hook_rails!
|
|
end
|
|
|
|
# We have to add the reloader after initialize to see if cache_classes has
|
|
# been turned on.
|
|
#
|
|
# This hook happens after all initialziers are run, just before returning
|
|
# from config/environment.rb back to sidekiq/cli.rb.
|
|
config.after_initialize do
|
|
if ::Rails::VERSION::MAJOR >= 5
|
|
# The reloader also takes care of ActiveRecord but is incompatible with
|
|
# the ActiveRecord middleware so make sure it's not in the chain already.
|
|
if defined?(Sidekiq::Middleware::Server::ActiveRecord) && Sidekiq.server_middleware.exists?(Sidekiq::Middleware::Server::ActiveRecord)
|
|
raise ArgumentError, "You are using the Sidekiq ActiveRecord middleware and the new Rails 5 reloader which are incompatible. Please remove the ActiveRecord middleware from your Sidekiq middleware configuration."
|
|
else
|
|
Sidekiq.options[:reloader] = Sidekiq::Rails::Reloader.new
|
|
end
|
|
end
|
|
end
|
|
|
|
class Reloader
|
|
def initialize(app = ::Rails.application)
|
|
Sidekiq.logger.debug "Enabling Rails 5+ live code reloading, so hot!" unless app.config.cache_classes
|
|
@app = app
|
|
end
|
|
|
|
def call
|
|
@app.reloader.wrap do
|
|
yield
|
|
end
|
|
end
|
|
|
|
def inspect
|
|
"#<Sidekiq::Rails::Reloader @app=#{@app.class.name}>"
|
|
end
|
|
end
|
|
end if defined?(::Rails)
|
|
end
|