patient_http-sidekiq 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97f976999ea59ac067153a7698579accb7e7a9941171adbb31e1270ff044fc8
-  data.tar.gz: bf45c48c1afaae62826c66f8a2a8f5cd82379b40edc0c9d34faad1c856cfbcd2
+  metadata.gz: 25eda5f2b6779bc4c2208a6e57bf50bb98277706c97d7ff6bacf7368c369c842
+  data.tar.gz: b110134e0fbb6a9ad8cee382c81d809267ebe0d5eb730a93fd10ce5871de2c1e
 SHA512:
-  metadata.gz: bff1df1ca4265615ec56aedce59ef87a08f70344f31324e432e231d114c7b04139424a29cf510d8aac6cc0dad2643149cf1f4b17c194066e3fe13deea4a8989b
-  data.tar.gz: 2fb165723aecdd602a638f81a3a2804ff3951e1b3db74c4dc1afbc5a6e32420adc9728fbe06d503bd424616fd5c665faf8cb93b74bbcde2b2193681d0c6f3651
+  metadata.gz: 62a51fd65f0d68bbe3223417bd663468ab4fe120704f6a4ddf32f6f220d057365588058061baa41c63aa33c3221dcba16105e85a0d5dba0c2c2e1dd365144626
+  data.tar.gz: 28550b4fe12f889a9fa28e0e9bd25737693994940cba28d385207870909f019c88d69acc5248a55af302054f5352db6b08780772457b7617608f1677a3ad16c0

data/CHANGELOG.md

@@ -4,6 +4,25 @@ 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.2
+
+### Fixed
+
+- The Web UI stylesheet now loads on Sidekiq 7.x. The `style_tag` helper returns the link tag on Sidekiq 7 but adds it to the page head on Sidekiq 8; the view now handles both.
+- The Web UI stylesheet now uses CSS variables that the Sidekiq 8 web UI actually defines (`--color-primary`, `--color-text`, ...), with static fallback values for Sidekiq 7.x.
+
+## 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.2

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/assets/patient-http/css/patient_http.css

