wurk 0.0.4 → 1.0.0

data/lib/wurk/web/rack_app.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative 'extension'
+
+module Wurk
+  class Web
+    # Upstream-compatible class-level Rack surface (#204): Sidekiq apps do
+    # `run Sidekiq::Web`, `mount Sidekiq::Web => "/sidekiq"`, and rack-test
+    # ecosystem suites call `Sidekiq::Web.call(env)` directly. Wurk's full
+    # dashboard is the engine-mounted SPA; this standalone entry serves the
+    # registered third-party Web extensions (#187's renderer) under their own
+    # route paths — the surface ecosystem gems exercise. Non-extension paths
+    # 404 rather than half-serving the SPA without its engine.
+    #
+    # Same CSRF model as upstream Sidekiq 8 and ExtensionsController (spec
+    # §25.1): unsafe methods must carry `Sec-Fetch-Site: same-origin`.
+    SAFE_METHODS = %w[GET HEAD OPTIONS TRACE].freeze
+    NOT_FOUND_HEADERS = { 'Content-Type' => 'text/plain' }.freeze
+
+    class << self
+      # Class-level Rack entry — wraps host-registered middleware (`Wurk::Web.use`)
+      # around the extensions dispatcher. INTENTIONALLY bypasses
+      # `Wurk::Web::Authorization` (`config.authorized?` + `config.read_only?`):
+      # the full dashboard with its auth/read-only enforcement is the
+      # engine-mounted SPA wired in `lib/wurk/engine.rb`, and the engine's
+      # middleware stack already includes `Authorization`. This standalone
+      # surface exists for ecosystem rack-test consumers (`Sidekiq::Web.call`)
+      # whose mounted-app expectations cover extension routes only — wrapping
+      # auth here would break `run Sidekiq::Web` / rack-test parity with
+      # upstream Sidekiq, which also doesn't auth-gate `Sidekiq::Web.call`.
+      def call(env)
+        config.rack_app(method(:dispatch)).call(env)
+      end
+
+      private
+
+      def dispatch(env)
+        return [403, NOT_FOUND_HEADERS.dup, ['Forbidden']] unless safe_request?(env)
+
+        dispatch_to_extensions(env)
+      end
+
+      def safe_request?(env)
+        SAFE_METHODS.include?(env['REQUEST_METHOD']) ||
+          env['HTTP_SEC_FETCH_SITE'] == 'same-origin'
+      end
+
+      # First extension whose routes answer the path wins; a per-extension
+      # "no such route" 404 keeps scanning so extensions can't shadow each
+      # other, and is returned only when nothing else matched.
+      def dispatch_to_extensions(env)
+        not_found = nil
+        config.extensions.each do |ext|
+          result = extension_result(ext, env)
+          next unless result
+          return rackify(result) unless result[0] == 404
+
+          not_found ||= result
+        end
+        rackify(not_found || [404, NOT_FOUND_HEADERS.dup, 'Not Found'])
+      end
+
+      def extension_result(ext, env)
+        Extension::Renderer.call(
+          name: ext[:name], method: env['REQUEST_METHOD'],
+          subpath: env['PATH_INFO'].to_s, env: env, mount: env['SCRIPT_NAME'].to_s,
+          embed: false
+        )
+      end
+
+      # Renderer returns [status, headers, String]; Rack wants an each-able body.
+      def rackify((status, headers, body))
+        [status, headers, body.is_a?(::Array) ? body : [body.to_s]]
+      end
+    end
+  end
+end

data/lib/wurk/web.rb

@@ -3,6 +3,8 @@
 require_relative 'web/config'
 require_relative 'web/search'
 require_relative 'web/enterprise'
+require_relative 'web/batch_status'
+require_relative 'web/rack_app'
 
 module Wurk
   # Web UI namespace. Holds three sibling concerns:

data/lib/wurk/worker/setter.rb

@@ -49,7 +49,11 @@ module Wurk
           'class' => @klass,
           'args' => args
         )
-        @klass.build_client.push_bulk(merged)
+        # Mirror client_push: a per-call `set(pool:)` selects the Redis pool and
+        # is removed so it never persists (normalize_item strips the class-level
+        # pool re-merged into each payload).
+        pool = merged.delete('pool') || @klass.get_sidekiq_options['pool']
+        @klass.build_client(pool).push_bulk(merged)
       end
 
       private

data/lib/wurk/worker.rb

@@ -117,12 +117,23 @@ module Wurk
       def client_push(item)
         raise ArgumentError, "Job arguments to #{name || self} must have string keys" if symbol_keyed?(item)
 
-        build_client.push(item)
-      end
-
-      def build_client
-        pool = get_sidekiq_options['pool']
-        Wurk::Client.new(pool: pool)
+        # `pool` is a transient enqueue-time attribute: a per-call `set(pool:)`
+        # overrides the class-level option, then it's deleted so it never reaches
+        # the wire (normalize_item strips any class-level pool re-merged below).
+        pool = item.delete('pool') || get_sidekiq_options['pool']
+        build_client(pool, client_class: item.delete('client_class')).push(item)
+      end
+
+      # `client_class` swaps the enqueue client (e.g. TransactionAwareClient via
+      # Wurk.transactional_push!). Resolution order: per-call `set(client_class:)`,
+      # then the class option, then the live process default, then Wurk::Client.
+      # The default_job_options fallback keeps a global `transactional_push!`
+      # order-independent: a class whose options memoized before the opt-in (its
+      # inherited copy is a stale dup) still routes through the new client.
+      def build_client(pool = get_sidekiq_options['pool'], client_class: nil)
+        klass = client_class || get_sidekiq_options['client_class'] ||
+                Wurk.default_job_options['client_class'] || Wurk::Client
+        klass.new(pool: pool)
       end
 
       # --- Sidekiq::Testing class-level helpers (spec §24.3) --------------

