sidekiq-web_custom 0.2.0

data/dummy_rails/config/environments/test.rb

@@ -0,0 +1,40 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/dummy_rails/config/initializers/assets.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+# Add Yarn node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join('node_modules')
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/dummy_rails/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/dummy_rails/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/dummy_rails/config/initializers/sidekiq-web_custom.rb

@@ -0,0 +1,3 @@
+# require 'sidekiq/web_custom'
+
+Sidekiq::WebCustom.configure

data/dummy_rails/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/dummy_rails/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/dummy_rails/config/puma.rb

@@ -0,0 +1,37 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/dummy_rails/config/routes.rb

@@ -0,0 +1,5 @@
+require 'sidekiq/web_custom'
+
+Rails.application.routes.draw do
+   mount Sidekiq::Web => '/'
+end

data/dummy_rails/config/secrets.yml

@@ -0,0 +1,5 @@
+development:
+  secret_key_base: this-is-not-a-secure-secret
+
+test:
+  secret_key_base: this-is-a-better-secret1

data/dummy_rails/config/spring.rb

@@ -0,0 +1,5 @@
+%w[
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+].each { |path| Spring.watch(path) }

data/dummy_rails/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket
+
+# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/dummy_rails/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "dummy_rails",
+  "private": true,
+  "dependencies": {}
+}

data/dummy_rails/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ice_age/freeze' # freeze ENV
+require 'null_logger'
+require 'pry'
+require 'simplecov'
+
+
+SimpleCov.start unless SimpleCov.running
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # allow 'fit' examples
+  config.filter_run_when_matching :focus
+
+  config.around(:each) do |example|
+    # only let Timecop operate in blocks
+    Timecop.safe_mode = true
+
+    # Freeze time by default
+    Timecop.freeze do
+      example.run
+    end
+  end
+
+  # remove stdout logging when running tests
+  Sidekiq.logger = NullLogger.new
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/lib/load_random_workers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'byebug'
+
+worker_files = Dir[Rails.root.join('app','workers','**','*_worker.rb').to_s]
+require_workers = worker_files.map { |path| File.basename(path, '.rb') }
+require_workers.each do |worker|
+  require worker
+end
+
+workers = ObjectSpace.each_object(Class).select do |klass|
+  klass.included_modules.include?(Sidekiq::Worker)
+end
+
+
+while true
+  workers.each do |worker|
+    sleep(0.5)
+    puts worker.perform_async
+    sleep(0.5)
+    puts worker.perform_at((rand*10).hours.from_now)
+  end
+end
+
+Dir.glob["#{APP_PATH}/app/workers/**/*_worker.rb"]

data/lib/sidekiq/views/actions/queues/delete.erb

@@ -0,0 +1,12 @@
+<form action="<%=root_path %>queues/<%= CGI.escape(queue.name) %>" method="post" style="display: inline">
+  <%= csrf_tag %>
+  <input class="btn btn-danger btn-xs" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSureDeleteQueue', :queue => h(queue.name)) %>" />
+
+  <% if Sidekiq.pro? %>
+    <% if queue.paused? %>
+      <input class="btn btn-danger btn-xs" type="submit" name="unpause" value="<%= t('Unpause') %>" />
+    <% else %>
+      <input class="btn btn-danger btn-xs" type="submit" name="pause" value="<%= t('Pause') %>" />
+    <% end %>
+  <% end %>
+</form>

data/lib/sidekiq/views/actions/queues/drain_queue.erb

@@ -0,0 +1,4 @@
+<form onclick="_sidekiq_web_block_screen('Draining queue. Please Wait...')" action="<%=root_path %>queues/drain/<%= CGI.escape(queue.name) %>" method="post" style="display: inline">
+  <%= csrf_tag %>
+  <input class="btn btn-warn btn-xs" type="submit" name="drain_queue" value="Drain <%= Sidekiq::WebCustom.config.drain_rate %>" />
+</form>

data/lib/sidekiq/views/actions/queues/pause.erb

@@ -0,0 +1,13 @@
+<% if Sidekiq.pro? %>
+  <% if queue.paused? %>
+    <form action="<%=root_path %>queues/<%= CGI.escape(queue.name) %>/unpause" method="post" style="display: inline">
+      <%= csrf_tag %>
+      <input class="btn btn-success btn-xs" type="submit" name="unpause" value="<%= t('Unpause') %>" style="background-image: none" />
+    </form>
+  <% else %>
+    <form action="<%=root_path %>queues/<%= CGI.escape(queue.name) %>/pause" method="post" style="display: inline">
+      <%= csrf_tag %>
+      <input class="btn btn-warning btn-xs" type="submit" name="pause" value="<%= t('Pause') %>" style="background-image: none" />
+    </form>
+  <% end %>
+<% end %>

