sidekiq-web_custom 0.2.0

data/lib/sidekiq/web_custom/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module WebCustom
+    MAJOR = 0  # With backwards incompatability. Requires annoucment and update documentation
+    MINOR = 2  # With feature launch. Documentation of upgrade is useful via a changelog
+    PATCH = 0  # With minor upgrades or patcing a small bug. No changelog necessary
+    VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+    def self.get_version
+      puts VERSION
+    end
+  end
+end

data/lib/sidekiq/web_custom/web_action.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module WebCustom
+    module WebAction
+      OVERWRITE_VALUE = '__sidekiq_web_custom_replacement__'
+
+      def self.local_erbs
+        @local_erbs ||= "#{File.expand_path("#{File.dirname(__FILE__)}/..")}/views"
+      end
+
+      def erb(content, options = {})
+        if content.is_a?(Symbol) && !Sidekiq::WebCustom.local_erb_mapping[content].nil?
+          unless respond_to?(:"_erb_#{content}")
+            file_name = Sidekiq::WebCustom.local_erb_mapping[content]
+            src = ERB.new(src_file_replacement(content)).src
+            WebAction.class_eval("def _erb_#{content}\n#{src}\n end", file_name)
+          end
+        end
+        super(content, options)
+      end
+
+      def src_file_replacement(content)
+        file_name = Sidekiq::WebCustom.local_erb_mapping[content]
+        contents = File.read(file_name)
+        begin
+          available_actions = Sidekiq::WebCustom.config.public_send("actions_for_#{content}")
+        rescue NoMethodError
+          available_actions = []
+        end
+        actions = available_actions.map do |action, action_path|
+          File.read(action_path)
+        end.join(" ")
+        contents.gsub(OVERWRITE_VALUE, actions)
+      end
+    end
+  end
+end

data/lib/sidekiq/web_custom/web_app.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module WebCustom
+    class WebApp
+      MAPPED_TYPE = {
+        retries: RetrySet,
+        scheduled: ScheduledSet,
+      }
+      def self.registered(app)
+        app.post '/queues/drain/:name' do
+          timeout_params = {
+            warn: Sidekiq::WebCustom.config.warn_execution_time,
+            timeout: Sidekiq::WebCustom.config.max_execution_time,
+            proc: ->(thread, seconds) { thread[Sidekiq::WebCustom::BREAK_BIT] = 1; Sidekiq.logger.warn "set bit #{thread[Sidekiq::WebCustom::BREAK_BIT]}" }
+          }
+          Thread.current[Sidekiq::WebCustom::BREAK_BIT] = nil
+          Sidekiq::WebCustom::Timeout.timeout(timeout_params) do
+            Sidekiq::Queue.new(params[:name]).drain(max: Sidekiq::WebCustom.config.drain_rate)
+          end
+          redirect_with_query("#{root_path}queues")
+        end
+
+        app.post '/job/delete' do
+          parsed = parse_params(params['entry.score'])
+
+          klass = MAPPED_TYPE[params['entry.type'].to_sym]
+          job = klass.new.fetch(*parsed)&.first
+
+          job&.delete
+          redirect_with_query("#{root_path}scheduled")
+        end
+
+        app.post '/job/execute' do
+          parsed = parse_params(params['entry.score'])
+
+          klass = MAPPED_TYPE[params['entry.type'].to_sym]
+          job = klass.new.fetch(*parsed)&.first
+
+          status = job&.execute
+          redirect_with_query("#{root_path}#{params['entry.type']}")
+        end
+      end
+    end
+  end
+end

