sidekiq-belt 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb3a875c6a19a21d87d63f32b116f44fdba5c55dcb62577a94e6b1727449d0b
-  data.tar.gz: de58057b262d16db28fd45ff42f888361e9692158d1c906ffa3566dc38081c01
+  metadata.gz: c5172fbb6524305c54365270d2cbd464351a3e7ff990da9b08cb5a9a32f7f40a
+  data.tar.gz: f4c42f4fe4e5e3b7ddb103e03612a7fade9b55885f7fb094d28bc33dca59dd50
 SHA512:
-  metadata.gz: 25897766813a45a51454e7b43a4737e9acb223d2e89490f657a02afe90f295e9edff9b240021ab8e3aaa978064bbde966d4713ed1c1385c5d4274f51c4cce64c
-  data.tar.gz: 1da39ce3c83f28daac2f8c1b598ac8c7c8c587e6d6dfb08ba3258deceacc96b65772cdde00ca9eb3440fc486a298f9e62152b9d67e5716f0f746a63ea25337ed
+  metadata.gz: d9ce134a5e9962330c6086cbdddaeaca5109fea7545ad44c144cd8d7590f43ce5a3ecf93a75076f6009f7af97038ccc3ca2205f8c72802ca946588fb16c98b62
+  data.tar.gz: c282c58813f4a0a1a5cef2a60dacd0b47082889a2a7aaaefa6ad5be9f6ec7b018f9e0dff415a5a7ec48ea75312bb5d7fc12ecf2617c68bd773a5ba0a73d8b426

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3
   NewCops: enable
 
 Style/StringLiterals:

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 ## [Unreleased]
+## [2.0.0] - 2024-09-27
+- Support for Sidekiq v8
+
+## [1.0.0] - 2024-11-19
+- Force run batch callback
+
 ## [0.3.6] - 2024-09-27
 
 - Added force kill to instances

data/CODE_OF_CONDUCT.md

@@ -2,83 +2,131 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at daniloj.dasilva@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+daniloj.dasilva@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Danilo Jeremias da Silva
+Copyright (c) 2024 Danilo Jeremias da Silva
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/sidekiq/belt/community/force_kill.rb

@@ -25,7 +25,7 @@ module Sidekiq
             end
 
             app.get("/force_kill/:identity/kill") do
-              process = Sidekiq::ProcessSet[params["identity"]]
+              process = Sidekiq::ProcessSet[route_params(:identity)]
 
               if process
                 process.stop!
@@ -38,7 +38,10 @@ module Sidekiq
         end
 
         def self.use!
-          Sidekiq::Web.register(Sidekiq::Belt::Community::ForceKill::SidekiqForceKill)
+          Sidekiq::Web.configure do |cfg|
+            cfg.register(Sidekiq::Belt::Community::ForceKill::SidekiqForceKill, name: "force_kill", tab: nil,
+                                                                                index: nil)
+          end
           Sidekiq::Process.prepend(Sidekiq::Belt::Community::ForceKill)
         end
       end

data/lib/sidekiq/belt/community/run_job.rb

@@ -29,8 +29,6 @@ module Sidekiq
 
         module SidekiqRunJob
           def self.registered(app)
-            app.tabs["Run Jobs"] = "run_jobs"
-
             app.get("/run_jobs") do
               @jobs = Sidekiq::Belt::Community::RunJob.list_grouped_jobs
 
@@ -38,7 +36,7 @@ module Sidekiq
             end
 
             app.post("/run_jobs/:rjid/run") do
-              Sidekiq::Belt::Community::RunJob.run_job(params[:rjid].to_i)
+              Sidekiq::Belt::Community::RunJob.run_job(route_params(:rjid).to_i)
 
               return redirect "#{root_path}run_jobs"
             end
@@ -46,7 +44,10 @@ module Sidekiq
         end
 
         def self.use!
-          Sidekiq::Web.register(Sidekiq::Belt::Community::RunJob::SidekiqRunJob)
+          Sidekiq::Web.configure do |cfg|
+            cfg.register(Sidekiq::Belt::Community::RunJob::SidekiqRunJob, name: "run_jobs", tab: "Run Jobs",
+                                                                          index: "run_jobs")
+          end
         end
       end
     end

data/lib/sidekiq/belt/community/top_label.rb

@@ -6,23 +6,62 @@ require "sidekiq/web/helpers"
 module Sidekiq
   module Belt
     module Community
-      module TopLabel
+      class TopLabel
         def self.use!
           Sidekiq::WebActionHelper.change_layout do |content|
