patient_http-sidekiq 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25eda5f2b6779bc4c2208a6e57bf50bb98277706c97d7ff6bacf7368c369c842
-  data.tar.gz: b110134e0fbb6a9ad8cee382c81d809267ebe0d5eb730a93fd10ce5871de2c1e
+  metadata.gz: e5ae5287613de3682de817fb6c434e6a1a33c21c1b8aa1dde7b7808c1733b927
+  data.tar.gz: 350e8f054d1047fe70482d9c3fc2f5473b077e1e7f1c64cc6f023c8bf76f62b4
 SHA512:
-  metadata.gz: 62a51fd65f0d68bbe3223417bd663468ab4fe120704f6a4ddf32f6f220d057365588058061baa41c63aa33c3221dcba16105e85a0d5dba0c2c2e1dd365144626
-  data.tar.gz: 28550b4fe12f889a9fa28e0e9bd25737693994940cba28d385207870909f019c88d69acc5248a55af302054f5352db6b08780772457b7617608f1677a3ad16c0
+  metadata.gz: d843ce929d22f48c20bc7f487b35d11421166218081f4fea2490440781d0a00839266c3cb1dec039611a6728e2213c3a71f0a966454ba40c1efc6ab466648ca7
+  data.tar.gz: 006cf97e99a6d27847b038c19065a88b09e28a94c7392fbee5af4253e9483652e8022b21e42c271840cfc8bff326fcfd490b137d1b08c8984760c68f6f7bc3df

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.0
+
+### Added
+
+- `PatientHttp::Sidekiq.with_sidekiq_options` sets Sidekiq job options (queue, retry, etc.) at runtime for the requests enqueued within a block. When the options include a queue, the callback job for the request is enqueued on that queue as well.
+
 ## 1.1.2
 
 ### Fixed

data/README.md