@@ -1,18 +1,29 @@
 /* PatientHttp Dashboard Stylesheet */
 
 .patient-http-dashboard {
-  --patient-http-primary: var(--color-brand);
-  --patient-http-success: var(--color-ok);
-  --patient-http-error: var(--color-err);
-  --patient-http-warning: var(--color-warn);
-  --patient-http-bg: var(--color-bg);
-  --patient-http-text: var(--color-fg);
-  --patient-http-border: var(--color-border);
-  --patient-http-subtle: var(--color-subtle);
+  /* The --color-* variables come from the Sidekiq 8 web UI stylesheet. The
+     fallback values are for Sidekiq 7.x, which defines no CSS variables.
+     Status colors are static because Sidekiq 8 only defines pastel label
+     backgrounds, which are unreadable as text colors. */
+  --patient-http-primary: var(--color-primary, #b91d47);
+  --patient-http-success: #28a745;
+  --patient-http-error: #dc3545;
+  --patient-http-warning: #b45309;
+  --patient-http-bg: var(--color-bg, transparent);
+  --patient-http-text: var(--color-text, inherit);
+  --patient-http-border: var(--color-border, #dee2e6);
+  --patient-http-subtle: var(--color-text-light, #757575);
+  --patient-http-card-bg: var(--color-elevated, transparent);
+  --patient-http-card-hover: var(--color-selected, transparent);
+
+  /* Reset the base font size because the Bootstrap CSS in the Sidekiq 7.x
+     web UI sets a 10px root font size. Font sizes below are in em so they
+     scale from this base on every Sidekiq version. */
+  font-size: var(--font-size, 16px);
 }
 
 .patient-http-dashboard .section {
-  margin-top: 1.5rem;
+  margin-top: 24px;
   background: var(--patient-http-bg);
 }
 
@@ -20,7 +31,7 @@
   display: flex;
   justify-content: space-between;
   align-items: center;
-  margin-bottom: var(--space-lg, 1.5rem);
+  margin-bottom: 24px;
 }
 
 .patient-http-dashboard .header-with-button h2 {
@@ -32,30 +43,30 @@
 }
 
 .patient-http-dashboard .clear-stats-form .btn {
-  font-size: 0.875rem;
-  padding: 0.5rem 1rem;
+  font-size: 0.875em;
+  padding: 8px 16px;
 }
 
 .patient-http-dashboard h2 {
-  margin: 0 0 var(--space-lg, 1.5rem) 0;
+  margin: 0 0 24px 0;
   color: var(--patient-http-text);
-  font-size: 1.75rem;
+  font-size: 1.75em;
   font-weight: 600;
   letter-spacing: -0.015em;
 }
 
 .patient-http-dashboard h3 {
-  margin: var(--space-xl, 2rem) 0 var(--space-lg, 1.5rem) 0;
+  margin: 32px 0 24px 0;
   color: var(--patient-http-text);
-  font-size: 1.25rem;
+  font-size: 1.25em;
   font-weight: 600;
   letter-spacing: -0.01em;
 }
 
 .patient-http-dashboard h4 {
-  margin: var(--space-md, 1rem) 0 var(--space-sm, 0.75rem) 0;
+  margin: 16px 0 12px 0;
   color: var(--patient-http-text);
-  font-size: 1rem;
+  font-size: 1em;
   font-weight: 600;
 }
 
@@ -63,30 +74,30 @@
 .stats-grid {
   display: grid;
   grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
-  gap: var(--space-lg, 1.5rem);
-  margin-bottom: var(--space-xl, 2rem);
+  gap: 24px;
+  margin-bottom: 32px;
 }
 
 .stat-card {
-  padding: var(--space-lg, 1.5rem);
-  background: var(--color-card-bg, rgb(255 255 255));
+  padding: 24px;
+  background: var(--patient-http-card-bg);
   border: 1px solid var(--patient-http-border);
-  border-radius: 0.375rem;
+  border-radius: 6px;
   display: flex;
   flex-direction: column;
   justify-content: space-between;
 }
 
 .stat-label {
-  font-size: 0.875rem;
-  color: var(--color-subtle, rgb(128 128 128));
+  font-size: 0.875em;
+  color: var(--patient-http-subtle);
   font-weight: 500;
-  margin-bottom: var(--space-sm, 0.75rem);
+  margin-bottom: 12px;
   letter-spacing: 0.02em;
 }
 
 .stat-value {
-  font-size: 2rem;
+  font-size: 2em;
   font-weight: 700;
   color: var(--patient-http-primary);
   letter-spacing: -0.02em;
@@ -99,75 +110,75 @@
 
 /* Capacity Section */
 .capacity-section {
-  margin: var(--space-xl, 2rem) 0;
-  padding: var(--space-lg, 1.5rem);
-  background: var(--color-card-bg, rgb(255 255 255));
+  margin: 32px 0;
+  padding: 24px;
+  background: var(--patient-http-card-bg);
   border: 1px solid var(--patient-http-border);
-  border-radius: 0.375rem;
+  border-radius: 6px;
 }
 
 .capacity-cards {
   display: grid;
   grid-template-columns: repeat(auto-fit, minmax(180px, 1fr));
-  gap: var(--space-lg, 1.5rem);
-  margin-bottom: var(--space-xl, 2rem);
+  gap: 24px;
+  margin-bottom: 32px;
 }
 
 .capacity-card {
-  padding: var(--space-md, 1rem);
-  background: var(--patient-http-bg, rgb(255 255 255));
+  padding: 16px;
+  background: var(--patient-http-card-bg);
   border: 1px solid var(--patient-http-border);
-  border-radius: 0.25rem;
+  border-radius: 4px;
   text-align: center;
 }
 
 .capacity-label {
-  font-size: 0.875rem;
-  color: var(--color-subtle, rgb(128 128 128));
+  font-size: 0.875em;
+  color: var(--patient-http-subtle);
   font-weight: 500;
-  margin-bottom: 0.5rem;
+  margin-bottom: 8px;
   display: block;
 }
 
 .capacity-value {
   display: block;
-  font-size: 1.75rem;
+  font-size: 1.75em;
   font-weight: 700;
   color: var(--patient-http-primary);
   line-height: 1;
-  margin-bottom: 0.25rem;
+  margin-bottom: 4px;
 }
 
 .capacity-unit {
-  font-size: 0.75rem;
-  color: var(--color-subtle, rgb(128 128 128));
+  font-size: 0.75em;
+  color: var(--patient-http-subtle);
   text-transform: uppercase;
   letter-spacing: 0.05em;
 }
 
 /* Process Breakdown Table */
 .process-breakdown {
-  margin-top: var(--space-lg, 1.5rem);
+  margin-top: 24px;
 }
 
 /* Breakdown Sections (HTTP Status Codes, Error Types) */
 .breakdown-section {
-  margin: var(--space-xl, 2rem) 0;
-  padding: var(--space-lg, 1.5rem);
-  background: var(--color-card-bg, rgb(255 255 255));
+  margin: 32px 0;
+  padding: 24px;
+  background: var(--patient-http-card-bg);
   border: 1px solid var(--patient-http-border);
-  border-radius: 0.375rem;
+  border-radius: 6px;
 }
 
 .breakdown-section h3 {
-  margin: 0 0 var(--space-lg, 1.5rem) 0;
+  margin: 0 0 24px 0;
 }
 
 /* Table Styling */
 .patient-http-dashboard .table {
   width: 100%;
   border-collapse: collapse;
-  margin-top: var(--space-md, 1rem);
+  margin-top: 16px;
 }
 
 .patient-http-dashboard .table thead {
@@ -176,16 +187,16 @@
 }
 
 .patient-http-dashboard .table th {
-  padding: var(--space-md, 1rem);
+  padding: 16px;
   text-align: left;
   font-weight: 600;
   color: var(--patient-http-text);
-  font-size: 0.875rem;
+  font-size: 0.875em;
   letter-spacing: 0.01em;
 }
 
 .patient-http-dashboard .table td {
-  padding: var(--space-md, 1rem);
+  padding: 16px;
   border-bottom: 1px solid var(--patient-http-border);
   color: var(--patient-http-text);
 }
@@ -196,7 +207,7 @@
 
 .patient-http-dashboard .table .empty-state {
   text-align: center;
-  color: var(--color-subtle, rgb(128 128 128));
+  color: var(--patient-http-subtle);
   font-style: italic;
 }
 
@@ -211,15 +222,15 @@
   }
 
   .patient-http-dashboard h2 {
-    font-size: 1.5rem;
+    font-size: 1.5em;
   }
 
   .patient-http-dashboard h3 {
-    font-size: 1.125rem;
+    font-size: 1.125em;
   }
 
   .stat-value {
-    font-size: 1.5rem;
+    font-size: 1.5em;
   }
 }
 
@@ -233,17 +244,10 @@
   }
 
   .capacity-value {
-    font-size: 1.5rem;
+    font-size: 1.5em;
   }
 }
 
-/* Dark Mode Support (via CSS variables) */
-@media (prefers-color-scheme: dark) {
-  .stat-card {
-    background: var(--color-card-bg);
-  }
-
-  .stat-card:hover {
-    background: var(--color-card-hover);
-  }
+.stat-card:hover {
+  background: var(--patient-http-card-hover);
 }

data/lib/patient_http/sidekiq/web_ui/views/patient_http.html.erb

@@ -138,5 +138,7 @@
   </div>
 </div>
 
-<%# Note: style tag does not use the "=" to send output %>
-<% style_tag("patient-http/css/patient_http.css") %>
+<%# Sidekiq 8 adds the link tag to the page head and returns an Array;
+    Sidekiq 7 returns the link tag as a String that must be output in place. %>
+<% stylesheet = style_tag("patient-http/css/patient_http.css") %>
+<%= stylesheet if stylesheet.is_a?(String) %>

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.2
 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