-            top_label = (Sidekiq::Belt.config.top_label || {}).fetch(Sidekiq::Belt.env, {})
-
-            html = "<div class='container-fluid'
-                         style='background: #{::Rack::Utils.escape_html(top_label.fetch(:background_color, "red"))};
-                                text-align: center;
-                                color: #{::Rack::Utils.escape_html(top_label.fetch(:color, "white"))};'>
-                      &nbsp;#{::Rack::Utils.escape_html(top_label[:text].to_s)}&nbsp;
-                    </div>"
-            unless top_label.empty?
-              content.gsub!('<div class="container-fluid">',
-                            "#{html} <div class='container-fluid'>")
-            end
+            Sidekiq::Belt::Community::TopLabel.new(content).apply
           end
         end
+
+        attr_reader :content, :top_label
+
+        def initialize(content)
+          @content = content
+          @top_label = fetch_top_label
+        end
+
+        def apply
+          inject_styles_and_label unless top_label.empty?
+
+          content
+        end
+
+        def fetch_top_label
+          (Sidekiq::Belt.config.top_label || {}).fetch(Sidekiq::Belt.env, {})
+        end
+
+        def inject_styles_and_label
+          content.gsub!("</head>", "<style nonce='#{nonce_id}'>#{styles}</style></head>")
+          content.sub!(/<body[^>]*>/, "\\0#{top_label_div}")
+        end
+
+        def nonce_id
+          content[/nonce="([^"]*)"/, 1].to_s
+        end
+
+        def top_label_div
+          text = ::Rack::Utils.escape_html(top_label[:text].to_s)
+          "<div class='container-fluid top_label'>&nbsp;#{text}&nbsp;</div>"
+        end
+
+        def styles
+          <<~CSS
+            header:first-of-type, .navbar-default {
+              margin-top: 20px;
+            }
+
+            .top_label {
+              background: #{::Rack::Utils.escape_html(top_label.fetch(:background_color, "red"))} !important;
+              z-index: 99999;
+              text-align: center;
+              color: #{::Rack::Utils.escape_html(top_label.fetch(:color, "white"))};
+              position: fixed;
+              width: 100%;
+              top: 0;
+              right: 0;
+            }
+          CSS
+        end
       end
     end
   end

data/lib/sidekiq/belt/ent/periodic_pause.rb

@@ -62,13 +62,13 @@ module Sidekiq
             end
 
             app.post("/loops/:lid/pause") do
-              Sidekiq::Periodic::Loop.new(params[:lid]).pause!
+              Sidekiq::Periodic::Loop.new(route_params(:lid)).pause!
 
               return redirect "#{root_path}loops"
             end
 
             app.post("/loops/:lid/unpause") do
-              Sidekiq::Periodic::Loop.new(params[:lid]).unpause!
+              Sidekiq::Periodic::Loop.new(route_params(:lid)).unpause!
 
               return redirect "#{root_path}loops"
             end
@@ -87,7 +87,11 @@ module Sidekiq
           require("sidekiq-ent/periodic/manager")
           require("sidekiq-ent/periodic/static_loop")
 
-          Sidekiq::Web.register(Sidekiq::Belt::Ent::PeriodicPause::SidekiqLoopsPeriodicPause)
+          Sidekiq::Web.configure do |cfg|
+            cfg.register(Sidekiq::Belt::Ent::PeriodicPause::SidekiqLoopsPeriodicPause, name: "periodic_pause",
+                                                                                       tab: nil, index: nil)
+          end
+
           Sidekiq::Periodic::Loop.prepend(Sidekiq::Belt::Ent::PeriodicPause)
           Sidekiq::Periodic::StaticLoop.prepend(Sidekiq::Belt::Ent::PeriodicPause)
           Sidekiq::Periodic::Manager.prepend(Sidekiq::Belt::Ent::PeriodicPause::PauseServer)

data/lib/sidekiq/belt/ent/periodic_run.rb

@@ -66,7 +66,7 @@ module Sidekiq
             end
 
             app.post("/loops/:lid/run") do
-              Sidekiq::Periodic::Loop.new(params[:lid]).run
+              Sidekiq::Periodic::Loop.new(route_params(:lid)).run
 
               return redirect "#{root_path}loops"
             end
@@ -78,7 +78,10 @@ module Sidekiq
           require("sidekiq-ent/periodic")
           require("sidekiq-ent/periodic/static_loop")
 
-          Sidekiq::Web.register(Sidekiq::Belt::Ent::PeriodicRun::SidekiqLoopsPeriodicRun)
+          Sidekiq::Web.configure do |cfg|
+            cfg.register(Sidekiq::Belt::Ent::PeriodicRun::SidekiqLoopsPeriodicRun, name: "periodic_run", tab: nil,
+                                                                                   index: nil)
+          end
           Sidekiq::Periodic::Loop.prepend(Sidekiq::Belt::Ent::PeriodicRun)
           Sidekiq::Periodic::StaticLoop.prepend(Sidekiq::Belt::Ent::PeriodicRun)
         end

