sidekiq-kicks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72e0c33ace102f6f4a134209c7fd09762663f7f82c4fa54fe5b57be53447f1c6
+  data.tar.gz: b285603a30cc23060265ae1a1499be62730189db88490a7c0395ff3b0e3ba3c5
+SHA512:
+  metadata.gz: 00febc0b3841748ed46995e3ef758d35a381ae35be57ed8b06e19f9567b51507d428b2617b1e2c1d7057d5df00b1e2ed9ffa7df08f78f094ad8266fa0404b8a5
+  data.tar.gz: e69274c9e3635d3cdab3ac374f3565fa5049f6f67aa9356af3c5fcd1595996b50af4d80a7ee0cf126bcda4bba9b7fd656e0102c935c58d8d36b0196d411476f6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Andrew Kodkod
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Sidekiq Kicks
+
+Extra functionality for Sidekiq's web dashboard.
+
+## Features
+
+- **Reset Buttons**: Reset processed and failed counters directly from the dashboard. Clears both total counters and historical daily stats.
+
+## Requirements
+
+- Ruby >= 3.1
+- Sidekiq >= 8.0
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "sidekiq-kicks"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+In your `config/routes.rb`:
+
+```ruby
+require "sidekiq/web"
+require "sidekiq/kicks/web"
+
+mount Sidekiq::Web, at: "/sidekiq"
+```
+
+That's it! Reset buttons (↻) will appear on the processed and failed stat boxes on the Sidekiq dashboard.
+
+## How It Works
+
+- Clicking a reset button shows a confirmation dialog
+- Upon confirmation, both the total counter and all daily historical stats are cleared
+- The page refreshes to show the updated (zeroed) counters
+
+## Development
+
+```bash
+bin/setup
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akodkod/sidekiq-kicks.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sidekiq/kicks/stats_resetter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Kicks
+    class StatsResetter
+      def reset_processed
+        reset_stat("processed")
+      end
+
+      def reset_failed
+        reset_stat("failed")
+      end
+
+      private
+
+      def reset_stat(name)
+        Sidekiq.redis do |conn|
+          conn.del("stat:#{name}")
+
+          keys = conn.keys("stat:#{name}:*")
+          conn.del(*keys) if keys.any?
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/kicks/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Kicks
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/kicks/web.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "sidekiq/web"
+require_relative "../kicks"
+
+module Sidekiq
+  module Kicks
+    module Web
+      ASSETS_PATH = File.expand_path("../../../web/assets", __dir__)
+
+      class ScriptInjector
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          status, headers, body = @app.call(env)
+
+          if html_response?(headers) && inject_path?(env)
+            body = inject_script(body, env)
+            headers.delete("Content-Length")
+          end
+
+          [status, headers, body]
+        end
+
+        private
+
+        def html_response?(headers)
+          content_type = headers["Content-Type"] || headers["content-type"]
+          content_type&.include?("text/html")
+        end
+
+        def inject_path?(env)
+          path = env["PATH_INFO"]
+          ["/", ""].include?(path)
+        end
+
+        def inject_script(body, env)
+          html = body_to_string(body)
+
+          script_path = "#{root_path(env)}kicks/kicks.js"
+          script_tag = %(<script src="#{script_path}"></script>)
+
+          html = html.sub("</body>", "#{script_tag}</body>") if html.include?("</body>")
+
+          [html]
+        end
+
+        def body_to_string(body)
+          str = +""
+          body.each { |chunk| str << chunk }
+          body.close if body.respond_to?(:close)
+          str
+        end
+
+        def root_path(env)
+          "#{env['SCRIPT_NAME']}/"
+        end
+      end
+
+      def self.registered(app)
+        app.get("/kicks/kicks.js") do
+          js_content = File.read(File.join(ASSETS_PATH, "kicks.js"))
+          [200, { "content-type" => "application/javascript" }, [js_content]]
+        end
+
+        app.post("/kicks/reset_processed") do
+          StatsResetter.new.reset_processed
+          redirect root_path.to_s
+        end
+
+        app.post("/kicks/reset_failed") do
+          StatsResetter.new.reset_failed
+          redirect root_path.to_s
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::Web.configure do |config|
+  config.use(Sidekiq::Kicks::Web::ScriptInjector)
+  config.register(
+    Sidekiq::Kicks::Web,
+    name: "kicks",
+    tab: nil,
+    index: nil,
+  )
+end

data/lib/sidekiq/kicks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require_relative "kicks/version"
+require_relative "kicks/stats_resetter"
+
+module Sidekiq
+  module Kicks
+    class Error < StandardError; end
+  end
+end

data/web/assets/kicks.js

@@ -0,0 +1,83 @@
+(function() {
+  "use strict";
+
+  function addResetButtons() {
+    // Sidekiq 8.0 uses .cards-container with article elements
+    var cardsContainer = document.querySelector(".cards-container");
+    if (!cardsContainer) return;
+
+    var cards = cardsContainer.querySelectorAll("article");
+
+    cards.forEach(function(card) {
+      var statType = null;
+
+      // Check for Sidekiq 8.0 structure (spans with specific IDs)
+      if (card.querySelector("#txtProcessed")) {
+        statType = "processed";
+      } else if (card.querySelector("#txtFailed")) {
+        statType = "failed";
+      }
+
+      if (statType) {
+        var resetBtn = document.createElement("button");
+        resetBtn.className = "kicks-reset-btn";
+        resetBtn.innerHTML = "↻";
+        resetBtn.title = "Reset " + statType + " counter";
+        resetBtn.style.cssText = "position:absolute;top:4px;right:4px;background:transparent;border:none;cursor:pointer;font-size:14px;opacity:0.5;padding:2px 6px;border-radius:3px;";
+
+        resetBtn.addEventListener("mouseenter", function() {
+          this.style.opacity = "1";
+          this.style.background = "rgba(0,0,0,0.1)";
+        });
+
+        resetBtn.addEventListener("mouseleave", function() {
+          this.style.opacity = "0.5";
+          this.style.background = "transparent";
+        });
+
+        resetBtn.addEventListener("click", function(e) {
+          e.preventDefault();
+          e.stopPropagation();
+
+          if (confirm("Are you sure you want to reset the " + statType + " counter? This will also clear historical data.")) {
+            var formData = new FormData();
+            formData.append("authenticity_token", csrfToken());
+
+            fetch(rootPath() + "kicks/reset_" + statType, {
+              method: "POST",
+              credentials: "same-origin",
+              body: formData
+            }).then(function() {
+              window.location.reload();
+            });
+          }
+        });
+
+        card.style.position = "relative";
+        card.appendChild(resetBtn);
+      }
+    });
+  }
+
+  function rootPath() {
+    var path = window.location.pathname;
+    // Match /sidekiq or /something/sidekiq
+    var sidekiqMatch = path.match(/(.*\/sidekiq)\/?/);
+    if (sidekiqMatch) {
+      return sidekiqMatch[1] + "/";
+    }
+    return "/";
+  }
+
+  function csrfToken() {
+    // Sidekiq stores CSRF token in hidden form inputs, not meta tags
+    var input = document.querySelector('input[name="authenticity_token"]');
+    return input ? input.value : "";
+  }
+
+  if (document.readyState === "loading") {
+    document.addEventListener("DOMContentLoaded", addResetButtons);
+  } else {
+    addResetButtons();
+  }
+})();

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-kicks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kodkod
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: Extends Sidekiq's web UI with useful features like reset buttons for
+  processed/failed counters
+email:
+- 678665+akodkod@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sidekiq/kicks.rb
+- lib/sidekiq/kicks/stats_resetter.rb
+- lib/sidekiq/kicks/version.rb
+- lib/sidekiq/kicks/web.rb
+- web/assets/kicks.js
+homepage: https://github.com/akodkod/sidekiq-kicks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/akodkod/sidekiq-kicks
+  source_code_uri: https://github.com/akodkod/sidekiq-kicks
+  changelog_uri: https://github.com/akodkod/sidekiq-kicks/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Extra functionality for Sidekiq's web dashboard
+test_files: []