sidekiq-benchmark 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: 4c14f4a4df0d3176c7471258d3a7c40eb89bcd98
-  data.tar.gz: 892130faabd2c956cf6727d1c17a760169da3ce3
+SHA256:
+  metadata.gz: 9ff40d5ce3fb48bd55615763f3e3ac80512aa698f55b654f6c42bb028ee573e0
+  data.tar.gz: b430cac0a57e74485caaac5e9c726f2fb17de9f5637c3febd3f9925258da3c2d
 SHA512:
-  metadata.gz: a6d232bd0fa047ba153567e2fcee693a0ce3cb5916b73db8bae107502f65605e8d6a3fa222a96ef9d14c2a5f4e3625495aea55a92d89db0793eb1703c8335e60
-  data.tar.gz: 31231c0ee739b0380359a4d58b5a9e9a4cf2c46fa32095f1d33f46c80b6ec9056d1072ea69b71b5e0e329a5e2e057e7217988a3116cd6e3df0f042f9e3027eb2
+  metadata.gz: 2f651f4b5349baea57d53f747a2813e349004521e628e82615a14f228b8ae5b5991e7d4603f1e0487068b02cfa44c89d2487402a848ffd590e0abc93c60f5b78
+  data.tar.gz: 985cc8dff35334d70e23121185fe7adc390145fdc237e9adccf423e9614f0a2e0e5616ed9cee94d55867ff4ff4ef88d95b100843291bb7307335c5488a7ea234

data/.gitignore

@@ -18,3 +18,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.1.1
+  - 2.7.1
 services:
   - redis-server

data/Makefile

@@ -0,0 +1,26 @@
+.PHONY: test
+
+DOCKER_CONSOLE := docker-compose run -w /app --rm console
+PROJECT_NAME ?= $(shell basename $(shell pwd))
+
+container:
+	mkdir -p gem/
+	mkdir -p vendor/
+	docker-compose build
+	$(DOCKER_CONSOLE) bundle install
+
+bundle bundle_install bundle_update:
+	$(eval bundle_cmd ?= $(shell echo $@ | tr _ ' '))
+	$(DOCKER_CONSOLE) $(bundle_cmd)
+
+build:
+	$(DOCKER_CONSOLE) gem build $(PROJECT_NAME).gemspec
+
+clean:
+	$(DOCKER_CONSOLE) rm -fr gem/
+
+test:
+	$(DOCKER_CONSOLE) bundle exec rake test
+
+console:
+	$(DOCKER_CONSOLE)

data/README.md

@@ -19,7 +19,7 @@ And then execute:
 
 ## Requirements
 
-Redis 2.6.0 or newer required
+From version 0.5.0 works with Sidekiq 4.2 or newer
 
 ## Usage
 
