sidekiq-unique-jobs 7.0.0.beta29 → 7.0.4

data/lib/sidekiq_unique_jobs/timer_task.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # @see [Concurrent::TimerTask] https://www.rubydoc.info/gems/concurrent-ruby/Concurrent/TimerTask
+  #
+  class TimerTask < ::Concurrent::TimerTask
+    private
+
+    def ns_initialize(opts, &task)
+      set_deref_options(opts)
+
+      self.execution_interval = opts[:execution] || opts[:execution_interval] || EXECUTION_INTERVAL
+      self.timeout_interval = opts[:timeout] || opts[:timeout_interval] || TIMEOUT_INTERVAL
+      @run_now  = opts[:now] || opts[:run_now]
+      @executor = Concurrent::RubySingleThreadExecutor.new
+      @running  = Concurrent::AtomicBoolean.new(false)
+      @task     = task
+      @value    = nil
+
+      self.observers = Concurrent::Collection::CopyOnNotifyObserverSet.new
+    end
+
+    def schedule_next_task(interval = execution_interval)
+      exec_task = ->(completion) { execute_task(completion) }
+      Concurrent::ScheduledTask.execute(interval, args: [Concurrent::Event.new], &exec_task)
+      nil
+    end
+
+    # @!visibility private
+    def execute_task(completion) # rubocop:disable Metrics/MethodLength
+      return nil unless @running.true?
+
+      timeout_task = -> { timeout_task(completion) }
+
+      Concurrent::ScheduledTask.execute(
+        timeout_interval,
+        args: [completion],
+        &timeout_task
+      )
+      @thread_completed = Concurrent::Event.new
+
+      @value = @reason  = nil
+      @executor.post do
+        @value = @task.call(self)
+      rescue Exception => ex # rubocop:disable Lint/RescueException
+        @reason = ex
+      ensure
+        @thread_completed.set
+      end
+
+      @thread_completed.wait
+
+      if completion.try?
+        schedule_next_task
+        time = Time.now
+        observers.notify_observers do
+          [time, value, @reason]
+        end
+      end
+      nil
+    end
+
+    # @!visibility private
+    def timeout_task(completion)
+      return unless @running.true?
+      return unless completion.try?
+
+      @executor.kill
+      @executor.wait_for_termination
+      @executor = Concurrent::RubySingleThreadExecutor.new
+
+      @thread_completed.set
+
+      schedule_next_task
+      observers.notify_observers(Time.now, nil, Concurrent::TimeoutError.new)
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/version.rb

@@ -3,5 +3,5 @@
 module SidekiqUniqueJobs
   #
   # @return [String] the current SidekiqUniqueJobs version
-  VERSION = "7.0.0.beta29"
+  VERSION = "7.0.4"
 end

data/lib/sidekiq_unique_jobs/web.rb

@@ -13,6 +13,23 @@ module SidekiqUniqueJobs
         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]
+        @pagination     = { pattern: @filter, cursor: @current_cursor, page_size: @count }
+        @total_size, @next_cursor, @changelogs = changelog.page(**@pagination)
+
+        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 == ""
@@ -53,7 +70,14 @@ module SidekiqUniqueJobs
   end
 end
 
-require "sidekiq/web" unless defined?(Sidekiq::Web)
-Sidekiq::Web.register(SidekiqUniqueJobs::Web)
-Sidekiq::Web.tabs["Locks"] = "locks"
-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

@@ -10,12 +10,12 @@ module SidekiqUniqueJobs
     module Helpers
       #
       # @return [String] the path to gem specific views
-      VIEW_PATH    = File.expand_path("../web/views", __dir__)
+      VIEW_PATH    = File.expand_path("../web/views", __dir__).freeze
       #
       # @return [Array<String>] safe params
       SAFE_CPARAMS = %w[cursor prev_cursor].freeze
 
-      module_function
+      extend self
 
       #
       # Opens a template file contained within this gem
@@ -25,7 +25,18 @@ module SidekiqUniqueJobs
       # @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
