sidekiq_alive 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a44c1e18d7a26b469ed2eb4a99d6c5d9feeca58
-  data.tar.gz: 870314a23499da71ff34ad9a5c5fa3124dc16b93
+  metadata.gz: 0e7e972b09b3d5ee8de3fe0e32bd23adae47a46d
+  data.tar.gz: 3c7e7ebcfcba7f850e0563f2fc8d2651cf585321
 SHA512:
-  metadata.gz: a434f4c9fbcb140ca1d070ac7b83aae54531c955b0ce4bfb673f705a4988adb91177bc5a6beb491be0985fcbce88024125869d230f7428727f954ec796b1d915
-  data.tar.gz: b35a6b390fc8d615d1f6bcd4ef97b07d8bac87968872358a451a806e26dd32dc5df53d3f2afc7308947a29dfd5478a6da4f60440a98e1974a35c8621297e37ad
+  metadata.gz: 1470c68f1fecbafa1d5a6e0e53c0767b89c65cd3e8cfec47662df6ed738179f467c0e603efbf56b24a91c0a54764f9aafa775b955b08c51172e48d1affc1ba26
+  data.tar.gz: 4e67168aa2f3de897070748382482df8d1b69f11aa24d482affae8bdb3d02e0a06475f5102e8a683ed79e0b5ad8e6127daed7f0249c71f15edb2d855fd3fab42

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (0.1.0)
+    sidekiq_alive (0.1.1)
       sidekiq
+      sinatra
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +15,8 @@ GEM
     rack (1.6.8)
     rack-protection (1.5.3)
       rack
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
     rake (10.5.0)
     redis (3.3.5)
     rspec (3.7.0)
@@ -28,12 +31,20 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
+    rspec-sidekiq (3.0.3)
+      rspec-core (~> 3.0, >= 3.0.0)
+      sidekiq (>= 2.4.0)
     rspec-support (3.7.1)
     sidekiq (4.2.10)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.8)
 
 PLATFORMS
   ruby
@@ -41,9 +52,11 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   mock_redis
+  rack-test
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec-sidekiq (~> 3.0)
   sidekiq_alive!
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -37,7 +37,7 @@ rails example:
 `config/initializers/sidekiq.rb`
 
 ```ruby
-SidekiqAlive..start
+SidekiqAlive.start
 ```
 
 ### Run the job for first time
@@ -49,7 +49,7 @@ rails example:
 ```
 $ bundle exec rails console
 
-#=> SidekiqAlive.perform_now
+#=> SidekiqAlive::Worker.perform_async
 ```
 
 ### Kubernetes setup

data/lib/sidekiq_alive.rb

@@ -1,19 +1,22 @@
+require "sidekiq"
+require "singleton"
 require "sidekiq_alive/version"
-require 'sidekiq'
+require "sidekiq_alive/config"
 
 module SidekiqAlive
   def self.start
     Sidekiq.configure_server do |config|
       config.on(:startup) do
+        SidekiqAlive::Worker.perform_async
         SidekiqAlive::Server.start
       end
     end
   end
 
   def self.store_alive_key
-    redis.set(liveness_key,
+    redis.set(config.liveness_key,
               Time.now.to_i,
-              { ex: time_to_live.to_i })
+              { ex: config.time_to_live.to_i })
   end
 
   def self.redis
@@ -21,48 +24,19 @@ module SidekiqAlive
   end
 
   def self.alive?
-    redis.ttl(liveness_key) == -2 ? false : true
+    redis.ttl(config.liveness_key) == -2 ? false : true
   end
 
   # CONFIG ---------------------------------------
 
   def self.setup
-    yield(self)
+    yield(config)
   end
 
-  def self.port=(port)
-    @port = port
+  def self.config
+    @config ||= SidekiqAlive::Config.instance
   end
-
-  def self.port
-    @port || 7433
-  end
-
-  def self.liveness_key=(key)
-    @liveness_key = key
-  end
-
-  def self.liveness_key
-    @liveness_key || "SIDEKIQ::LIVENESS_PROBE_TIMESTAMP"
-  end
-
-  def self.time_to_live=(time)
-    @time_to_live = time
-  end
-
-  def self.time_to_live
-    @time_to_live || 10 * 60
-  end
-
-  def self.callback=(block)
-    @after_storing_key = block
-  end
-
-  def self.callback
-    @after_storing_key || proc {} # do nothing
-  end
-
 end
 