@@ -92,6 +92,3 @@ require 'sidekiq-benchmark/testing'
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-
-[![endorse](https://api.coderwall.com/kosmatov/endorsecount.png)](https://coderwall.com/kosmatov)

data/docker-compose.yml

@@ -0,0 +1,35 @@
+version: '3.8'
+
+x-logging: &logging
+  options:
+    max-size: '5k'
+    max-file: '5'
+    labels: "{{.Name}}"
+  driver: json-file
+
+services:
+  app: &base
+    image: ruby:latest
+    environment: &app_env
+      - BUNDLE_PATH=/app/vendor
+      - REDIS_HOST=redis
+    volumes:
+      - .:/app:cached
+      - ./vendor:/app/vendor
+      - ./gem:/app/gem
+      - ~/.pry_history:/root/.pry_history
+      - ~/.bash_history:/root/.bash_history
+    links:
+      - redis:redis
+    logging: *logging
+
+  redis:
+    image: redis:alpine
+    logging: *logging
+
+  console:
+    <<: *base
+    command: bash
+
+volumes:
+  vendor_cache:

data/lib/sidekiq-benchmark.rb

@@ -6,6 +6,11 @@ Sidekiq::Web.tabs["Benchmarks"] = "benchmarks"
 
 module Sidekiq
   module Benchmark
+    REDIS_NAMESPACE = :benchmark
+    TYPES_KEY = "#{REDIS_NAMESPACE}:types".freeze
+    STAT_KEYS = %i[stats total]
+    REDIS_KEYS_TTL = 3600 * 24 * 30
+
     autoload :Worker, 'sidekiq-benchmark/worker'
   end
 end

data/lib/sidekiq-benchmark/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Benchmark
-    VERSION = "0.4.1"
+    VERSION = "0.7.0"
   end
 end

data/lib/sidekiq-benchmark/web.rb

@@ -1,41 +1,43 @@
-require 'sinatra/assetpack'
 require 'chartkick'
 
 module Sidekiq
   module Benchmark
     module Web
-      def self.registered(app)
-        web_dir = File.expand_path("../../../web", __FILE__)
-        js_dir = File.join(web_dir, "assets", "javascripts")
+      WEB_DIR = File.expand_path("../../../web", __FILE__).freeze
+      JS_DIR = File.join(WEB_DIR, "assets", "javascripts").freeze
+      VIEW_PATH = File.join(WEB_DIR, "views", "benchmarks.erb").freeze
 
+      def self.registered(app)
         app.helpers Chartkick::Helper
-        app.register Sinatra::AssetPack
-
-        app.assets {
-          serve '/js', from: js_dir
 
-          js 'chartkick', ['/js/chartkick.js']
-        }
+        app.get '/benchmarks/javascripts/chartkick.js' do
+          body = File.read File.join(JS_DIR, 'chartkick.js')
+          headers = {
+            'Content-Type' => 'application/javascript',
+            'Cache-Control' => 'public, max-age=84600'
+          }
+          [200, headers, [body]]
+        end
 
         app.get "/benchmarks" do
           @charts = {}
 
           Sidekiq.redis do |conn|
-            @types = conn.smembers "benchmark:types"
+            @types = conn.smembers TYPES_KEY
             @types.each do |type|
-              @charts[type] = { total: [], stats: [] }
+              @charts[type] = STAT_KEYS.reduce({}) { |a, e| a[e] = []; a }
 
-              total_keys = conn.hkeys("benchmark:#{type}:total") -
-                ['start_time', 'job_time', 'finish_time']
+              total_key = "#{REDIS_NAMESPACE}:#{type}:total"
+              total_keys = conn.hkeys(total_key) - %w(start_time job_time finish_time)
 
-              total_time = conn.hget "benchmark:#{type}:total", :job_time
+              total_time = conn.hget total_key, :job_time
               total_time = total_time.to_f
               total_keys.each do |key|
-                value = conn.hget "benchmark:#{type}:total", key
+                value = conn.hget total_key, key
                 @charts[type][:total] << [key, value.to_f.round(2)]
               end
 
-              stats = conn.hgetall "benchmark:#{type}:stats"
+              stats = conn.hgetall "#{REDIS_NAMESPACE}:#{type}:stats"
               stats.each do |key, value|
                 @charts[type][:stats] << [key.to_f, value.to_i]
               end
@@ -45,14 +47,25 @@ module Sidekiq
             end
           end
 
-          view_path = File.join(web_dir, "views", "benchmarks.erb")
-          template = File.read view_path
-          render :erb, template
+          erb File.read(VIEW_PATH)
         end
 
         app.post "/benchmarks/remove" do
           Sidekiq.redis do |conn|
-            keys = conn.keys "benchmark:*"
+            keys = STAT_KEYS.map { |key| "#{REDIS_NAMESPACE}:#{params[:type]}:#{key}" }
+            conn.srem TYPES_KEY, params[:type]
+            conn.del keys
+          end
+
+          redirect "#{root_path}benchmarks"
+        end
+        app.post "/benchmarks/remove_all" do
+          Sidekiq.redis do |conn|
+            types = conn.smembers TYPES_KEY
+            keys = STAT_KEYS.map do |key|
+              types.map { |type| "#{REDIS_NAMESPACE}:#{type}:#{key}" }
+            end.flatten
+            keys << TYPES_KEY
             conn.del keys
           end
 

data/lib/sidekiq-benchmark/worker.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Benchmark
     module Worker
-
       def benchmark(options = {})
         @benchmark ||= Benchmark.new self, benchmark_redis_type_key, options
 
@@ -18,9 +19,7 @@ module Sidekiq
       end
 
       class Benchmark
-        REDIS_NAMESPACE = :benchmark
-
-        attr_reader :metrics, :start_time, :finish_time, :redis_key
+        attr_reader :metrics, :start_time, :finish_time, :redis_keys
 
         def initialize(worker, redis_key, options)
           @metrics = {}
@@ -28,7 +27,12 @@ module Sidekiq
           @options = options
           @start_time = Time.now
 
-          @redis_key = "#{REDIS_NAMESPACE}:#{redis_key}"
+          @redis_keys =
+            %i[total stats].reduce({}) do |m, e|
+              m[e] = "#{REDIS_NAMESPACE}:#{redis_key}:#{e}"
+              m
+            end
+
           set_redis_key redis_key
         end
 
@@ -46,6 +50,8 @@ module Sidekiq
           self[name] ||= 0.0
           self[name] += t1 - t0
 
+          Sidekiq.logger.info "Benchmark #{name}: #{t1 - t0} sec." if @options[:log]
+
           ret
         end
         alias_method :bm, :measure
@@ -62,18 +68,10 @@ module Sidekiq
           @metrics[name]
         end
 
-        def method_missing(name, *args, &block)
-          if block_given?
-            measure(name, &block)
-            self[name]
-          else
-            self[name] = args[0]
-          end
-        end
-
         def set_redis_key(key)
           Sidekiq.redis do |conn|
-            conn.sadd "#{REDIS_NAMESPACE}:types", key
+            conn.sadd TYPES_KEY, key
+            conn.expire TYPES_KEY, REDIS_KEYS_TTL
           end
         end
 
@@ -83,17 +81,29 @@ module Sidekiq
           Sidekiq.redis do |conn|
             conn.multi do
               @metrics.each do |key, value|
-                conn.hincrbyfloat "#{redis_key}:total", key, value
+                conn.hincrbyfloat redis_keys[:total], key, value
               end
 
-              conn.hincrby "#{redis_key}:stats", job_time_key, 1
+              conn.hincrby redis_keys[:stats], job_time_key, 1
+
+              conn.hsetnx redis_keys[:total], "start_time", start_time
+              conn.hset redis_keys[:total], "finish_time", finish_time
 
-              conn.hsetnx "#{redis_key}:total", "start_time", start_time
-              conn.hset "#{redis_key}:total", "finish_time", finish_time
+              conn.expire redis_keys[:stats], REDIS_KEYS_TTL
+              conn.expire redis_keys[:total], REDIS_KEYS_TTL
             end
           end
         end
 
+        def method_missing(name, *args, &block)
+          if block_given?
+            measure(name, &block)
+            self[name]
+          else
+            self[name] = args[0]
+          end
+        end
+
       end
     end
   end

data/sidekiq-benchmark.gemspec

@@ -18,14 +18,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "chartkick", '>= 1.1.1'
-  gem.add_dependency "sinatra-assetpack", '>= 0.2.5'
+  gem.add_dependency "chartkick", ">= 1.1.1"
+  gem.add_dependency "sidekiq", "~> 5"
 
-  gem.add_development_dependency "sidekiq"
-  gem.add_development_dependency "sinatra"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rack-test"
   gem.add_development_dependency "minitest", "~> 5"
   gem.add_development_dependency "coveralls"
+  gem.add_development_dependency "pry"
   gem.add_development_dependency 'delorean', '~> 2.1'
 end

data/test/lib/testing.rb

@@ -1,7 +1,8 @@
 require 'test_helper'
-require 'sidekiq-benchmark/testing'
 
 class Sidekiq::Benchmark::TestingTest < Minitest::Spec
+  require 'sidekiq-benchmark/testing'
+
   describe 'Testing' do
     before do
       Sidekiq::Benchmark::Test.flush_db
@@ -10,13 +11,13 @@ class Sidekiq::Benchmark::TestingTest < Minitest::Spec
 
     it "save nothing to redis" do
       Sidekiq.redis do |conn|
-        total_time = conn.hget("#{@worker.benchmark.redis_key}:total", :job_time)
-        total_time.must_be_nil
+        total_time = conn.hget(@worker.benchmark.redis_keys[:total], :job_time)
+        _(total_time).must_be_nil
       end
     end
 
     it "run code in bm blocks" do
-      @worker.counter.wont_equal 0
+      _(@worker.counter).wont_equal 0
     end
   end
 end

data/test/lib/web_test.rb

@@ -14,33 +14,38 @@ module Sidekiq
           Test.flush_db
         end
 
-        it "should display index without stats" do
+        it "display index without stats" do
           get '/benchmarks'
-          last_response.status.must_equal 200
+          _(last_response.status).must_equal 200
         end
 
-        it "should display index with stats" do
+        it "display index with stats" do
           WorkerMock.new
 
           get '/benchmarks'
-          last_response.status.must_equal 200
+          _(last_response.status).must_equal 200
         end
 
-        it "should remove benchmarks data" do
+        it "remove all benchmarks data" do
           WorkerMock.new
 
-          Sidekiq.redis do |conn|
-            keys = conn.keys "benchmark:*"
-            keys.wont_be_empty
-          end
+          Sidekiq.redis { |conn| _(conn.keys("benchmark:*")).wont_be_empty }
 
-          post '/benchmarks/remove'
-          last_response.status.must_equal 302
+          post '/benchmarks/remove_all'
+          _(last_response.status).must_equal 302
 
-          Sidekiq.redis do |conn|
-            keys = conn.keys "benchmark:*"
-            keys.must_be_empty
-          end
+          Sidekiq.redis { |conn| _(conn.keys("benchmark:*")).must_be_empty }
+        end
+
+        it "remove benchmark data" do
+          WorkerMock.new
+
+          Sidekiq.redis { |conn| _(conn.keys("benchmark:sidekiq_benchmark_test_workermock:*")).wont_be_empty }
+
+          post '/benchmarks/remove', type: :sidekiq_benchmark_test_workermock
+          _(last_response.status).must_equal 302
+
+          Sidekiq.redis { |conn| _(conn.keys("benchmark:sidekiq_benchmark_test_workermock:*")).must_be_empty }
         end
       end
     end

data/test/lib/worker_test.rb

@@ -16,12 +16,12 @@ module Sidekiq
           metrics = @worker.benchmark.metrics
 
           @worker.metric_names.each do |metric_name|
-            metrics[metric_name].wont_be_nil
+            _(metrics[metric_name]).wont_be_nil
           end
 
-          @worker.benchmark.start_time.wont_be_nil
-          @worker.benchmark.finish_time.wont_be_nil
-          metrics[:assigned_metric].must_equal @worker.assigned_metric
+          _(@worker.benchmark.start_time).wont_be_nil
+          _(@worker.benchmark.finish_time).wont_be_nil
+          _(metrics[:assigned_metric]).must_equal @worker.assigned_metric
         end
 
         it 'should add up metrics' do
@@ -33,11 +33,11 @@ module Sidekiq
 
         it "should save metrics to redis" do
           Sidekiq.redis do |conn|
-            total_time = conn.hget("#{@worker.benchmark.redis_key}:total", :job_time)
-            total_time.wont_be_nil
+            total_time = conn.hget(@worker.benchmark.redis_keys[:total], :job_time)
+            _(total_time).wont_be_nil
 
-            metrics = conn.hkeys("#{@worker.benchmark.redis_key}:stats")
-            metrics.wont_be_empty
+            metrics = conn.hkeys(@worker.benchmark.redis_keys[:stats])
+            _(metrics).wont_be_empty
           end
         end
 
@@ -46,23 +46,21 @@ module Sidekiq
           metrics = worker.benchmark.metrics
 
           Sidekiq.redis do |conn|
-            metric_set = conn.hkeys("#{worker.benchmark.redis_key}:stats")
-            metric_set.must_be_empty
+            metric_set = conn.hkeys(worker.benchmark.redis_keys[:stats])
+            _(metric_set).must_be_empty
           end
 
           worker.metric_names.each do |metric_name|
-            metrics[metric_name].wont_be_nil
+            _(metrics[metric_name]).wont_be_nil
           end
 
-          worker.benchmark.finish_time.must_be_nil
-
+          _(worker.benchmark.finish_time).must_be_nil
           worker.finish
-
-          worker.benchmark.finish_time.wont_be_nil
+          _(worker.benchmark.finish_time).wont_be_nil
 
           Sidekiq.redis do |conn|
-            metric_set = conn.hkeys("#{worker.benchmark.redis_key}:stats")
-            metric_set.wont_be_empty
+            metric_set = conn.hkeys(worker.benchmark.redis_keys[:stats])
+            _(metric_set).wont_be_empty
           end
         end
 
@@ -70,8 +68,8 @@ module Sidekiq
           worker = AlterWorkerMock.new
           value  = worker.benchmark.call(:multiply, 4, 4)
 
-          value.must_equal 16
-          worker.benchmark.metrics[:multiply].wont_be_nil
+          _(value).must_equal 16
+          _(worker.benchmark.metrics[:multiply]).wont_be_nil
         end
 
       end