data/lib/sidekiq/belt/pro/failed_batch_remove.rb

@@ -26,7 +26,7 @@ module Sidekiq
             end
 
             app.post("/batches/:bid/remove") do
-              Sidekiq::Batch::Status.new(params[:bid]).delete
+              Sidekiq::Batch::Status.new(route_params(:bid)).delete
 
               return redirect "#{root_path}batches"
             end
@@ -36,7 +36,10 @@ module Sidekiq
         def self.use!
           require("sidekiq/web")
 
-          Sidekiq::Web.register(Sidekiq::Belt::Pro::FailedBatchRemove::SidekiqFailedBatchRemove)
+          Sidekiq::Web.configure do |cfg|
+            cfg.register(Sidekiq::Belt::Pro::FailedBatchRemove::SidekiqFailedBatchRemove, name: "remove_batch",
+                                                                                          tab: nil, index: nil)
+          end
         end
       end
     end

data/lib/sidekiq/belt/pro/force_batch_callback.rb

@@ -37,7 +37,7 @@ module Sidekiq
             end
 
             app.post("/batches/:bid/force_callback/:action") do
-              Sidekiq::Batch::Callback.perform_inline(params[:action], params[:bid])
+              Sidekiq::Batch::Callback.perform_inline(route_params(:action), route_params(:bid))
 
               return redirect "#{root_path}batches"
             end
@@ -47,7 +47,10 @@ module Sidekiq
         def self.use!
           require("sidekiq/web")
 
-          Sidekiq::Web.register(Sidekiq::Belt::Pro::ForceBatchCallback::SidekiqForceBatchCallback)
+          Sidekiq::Web.configure do |cfg|
+            cfg.register(Sidekiq::Belt::Pro::ForceBatchCallback::SidekiqForceBatchCallback, name: "force_batch",
+                                                                                            tab: nil, index: nil)
+          end
         end
       end
     end

data/lib/sidekiq/belt/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Belt
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/sidekiq/belt.rb

@@ -3,6 +3,7 @@
 require "sidekiq"
 
 require_relative "belt/version"
+require "sidekiq/web"
 require_relative "web_action_helper"
 require_relative "web_router_helper"
 

data/lib/sidekiq/web_action_helper.rb

@@ -10,7 +10,11 @@ module Sidekiq
         replace_views = Sidekiq::Config::DEFAULTS[:replace_views] || {}
 
         replace_views.each do |key, content_blocks|
-          next if WebRoute.new("", key, true).match("", self.class.path_info).nil?
+          if Sidekiq::VERSION.to_i >= 8
+            next if Sidekiq::Web::Application.match(self.class.full_env).nil?
+          elsif WebRoute.new("", key, true).match("", self.class.full_env["PATH_INFO"]).nil?
+            next
+          end
 
           content_blocks.each do |content_block|
             content_block.call(content)
@@ -21,12 +25,12 @@ module Sidekiq
       end
 
       class << self
-        attr_accessor :path_info
+        attr_accessor :full_env
       end
     end
 
     def erb(content, options = {})
-      ERB.path_info = ::Rack::Utils.unescape(env["PATH_INFO"])
+      ERB.full_env = env
 
       super
     end
@@ -49,5 +53,9 @@ module Sidekiq
     end
   end
 
-  Sidekiq::WebAction.prepend(Sidekiq::WebActionHelper)
+  if defined?(Sidekiq::Web::Action)
+    Sidekiq::Web::Action.prepend(Sidekiq::WebActionHelper)
+  else
+    Sidekiq::WebAction.prepend(Sidekiq::WebActionHelper)
+  end
 end

data/lib/sidekiq/web_router_helper.rb

@@ -13,5 +13,9 @@ module Sidekiq
     end
   end
 
-  Sidekiq::WebRouter.prepend(Sidekiq::WebRouterHelper)
+  if defined?(Sidekiq::Web::Router)
+    Sidekiq::Web::Router.prepend(Sidekiq::WebRouterHelper)
+  else
+    Sidekiq::WebRouter.prepend(Sidekiq::WebRouterHelper)
+  end
 end

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-belt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Danilo Jeremias da Silva
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.4
+        version: 7.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.4
+        version: 7.3.8
 description: This Ruby gem enhances the capabilities of Sidekiq, Sidekiq Pro, and
   Sidekiq Enterprise by adding essential utilities.
 email:
@@ -63,8 +62,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/dannnylo/sidekiq-belt
   source_code_uri: https://github.com/dannnylo/sidekiq-belt
+  changelog_uri: https://github.com/dannnylo/sidekiq-belt/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: This Ruby gem enhances the capabilities of Sidekiq, Sidekiq Pro, and Sidekiq
   Enterprise by adding essential utilities.