")
- 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!("", "")
+ content.sub!(/
]*>/, "\\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)
+ " #{text}
"
+ 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
diff --git a/lib/sidekiq/belt/ent/periodic_pause.rb b/lib/sidekiq/belt/ent/periodic_pause.rb
index dae9a27..80ae40d 100644
--- a/lib/sidekiq/belt/ent/periodic_pause.rb
+++ b/lib/sidekiq/belt/ent/periodic_pause.rb
@@ -62,13 +62,13 @@ def self.registered(app)
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 @@ def self.use!
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)
diff --git a/lib/sidekiq/belt/ent/periodic_run.rb b/lib/sidekiq/belt/ent/periodic_run.rb
index 4623357..dede508 100644
--- a/lib/sidekiq/belt/ent/periodic_run.rb
+++ b/lib/sidekiq/belt/ent/periodic_run.rb
@@ -66,7 +66,7 @@ def self.registered(app)
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 @@ def self.use!
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
diff --git a/lib/sidekiq/belt/pro/failed_batch_remove.rb b/lib/sidekiq/belt/pro/failed_batch_remove.rb
index c396663..bb82dad 100644
--- a/lib/sidekiq/belt/pro/failed_batch_remove.rb
+++ b/lib/sidekiq/belt/pro/failed_batch_remove.rb
@@ -26,7 +26,7 @@ def self.registered(app)
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 @@ def self.registered(app)
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
diff --git a/lib/sidekiq/belt/pro/force_batch_callback.rb b/lib/sidekiq/belt/pro/force_batch_callback.rb
index a56a97d..c86ce8e 100644
--- a/lib/sidekiq/belt/pro/force_batch_callback.rb
+++ b/lib/sidekiq/belt/pro/force_batch_callback.rb
@@ -37,7 +37,7 @@ def self.registered(app)
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 @@ def self.registered(app)
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
diff --git a/lib/sidekiq/belt/version.rb b/lib/sidekiq/belt/version.rb
index a90ec1f..f24fd61 100644
--- a/lib/sidekiq/belt/version.rb
+++ b/lib/sidekiq/belt/version.rb
@@ -2,6 +2,6 @@
module Sidekiq
module Belt
- VERSION = "1.0.0"
+ VERSION = "2.0.0"
end
end
diff --git a/lib/sidekiq/web_action_helper.rb b/lib/sidekiq/web_action_helper.rb
index 08c8f15..da6950f 100644
--- a/lib/sidekiq/web_action_helper.rb
+++ b/lib/sidekiq/web_action_helper.rb
@@ -10,7 +10,11 @@ def initialize(content)
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 @@ def initialize(content)
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 @@ def _render
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
diff --git a/lib/sidekiq/web_router_helper.rb b/lib/sidekiq/web_router_helper.rb
index 3a7113f..9342687 100644
--- a/lib/sidekiq/web_router_helper.rb
+++ b/lib/sidekiq/web_router_helper.rb
@@ -13,5 +13,9 @@ def replace_content(path, &block)
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
diff --git a/sidekiq-belt.gemspec b/sidekiq-belt.gemspec
index a926e5a..756f99f 100644
--- a/sidekiq-belt.gemspec
+++ b/sidekiq-belt.gemspec
@@ -15,23 +15,25 @@ Gem::Specification.new do |spec|
spec.homepage = "https://github.com/dannnylo/sidekiq-belt"
spec.license = "MIT"
- spec.required_ruby_version = ">= 2.6.0"
+ spec.required_ruby_version = ">= 3.0.0"
spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = spec.homepage
+ spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
- spec.files = Dir.chdir(__dir__) do
- `git ls-files -z`.split("\x0").reject do |f|
- (File.expand_path(f) == __FILE__) ||
- f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+ gemspec = File.basename(__FILE__)
+ spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+ ls.readlines("\x0", chomp: true).reject do |f|
+ (f == gemspec) ||
+ f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci .github appveyor Gemfile])
end
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]
- spec.add_dependency "sidekiq", "> 7.1.4"
+ spec.add_dependency "sidekiq", ">= 7.3.8"
spec.metadata["rubygems_mfa_required"] = "true"
end
diff --git a/spec/sidekiq/belt/community/run_job_spec.rb b/spec/sidekiq/belt/community/run_job_spec.rb
index acff747..3467341 100644
--- a/spec/sidekiq/belt/community/run_job_spec.rb
+++ b/spec/sidekiq/belt/community/run_job_spec.rb
@@ -10,7 +10,8 @@
described_class.use!
- expect(Sidekiq::Web).to have_received(:register).with(described_class::SidekiqRunJob)
+ expect(Sidekiq::Web).to have_received(:register).with(described_class::SidekiqRunJob,
+ { index: "run_jobs", name: "run_jobs", tab: "Run Jobs" })
end
it "registers the tab 'Run Jobs' with the path 'run_jobs'" do
diff --git a/spec/sidekiq/belt/ent/periodic_pause_spec.rb b/spec/sidekiq/belt/ent/periodic_pause_spec.rb
index 33f2af8..bcb9345 100644
--- a/spec/sidekiq/belt/ent/periodic_pause_spec.rb
+++ b/spec/sidekiq/belt/ent/periodic_pause_spec.rb
@@ -98,7 +98,8 @@ def initialize(lid, klass, options)
expect(described_class).to have_received(:require).with("sidekiq-ent/periodic/manager").once
expect(described_class).to have_received(:require).with("sidekiq-ent/periodic/static_loop").once
- expect(Sidekiq::Web).to have_received(:register).with(described_class::SidekiqLoopsPeriodicPause)
+ expect(Sidekiq::Web).to have_received(:register).with(described_class::SidekiqLoopsPeriodicPause,
+ { index: nil, name: "periodic_pause", tab: nil })
expect(Sidekiq::Periodic::Loop).to have_received(:prepend).with(described_class)
expect(Sidekiq::Periodic::StaticLoop).to have_received(:prepend).with(described_class)
expect(Sidekiq::Periodic::Manager).to have_received(:prepend).with(described_class::PauseServer)
diff --git a/spec/sidekiq/belt/ent/periodic_run_spec.rb b/spec/sidekiq/belt/ent/periodic_run_spec.rb
index 7a180c2..6e6e622 100644
--- a/spec/sidekiq/belt/ent/periodic_run_spec.rb
+++ b/spec/sidekiq/belt/ent/periodic_run_spec.rb
@@ -56,7 +56,8 @@ def initialize(lid, klass, options)
expect(described_class).to have_received(:require).with("sidekiq-ent/periodic").once
expect(described_class).to have_received(:require).with("sidekiq-ent/periodic/static_loop").once
- expect(Sidekiq::Web).to have_received(:register).with(described_class::SidekiqLoopsPeriodicRun)
+ expect(Sidekiq::Web).to have_received(:register).with(described_class::SidekiqLoopsPeriodicRun,
+ { index: nil, name: "periodic_run", tab: nil })
expect(Sidekiq::Periodic::Loop).to have_received(:prepend).with(described_class)
expect(Sidekiq::Periodic::StaticLoop).to have_received(:prepend).with(described_class)
end
diff --git a/spec/sidekiq/web_action_helper_spec.rb b/spec/sidekiq/web_action_helper_spec.rb
index 0aa84ed..ec364bb 100644
--- a/spec/sidekiq/web_action_helper_spec.rb
+++ b/spec/sidekiq/web_action_helper_spec.rb
@@ -30,7 +30,7 @@ def render(_engine, content, _options = {})
end
it "replaces the page content with the block content" do
- dummy_web_action::ERB.path_info = "/"
+ dummy_web_action::ERB.full_env = { "PATH_INFO" => "/" }
expect(dummy_web_action::ERB.new("Sidekiq default").result).to eq("Sidekiq replaced twice")
end
end
@@ -41,7 +41,7 @@ def render(_engine, content, _options = {})
end
it "replaces the page content with the block content" do
- dummy_web_action::ERB.path_info = "/"
+ dummy_web_action::ERB.full_env = { "PATH_INFO" => "/" }
expect(dummy_web_action::ERB.new("Sidekiq default").result).to eq("Sidekiq default")
end
end