sidekiq-unique-jobs 4.0.18 → 7.1.28

data/lib/sidekiq_unique_jobs/version_check.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Handles checking if a version is compliant with given constraint
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class VersionCheck
+    PATTERN = /(?<operator1>[<>=]+)?\s?(?<version1>(\d+.?)+)(\s+&&\s+)?(?<operator2>[<>=]+)?\s?(?<version2>(\d+.?)+)?/m.freeze # rubocop:disable Layout/LineLength, Lint/MixedRegexpCaptureTypes
+
+    #
+    # Checks if a version is constraint is satisfied
+    #
+    # @example A satisfied constraint
+    #   VersionCheck.satisfied?("5.0.0", ">= 4.0.0") #=> true
+    #
+    # @example An unsatisfied constraint
+    #   VersionCheck.satisfied?("5.0.0", "<= 4.0.0") #=> false
+    #
+    #
+    # @param [String] version a version string `5.0.0`
+    # @param [String] constraint a version constraint `>= 5.0.0 <= 5.1.1`
+    #
+    # @return [true, false] <description>
+    #
+    def self.satisfied?(version, constraint)
+      new(version, constraint).satisfied?
+    end
+
+    #
+    # Checks if a version is constraint is unfulfilled
+    #
+    # @example A satisfied constraint
+    #   VersionCheck.unfulfilled?("5.0.0", ">= 4.0.0") #=> false
+    #
+    # @example An unfulfilled constraint
+    #   VersionCheck.unfulfilled?("5.0.0", "<= 4.0.0") #=> true
+    #
+    #
+    # @param [String] version a version string `5.0.0`
+    # @param [String] constraint a version constraint `>= 5.0.0 <= 5.1.1`
+    #
+    # @return [true, false] <description>
+    #
+    def self.unfulfilled?(version, constraint)
+      !satisfied?(version, constraint)
+    end
+
+    #
+    # @!attribute [r] version
+    #   @return [String] a version string `5.0.0`
+    attr_reader :version
+    #
+    # @!attribute [r] match
+    #   @return [String] a version constraint `>= 5.0.0 <= 5.1.1`
+    attr_reader :match
+
+    #
+    # Initialize a new VersionCheck instance
+    #
+    # @param [String] version a version string `5.0.0`
+    # @param [String] constraint a version constraint `>= 5.0.0 <= 5.1.1`
+    #
+    def initialize(version, constraint)
+      @version   = Gem::Version.new(version)
+      @match     = PATTERN.match(constraint.to_s)
+
+      raise ArgumentError, "A version (eg. 5.0) is required to compare against" unless @version
+      raise ArgumentError, "At least one operator and version is required (eg. >= 5.1)" unless constraint
+    end
+
+    #
+    # Checks if all constraints were met
+    #
+    #
+    # @return [true,false]
+    #
+    def satisfied?
+      constraints.all? do |expected, operator|
+        compare(expected, operator)
+      end
+    end
+
+    private
+
+    def compare(expected, operator)
+      Gem::Version.new(version).send(operator, Gem::Version.new(expected))
+    end
+
+    def constraints
+      result = { version_one => operator_one }
+      result[version_two] = operator_two if version_two
+
+      result
+    end
+
+    def version_one
+      match[:version1]
+    end
+
+    def operator_one
+      match[:operator1]
+    end
+
+    def version_two
+      match[:version2]
+    end
+
+    def operator_two
+      match[:operator2]
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Web
+    #
+    # Provides view helpers for the Sidekiq::Web extension
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Helpers
+      #
+      # @return [String] the path to gem specific views
+      VIEW_PATH    = File.expand_path("../web/views", __dir__).freeze
+      #
+      # @return [Array<String>] safe params
+      SAFE_CPARAMS = %w[
+        filter count cursor prev_cursor poll direction
+      ].freeze
+
+      extend self
+
+      #
+      # Opens a template file contained within this gem
+      #
+      # @param [Symbol] name the name of the template
+      #
+      # @return [String] the file contents of the template
+      #
+      def unique_template(name)
+        File.read(unique_filename(name))
+      end
+
+      #
+      # Construct template file name
+      #
+      # @param [Symbol] name the name of the template
+      #
+      # @return [String] the full name of the file
+      #
+      def unique_filename(name)
+        File.join(VIEW_PATH, "#{name}.erb")
+      end
+
+      #
+      # The collection of digests
+      #
+      #
+      # @return [SidekiqUniqueJobs::Digests] the sorted set with digests
+      #
+      def digests
+        @digests ||= SidekiqUniqueJobs::Digests.new
+      end
+
+      #
+      # The collection of digests
+      #
+      #
+      # @return [SidekiqUniqueJobs::ExpiringDigests] the sorted set with expiring digests
+      #
+      def expiring_digests
+        @expiring_digests ||= SidekiqUniqueJobs::ExpiringDigests.new
+      end
+
+      #
+      # The collection of changelog entries
+      #
+      #
+      # @return [SidekiqUniqueJobs::Digests] the sorted set with digests
+      #
+      def changelog
+        @changelog ||= SidekiqUniqueJobs::Changelog.new
+      end
+
+      #
+      # Creates url safe parameters
+      #
+      # @param [Hash] options the key/value to parameterize
+      #
+      # @return [String] a url safe parameter string
+      #
+      def cparams(options)
+        stringified_options = options.transform_keys(&:to_s)
+        params.merge(stringified_options).map do |key, value|
+          next unless SAFE_CPARAMS.include?(key)
+
+          "#{key}=#{CGI.escape(value.to_s)}"
+        end.compact.join("&")
+      end
+
+      #
+      # Used to avoid incompatibility with older sidekiq versions
+      #
+      #
+      # @param [Array] args the unique arguments to display
+      # @param [Integer] truncate_after_chars
+      #
+      # @return [String] a string containing all non-truncated arguments
+      #
+      def display_lock_args(args, truncate_after_chars = 2000)
+        return "Invalid job payload, args is nil" if args.nil?
+        return "Invalid job payload, args must be an Array, not #{args.class.name}" unless args.is_a?(Array)
+
+        begin
+          args.map do |arg|
+            h(truncate(to_display(arg), truncate_after_chars))
+          end.join(", ")
+        rescue StandardError
+          "Illegal job arguments: #{h args.inspect}"
+        end
+      end
+
+      #
+      # Redirect to with falback
+      #
+      # @param [String] subpath the path to redirect to
+      #
+      # @return a redirect to the new subpath
+      #
+      def redirect_to(subpath)
+        if respond_to?(:to)
+          # Sinatra-based web UI
+          redirect to(subpath)
+        else
+          # Non-Sinatra based web UI (Sidekiq 4.2+)
+          redirect "#{root_path}#{subpath}"
+        end
+      end
+
+      #
+      # Gets a relative time as html
+      #
+      # @param [Time] time an instance of Time
+      #
+      # @return [String] a html safe string with relative time information
+      #
+      def relative_time(time)
+        stamp = time.getutc.iso8601
+        %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
+      end
+
+      #
+      # Gets a relative time as html without crashing
+      #
+      # @param [Float, Integer, String, Time] time a representation of a timestamp
+      #
+      # @return [String] a html safe string with relative time information
+      #
+      def safe_relative_time(time)
+        time = parse_time(time)
+
+        relative_time(time)
+      end
+
+      #
+      # Constructs a time from a number of different types
+      #
+      # @param [Float, Integer, String, Time] time a representation of a timestamp
+      #
+      # @return [Time]
+      #
+      def parse_time(time)
+        case time
+        when Time
+          time
+        when Integer, Float
+          Time.at(time)
+        else
+          Time.parse(time.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/web/views/_paging.erb

@@ -0,0 +1,10 @@
+<ul class="pagination pull-right flip">
+  <% if @prev_cursor %>
+  <li>
+    <a href="<%= url %>?<%= cparams(filter: @filter, cursor: @prev_cursor, prev_cursor: @next_cursor) %>">Previous <%= @count %></a>
+  </li>
+  <% end %>
+  <li>
+    <a href="<%= url %>?<%= cparams(filter: @filter, cursor: @next_cursor, prev_cursor: @current_cursor) %>">Next <%= @count %></a>
+  </li>
+</ul>

data/lib/sidekiq_unique_jobs/web/views/changelogs.erb

@@ -0,0 +1,54 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+    <%= t('Changelog Entries') %>
+    </h3>
+  </div>
+  <form action="<%= root_path %>changelogs" class="form form-inline" method="get">
+    <%= csrf_tag %>
+    <input name="filter" class="form-control" type="text" value="<%= @filter %>" />
+    <button class="btn btn-default" type="submit">
+    <%= t('Filter') %>
+    </button>
+  </form>
+  <% if @changelogs.any? && @total_size > @count.to_i %>
+  <div class="col-sm-4">
+    <%= erb unique_template(:_paging), locals: { url: "#{root_path}changelogs" } %>
+  </div>
+  <% end %>
+</header>
+<% if @changelogs.any? %>
+<div class="table_container">
+  <form action="<%= root_path %>changelogs/delete_all" method="get">
+    <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+  </form>
+  <br/>
+  <table class="table table-striped table-bordered table-hover">
+    <thead>
+      <tr>
+        <th><%= t('Time') %></th>
+        <th><%= t('Digest') %></th>
+        <th><%= t('Script') %></th>
+        <th><%= t('JID') %></th>
+        <th><%= t('Prev JID') %></th>
+        <th><%= t('Message') %></th>
+      </tr>
+    </thead>
+    <tbody>
+    <% @changelogs.each do |changelog| %>
+      <tr  class="changelog-row">
+        <td><%= safe_relative_time(changelog["time"]) %></td>
+        <td><%= changelog["digest"] %></td>
+        <td><%= changelog["script"] %></td>
+        <td><%= changelog["job_id"] %></td>
+        <td><%= changelog["prev_jid"] %></td>
+        <td><%= changelog["message"] %></th>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+  <form action="<%= root_path %>changelogs/delete_all" method="get">
+    <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+  </form>
+</div>
+<% end %>

data/lib/sidekiq_unique_jobs/web/views/lock.erb

@@ -0,0 +1,108 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+    <%= t('Lock information') %> <a class="btn btn-default btn-xs" href="<%= root_path %>locks"><%= t('GoBack') %></a>
+    </h3>
+  </div>
+  <div class="col-sm-7 table-responsive">
+    <% if @lock.info.none? %>
+    <h3>No Lock Information Available</h3>
+    <p>To use it turn the following setting on:
+      <code>SidekiqUniqueJobs.config.lock_info = true</code>
+    </p>
+    <% else %>
+    <table class="table table-striped table-bordered table-white table-hover">
+      <caption>Information about lock</caption>
+      <tbody>
+        <tr>
+          <th scope=row><%= t('Worker') %></td>
+          <td><%= @lock.info["worker"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Queue') %></td>
+          <td><%= @lock.info["queue"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Limit') %></td>
+          <td><%= @lock.info["limit"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('TTL') %></td>
+          <td><%= @lock.info["ttl"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Timeout') %></td>
+          <td><%= @lock.info["timeout"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Args') %></td>
+          <td>
+            <code class="code-wrap">
+              <!-- We don't want to truncate any job arguments when viewing a single job's status page -->
+              <div class="args-extended"><%= display_lock_args(@lock.info["lock_args"], nil) %></div>
+            </code>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <% end %>
+  </div>
+</header>
+<div class="row">
+  <div class="col-sm-6 table-responsive">
+    <table class="table table-striped table-bordered table-hover">
+      <caption>Digest: <strong class="text-muted"><%= @lock.key %></strong></caption>
+      <thead>
+        <tr>
+          <th scope="col"><%= t('Locked JIDs') %></th>
+          <th scope="col"><%= t('Since') %></th>
+          <th scope="col"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @lock.locked_jids(with_values: true).each do |job_id, time| %>
+        <tr>
+          <td><%= job_id %></td>
+          <td><%= safe_relative_time(time.to_f) %></td>
+          <td>
+            <form action="<%= root_path %>locks/<%= @lock.key %>/jobs/<%= job_id %>/delete" method="get">
+              <%= csrf_tag %>
+              <input class="btn btn-danger btn-xs flip" type="submit" name="delete" value="<%= t('Unlock') %>" data-confirm="<%= t('AreYouSure') %>" />
+            </form>
+          </td>
+        </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  <div class="col-sm-6 table-responsive">
+    <% if @lock.changelog.count.positive? %>
+    <table class="table table-striped table-bordered table-hover">
+      <caption>Changelogs</caption>
+      <thead>
+        <tr>
+          <th scope="col"><%= t('At') %></th>
+          <th scope="col"><%= t('JID') %></th>
+          <th scope="col"><%= t('Message') %></th>
+          <th scope="col"><%= t('Script') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @lock.changelogs.each do |entry| %>
+        <tr>
+          <td scope="row"><%= safe_relative_time(entry["time"].to_f) %></td>
+          <td><%= entry["job_id"] %></td>
+          <td><%= entry["message"] %></td>
+          <td><%= entry["script"] %></td>
+        </tr>
+        <% end %>
+      </tbody>
+    </table>
+    <% end %>
+  </div>
+</div>
+<form action="<%= root_path %>locks/<%= @lock.key %>/delete" method="get">
+  <%= csrf_tag %>
+  <a class="btn btn-default btn-xs" href="<%= root_path %>locks"><%= t('GoBack') %></a>
+  <input class="btn btn-danger btn-xs flip" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+</form>

data/lib/sidekiq_unique_jobs/web/views/locks.erb

@@ -0,0 +1,54 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+    <%= t('Locks') %>
+    </h3>
+  </div>
+  <form action="<%= root_path %>locks" class="form form-inline" method="get">
+    <%= csrf_tag %>
+    <input name="filter" class="form-control" type="text" value="<%= @filter %>" />
+    <button class="btn btn-default" type="submit">
+    <%= t('Filter') %>
+    </button>
+  </form>
+  <% if @locks.any? && @total_size > @count %>
+  <div class="col-sm-4">
+    <%= erb unique_template(:_paging), locals: { url: "#{root_path}locks" } %>
+  </div>
+  <% end %>
+</header>
+<% if @locks.any? %>
+<div class="table_container">
+  <table class="table table-striped table-bordered table-hover">
+    <thead>
+      <tr>
+        <th><%= t('Delete') %></th>
+        <th><%= t('Digest') %></th>
+        <th><%= t('Lock') %></th>
+        <th><%= t('Locks') %></th>
+        <th><%= t('Since') %></th>
+      </tr>
+    </thead>
+    <% @locks.each do |lock| %>
+    <tbody>
+      <tr class="lock-row">
+        <td>
+          <form action="<%= root_path %>locks/<%= lock.key %>/delete" method="get">
+            <%= csrf_tag %>
+            <input name="lock" value="<%= h lock.key %>" type="hidden" />
+            <input class="btn btn-danger btn-xs" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+          </form>
+        </td>
+        <td><a href="<%= root_path %>locks/<%= lock.key %>"><%= lock.key %></a></td>
+        <td><%= lock.info["lock"] %></td>
+        <td><%= lock.locked.count %></td>
+        <td><%= safe_relative_time(lock.created_at) %></td>
+      </tr>
+    </tbody>
+    <% end %>
+</table>
+<form action="<%= root_path %>locks/delete_all" method="get">
+  <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+</form>
+</div>
+<% end %>

data/lib/sidekiq_unique_jobs/web.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "web/helpers"
+
+module SidekiqUniqueJobs
+  # Utility module to help manage unique keys in redis.
+  # Useful for deleting keys that for whatever reason wasn't deleted
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  module Web
+    def self.registered(app) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      app.helpers do
+        include Web::Helpers
+      end
+
+      app.get "/changelogs" do
+        @filter         = params[:filter] || "*"
+        @filter         = "*" if @filter == ""
+        @count          = (params[:count] || 100).to_i
+        @current_cursor = params[:cursor]
+        @prev_cursor    = params[:prev_cursor]
+        @total_size, @next_cursor, @changelogs = changelog.page(
+          cursor: @current_cursor,
+          pattern: @filter,
+          page_size: @count,
+        )
+
+        erb(unique_template(:changelogs))
+      end
+
+      app.get "/changelogs/delete_all" do
+        changelog.clear
+        redirect_to :changelogs
+      end
+
+      app.get "/locks" do
+        @filter         = params[:filter] || "*"
+        @filter         = "*" if @filter == ""
+        @count          = (params[:count] || 100).to_i
+        @current_cursor = params[:cursor]
+        @prev_cursor    = params[:prev_cursor]
+
+        @total_size, @next_cursor, @locks = digests.page(
+          cursor: @current_cursor,
+          pattern: @filter,
+          page_size: @count,
+        )
+
+        erb(unique_template(:locks))
+      end
+
+      app.get "/expiring_locks" do
+        @filter         = params[:filter] || "*"
+        @filter         = "*" if @filter == ""
+        @count          = (params[:count] || 100).to_i
+        @current_cursor = params[:cursor]
+        @prev_cursor    = params[:prev_cursor]
+
+        @total_size, @next_cursor, @locks = expiring_digests.page(
+          cursor: @current_cursor,
+          pattern: @filter,
+          page_size: @count,
+        )
+
+        erb(unique_template(:locks))
+      end
+
+      app.get "/locks/delete_all" do
+        digests.delete_by_pattern("*", count: digests.count)
+        expiring_digests.delete_by_pattern("*", count: digests.count)
+        redirect_to :locks
+      end
+
+      app.get "/locks/:digest" do
+        @digest = params[:digest]
+        @lock   = SidekiqUniqueJobs::Lock.new(@digest)
+
+        erb(unique_template(:lock))
+      end
+
+      app.get "/locks/:digest/delete" do
+        digests.delete_by_digest(params[:digest])
+        expiring_digests.delete_by_digest(params[:digest])
+        redirect_to :locks
+      end
+
+      app.get "/locks/:digest/jobs/:job_id/delete" do
+        @digest = params[:digest]
+        @lock   = SidekiqUniqueJobs::Lock.new(@digest)
+        @lock.unlock(params[:job_id])
+
+        redirect_to "locks/#{@lock.key}"
+      end
+    end
+  end
+end
+
+begin
+  require "delegate" unless defined?(DelegateClass)
+  require "sidekiq/web" unless defined?(Sidekiq::Web)
+
+  Sidekiq::Web.register(SidekiqUniqueJobs::Web)
+  Sidekiq::Web.tabs["Locks"]          = "locks"
+  Sidekiq::Web.tabs["Expiring Locks"] = "expiring_locks"
+  Sidekiq::Web.tabs["Changelogs"]     = "changelogs"
+  Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "locales")
+rescue NameError, LoadError => ex
+  SidekiqUniqueJobs.logger.error(ex)
+end