cogworker 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6ea3cf9620f3c099c39fe6bba306cd78b037e8c0c7c8dab161586c98d1081f
-  data.tar.gz: b0b58c6118437e59c6748202ef21a8980ed22f916f27ed14ec3179de8bb435e0
+  metadata.gz: 2a2d6b5721f03a71d8a74d376311c047175b71f950d51f227c60598dad74dce2
+  data.tar.gz: d6f10624306849c6e32e8d7fa0211db6c2b947d78d53fec10b79039bfec57645
 SHA512:
-  metadata.gz: ce3267edd66d5fcab03aec48a0ae8b3fbeb749a1c4e7db298158387c9fd7a8c6f7332dee99ed1b91499bc9c0b87f748dfb966c274b55ad6e643e76afbf5d57d9
-  data.tar.gz: d1706f96404137a3594ca6182988a10c990f77a15b4f5aa0a2f2e758eab6dcc4815f88a9c6ac5aada117bfe3f5660df93e489b9df311460c5d7d2829e76868d4
+  metadata.gz: 97347577fddf8a44cc0c5df6b6aafd5a60c285f88f58f7c09193f8a1031d5bf9dc0381e2708a9d591ff81dde7781b31be6a72f7d7567b9f2a0a8b74fb0de2658
+  data.tar.gz: 84ea3a607e75d78b23dab9919c33595ade3ac2382c2c253896a6e3b4df7664d8369fbd1b81a387eaaa9ae95fe3867dd8739ce7d757a0e576047f51321e78cd5e

data/README.md

@@ -363,6 +363,18 @@ about two minutes after the process's last heartbeat (7 minutes by default).
 On first start against an empty Redis, each entry's most recent due slot
 fires right away. To turn that off, set `config.periodic_catch_up = false`.
 
+Entries are only ever added to the published schedule (what the Schedules
+tab shows), so one removed from your code stays listed there. Pass
+`replace: true` to clear what was registered before and replace the
+published schedule with exactly this set on every boot:
+
+```ruby
+config.periodic(replace: true, &PERIODIC_JOBS)
+```
+
+Don't use it if different processes register different schedules against
+the same Redis — each would erase the others' entries from the tab.
+
 ## Job status
 
 ```ruby

data/lib/cogworker/config.rb

@@ -9,7 +9,7 @@ module Cogworker
     FETCH_MODES = %i[reliable basic].freeze
 
     attr_reader :server_chain, :client_chain, :periodic_manager, :redis_options, :fetch, :fetch_idle_max_interval,
-                :orphan_threshold, :max_orphanings
+                :orphan_threshold, :max_orphanings, :periodic_replace
     attr_accessor :concurrency, :queues, :periodic_catch_up, :unique_lock_ttl
 
     def initialize
@@ -133,7 +133,18 @@ module Cogworker
     # registers cron entries synchronously as it runs. No-op-safe: an app
     # that never calls this simply has an empty periodic_manager, and the
     # Ticker (started later, per process) has nothing to do.
-    def periodic(&block)
+    #
+    # `replace: true` clears what earlier calls registered first, and makes
+    # the Ticker replace the whole published `periodic:schedule` rather than
+    # adding to it — so an entry deleted from (or changed in) the schedule
+    # file disappears from the Web UI instead of lingering there forever.
+    # Opt-in: with processes that register *different* schedules against one
+    # Redis, each would wipe the others' entries off the Schedules tab.
+    def periodic(replace: false, &block)
+      if replace
+        periodic_manager.clear!
+        @periodic_replace = true
+      end
       block&.call(periodic_manager)
       periodic_manager
     end

data/lib/cogworker/launcher.rb

@@ -21,6 +21,7 @@ module Cogworker
       # two runs at once.
       @ticker = Periodic::Ticker.new(
         @manager, config.periodic_manager.entries, catch_up: config.periodic_catch_up,
+                                                   replace: config.periodic_replace,
                                                    ready: -> { @scheduled.ready_for_ticker? }
       )
       @signal_queue = ::Queue.new

data/lib/cogworker/periodic/manager.rb

@@ -23,6 +23,11 @@ module Cogworker
         @entries << entry
         entry
       end
+
+      # In place: Launcher hands this same `entries` array to the Ticker.
+      def clear!
+        @entries.clear
+      end
     end
   end
 end

data/lib/cogworker/periodic/ticker.rb

@@ -46,10 +46,11 @@ module Cogworker
         return 1
       LUA
 
-      def initialize(manager, entries, catch_up: true, ready: -> { true })
+      def initialize(manager, entries, catch_up: true, replace: false, ready: -> { true })
         @manager = manager
         @entries = entries
         @catch_up = catch_up
+        @replace = replace
         @ready = ready
         @last_checked_slot = {}
         @cron_cache = {}
@@ -84,8 +85,12 @@ module Cogworker
       # here (not at DSL-registration time in Config#periodic) so it never
       # depends on `config.redis =` having already run — every process that
       # boots re-writes the same idempotent entries regardless of ordering.
+      # With `replace` (Config#periodic(replace: true)) the hash is swapped
+      # out wholesale in one MULTI, dropping entries no longer registered
+      # (their `last_slot`/`disabled` state is left alone: an old process
+      # still ticking them mid-deploy must not re-fire an already-run slot).
       def publish_schedule!
-        return if @entries.empty?
+        return if @entries.empty? && !@replace
 
         payloads = @entries.each_with_object({}) do |entry, h|
           h[entry.pjid] = JSON.generate(
@@ -93,7 +98,14 @@ module Cogworker
             'unique' => entry.unique, 'args' => entry.args
           )
         end
-        Cogworker.config.redis { |c| c.hset(RedisKeys::PERIODIC_SCHEDULE, *payloads.to_a.flatten) }
+        Cogworker.config.redis do |c|
+          next c.hset(RedisKeys::PERIODIC_SCHEDULE, *payloads.to_a.flatten) unless @replace
+
+          c.multi do |tx|
+            tx.del(RedisKeys::PERIODIC_SCHEDULE)
+            tx.hset(RedisKeys::PERIODIC_SCHEDULE, *payloads.to_a.flatten) unless payloads.empty?
+          end
+        end
       end
 
       # A failed tick is logged and retried next interval rather than ending

data/lib/cogworker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cogworker
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogworker
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - vdonec