sidekiq-belt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f46a9f9e25f3ca4a020066547c25df3162a9644bd35d7a1a849d5766e0d1eac
-  data.tar.gz: 7e4153736d66d52c7f86f0721ef4239ee5a7ed51e4b4c51b41a7db2ff6e23c7d
+  metadata.gz: 311732e41366c1a1737b160f74364c13e76015f731191ee0cbd34af81b80afd2
+  data.tar.gz: 120418dea454eec7c1c9e47d35ad64d823a478d761accc9b9a6b28505e046e3b
 SHA512:
-  metadata.gz: a9ab0684f188afa56b7fe97c1efc88acaf381419c5d1f5f5f879eda5e22c7e7f36e7d48f5e2cf76caede6ae36381cdaf9b5429f89f0a0278269c8f31db71e24a
-  data.tar.gz: 2b07483a5a2cb6fa6d6a2af9e167857a0da4c5f7b55ee8ccce1e0e225029a71f93d39ebf94a98a39d8727614ea6e0f09445b34e7f62f89c1d27356a710efaa86
+  metadata.gz: 32111af8a8f7f4325f4dee59864eb8bcf0469747663dcdab7f0c5bdb5ec7636526f44447e1914b7cd7cce5b3ad60957c66b6fa52ff5fc2ad4549c78c81723ee2
+  data.tar.gz: bf61e75d9ca7875ee303726765c323074dfe3f2d76e35ab725cfb51f308a56fbb1fc902a1ce1ae065770ae1e98f88ada773eab0809712ffdb543b9b082146c31

data/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 require:
   - rubocop-rake
   - rubocop-rspec
@@ -225,3 +223,19 @@ RSpec/ExampleLength:
 
 RSpec/NestedGroups:
   Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/sidekiq-belt.rb'
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-10-07
+
+- Feature to Pause/Unpause Periodic Jobs
+
 ## [0.1.0] - 2023-10-07
 
-- Run manualy Periodic Jobs
+- Feature to run manualy Periodic Jobs

data/README.md

@@ -14,10 +14,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Features
 
-GitHub Copilot: Sure, here's a rewritten version of the content that is easier to read for a developer:
-
-## Features
-
 To enable all features, add the following code to the end of the Sidekiq initializer file:
 
 ```ruby
@@ -45,48 +41,28 @@ To enable this feature, pass the `periodic_run` option:
 Sidekiq::Belt.use!([:periodic_run])
 ```
 