@@ -232,6 +232,21 @@ PatientHttp.execute(request: request, callback: MyCallback, callback_args: {user
 
 See the [patient_http docs](https://github.com/bdurand/patient_http) for the full `Request` and `Response` API reference.
 
+### Setting Sidekiq Options At Runtime
+
+You can set Sidekiq job options for individual requests with `PatientHttp::Sidekiq.with_sidekiq_options`. The options apply to all requests enqueued within the block. Use this, for example, to route urgent requests to a higher priority queue:
+
+```ruby
+PatientHttp::Sidekiq.with_sidekiq_options(queue: "high_priority") do
+  PatientHttp.get("https://api.example.com/users/123", callback: MyCallback)
+end
+```
+
+The options are applied with Sidekiq's `set` method, so any Sidekiq job option (`queue`, `retry`, etc.) is allowed. Notes on the behavior:
+
+- If the options include a `queue`, the callback job that invokes your `on_complete`/`on_error` methods is enqueued on that queue as well, so the whole request keeps one priority end to end.
+- Nested blocks merge their options, and the innermost values take precedence. The previous options are restored when the block exits, even if the block raises an error.
+
 ### Using Request Templates
 
 For repeated requests to the same API, use `PatientHttp::RequestTemplate` to share configuration:
@@ -446,6 +461,7 @@ PatientHttp::Sidekiq.configure do |config|
   config.payload_store_threshold = 64 * 1024
 
   # Sidekiq options for RequestWorker and CallbackWorker
+  # (use PatientHttp::Sidekiq.with_sidekiq_options to override per request)
   config.sidekiq_options = {queue: "patient_http", retry: 5}
 
   # Handler called when a callback job exhausts all Sidekiq retries

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/lib/patient_http/sidekiq/task_handler.rb

@@ -28,7 +28,7 @@ module PatientHttp
       # @return [void]
       def on_complete(response, callback)
         data = store_if_needed(response.as_json)
-        CallbackWorker.perform_async(data, "response", callback)
+        callback_worker.perform_async(data, "response", callback)
         delete_stored_request_payload
       end
 
@@ -42,7 +42,7 @@ module PatientHttp
       # @return [void]
       def on_error(error, callback)
         data = store_if_needed(error.as_json)
-        CallbackWorker.perform_async(data, "error", callback)
+        callback_worker.perform_async(data, "error", callback)
         delete_stored_request_payload
       end
 
@@ -69,6 +69,18 @@ module PatientHttp
 
       private
 
+      # Returns CallbackWorker or a Sidekiq job setter that routes the callback
+      # job to the same queue as the request job when a runtime queue was set
+      # at enqueue time.
+      def callback_worker
+        queue = @sidekiq_job["patient_http_callback_queue"]
+        if queue
+          CallbackWorker.set(queue: queue)
+        else
+          CallbackWorker
+        end
+      end
+
       # Delete the externally stored request payload once the request has
       # completed. Until then the payload must remain fetchable because the
       # Sidekiq job hash referencing it can be re-pushed by Sidekiq retries,

data/lib/patient_http/sidekiq.rb

@@ -18,6 +18,12 @@ require "patient_http"
 #     callback_args: {user_id: 123}
 #   )
 #
+# Set Sidekiq job options at runtime for the requests enqueued within a block:
+#
+#   PatientHttp::Sidekiq.with_sidekiq_options(queue: "high_priority") do
+#     PatientHttp::Sidekiq.execute(request, callback: MyCallback)
+#   end
+#
 # Define a callback service class with +on_complete+ and +on_error+ methods:
 #
 #   class MyCallback
@@ -209,6 +215,32 @@ module PatientHttp
         configuration.encryptor.decrypt(data)
       end
 
+      # Set Sidekiq job options for HTTP requests enqueued within the block.
+      # Options are applied with Sidekiq's `set` method (queue, retry, etc.).
+      # Nested calls merge options with the innermost values taking precedence.
+      # If the options include a queue, the callback job for the request is
+      # enqueued on that queue as well. Options only apply to requests enqueued
+      # in the same fiber as the block. This method has no effect
+      # when jobs run inline with Sidekiq::Testing.inline!.
+      #
+      # @param options [Hash] Sidekiq job options (symbol or string keys)
+      # @yield block within which enqueued requests use the options
+      # @return [Object] the return value of the block
+      def with_sidekiq_options(options)
+        unless options.is_a?(Hash)
+          raise ArgumentError.new("options must be a Hash, got: #{options.class}")
+        end
+        raise ArgumentError.new("with_sidekiq_options requires a block") unless block_given?
+
+        previous = Thread.current[:patient_http_sidekiq_options]
+        begin
+          Thread.current[:patient_http_sidekiq_options] = (previous || {}).merge(options.transform_keys(&:to_s))
+          yield
+        ensure
+          Thread.current[:patient_http_sidekiq_options] = previous
+        end
+      end
+
       # Execute an async HTTP request.
       #
       # @param request [PatientHttp::Request] the HTTP request to execute
@@ -236,7 +268,14 @@ module PatientHttp
           encrypted
         end
 
-        RequestWorker.perform_async(data, callback_name, raise_error_responses, callback_args, request_id)
+        options = current_sidekiq_options
+        if options&.any?
+          queue = options["queue"]
+          options = options.merge("patient_http_callback_queue" => queue.to_s) if queue
+          RequestWorker.set(options).perform_async(data, callback_name, raise_error_responses, callback_args, request_id)
+        else
+          RequestWorker.perform_async(data, callback_name, raise_error_responses, callback_args, request_id)
+        end
 
         request_id
       end
@@ -347,6 +386,15 @@ module PatientHttp
       # @return [PatientHttp::Processor, nil]
       # @api private
       attr_accessor :processor
+
+      private
+
+      # Current scoped Sidekiq options, if any.
+      #
+      # @return [Hash, nil]
+      def current_sidekiq_options
+        Thread.current[:patient_http_sidekiq_options]
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: patient_http-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Brian Durand