Module: Sidekiq

Defined in:
lib/wurk/compat.rb,
lib/wurk/active_job/wrapper.rb

Overview

Defined under the ‘Sidekiq::ActiveJob` namespace (not `Wurk::ActiveJob`) so the canonical `class` string written to Redis stays `“Sidekiq::ActiveJob::Wrapper”` — the exact wire shape Sidekiq emits. Mixed Sidekiq/Wurk worker pools can read the same payloads either way. Wire-compat is sacred.

‘Wurk::ActiveJob::Wrapper` and `ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper` both resolve here so legacy enqueued payloads load on the gem swap.

Spec: docs/target/sidekiq-free.md §28.

Defined Under Namespace

Modules: ActiveJob, Enterprise, Pro

Constant Summary collapse

NAME =

Version stamps mirror Sidekiq’s OSS release Wurk targets for compat. Third-party gems version-gate on these; raise the MAJOR only when the upstream Sidekiq major bumps and Wurk has matching surface.

'Sidekiq'
LICENSE =
'See LICENSE'
VERSION =
'8.1.5'
MAJOR =
8
BasicFetch =
Wurk::Fetcher::Reliable
Batch =
Wurk::Batch
BatchSet =
Wurk::BatchSet
Capsule =
Wurk::Capsule
CLI =
Wurk::CLI
Client =
Wurk::Client
Component =
Wurk::Component
Config =
Wurk::Configuration
Context =
Wurk::Context
CronParser =

No ‘Sidekiq::Cron` alias on purpose (#204): real Sidekiq never defines it — that namespace belongs to the third-party sidekiq-cron gem, and squatting it made the gem’s own classes (Poller, Job) collide at load. Wurk’s native periodic surface is ‘Sidekiq::Periodic` (Ent parity) / `Wurk::Cron`.

Wurk::Cron::Parser
Periodic =
Wurk::Cron
DeadSet =
Wurk::DeadSet
Deploy =
Wurk::Deploy
Embedded =
Wurk::Embedded
Encryption =
Wurk::Encryption
History =
Wurk::History
IterableJob =
Wurk::IterableJob
IterableJobQuery =
Wurk::IterableJobQuery
Job =
Wurk::Job
JobLogger =
Wurk::JobLogger
JobRecord =
Wurk::JobRecord
JobRetry =
Wurk::JobRetry
JobUtil =
Wurk::JobUtil
Keys =
Wurk::Keys
Launcher =
Wurk::Launcher
Limiter =
Wurk::Limiter
Logger =
Wurk::Logger
Manager =
Wurk::Manager
Metrics =
Wurk::Metrics
Middleware =
Wurk::Middleware
ServerMiddleware =
Wurk::Middleware::ServerMiddleware
ClientMiddleware =
Wurk::Middleware::ClientMiddleware
Process =
Wurk::Process
ProcessSet =
Wurk::ProcessSet
Processor =
Wurk::Processor
Profiler =
Wurk::Profiler
ProfileSet =
Wurk::ProfileSet
ProfileRecord =
Wurk::ProfileRecord
Queue =
Wurk::Queue
RedisClientAdapter =
Wurk::RedisClientAdapter
RedisConnection =
Wurk::RedisConnection
RetrySet =
Wurk::RetrySet
Scheduled =
Wurk::Scheduled
ScheduledSet =
Wurk::ScheduledSet
Shutdown =
Wurk::Shutdown
SortedEntry =
Wurk::SortedEntry
Stats =
Wurk::Stats
Testing =
Wurk::Testing
TransactionAwareClient =
Wurk::TransactionAwareClient
Queues =
Wurk::Queues
EmptyQueueError =
Wurk::Testing::EmptyQueueError
Web =
Wurk::Web
Work =
Wurk::Work
Worker =
Wurk::Worker
Workers =
Wurk::Workers
WorkSet =
Wurk::WorkSet
CurrentAttributes =

Drop-in alias. Sidekiq documents the top-level constant ‘Sidekiq::CurrentAttributes` (with `.persist` and `Save`/`Load` nested), not the `Middleware::`-namespaced form. Set when this opt-in file is required, so `Sidekiq::CurrentAttributes.persist(MyAttrs)` resolves.

Wurk::Middleware::CurrentAttributes

Class Method Summary collapse

Class Method Details

.configure_clientObject



151
# File 'lib/wurk/compat.rb', line 151

def configure_client(&) = Wurk.configure_client(&)

.configure_embedObject



152
# File 'lib/wurk/compat.rb', line 152

def configure_embed(&) = Wurk.configure_embed(&)

.configure_serverObject



150
# File 'lib/wurk/compat.rb', line 150

def configure_server(&) = Wurk.configure_server(&)

.default_configurationObject



153
# File 'lib/wurk/compat.rb', line 153

def default_configuration = Wurk.default_configuration

.default_job_optionsObject



165
# File 'lib/wurk/compat.rb', line 165

def default_job_options = Wurk.default_job_options

.default_job_options=(hash) ⇒ Object



167
168
169
# File 'lib/wurk/compat.rb', line 167

def default_job_options=(hash)
  Wurk.default_job_options = hash
end

.dump_json(obj) ⇒ Object



176
# File 'lib/wurk/compat.rb', line 176

def dump_json(obj) = Wurk.dump_json(obj)

.ent?Boolean

Returns:

  • (Boolean)


164
# File 'lib/wurk/compat.rb', line 164

def ent? = Wurk.ent?

.load_json(str) ⇒ Object



175
# File 'lib/wurk/compat.rb', line 175

def load_json(str) = Wurk.load_json(str)

.loggerObject



156
# File 'lib/wurk/compat.rb', line 156

def logger = Wurk.logger

.logger=(logger) ⇒ Object



158
159
160
# File 'lib/wurk/compat.rb', line 158

def logger=(logger)
  Wurk.logger = logger
end

.pro?Boolean

Returns:

  • (Boolean)


163
# File 'lib/wurk/compat.rb', line 163

def pro? = Wurk.pro?

.redisObject



154
# File 'lib/wurk/compat.rb', line 154

def redis(&) = Wurk.redis(&)

.redis_poolObject



155
# File 'lib/wurk/compat.rb', line 155

def redis_pool = Wurk.redis_pool

.server?Boolean

Returns:

  • (Boolean)


162
# File 'lib/wurk/compat.rb', line 162

def server? = Wurk.server?

.strict_args!(mode = :raise) ⇒ Object



171
# File 'lib/wurk/compat.rb', line 171

def strict_args!(mode = :raise) = Wurk.strict_args!(mode)

.testing!(mode = :fake) ⇒ Object



173
# File 'lib/wurk/compat.rb', line 173

def testing!(mode = :fake, &) = Wurk.testing!(mode, &)

.testing?Boolean

Returns:

  • (Boolean)


174
# File 'lib/wurk/compat.rb', line 174

def testing? = Wurk.testing?

.transactional_push!Object



172
# File 'lib/wurk/compat.rb', line 172

def transactional_push! = Wurk.transactional_push!