-![periodic_run_index](https://github.com/dannnylo/sidekiq-belt/assets/20794/1c6ceed7-c2be-447e-b61c-b1e15f002bc2)
-![periodic_run_show](https://github.com/dannnylo/sidekiq-belt/assets/20794/be8cab4b-bfb1-4e15-b01b-56c69231169b)
-
-### Pause Periodic Jobs (sidekiq-enterprise)
-
-This feature is not yet implemented.
-
-### Delete an Unfinished Batch (sidekiq-pro)
-
-This feature is not yet implemented.
-```
-Sidekiq::Belt.use!
-```
+![periodic_run_index](https://github.com/dannnylo/sidekiq-belt/assets/20794/0cc900bc-6925-4139-affd-f41b81318727)
+![periodic_run_show](https://github.com/dannnylo/sidekiq-belt/assets/20794/086be190-af8e-44d9-bbf6-eed94b7314a0)
 
-or
 
-```
-Sidekiq::Belt.use!([:all])
-```
+### Pause Periodic Jobs (sidekiq-enterprise)
 
-To enable only the features you want, add the code to the Sidekiq initializer file while passing the necessary options.
+This option adds a button to pause and unpause the cron of a periodic job.
+When a periodic job is paused, the perform is skiped and on server this content is logged.
 
 ```
-Sidekiq::Belt.use!([:periodic_run, :periodic_pause])
+2023-10-12T19:24:00.001Z pid=127183 tid=2ian INFO: Job SomeHourlyWorkerClass is paused by Periodic Pause
 ```
 
-### Run manualy Periodic Jobs (sidekiq-enterprise)
+To enable this feature, pass the `periodic_pause` option:
 
-This functionality adds a button on the Sidekiq Enterprise web page that allows manual execution of a job.
-
-To enable this feature, pass the periodic_run option:
-
-```
-Sidekiq::Belt.use!([:periodic_run])
+```ruby
+Sidekiq::Belt.use!([:periodic_pause])
 ```
 
-![periodic_run_index](https://github.com/dannnylo/sidekiq-belt/assets/20794/1c6ceed7-c2be-447e-b61c-b1e15f002bc2)
-![periodic_run_show](https://github.com/dannnylo/sidekiq-belt/assets/20794/be8cab4b-bfb1-4e15-b01b-56c69231169b)
-
-### Pause Periodic Jobs (sidekiq-enterprise)
+### Delete an Unfinished Batch (sidekiq-pro)
 
-It will be implemented in upcoming versions.
+This feature is not yet implemented.
 
 ### Delete a not finished Batch (sidekiq-pro)
 

data/lib/sidekiq/belt/ent/periodic_pause.rb

@@ -1,15 +1,84 @@
 # frozen_string_literal: true
 
+require "sidekiq/web/helpers"
+
 module Sidekiq
   module Belt
     module Ent
       module PeriodicPause
+        def paused?
+          Sidekiq.redis { |r| r.hget("PeriodicPaused", @lid.to_s) }.to_s == "p"
+        end
+
+        def pause!
+          Sidekiq.redis { |r| r.hset("PeriodicPaused", @lid.to_s, "p") }
+        end
+
+        def unpause!
+          Sidekiq.redis { |r| r.hdel("PeriodicPaused", @lid.to_s) }
+        end
+
+        module SidekiqLoopsPeriodicPause
+          PAUSE_BUTTON = <<~ERB
+            <form action="<%= root_path %>loops/<%= loup.lid %>/pause" method="post">
+              <%= csrf_tag %>
+              <input class="btn btn-danger" type="submit" name="pause" value="<%= t('Pause') %>"
+                data-confirm="Pause the job <%= loup.klass %>? <%= t('AreYouSure') %>" />
+            </form>
+          ERB
+
+          UNPAUSE_BUTTON = <<~ERB
+            <form action="<%= root_path %>loops/<%= loup.lid %>/unpause" method="post">
+              <%= csrf_tag %>
+              <input class="btn btn-danger" type="submit" name="pause" value="<%= t('Unpause') %>"
+                data-confirm="Unpause the job <%= loup.klass %>? <%= t('AreYouSure') %>" />
+            </form>
+          ERB
+
+          def self.registered(app)
+            app.replace_content("/loops") do |content|
+              # Add the top of the table
+              content.gsub!("</th>\n    </tr>", "</th><th><%= t('Pause/Unpause') %></th></th>\n    </tr>")
+
+              # Add the run button
+              content.gsub!(
+                "</td>\n      </tr>\n    <% end %>",
+                "</td>\n<td>" \
+                "<% if (loup.paused?) %>#{UNPAUSE_BUTTON}<% else %>#{PAUSE_BUTTON}<% end %>" \
+                "</td>\n      </tr>\n    <% end %>"
+              )
+            end
+
+            app.post("/loops/:lid/pause") do
+              Sidekiq::Periodic::Loop.new(params[:lid]).pause!
+
+              return redirect "#{root_path}loops"
+            end
+
+            app.post("/loops/:lid/unpause") do
+              Sidekiq::Periodic::Loop.new(params[:lid]).unpause!
+
+              return redirect "#{root_path}loops"
+            end
+          end
+        end
+
+        module PauseServer
+          def enqueue_job(cycle, ts)
+            cycle.paused? ? logger.info("Job #{cycle.klass} is paused by Periodic Pause") : super
+          end
+        end
+
         def self.use!
-          # require("sidekiq-ent/periodic")
-          # require("sidekiq-ent/periodic/static_loop")
+          require("sidekiq-ent/web")
+          require("sidekiq-ent/periodic")
+          require("sidekiq-ent/periodic/manager")
+          require("sidekiq-ent/periodic/static_loop")
 
-          # Sidekiq::Periodic::Loop.prepend(Sidekiq::Belt::Ent::PeriodicPause)
-          # Sidekiq::Periodic::StaticLoop.prepend(Sidekiq::Belt::Ent::PeriodicPause)
+          Sidekiq::Web.register(Sidekiq::Belt::Ent::PeriodicPause::SidekiqLoopsPeriodicPause)
+          Sidekiq::Periodic::Loop.prepend(Sidekiq::Belt::Ent::PeriodicPause)
+          Sidekiq::Periodic::StaticLoop.prepend(Sidekiq::Belt::Ent::PeriodicPause)
+          Sidekiq::Periodic::Manager.prepend(Sidekiq::Belt::Ent::PeriodicPause::PauseServer)
         end
       end
     end

data/lib/sidekiq/belt/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Belt
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-belt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danilo Jeremias da Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -34,7 +34,6 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE

data/.rubocop_todo.yml

@@ -1,15 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2023-10-11 15:02:29 UTC using RuboCop version 1.56.4.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
-  Exclude:
-    - 'lib/sidekiq-belt.rb'