sidekiq-heartbeat_monitor 1.0.2.0 → 1.0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7220abb41d5b0d785ef913cad349184e8e61e10
-  data.tar.gz: ef32dc8543669e7e375de343d6e69433d674d8d5
+  metadata.gz: 63e40fd229b698071996b154e4e03e663be310f9
+  data.tar.gz: 1f6f80eb7e1a17096aa0fab8643f9a8d6dcbb7ee
 SHA512:
-  metadata.gz: 45121b850630fa2c1df916c733014d26198506ccfc10315dfd36f9b16551427792a29a78c44d54bf36752c3d4d208bf4e60c332f62f667669a482bcb24f0a4cb
-  data.tar.gz: fd515bb0ab900404ad85e536e0b512a603f75cc5a88d941b0755d553dbfa1ce0bc5c47a6c91b8bc40615f0b83ff37896128c7d20f9858d04bba1419f84937425
+  metadata.gz: 11a89bf560477d9f172c875233ddbe57624e5a2e12ac9c2fa7ac99e9ee2d8225421e75c18adcb5d91c9924407d2524b00f5abeba4744eac407cf8f218fefb06b
+  data.tar.gz: 1ab1b00e3d63905f01319a01128bbe36fc0396b496fe5ff16eee07e311a0bce43b171f71d570366cf8a2c93e64b5ad3ab2b84696195b5a95d0860e1c8eca3e5c

data/README.md

@@ -21,6 +21,14 @@ Or install it yourself as:
 
 **Configuration is required - see the Configuration section below**
 
+### (Optional) Install Cron Task
+The gem will automatically try to install your cron task when you run your sidekiq server, however if for some reason it does not install the cron task
+then you can install it manually using the available rake task command:
+```
+rake sidekiq::heartbeat_monitor:install
+```
+
+
 ### Requirements
 1. [Dont Repeat For Gem](https://www.github.com/jayelkaake/dont_repeat_for) - To allow you to only send notifications every so often.
 2. Redis

data/lib/sidekiq/heartbeat_monitor.rb

@@ -4,6 +4,10 @@ require 'sidekiq/heartbeat_monitor/config'
 require 'sidekiq/heartbeat_monitor/util'
 require 'sidekiq/heartbeat_monitor/scheduler'
 require 'sidekiq/heartbeat_monitor/worker'
+require 'sidekiq/heartbeat_monitor/test_worker'
+
+require 'sidekiq/heartbeat_monitor/railtie' if defined?(Rails)
+
 
 module Sidekiq
   module HeartbeatMonitor

data/lib/sidekiq/heartbeat_monitor/config.rb

@@ -62,6 +62,44 @@ module Sidekiq
         end
       end
 
+      def self.install_cron_job!(output: false)
+        job = Sidekiq::Cron::Job.find("sidekiq_monitor")
+
+        target_job = Sidekiq::Cron::Job.new(
+          name: 'sidekiq_monitor', 
+          cron: '* * * * *', 
+          klass: Sidekiq::HeartbeatMonitor::Scheduler
+        )
+
+        if job.present?
+          if job.cron != target_job.cron && job.klass.to_s != target_job.klass
+            unless job.destroy
+              puts "ERROR: An existing cron job was found with the same name but incorrect configuration. An attempt to delete it (to create a new, correctly configured one) failed." if output
+              return false
+            end
+
+            if target_job.save
+              puts "SUCCESS: An existing crob job was found that had the same name but had outdated configuration, so it was deleted and a new one was installed successfully." if output
+              true
+            else
+              puts "ERROR: Sidekiq heartbeat monitor found an existing cron job with the same name but it is configured incorrectly. It was deleted, but a new one could not be created. Run this command again to try adding it manually again and please ensure you can programmatically add sidekiq cron jobs as well." if output
+              false
+            end
+          else
+            puts "SUCCESS: Sidekiq heartbeat monitor cron job already exists and appears to be configured properly so nothing was changed."  if output
+            true
+          end
+        else
+          if target_job.save
+            puts "SUCCESS: New cron task was installed successfully." if output
+            true
+          else
+            puts "ERROR: New cron task could not be saved for some reason. Please ensure you can programmatically add sidekiq cron jobs and try again." if output
+            false
+          end
+        end
+      end
+
       private
 
       def setup_slack_notifier!(slack_notifier_url)
@@ -74,22 +112,15 @@ module Sidekiq
       end
 
       def install_cron_job!
-        job = Sidekiq::Cron::Job.find("sidekiq_monitor")
+        # Only install the cron job if we're running as a sidekiq server
+        return unless Sidekiq.server?
 
-        target_job = Sidekiq::Cron::Job.new(
-          name: 'sidekiq_monitor', 
-          cron: '* * * * *', 
-          klass: Sidekiq::HeartbeatMonitor::Scheduler
-        )
+        self.class.install_cron_job!
 
-        if job.present?
-          if job.cron != target_job.cron && job.klass.to_s != target_job.klass
-            job.destroy
-            target_job.save
-          end
-        else
-          target_job.save
-        end
+      rescue Redis::CannotConnectError
+        # If we failed to connect at this point then likely Redis is not yet configured at this point in initialization, 
+        # so we should just abort
+        false
       end
 
     end

data/lib/sidekiq/heartbeat_monitor/railtie.rb

@@ -0,0 +1,15 @@
+require 'sidekiq/heartbeat_monitor'
+require 'rails'
+
+module Sidekiq
+  module HeartbeatMonitor
+    class Railtie < ::Rails::Railtie
+      railtie_name :sidekiq_heartbeat_monitor
+
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

data/lib/sidekiq/heartbeat_monitor/tasks/install.rake

@@ -0,0 +1,9 @@
+namespace :sidekiq do
+  namespace :heartbeat_monitor do
+
+    desc "Install sidekiq heartbeat monitor gem heartbeat cron task."
+    task :install => :environment do
+      Sidekiq::HeartbeatMonitor::Config.install_cron_job!(output: true)
+    end
+  end
+end

data/lib/sidekiq/heartbeat_monitor/test_worker.rb

@@ -0,0 +1,21 @@
+module Sidekiq
+  module HeartbeatMonitor
+    ##
+    # Used for testing purposes to ensure that the system is working properly.
+    class TestWorker
+
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 0
+
+      def perform(wait_time = 1.second)
+        puts "Internal test worker started and will continue for the next #{wait_time} seconds." if wait_time > 3.seconds
+
+        sleep(wait_time)
+
+        puts "Internal test worker finished after #{wait_time} seconds." if wait_time > 3.seconds
+      end
+
+    end
+  end
+end

data/lib/sidekiq/heartbeat_monitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
     module HeartbeatMonitor
-        VERSION = '1.0.2.0'
+        VERSION = '1.0.3.0'
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-heartbeat_monitor
 version: !ruby/object:Gem::Version
-  version: 1.0.2.0
+  version: 1.0.3.0
 platform: ruby
 authors:
 - Jay El-Kaake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -183,7 +183,10 @@ files:
 - bin/setup
 - lib/sidekiq/heartbeat_monitor.rb
 - lib/sidekiq/heartbeat_monitor/config.rb
+- lib/sidekiq/heartbeat_monitor/railtie.rb
 - lib/sidekiq/heartbeat_monitor/scheduler.rb
+- lib/sidekiq/heartbeat_monitor/tasks/install.rake
+- lib/sidekiq/heartbeat_monitor/test_worker.rb
 - lib/sidekiq/heartbeat_monitor/util.rb
 - lib/sidekiq/heartbeat_monitor/version.rb
 - lib/sidekiq/heartbeat_monitor/worker.rb