-require 'sidekiq_alive/server'
-require 'sidekiq_alive/worker'
+require "sidekiq_alive/worker"
+require "sidekiq_alive/server"

data/lib/sidekiq_alive/config.rb

@@ -0,0 +1,14 @@
+module SidekiqAlive
+  class Config
+    include Singleton
+
+    attr_accessor :port, :liveness_key, :time_to_live, :callback
+
+    def initialize
+      @port = 7433
+      @liveness_key = 'SIDEKIQ::LIVENESS_PROBE_TIMESTAMP'
+      @time_to_live = 10 * 60
+      @callback = proc {}
+    end
+  end
+end

data/lib/sidekiq_alive/server.rb

@@ -1,46 +1,33 @@
+require "sinatra/base"
+require_relative "./config"
 module SidekiqAlive
-  module Server
-    def self.start
-      require 'socket'
-      Sidekiq::Logging.logger.info "Starting liveness server on #{config.port}"
-      store_alive_key # initial livenessProbe to avoid to kill the instance before it triggers the first liveness
+  class Server < Sinatra::Base
+    set :bind, '0.0.0.0'
 
-      # Start Server
-      Thread.start do
-        server = TCPServer.new('0.0.0.0', config.port)
-        loop do
-          Thread.start(server.accept) do |socket|
-            request = socket.gets # Read the first line of the request (the Request-Line)
-            if config.alive?
-              status = "200 OK"
-              response = "Alive!\n"
-            else
-              status = "500 ERROR"
-              response = "Looks like sidekiq is not working\n"
-              Sidekiq::Logging.logger.error response
-            end
-            socket.print "HTTP/1.1 #{status}\r\n" +
-                             "Content-Type: text/plain\r\n" +
-                             "Content-Length: #{response.bytesize}\r\n" +
-                             "Connection: close\r\n"
-            socket.print "\r\n" # blank line separates the header from the body, as required by the protocol
-            socket.print response
-            socket.close
-          end
-        end
+    class << self
+      def start
+        Sidekiq::Logging.logger.info "Writing SidekiqAlive alive key in redis: #{SidekiqAlive.config.liveness_key}"
+        SidekiqAlive.store_alive_key
+        set :port, SidekiqAlive.config.port
+        Thread.start { run! }
       end
-    end
 
-    def self.config
-      SidekiqAlive
+      def quit!
+        super
+        exit
+      end
     end
 
-    def self.store_alive_key
-      Sidekiq::Logging.logger.info "Writing Startup alive key in redis: #{config.liveness_key}"
-      # TODO run worker unless one already enqueued
-      config.store_alive_key
+    get '/' do
+      if SidekiqAlive.alive?
+        status 200
+        body "Alive!"
+      else
+        response = "Can't find the alive key"
+        Sidekiq::Logging.logger.error(response)
+        status 404
+        body response
+      end
     end
-
-
   end
 end

data/lib/sidekiq_alive/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAlive
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/sidekiq_alive/worker.rb

@@ -5,14 +5,18 @@ module SidekiqAlive
 
     def perform
       write_living_probe
-      self.class.perform_in(SidekiqAlive.time_to_live / 2)
+      self.class.perform_in(config.time_to_live / 2)
     end
 
     def write_living_probe
       # Write liveness probe
       SidekiqAlive.store_alive_key
       # after callbacks
-      SidekiqAlive.callback.call()
+      config.callback.call()
+    end
+
+    def config
+      SidekiqAlive.config
     end
   end
 end

data/sidekiq_alive.gemspec

@@ -33,6 +33,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec-sidekiq", "~> 3.0"
   spec.add_development_dependency "mock_redis"
   spec.add_dependency "sidekiq"
+  spec.add_dependency "sinatra"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
 
@@ -109,6 +151,7 @@ files:
 - bin/console
 - bin/setup
 - lib/sidekiq_alive.rb
+- lib/sidekiq_alive/config.rb
 - lib/sidekiq_alive/server.rb
 - lib/sidekiq_alive/version.rb
 - lib/sidekiq_alive/worker.rb
@@ -133,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Liveness probe for sidekiq on Kubernetes deployments.