data/lib/sidekiq/views/actions/retries/delete.erb

@@ -0,0 +1,5 @@
+<form onclick="_sidekiq_web_block_screen('Deleting Job. Please Wait...')" action="<%=root_path %>job/delete" method="post" style="display: inline">
+  <%= csrf_tag %>
+  <input type="hidden" id="individual_job" name="entry.score" value='<%= job_params(entry.item, entry.score) %>' >
+  <input class="btn btn-danger btn-xs" type="submit" name='delete_job' value='Delete Job' />
+</form>

data/lib/sidekiq/views/actions/retries/execute.erb

@@ -0,0 +1,7 @@
+<form onclick="_sidekiq_web_block_screen('Executing Job. Please Wait...')" action="<%=root_path %>job/execute" method="post" style="display: inline">
+  <%= csrf_tag %>
+  <input type="hidden" id="execute_job" name="entry.score" value='<%= job_params(entry.item, entry.score) %>' >
+  <input type="hidden" id="execute_job_type" name="entry.type" value='<%= request.url.split('/')[-1] %>' >
+  <input class="btn btn-warn btn-xs" type="submit" name='execute_job' value='Execute Job' />
+</form>
+

data/lib/sidekiq/views/actions/scheduled/delete.erb

@@ -0,0 +1,5 @@
+<form onclick="_sidekiq_web_block_screen('Deleting Job. Please Wait...')" action="<%=root_path %>job/delete" method="post" style="display: inline">
+  <%= csrf_tag %>
+  <input type="hidden" id="individual_job" name="entry.score" value='<%= job_params(entry.item, entry.score) %>' >
+  <input class="btn btn-danger btn-xs" type="submit" name='delete_job' value='Delete Job' />
+</form>

data/lib/sidekiq/views/actions/scheduled/execute.erb

@@ -0,0 +1,7 @@
+<form onclick="_sidekiq_web_block_screen('Executing Job. Please Wait...')" action="<%=root_path %>job/execute" method="post" style="display: inline">
+  <%= csrf_tag %>
+  <input type="hidden" id="execute_job" name="entry.score" value='<%= job_params(entry.item, entry.score) %>' >
+  <input type="hidden" id="execute_job_type" name="entry.type" value='<%= request.url.split('/')[-1] %>' >
+  <input class="btn btn-warn btn-xs" type="submit" name='execute_job' value='Execute Job' />
+</form>
+

data/lib/sidekiq/views/queues.erb

@@ -0,0 +1,64 @@
+<h3><%= t('Queues') %></h3>
+
+<div class="table_container">
+  <table class="queues table table-hover table-bordered table-striped">
+    <thead>
+      <th><%= t('Queue') %></th>
+      <th><%= t('Size') %></th>
+      <th><%= t('Latency') %></th>
+      <th><%= t('Actions') %></th>
+    </thead>
+    <% @queues.each do |queue| %>
+      <tr>
+        <td>
+          <a href="<%= root_path %>queues/<%= CGI.escape(queue.name) %>"><%= h queue.name %></a>
+          <% if queue.paused? %>
+            <span class="label label-danger"><%= t('Paused') %></span>
+          <% end %>
+        </td>
+        <td><%= number_with_delimiter(queue.size) %> </td>
+        <td><% queue_latency = queue.latency %><%= number_with_delimiter(queue_latency.round(2)) %><%= (queue_latency < 60) ? '' : " (#{relative_time(Time.at(Time.now.to_f - queue_latency))})" %> </td>
+
+        <td class="delete-confirm">
+          __sidekiq_web_custom_replacement__
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>
+
+<div id="_sidekiq_web_block_screen_div_" style='display: none'>
+  <div id="_sidekiq_web_block_screen_text_"></div>
+</div>
+
+<script type="text/javascript">
+  function _sidekiq_web_block_screen(text) {
+    document.getElementById('_sidekiq_web_block_screen_text_').innerHTML = text
+    document.getElementById('_sidekiq_web_block_screen_div_').style.display = "block";
+  }
+</script>
+
+<style>
+#_sidekiq_web_block_screen_div_ {
+  position: fixed;
+  display: none;
+  width: 100%;
+  height: 100%;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background-color: rgba(0,0,0,0.8);
+  z-index: 2;
+}
+
+#_sidekiq_web_block_screen_text_{
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  font-size: 50px;
+  color: white;
+  transform: translate(-50%,-50%);
+  -ms-transform: translate(-50%,-50%);
+}
+</style>

