1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
# frozen_string_literal: true
require "erb"
require "securerandom"
require "sidekiq"
require "sidekiq/api"
require "sidekiq/paginator"
require "sidekiq/web/helpers"
require "sidekiq/web/router"
require "sidekiq/web/action"
require "sidekiq/web/application"
require "sidekiq/web/csrf_protection"
require "rack/content_length"
require "rack/builder"
require "rack/static"
module Sidekiq
class Web
ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../web")
VIEWS = "#{ROOT}/views"
LOCALES = ["#{ROOT}/locales"]
LAYOUT = "#{VIEWS}/layout.erb"
ASSETS = "#{ROOT}/assets"
DEFAULT_TABS = {
"Dashboard" => "",
"Busy" => "busy",
"Queues" => "queues",
"Retries" => "retries",
"Scheduled" => "scheduled",
"Dead" => "morgue",
"Metrics" => "metrics"
}
if Gem::Version.new(Rack::RELEASE) < Gem::Version.new("3")
CONTENT_LANGUAGE = "Content-Language"
CONTENT_SECURITY_POLICY = "Content-Security-Policy"
LOCATION = "Location"
X_CASCADE = "X-Cascade"
X_CONTENT_TYPE_OPTIONS = "X-Content-Type-Options"
else
CONTENT_LANGUAGE = "content-language"
CONTENT_SECURITY_POLICY = "content-security-policy"
LOCATION = "location"
X_CASCADE = "x-cascade"
X_CONTENT_TYPE_OPTIONS = "x-content-type-options"
end
class << self
def settings
self
end
def default_tabs
DEFAULT_TABS
end
def custom_tabs
@custom_tabs ||= {}
end
alias_method :tabs, :custom_tabs
def custom_job_info_rows
@custom_job_info_rows ||= []
end
def locales
@locales ||= LOCALES
end
def views
@views ||= VIEWS
end
def enable(*opts)
opts.each { |key| set(key, true) }
end
def disable(*opts)
opts.each { |key| set(key, false) }
end
def middlewares
@middlewares ||= []
end
def use(*args, &block)
middlewares << [args, block]
end
def set(attribute, value)
send(:"#{attribute}=", value)
end
attr_accessor :app_url, :redis_pool
attr_writer :locales, :views
end
def self.inherited(child)
child.app_url = app_url
child.redis_pool = redis_pool
end
def settings
self.class.settings
end
def middlewares
@middlewares ||= self.class.middlewares
end
def use(*args, &block)
middlewares << [args, block]
end
def call(env)
env[:csp_nonce] = SecureRandom.base64(16)
app.call(env)
end
def self.call(env)
@app ||= new
@app.call(env)
end
def app
@app ||= build
end
def enable(*opts)
opts.each { |key| set(key, true) }
end
def disable(*opts)
opts.each { |key| set(key, false) }
end
def set(attribute, value)
send(:"#{attribute}=", value)
end
# Register a class as a Sidekiq Web UI extension. The class should
# provide one or more tabs which map to an index route. Options:
#
# @param extension [Class] Class which contains the HTTP actions, required
# @param name [String] the name of the extension, used to namespace assets
# @param tab [String | Array] labels(s) of the UI tabs
# @param index [String | Array] index route(s) for each tab
# @param root_dir [String] directory location to find assets, locales and views, typically `web/` within the gemfile
# @param asset_paths [Array] one or more directories under {root}/assets/{name} to be publicly served, e.g. ["js", "css", "img"]
# @param cache_for [Integer] amount of time to cache assets, default one day
#
# TODO name, tab and index will be mandatory in 8.0
#
# Web extensions will have a root `web/` directory with `locales/`, `assets/`
# and `views/` subdirectories.
def self.register(extension, name: nil, tab: nil, index: nil, root_dir: nil, cache_for: 86400, asset_paths: nil)
tab = Array(tab)
index = Array(index)
tab.zip(index).each do |tab, index|
tabs[tab] = index
end
if root_dir
locdir = File.join(root_dir, "locales")
locales << locdir if File.directory?(locdir)
if asset_paths && name
# if you have {root}/assets/{name}/js/scripts.js
# and {root}/assets/{name}/css/styles.css
# you would pass in:
# asset_paths: ["js", "css"]
# See script_tag and style_tag in web/helpers.rb
assdir = File.join(root_dir, "assets")
assurls = Array(asset_paths).map { |x| "/#{name}/#{x}" }
assetprops = {
urls: assurls,
root: assdir,
cascade: true
}
assetprops[:header_rules] = [[:all, {Rack::CACHE_CONTROL => "private, max-age=#{cache_for.to_i}"}]] if cache_for
middlewares << [[Rack::Static, assetprops], nil]
end
end
yield self if block_given?
extension.registered(WebApplication)
end
private
def build
klass = self.class
m = middlewares
rules = []
rules = [[:all, {Rack::CACHE_CONTROL => "private, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
::Rack::Builder.new do
use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],
root: ASSETS,
cascade: true,
header_rules: rules
m.each { |middleware, block| use(*middleware, &block) }
use Sidekiq::Web::CsrfProtection unless $TESTING
run WebApplication.new(klass)
end
end
end
Sidekiq::WebApplication.helpers WebHelpers
Sidekiq::WebApplication.helpers Sidekiq::Paginator
Sidekiq::WebAction.class_eval <<-RUBY, __FILE__, __LINE__ + 1
def _render
#{ERB.new(File.read(Web::LAYOUT)).src}
end
RUBY
end
|