+
+      #
+      # 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
 
       #
@@ -38,6 +49,16 @@ module SidekiqUniqueJobs
         @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
       #

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/locks.erb

@@ -32,7 +32,7 @@
     <% @locks.each do |lock| %>
     <tr>
       <td>
-        <form action="<%= root_path %>locks/<%= lock.key %>" method="get">
+        <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') %>" />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta29
+  version: 7.0.4
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpoplpush-redis_script
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -177,7 +177,6 @@ files:
 - lib/sidekiq_unique_jobs/orphans/observer.rb
 - lib/sidekiq_unique_jobs/orphans/reaper.rb
 - lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb
-- lib/sidekiq_unique_jobs/profiler.rb
 - lib/sidekiq_unique_jobs/redis.rb
 - lib/sidekiq_unique_jobs/redis/entity.rb
 - lib/sidekiq_unique_jobs/redis/hash.rb
@@ -189,10 +188,12 @@ files:
 - lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb
 - lib/sidekiq_unique_jobs/script.rb
 - lib/sidekiq_unique_jobs/script/caller.rb
+- lib/sidekiq_unique_jobs/server.rb
 - lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb
 - lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb
 - lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb
 - lib/sidekiq_unique_jobs/testing.rb
+- lib/sidekiq_unique_jobs/timer_task.rb
 - lib/sidekiq_unique_jobs/timing.rb
 - lib/sidekiq_unique_jobs/unlockable.rb
 - lib/sidekiq_unique_jobs/update_version.rb
@@ -202,6 +203,7 @@ files:
 - lib/sidekiq_unique_jobs/web.rb
 - lib/sidekiq_unique_jobs/web/helpers.rb
 - lib/sidekiq_unique_jobs/web/views/_paging.erb
+- lib/sidekiq_unique_jobs/web/views/changelogs.erb
 - lib/sidekiq_unique_jobs/web/views/lock.erb
 - lib/sidekiq_unique_jobs/web/views/locks.erb
 - lib/tasks/changelog.rake
@@ -217,6 +219,9 @@ metadata:
 post_install_message: |
   IMPORTANT!
 
+  Automatic configuration of the sidekiq middelware is no longer done.
+  Please see: https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/README.md#add-the-middleware
+
   This version deprecated the following sidekiq_options
 
     - sidekiq_options lock_args: :method_name
@@ -248,11 +253,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.4
+rubygems_version: 3.2.6
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs

data/lib/sidekiq_unique_jobs/profiler.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module SidekiqUniqueJobs
-  #
-  # Class MethodProfiler provides method level profiling
-  #
-  # @author Mikael Henriksson <mikael@mhenrixon.com>
-  #
-  class Profiler
-    def self.patch(klass, methods, name) # rubocop:disable Metrics/MethodLength
-      patches = methods.map do |method_name|
-        <<~RUBY
-          unless defined?(#{method_name}__mp_unpatched)
-            alias_method :#{method_name}__mp_unpatched, :#{method_name}
-            def #{method_name}(*args, &blk)
-              unless prof = Thread.current[:_method_profiler]
-                return #{method_name}__mp_unpatched(*args, &blk)
-              end
-              begin
-                start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-                #{method_name}__mp_unpatched(*args, &blk)
-              ensure
-                data = (prof[:#{name}] ||= {duration: 0.0, calls: 0})
-                data[:duration] += Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
-                data[:calls] += 1
-              end
-            end
-          end
-        RUBY
-      end.join("\n")
-
-      klass.class_eval patches
-    end
-
-    def self.start
-      Thread.current[:_method_profiler] = {
-        __start: current_timestamp,
-      }
-    end
-
-    def self.stop
-      finish = current_timestamp
-      return unless (data = Thread.current[:_method_profiler])
-
-      Thread.current[:_method_profiler] = nil
-      start = data.delete(:__start)
-      data[:total_duration] = finish - start
-      data
-    end
-
-    def self.current_timestamp
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-  end
-end