data/lib/sidekiq/views/retries.erb

@@ -0,0 +1,123 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3><%= t('Retries') %></h3>
+  </div>
+  <% if @retries.size > 0 && @total_size > @count %>
+    <div class="col-sm-4">
+      <%= erb :_paging, locals: { url: "#{root_path}retries" } %>
+    </div>
+  <% end %>
+  <%= filtering('retries') %>
+</header>
+
+<% if @retries.size > 0 %>
+  <form action="<%= root_path %>retries" method="post">
+    <%= csrf_tag %>
+    <div class="table_container">
+      <table class="table table-striped table-bordered">
+        <thead>
+          <tr>
+            <th class="table-checkbox checkbox-column">
+              <label>
+                <input type="checkbox" class="check_all" />
+              </label>
+            </th>
+            <th><%= t('NextRetry') %></th>
+            <th><%= t('RetryCount') %></th>
+            <th><%= t('Queue') %></th>
+            <th><%= t('Job') %></th>
+            <th><%= t('Arguments') %></th>
+            <th><%= t('Error') %></th>
+            <th> Actions </th>
+          </tr>
+        </thead>
+        <% @retries.each do |entry| %>
+          <tr>
+            <td class="table-checkbox">
+              <label>
+                <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' />
+              </label>
+            </td>
+            <td>
+              <a href="<%= root_path %>retries/<%= job_params(entry.item, entry.score) %>"><%= relative_time(entry.at) %></a>
+            </td>
+            <td><%= entry['retry_count'] %></td>
+            <td>
+              <a href="<%= root_path %>queues/<%= entry.queue %>"><%= entry.queue %></a>
+            </td>
+            <td>
+              <%= entry.display_class %>
+              <%= display_tags(entry, "retries") %>
+            </td>
+            <td>
+              <div class="args"><%= display_args(entry.display_args) %></div>
+            </td>
+            <td>
+              <div><%= h truncate("#{entry['error_class']}: #{entry['error_message']}", 200) %></div>
+            </td>
+            <td>
+              __sidekiq_web_custom_replacement__
+            </td>
+          </tr>
+        <% end %>
+      </table>
+    </div>
+    <input class="btn btn-primary btn-xs pull-left flip" type="submit" name="retry" value="<%= t('RetryNow') %>" />
+    <input class="btn btn-danger btn-xs pull-left flip" type="submit" name="delete" value="<%= t('Delete') %>" />
+    <input class="btn btn-danger btn-xs pull-left flip" type="submit" name="kill" value="<%= t('Kill') %>" />
+  </form>
+
+  <% unfiltered? do %>
+    <form action="<%= root_path %>retries/all/delete" method="post">
+      <%= csrf_tag %>
+      <input class="btn btn-danger btn-xs pull-right flip" type="submit" name="delete" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
+    <form action="<%= root_path %>retries/all/retry" method="post">
+      <%= csrf_tag %>
+      <input class="btn btn-danger btn-xs pull-right flip" type="submit" name="retry" value="<%= t('RetryAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
+    <form action="<%= root_path %>retries/all/kill" method="post">
+      <%= csrf_tag %>
+      <input class="btn btn-danger btn-xs pull-right flip" type="submit" name="kill" value="<%= t('KillAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
+  <% end %>
+
+<% else %>
+  <div class="alert alert-success"><%= t('NoRetriesFound') %></div>
+<% end %>
+
+<div id="_sidekiq_web_block_screen_div_" style='display: none'>
+  <div id="_sidekiq_web_block_screen_text_"></div>
+</div>
+
+<script type="text/javascript">
+  function _sidekiq_web_block_screen(text) {
+    document.getElementById('_sidekiq_web_block_screen_text_').innerHTML = text
+    document.getElementById('_sidekiq_web_block_screen_div_').style.display = "block";
+  }
+</script>
+
+<style>
+#_sidekiq_web_block_screen_div_ {
+  position: fixed;
+  display: none;
+  width: 100%;
+  height: 100%;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background-color: rgba(0,0,0,0.8);
+  z-index: 2;
+}
+
+#_sidekiq_web_block_screen_text_{
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  font-size: 50px;
+  color: white;
+  transform: translate(-50%,-50%);
+  -ms-transform: translate(-50%,-50%);
+}
+</style>