data/sidekiq-web_custom.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq/web_custom/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-web_custom"
+  spec.version       = Sidekiq::WebCustom::VERSION
+  spec.authors       = ["Matt Taylor"]
+  spec.email         = ["mattius.taylor@gmail.com"]
+
+  spec.summary       = "This gem adds on custom capabilities to the Sidekiq Web UI"
+  spec.description   = "Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/matt-taylor/sidekiq-web_custom"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/matt-taylor/sidekiq-web_custom"
+  spec.metadata["changelog_uri"] = "https://github.com/matt-taylor/sidekiq-web_custom/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq', '>= 6.0'
+  spec.add_dependency 'timeoutable'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-web_custom
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Matt Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: timeoutable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- mattius.taylor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/all_workers
+- bin/bundle
+- bin/publish
+- bin/publish_git
+- bin/publish_ruby_gems
+- bin/rails
+- bin/sidekiq
+- bin/sidekiqmon
+- docker-compose.yml
+- dummy_rails/.rspec
+- dummy_rails/app/assets/config/manifest.js
+- dummy_rails/app/controllers/application_controller.rb
+- dummy_rails/app/helpers/application_helper.rb
+- dummy_rails/app/views/layouts/application.html.erb
+- dummy_rails/app/views/layouts/mailer.html.erb
+- dummy_rails/app/workers/exclude_hard_worker.rb
+- dummy_rails/app/workers/exclude_lazy_worker.rb
+- dummy_rails/app/workers/exclude_random_raise_worker.rb
+- dummy_rails/app/workers/hard_worker.rb
+- dummy_rails/app/workers/lazy_worker.rb
+- dummy_rails/app/workers/random_raise_worker.rb
+- dummy_rails/app/workers/taco_worker.rb
+- dummy_rails/app/workers/tostada_worker.rb
+- dummy_rails/bin/rspec
+- dummy_rails/config.ru
+- dummy_rails/config/application.rb
+- dummy_rails/config/boot.rb
+- dummy_rails/config/environment.rb
+- dummy_rails/config/environments/development.rb
+- dummy_rails/config/environments/production.rb
+- dummy_rails/config/environments/test.rb
+- dummy_rails/config/initializers/assets.rb
+- dummy_rails/config/initializers/cookies_serializer.rb
+- dummy_rails/config/initializers/filter_parameter_logging.rb
+- dummy_rails/config/initializers/sidekiq-web_custom.rb
+- dummy_rails/config/initializers/wrap_parameters.rb
+- dummy_rails/config/locales/en.yml
+- dummy_rails/config/puma.rb
+- dummy_rails/config/routes.rb
+- dummy_rails/config/secrets.yml
+- dummy_rails/config/spring.rb
+- dummy_rails/config/storage.yml
+- dummy_rails/package.json
+- dummy_rails/spec/spec_helper.rb
+- lib/load_random_workers.rb
+- lib/sidekiq/views/actions/queues/delete.erb
+- lib/sidekiq/views/actions/queues/drain_queue.erb
+- lib/sidekiq/views/actions/queues/pause.erb
+- lib/sidekiq/views/actions/retries/delete.erb
+- lib/sidekiq/views/actions/retries/execute.erb
+- lib/sidekiq/views/actions/scheduled/delete.erb
+- lib/sidekiq/views/actions/scheduled/execute.erb
+- lib/sidekiq/views/queues.erb
+- lib/sidekiq/views/retries.erb
+- lib/sidekiq/views/scheduled.erb
+- lib/sidekiq/web_custom.rb
+- lib/sidekiq/web_custom/configuration.rb
+- lib/sidekiq/web_custom/job.rb
+- lib/sidekiq/web_custom/processor.rb
+- lib/sidekiq/web_custom/queue.rb
+- lib/sidekiq/web_custom/timeout.rb
+- lib/sidekiq/web_custom/version.rb
+- lib/sidekiq/web_custom/web_action.rb
+- lib/sidekiq/web_custom/web_app.rb
+- sidekiq-web_custom.gemspec
+homepage: https://github.com/matt-taylor/sidekiq-web_custom
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matt-taylor/sidekiq-web_custom
+  source_code_uri: https://github.com/matt-taylor/sidekiq-web_custom
+  changelog_uri: https://github.com/matt-taylor/sidekiq-web_custom/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: This gem adds on custom capabilities to the Sidekiq Web UI
+test_files: []