patient_http-sidekiq 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97f976999ea59ac067153a7698579accb7e7a9941171adbb31e1270ff044fc8
-  data.tar.gz: bf45c48c1afaae62826c66f8a2a8f5cd82379b40edc0c9d34faad1c856cfbcd2
+  metadata.gz: f16c7b27f88a7f84cb0b34cb6ae28a931b9be60dcfa22c8107efeff1cf9bb82c
+  data.tar.gz: f6c20d30b05984bd72d21f4faea53f4eb2f5e08637894f09c286abc1df437640
 SHA512:
-  metadata.gz: bff1df1ca4265615ec56aedce59ef87a08f70344f31324e432e231d114c7b04139424a29cf510d8aac6cc0dad2643149cf1f4b17c194066e3fe13deea4a8989b
-  data.tar.gz: 2fb165723aecdd602a638f81a3a2804ff3951e1b3db74c4dc1afbc5a6e32420adc9728fbe06d503bd424616fd5c665faf8cb93b74bbcde2b2193681d0c6f3651
+  metadata.gz: 9d79dc80c1493605c18763b89533aeed861c3ab6e49d6ae29558d7650297752bccff9efaec56bf425366f2db79c48125351db0d1dd5b7310d353bf5af50ef9bd
+  data.tar.gz: 84c003b789d2809bfccd9e6ef11ddf80d56712ed963bb3e5bc5769cf7b6b7bdbfc4720e260b034cb0b99d340991f30a526bdd774cba1adccf811cdf2fd8c07f3

data/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.1.1
+
+### Fixed
+
+- The Sidekiq Web UI extension now registers correctly on Sidekiq 7.3. It previously raised `NoMethodError: undefined method 'register_extension' for class Sidekiq::Web` because that method only exists in Sidekiq 8.
+- The Web UI dashboard page now renders on Sidekiq versions before 8.1. Those versions resolve view files as `*.erb` instead of `*.html.erb`, so the template is now rendered from a string.
+- Requiring the Web UI on Sidekiq versions before 7.3 now raises a `LoadError` with a clear message instead of an obscure error.
+
+### Added
+
+- `require "patient_http/sidekiq/web"` can now be used to load the Web UI extension, matching the `require "sidekiq/web"` convention. The previous `patient_http/sidekiq/web_ui` path still works.
+
 ## 1.1.0
 
 ### Changed

data/README.md

@@ -485,12 +485,11 @@ See the [Configuration](lib/patient_http/sidekiq/configuration.rb) class for all
 
 ### Web UI
 
-If you're using Sidekiq's Web UI, you can add a tab with the async HTTP processor statistics. The extension auto-registers when `Sidekiq::Web` is defined:
+If you're using Sidekiq's Web UI, you can add a tab with the async HTTP processor statistics. The Web UI tab requires Sidekiq 7.3 or later.
 
 ```ruby
 # config/routes.rb (Rails)
-require "sidekiq/web"
-require "patient_http-sidekiq"
+require "patient_http/sidekiq/web"
 
 mount Sidekiq::Web => "/sidekiq"
 ```

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/patient_http/sidekiq/web.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# This file exists so that the require path for the web UI can match the
+# file path in sidekiq itself: `require "patient_http/sidekiq/web"`
+
+require_relative "web_ui"

data/lib/patient_http/sidekiq/web_ui.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
+require "sidekiq/version"
+
+# Sidekiq 7.3 introduced the web extension API used here (register with
+# keyword arguments); older versions cannot mount the tab or assets. Check
+# before loading sidekiq/web, which can itself fail to load on old versions.
+if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new("7.3")
+  raise LoadError.new("patient_http/sidekiq/web requires sidekiq >= 7.3 (you have #{::Sidekiq::VERSION})")
+end
+
 require "sidekiq/web"
 
 module PatientHttp
@@ -12,6 +21,13 @@ module PatientHttp
       VIEWS = File.join(ROOT, "views")
 
       class << self
+        # Sidekiq resolves symbol view names to different file names depending
+        # on the version (*.erb before 8.1, *.html.erb from 8.1 on), so the
+        # template is rendered from a string instead.
+        def template
+          @template ||= File.read(File.join(VIEWS, "patient_http.html.erb"))
+        end
+
         # This method is called by Sidekiq::Web when registering the extension
         def registered(app)
           # GET route for the main PatientHttp dashboard page
@@ -31,7 +47,7 @@ module PatientHttp
             current_inflight = processes.values.sum { |data| data[:inflight] }
             utilization = (max_capacity > 0) ? (current_inflight.to_f / max_capacity * 100).round(1) : 0
 
-            erb(:patient_http, views: PatientHttp::Sidekiq::WebUI::VIEWS, locals: {
+            erb(PatientHttp::Sidekiq::WebUI.template, locals: {
               totals: totals,
               total_requests: total_requests,
               avg_duration: avg_duration,
@@ -52,18 +68,26 @@ module PatientHttp
     end
   end
 
-  # Auto-register the web UI extension if Sidekiq::Web is available
-  # This is called after require "sidekiq/web" in the application
-  if defined?(::Sidekiq::Web)
+  register_options = {
+    name: "patient-http",
+    tab: "patient_http_tab",
+    index: "patient-http",
+    root_dir: PatientHttp::Sidekiq::WebUI::ROOT,
+    asset_paths: ["css", "js"]
+  }
+
+  if ::Sidekiq::Web.respond_to?(:configure)
     ::Sidekiq::Web.configure do |config|
-      config.register_extension(
-        PatientHttp::Sidekiq::WebUI,
-        name: "patient-http",
-        tab: "patient_http_tab",
-        index: "patient-http",
-        root_dir: PatientHttp::Sidekiq::WebUI::ROOT,
-        asset_paths: ["css", "js"]
-      )
+      if config.respond_to?(:register_extension)
+        # Sidekiq 8.x yields a Sidekiq::Web::Config object
+        config.register_extension(PatientHttp::Sidekiq::WebUI, **register_options)
+      else
+        # Sidekiq 7.3.5+ yields the Sidekiq::Web class, which only has register
+        config.register(PatientHttp::Sidekiq::WebUI, **register_options)
+      end
     end
+  else
+    # Sidekiq 7.3.0 - 7.3.4 has no Sidekiq::Web.configure
+    ::Sidekiq::Web.register(PatientHttp::Sidekiq::WebUI, **register_options)
   end
 end

data/patient_http-sidekiq.gemspec

@@ -41,6 +41,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "sidekiq", ">= 7.0"
   spec.add_dependency "patient_http", ">= 1.3.0"
-
-  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: patient_http-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Brian Durand
@@ -37,20 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem provides a mechanism to offload long-running HTTP requests from
   Sidekiq workers to a dedicated async I/O processor running in the same process,
   freeing the worker thread immediately while the HTTP request is in flight.
@@ -78,6 +64,7 @@ files:
 - lib/patient_http/sidekiq/task_handler.rb
 - lib/patient_http/sidekiq/task_monitor.rb
 - lib/patient_http/sidekiq/task_monitor_thread.rb
+- lib/patient_http/sidekiq/web.rb
 - lib/patient_http/sidekiq/web_ui.rb
 - lib/patient_http/sidekiq/web_ui/assets/patient-http/css/patient_http.css
 - lib/patient_http/sidekiq/web_ui/locales/ar.yml
@@ -133,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Offload long-running HTTP requests from Sidekiq workers to a dedicated async
   I/O processor