Module: Sidekiq

Defined in:
lib/wurk/compat.rb,
lib/wurk/compat/web.rb,
lib/wurk/compat/flow.rb,
lib/wurk/compat/deploy.rb,
lib/wurk/compat/server.rb,
lib/wurk/compat/encryption.rb,
lib/wurk/active_job/wrapper.rb,
lib/wurk/compat/profile_set.rb,
lib/wurk/compat/iterable_job.rb

Overview

Autoload target of IterableJob's Sidekiq aliases (compat.rb).

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
Client = 
Wurk::Client
Component = 
Wurk::Component
Config = 
Wurk::Configuration
Context = 
Wurk::Context
DeadSet = 
Wurk::DeadSet
Job = 
Wurk::Job
JobLogger = 
Wurk::JobLogger
JobRecord = 
Wurk::JobRecord
JobRetry = 
Wurk::JobRetry
JobSet =

sidekiq-unique-jobs reopens these with class Sidekiq::JobSet to prepend its lock release; without the alias that defines a fresh, unused class and deleted jobs never give their locks back.

Wurk::JobSet
JobUtil = 
Wurk::JobUtil
Keys = 
Wurk::Keys
Limiter = 
Wurk::Limiter
Loader = 
Wurk::Loader
Logger = 
Wurk::Logger
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
Queue = 
Wurk::Queue
RedisClientAdapter = 
Wurk::RedisClientAdapter
RedisConnection = 
Wurk::RedisConnection
RetrySet = 
Wurk::RetrySet
ScheduledSet = 
Wurk::ScheduledSet
Shutdown = 
Wurk::Shutdown
SortedEntry = 
Wurk::SortedEntry
SortedSet = 
Wurk::SortedSet
Stats = 
Wurk::Stats
Testing =

No Sidekiq::Status alias on purpose, same reason as Sidekiq::Cron (#204): the sidekiq-status gem owns that namespace and opens it with module Sidekiq::Status, which resolves an existing constant rather than defining a fresh module — so the alias would make the gem reopen Wurk::Status and, loading second, silently replace .get/.delete with its own two-arg-shaped versions while nesting its Storage/Worker/middlewares inside ours. Upstream Sidekiq's only Status is Sidekiq::Batch::Status (sidekiq-pro.md §2.5), which is aliased; the top-level name is not a Sidekiq surface at all. Wurk's tracking is Wurk::Status, reached by name, and its status:<jid> rows are disjoint from the gem's sidekiq:status:<jid>.

Wurk::Testing
TransactionAwareClient = 
Wurk::TransactionAwareClient
Queues = 
Wurk::Queues
EmptyQueueError = 
Wurk::Testing::EmptyQueueError
Work = 
Wurk::Work
Worker = 
Wurk::Worker
Workers = 
Wurk::Workers
WorkSet = 
Wurk::WorkSet
Web = 
Wurk::Web
WebHelpers = 
Wurk::Web::Extension::Helpers
Paginator = 
Wurk::Web::Paginator
Flow = 
Wurk::Flow
FlowSet = 
Wurk::FlowSet
Deploy = 
Wurk::Deploy
CLI = 
Wurk::CLI
Embedded = 
Wurk::Embedded
Launcher = 
Wurk::Launcher
Manager = 
Wurk::Manager
Scheduled = 
Wurk::Scheduled
History = 
Wurk::History
Periodic = 
Wurk::Cron
CronParser = 
Wurk::Cron::Parser
Encryption = 
Wurk::Encryption
ProfileSet = 
Wurk::ProfileSet
ProfileRecord = 
Wurk::ProfileRecord
IterableJob = 
Wurk::IterableJob
IterableJobQuery = 
Wurk::IterableJobQuery
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_client ⇒ Object 



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

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

.configure_embed ⇒ Object 



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

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

.configure_server ⇒ Object 



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

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

.const_missing(name) ⇒ Object

Answered from const_missing rather than defined as a constant, which would shadow ::Rails for every bare Rails.logger written inside module Sidekiq.



230
231
232
 
# File 'lib/wurk/compat.rb', line 230

def const_missing(name)
  name == :Rails ? RailsNamespace : super
end

.default_configuration ⇒ Object 



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

def default_configuration = Wurk.default_configuration

.default_job_options ⇒ Object 



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

def default_job_options = Wurk.default_job_options

.default_job_options=(hash) ⇒ Object 



224
225
226
 
# File 'lib/wurk/compat.rb', line 224

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

.dump_json(obj) ⇒ Object 



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

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

.ent? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ent? = Wurk.ent?

.freeze! ⇒ Object 



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

def freeze! = Wurk.default_configuration.freeze!

.gem_version ⇒ Object 



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

def gem_version = Gem::Version.new(VERSION)

.load_json(str) ⇒ Object 



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

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

.loader ⇒ Object 



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

def loader = Wurk.loader

.logger ⇒ Object 



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

def logger = Wurk.logger

.logger=(logger) ⇒ Object 



215
216
217
 
# File 'lib/wurk/compat.rb', line 215

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

.pro? ⇒ Boolean

Returns:

  • (Boolean) 


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

def pro? = Wurk.pro?

.redis(idempotent: false) ⇒ Object 



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

def redis(idempotent: false, &) = Wurk.redis(idempotent:, &)

.redis_pool ⇒ Object 



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

def redis_pool = Wurk.redis_pool

.server? ⇒ Boolean

Returns:

  • (Boolean) 


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

def server? = Wurk.server?

.strict_args!(mode = :raise) ⇒ Object 



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

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

.testing!(mode = :fake) ⇒ Object 



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

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

.testing? ⇒ Boolean

Returns:

  • (Boolean) 


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

def testing? = Wurk.testing?

.transactional_push! ⇒ Object 



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

def transactional_push! = Wurk.transactional_push!