sidekiq-unique-jobs 6.0.24 → 7.0.4

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = "6.0.24"
+  #
+  # @return [String] the current SidekiqUniqueJobs version
+  VERSION = "7.0.4"
 end

data/lib/sidekiq_unique_jobs/version_check.rb

@@ -4,13 +4,13 @@ module SidekiqUniqueJobs
   #
   # Handles checking if a version is compliant with given constraint
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @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
+    PATTERN = /(?<operator1>[<>=]+)?\s?(?<version1>(\d+.?)+)(\s+&&\s+)?(?<operator2>[<>=]+)?\s?(?<version2>(\d+.?)+)?/m.freeze # rubocop:disable Layout/LineLength, Lint/MixedRegexpCaptureTypes
 
     #
-    # Checks if a version is consrtaint is satisfied
+    # Checks if a version is constraint is satisfied
     #
     # @example A satisfied constraint
     #   VersionCheck.satisfied?("5.0.0", ">= 4.0.0") #=> true
@@ -22,12 +22,31 @@ module SidekiqUniqueJobs
     # @param [String] version a version string `5.0.0`
     # @param [String] constraint a version constraint `>= 5.0.0 <= 5.1.1`
     #
-    # @return [<type>] <description>
+    # @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`

data/lib/sidekiq_unique_jobs/web.rb

@@ -1,60 +1,83 @@
 # frozen_string_literal: true
 
-begin
-  require "delegate"
-  require "rack"
-  require "sidekiq/web"
-rescue LoadError
-  # client-only usage
-end
-
 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@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Web
-    def self.registered(app) # rubocop:disable Metrics/MethodLength
+    def self.registered(app) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       app.helpers do
         include Web::Helpers
       end
 
-      app.get "/unique_digests" do
+      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, @unique_digests =
-          SidekiqUniqueJobs::Digests.page(pattern: @filter, cursor: @current_cursor, page_size: @count)
+        @pagination     = { pattern: @filter, cursor: @current_cursor, page_size: @count }
+        @total_size, @next_cursor, @changelogs = changelog.page(**@pagination)
 
-        erb(unique_template(:unique_digests))
+        erb(unique_template(:changelogs))
       end
 
-      app.get "/unique_digests/delete_all" do
-        SidekiqUniqueJobs::Digests.delete_by_pattern("*", count: SidekiqUniqueJobs::Digests.count)
-        redirect_to :unique_digests
+      app.get "/changelogs/delete_all" do
+        changelog.clear
+        redirect_to :changelogs
       end
 
-      app.get "/unique_digests/:digest" do
+      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]
+        @pagination     = { pattern: @filter, cursor: @current_cursor, page_size: @count }
+        @total_size, @next_cursor, @locks = digests.page(**@pagination)
+
+        erb(unique_template(:locks))
+      end
+
+      app.get "/locks/delete_all" do
+        digests.delete_by_pattern("*", count: digests.count)
+        redirect_to :locks
+      end
+
+      app.get "/locks/:digest" do
         @digest = params[:digest]
-        @unique_keys = SidekiqUniqueJobs::Util.keys("#{@digest}*", 1000)
+        @lock   = SidekiqUniqueJobs::Lock.new(@digest)
 
-        erb(unique_template(:unique_digest))
+        erb(unique_template(:lock))
       end
 
-      app.get "/unique_digests/:digest/delete" do
-        SidekiqUniqueJobs::Digests.delete_by_digest(params[:digest])
-        redirect_to :unique_digests
+      app.get "/locks/:digest/delete" do
+        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
 
-if defined?(Sidekiq::Web)
-  Sidekiq::Web.register SidekiqUniqueJobs::Web
-  Sidekiq::Web.tabs["Unique Digests"] = "unique_digests"
-  # Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), 'locales')
+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["Changelogs"] = "changelogs"
+  Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "locales")
+rescue NameError, LoadError => ex
+  SidekiqUniqueJobs.logger.error(ex)
 end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -2,20 +2,73 @@
 
 module SidekiqUniqueJobs
   module Web
+    #
+    # Provides view helpers for the Sidekiq::Web extension
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
     module Helpers
-      VIEW_PATH = File.expand_path("../web/views", __dir__)
+      #
+      # @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[cursor prev_cursor].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.open(File.join(VIEW_PATH, "#{name}.erb")).read
+        File.open(unique_filename(name)).read
       end
 
-      SAFE_CPARAMS = %w[cursor prev_cursor].freeze
+      #
+      # 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 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)
         # stringify
-        options.keys.each do |key|
-          options[key.to_s] = options.delete(key)
-        end
+        options.transform_keys(&:to_s)
 
         params.merge(options).map do |key, value|
           next unless SAFE_CPARAMS.include?(key)
@@ -24,6 +77,35 @@ module SidekiqUniqueJobs
         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
@@ -34,14 +116,47 @@ module SidekiqUniqueJobs
         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 = if time.is_a?(Numeric)
+        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)
+          Time.parse(time.to_s)
         end
-
-        relative_time(time)
       end
     end
   end

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>
+        <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>