Module: Joblin::Batching::Compat::Sidekiq

Defined in:
lib/joblin/batching/compat/sidekiq.rb,
lib/joblin/batching/compat/sidekiq/web.rb,
lib/joblin/batching/compat/sidekiq/web/helpers.rb

Defined Under Namespace

Modules: Web, WorkerExtension Classes: ClientMiddleware, ServerMiddleware, SidekiqCallbackWorker

Constant Summary collapse

ACTIVE_JOB_WRAPPERS =

Sidekiq 8 renamed the ActiveJob wrapper class. Accept both so ActiveJob-based jobs stay batch-aware across Sidekiq 7 and 8.

[
  'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
  'Sidekiq::ActiveJob::Wrapper',
].freeze

Class Method Summary collapse

Class Method Details

.configure ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/joblin/batching/compat/sidekiq.rb', line 122

def self.configure
  return if @already_configured
  @already_configured = true

  if defined?(::Sidekiq::Batch) && ::Sidekiq::Batch != Joblin::Batching::Batch
    print "WARNING: Detected Sidekiq Pro or sidekiq-batch. Joblin JobBatches may not be fully compatible!"
  end

  sidekiq_middleware(:client) do |chain|
    chain.remove ::Sidekiq::Batch::Middleware::ClientMiddleware if defined?(::Sidekiq::Batch::Middleware::ClientMiddleware)
    chain.add Joblin::Batching::Compat::Sidekiq::ClientMiddleware
  end

  sidekiq_middleware(:server) do |chain|
    chain.remove ::Sidekiq::Batch::Middleware::ServerMiddleware if defined?(::Sidekiq::Batch::Middleware::ServerMiddleware)
    chain.add Joblin::Batching::Compat::Sidekiq::ServerMiddleware
  end

  ::Sidekiq.configure_server do |config|
    config.death_handlers << ->(job, ex) do
      switch_tenant(job) do
        if is_activejob_job?(job)
          Joblin::Batching::Compat::ActiveJob.handle_job_death(job["args"][0], ex)
        elsif job['bid'].present?
          ::Sidekiq::Batch.process_dead_job(job['bid'], job['jid'])
        end
      end
    end
  end

  ::Sidekiq.const_set(:Batch, Joblin::Batching::Batch)
  # This alias helps apartment-sidekiq set itself up correctly
  ::Sidekiq::Batch.const_set(:Server, Joblin::Batching::Compat::Sidekiq::ServerMiddleware)
  ::Sidekiq::Worker.send(:include, Joblin::Batching::Compat::Sidekiq::WorkerExtension)
  Batch::Callback.worker_class = SidekiqCallbackWorker
end

.is_activejob_job?(msg) ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
94
95
96
97
98
99
 
# File 'lib/joblin/batching/compat/sidekiq.rb', line 91

def self.is_activejob_job?(msg)
  return false unless defined?(::ActiveJob)
  return false unless ACTIVE_JOB_WRAPPERS.include?(msg['class'])

  # `wrapped` comes from the job payload; use safe_constantize so a
  # malformed/unknown value yields nil rather than raising NameError.
  wrapped = msg['wrapped'].to_s.safe_constantize
  !!(wrapped && wrapped < Joblin::Batching::Compat::ActiveJob::BatchAwareJob)
end

.sidekiq_middleware(placement, &blk) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/joblin/batching/compat/sidekiq.rb', line 111

def self.sidekiq_middleware(placement, &blk)
  install_middleware = ->(config) do
    config.send("#{placement}_middleware") do |chain|
      blk.call(chain)
    end
  end

  ::Sidekiq.configure_client(&install_middleware) if placement == :client
  ::Sidekiq.configure_server(&install_middleware)
end

.switch_tenant(job) ⇒ Object 



101
102
103
104
105
106
107
108
109
 
# File 'lib/joblin/batching/compat/sidekiq.rb', line 101

def self.switch_tenant(job)
  if defined?(::Apartment)
    ::Apartment::Tenant.switch(job['apartment'] || 'public') do
      yield
    end
  else
    yield
  end
end