data/lib/wurk.rb

@@ -7,6 +7,7 @@
 require_relative 'wurk/version'
 require_relative 'wurk/keys'
 require_relative 'wurk/redis_pool'
+require_relative 'wurk/redis_connection'
 require_relative 'wurk/middleware'
 require_relative 'wurk/middleware/chain'
 require_relative 'wurk/component'
@@ -18,6 +19,7 @@ require_relative 'wurk/configuration'
 require_relative 'wurk/job_util'
 require_relative 'wurk/client'
 require_relative 'wurk/client/buffered'
+require_relative 'wurk/transaction_aware_client'
 require_relative 'wurk/worker'
 require_relative 'wurk/worker/setter'
 require_relative 'wurk/job'
@@ -25,6 +27,7 @@ require_relative 'wurk/job/options'
 require_relative 'wurk/queues'
 require_relative 'wurk/testing'
 require_relative 'wurk/iterable_job'
+require_relative 'wurk/iterable_job_query'
 require_relative 'wurk/job_retry'
 require_relative 'wurk/job_record'
 require_relative 'wurk/queue'
@@ -36,6 +39,8 @@ require_relative 'wurk/dead_set'
 require_relative 'wurk/stats'
 require_relative 'wurk/process_set'
 require_relative 'wurk/work_set'
+require_relative 'wurk/profiler'
+require_relative 'wurk/profile_set'
 require_relative 'wurk/heartbeat'
 require_relative 'wurk/fetcher'
 require_relative 'wurk/fetcher/reliable'
@@ -54,6 +59,7 @@ require_relative 'wurk/batch_set'
 require_relative 'wurk/limiter'
 require_relative 'wurk/cron'
 require_relative 'wurk/leader'
+require_relative 'wurk/history'
 require_relative 'wurk/unique'
 require_relative 'wurk/encryption'
 require_relative 'wurk/metrics'
@@ -122,6 +128,10 @@ module Wurk
       configuration.logger
     end
 
+    def logger=(logger)
+      configuration.logger = logger
+    end
+
     # --- JSON ---------------------------------------------------------
 
     def load_json(string)
@@ -144,6 +154,13 @@ module Wurk
       @default_job_options = default_job_options.merge(hash.transform_keys(&:to_s))
     end
 
+    # Opt in to enqueue-after-commit globally: every `perform_async` builds a
+    # Wurk::TransactionAwareClient that defers its push to the surrounding
+    # ActiveRecord transaction's commit. Idempotent. Spec: sidekiq-free.md §3.
+    def transactional_push!
+      default_job_options['client_class'] = Wurk::TransactionAwareClient
+    end
+
     # --- strict args -------------------------------------------------
 
     # Sets the global mode used by Wurk::JobUtil#verify_json.
@@ -174,6 +191,17 @@ module Wurk
 
     attr_writer :server
 
+    # Enter server mode: set the module flag (read by third-party gems via
+    # `Sidekiq.server?`) AND the per-config `server?` predicate that gates
+    # `configure_server`. Both must be set before the app's initializers run,
+    # or `configure_server` blocks (server middleware, error handlers,
+    # lifecycle hooks) are silently skipped. Defaults to the global config; the
+    # CLI passes its own (possibly test-injected) Configuration instance.
+    def enter_server_mode(config = configuration)
+      @server = true
+      config[:server] = true
+    end
+
     # Wurk ships Pro+Ent features in the free gem; these flags exist solely
     # for third-party gems that branch on Sidekiq.pro? / Sidekiq.ent?.
     def pro?
@@ -211,6 +239,15 @@ require_relative 'wurk/health'
 # Spec: docs/target/sidekiq-pro.md §3.2.
 require_relative 'wurk/middleware/poison_pill'
 
+# InterruptHandler self-prepends to the head of the server chain so a
+# cooperatively-cancelled job (IterableJob) is re-pushed + cleanly skipped
+# instead of surfacing as a raw error. Sidekiq registers it from
+# `require "sidekiq/cli"`; we require it here at load so every server boot
+# path picks it up — standalone CLI, embedded, and swarm-forked children
+# (the swarm and embedded paths never run through Wurk::CLI#run).
+# Spec: docs/target/sidekiq-free.md §10.3.
+require_relative 'wurk/middleware/interrupt_handler'
+
 # Limiter server middleware: catches OverLimit, reschedules onto the same
 # queue with `Time.now + backoff` until `overrated` hits the reschedule cap.
 # Registered AFTER Batch::ServerMiddleware so a rescheduled OverLimit
@@ -226,6 +263,13 @@ Wurk.configuration.server_middleware.add(Wurk::Limiter::ServerMiddleware)
 # Spec: docs/target/sidekiq-pro.md §9.
 Wurk.configuration.server_middleware.add(Wurk::Metrics::Statsd)
 
+# Historical metrics middleware: records per-class processed/failed/ms into
+# Redis time-buckets so the dashboard history pane has data on a default boot.
+# Sidekiq auto-installs `Sidekiq::Metrics::Middleware` on the server for
+# embedded/CLI; we mirror that here at load. Runs server-side only (the chain
+# never executes in a client-only process). Spec: docs/target/sidekiq-free.md §10.3.
+Wurk.configuration.server_middleware.add(Wurk::Metrics::History)
+
 # Pro Fast API: Lua-backed Queue#delete_job / #delete_by_class plus
 # SortedSet#scan { |JobRecord| … }. Mixed in via include/prepend on the
 # existing data API classes so the surface is wire-compat with Sidekiq Pro.