sidekiq-instrumental 0.2.3 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a71199e63e3ff0539ef7e598490f27f0715d30b8
-  data.tar.gz: bd14c5b122c230a542cbed342e0e1e186eee2bd4
+SHA256:
+  metadata.gz: 554f7530d3719b65ba7c9cc9defedaea1cec95adea137a0627ad81b98cee4405
+  data.tar.gz: fca6e4182df43e4c1980efe397623248c66c9d6c1510294d01727ef6118ce17f
 SHA512:
-  metadata.gz: 509476fe83703bd76e2a4a4129c5236e63877f695125fe0cc5e8695555235781bf401230a31e90ac28d6fb8391d327913645459777c8853a2be1f62e67487498
-  data.tar.gz: 2f9a3de47b48efa0ee50a410899f5bf59bb6b21af4baec6c73afdb6dbafcb1ddc728a91bd1ce1bd7eee21aafe103642812cf58d89498b105fb7d3ef1de5467a5
+  metadata.gz: d04a719ca6409deeacf6cb4ed59acf544521617b75226a4888b2559e94b8bd8ed71132451594d9ef3a2981b9d60760c57b6fb3278b9d0646e0ef44e1286675ba
+  data.tar.gz: 3fb5692dc389eb03581a3c0b1ad1dffab4116a410ea21d82887bea2a289657612a9c3deef08b03afdf89335336160db95466ec060e829ed6d38f0bcd8af887bb

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+## Change description
+
+> Please include a summary of the change and which issue is fixed. Please also include
+  relevant motivation and context. List any dependencies that are required for this change.
+
+## Related issues
+
+- Source: <Issue link or Spec Link>
+- UAT: <UAT Link>
+- QA: <QA Task Link here>
+- Review app: <Link to Heroku>
+
+## Checklists
+
+### Development
+
+- [ ] The commit message follows our [guidelines](https://docs.hubstaff.com/hubstaff-docs/latest/great_commit_messages.html)
+- [ ] I have performed a self-review of my own code
+- [ ] I have thoroughly tested the changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+
+### Security
+
+- [ ] Security impact of change has been considered

data/.github/workflows/prs.yml

@@ -0,0 +1,39 @@
+---
+name: CI PR Builds
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.7'
+        sidekiq:
+          - '4'
+          - '5'
+    env:
+      BUNDLE_GEMFILE: "${{ github.workspace }}/gemfiles/Gemfile.sidekiq${{ matrix.sidekiq }}"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby }}"
+          bundler-cache: true
+      - name: Run bundle update
+        run: bundle update
+      - name: Run tests
+        run: bundle exec rake spec
+      - name: Rubocop
+        run: bundle exec rubocop
+      - name: Build gem
+        run: gem build *.gemspec

data/.gitignore

@@ -4,6 +4,7 @@
 /.ruby-version
 /.ruby-gemset
 /Gemfile.lock
+/gemfiles/*.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+Layout/LineLength:
+  Max: 90
+Metrics:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Next]
+### Added
+### Changed
+### Fixed
+
+## [0.3.2]
+### Added
+- Implement a custom version of Sidekiq's display\_class\_name that fix an issues with ActiveJob > 6 when the job's class is passed as class not String
+- Limit support up to Sidekiq < 6. 
+
+## [0.3.1]
+### Fixed
+- class name calculation needs to filter out unsupported characters by instrumental
+
+## [0.3.0]
+### Fixed
+- class name calculation now uses Sidekiq's display\_class\_name to support ActiveJob jobs
+

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sidekiq-instrumental.gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/sidekiq-instrumental.svg)](https://badge.fury.io/rb/sidekiq-instrumental)
+
 # Sidekiq::Instrumental
 
 sidekiq-instrumental is a simple gem to record Sidekiq queue stats into [Instrumental](https://instrumentalapp.com/).

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "sidekiq/instrumental"
+require 'bundler/setup'
+require 'sidekiq/instrumental'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "sidekiq/instrumental"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir -p ~/.gem
+echo -e "---\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 ~/.gem/credentials

data/bin/tag_check.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+tag=`git describe --tags --exact-match  HEAD 2> /dev/null`
+
+if [ $? -eq 0 ]; then
+  version=`grep VERSION lib/sidekiq/instrumental/version.rb | sed -e "s/.*'\([^']*\)'.*/\1/"`
+  
+  if [ "v$version" = "$tag" ]; then
+    echo "Revision $tag Matches $version"
+  else
+    echo "Revision $tag does not match $version"
+    exit 2
+  fi
+else
+  echo "No tag found"
+  exit 1
+fi

data/gemfiles/Gemfile.base

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec path: File.expand_path('..', __FILE__)
+
+File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/gemfiles/Gemfile.sidekiq4

@@ -0,0 +1,4 @@
+base_gemfile = File.expand_path('../Gemfile.base', __FILE__)
+eval File.read(base_gemfile)
+
+gem "sidekiq", ">= 4.0", "< 5.0"

data/gemfiles/Gemfile.sidekiq5

@@ -0,0 +1,4 @@
+base_gemfile = File.expand_path('../Gemfile.base', __FILE__)
+eval File.read(base_gemfile)
+
+gem "sidekiq", ">= 5.0", "< 6.0"

data/lib/sidekiq/instrumental/configuration.rb

@@ -1,17 +1,23 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Instrumental
+    # Configuration for gem
     class Configuration
-      ARRAY_OPTIONS = [:whitelist_queues, :blacklist_queues, :whitelist_classes, :blacklist_classes]
+      ARRAY_OPTIONS = %i[
+        whitelist_queues blacklist_queues
+        whitelist_classes blacklist_classes
+      ].freeze
 
       attr_accessor :instrumental_agent
       attr_accessor :enabled, *ARRAY_OPTIONS
 
-      alias_method :I, :instrumental_agent
+      alias I instrumental_agent
 
       def initialize
         @instrumental_agent = nil
         self.enabled = true
-        ARRAY_OPTIONS.each {|o| self.send("#{o}=", [])}
+        ARRAY_OPTIONS.each { |o| send("#{o}=", []) }
       end
 
       def enabled?
@@ -19,7 +25,9 @@ module Sidekiq
       end
 
       def queue_in_whitelist(queue)
-        whitelist_queues.nil? || whitelist_queues.empty? || whitelist_queues.include?(queue.to_s)
+        whitelist_queues.nil? ||
+          whitelist_queues.empty? ||
+          whitelist_queues.include?(queue.to_s)
       end
 
       def queue_in_blacklist(queue)
@@ -27,7 +35,9 @@ module Sidekiq
       end
 
       def class_in_whitelist(worker_instance)
-        whitelist_classes.nil? || whitelist_classes.empty? || whitelist_classes.include?(worker_instance.class.to_s)
+        whitelist_classes.nil? ||
+          whitelist_classes.empty? ||
+          whitelist_classes.include?(worker_instance.class.to_s)
       end
 
       def class_in_blacklist(worker_instance)
@@ -35,8 +45,11 @@ module Sidekiq
       end
 
       def allowed_to_submit(queue, worker_instance)
-        class_in_whitelist(worker_instance) && !class_in_blacklist(worker_instance) && queue_in_whitelist(queue) && !queue_in_blacklist(queue)
+        class_in_whitelist(worker_instance) &&
+          !class_in_blacklist(worker_instance) &&
+          queue_in_whitelist(queue) &&
+          !queue_in_blacklist(queue)
       end
     end
   end
-end
+end

data/lib/sidekiq/instrumental/middleware/base.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'sidekiq/api'
 
 module Sidekiq
   module Instrumental
     module Middleware
+      # Shared base code for measuring stats for server and client sidekiq
       class Base
         attr_reader :config
 
@@ -10,14 +13,19 @@ module Sidekiq
           @config = config
         end
 
-        def call(worker_instance, msg, queue, redis_pool = nil)
+        def call(worker_instance, msg, queue, _redis_pool = nil)
           start_time = Time.now
           result = yield
           elapsed = (Time.now - start_time).to_f
 
           return result unless config.enabled?
 
-          track(::Sidekiq::Stats.new, worker_instance, msg, queue, elapsed)
+          track(
+            ::Sidekiq::Stats.new,
+            worker_instance,
+            ::Sidekiq::Job.new(msg),
+            queue, elapsed
+          )
 
           result
         end
@@ -25,11 +33,49 @@ module Sidekiq
         protected
 
         def increment(*args)
-          config.I.increment *args
+          config.I.increment(*args)
         end
 
         def gauge(*args)
-          config.I.gauge *args
+          config.I.gauge(*args)
+        end
+
+        def build_class_key(klass_name)
+          key = underscore(klass_name)
+                  .gsub(/[^\d\w\-_\.]/, '_')
+                  .gsub(/\.{2,}/, '.')
+          key.chomp!('.') while key[-1] == '.'
+          key
+        end
+
+        # Borrowed from active support so we do not depend on it.
+        def underscore(camel_cased_word)
+          return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+
+          word = camel_cased_word.to_s.gsub('::', '/')
+          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          word.tr!('-', '_')
+          word.downcase!
+          word
+        end
+
+        # Returns the human-friendly class name, if its a known wrapper we unwrap it.
+        # Previously, this was done by the +display_name+ method of Sidekiq::Job,
+        # but after this change (https://github.com/rails/rails/commit/0e64348ccaf513de731f403259ec5b49e7b3f028)
+        # the method (https://github.com/mperham/sidekiq/blob/main/lib/sidekiq/api.rb#L342)
+        # no longer works as expected as it compares a class against a string,
+        # returning the wrapped job class not the class behind it as String.
+        def unwrap_class_name(job)
+          display_class = job.display_class
+
+          if %w[ActionMailer::DeliveryJob ActionMailer::MailDeliveryJob]
+               .include?(display_class.class.name)
+            # The class name was not unwrapped correctly by the +display_class+ method
+            job.args[0]['arguments'][0..1].join('#')
+          else
+            display_class
+          end
         end
       end
     end

data/lib/sidekiq/instrumental/middleware/client.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Instrumental
     module Middleware
+      # Client side sidekiq middleware
       class Client < Base
-
-        def track(stats, worker_instance, msg, queue, elapsed)
-
+        def track(_stats, worker_instance, msg, queue, _elapsed)
           increment('sidekiq.queued')
 
           return unless config.allowed_to_submit queue, worker_instance
 
-          base_key = "sidekiq.#{queue.to_s}."
+          base_key = "sidekiq.#{queue}."
           increment(base_key + 'queued')
 
-          base_key += msg['class'].underscore.gsub('/', '_') + '.'
+          display_class = unwrap_class_name(msg)
+          base_key += build_class_key(display_class) + '.'
 
           increment(base_key + 'queued')
         end
       end
     end
   end
-end
+end

data/lib/sidekiq/instrumental/middleware/server.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Instrumental
     module Middleware
+      # Server side sidekiq middleware
       class Server < Base
         protected
 
@@ -9,26 +12,28 @@ module Sidekiq
 
           return unless config.allowed_to_submit queue, worker_instance
 
-          base_key = "sidekiq.#{queue.to_s}."
+          base_key = "sidekiq.#{queue}."
 
           increment(base_key + 'processed')
           gauge(base_key + 'time', elapsed)
           gauge(base_key + 'enqueued', stats.queues[queue].to_i)
           gauge(base_key + 'latency', Sidekiq::Queue.new(queue.to_s).latency)
-          base_key += msg['class'].underscore.gsub('/', '_') + '.'
+
+          display_class = unwrap_class_name(msg)
+          base_key += build_class_key(display_class) + '.'
 
           increment(base_key + 'processed')
-          increment(base_key + 'time', elapsed)
+          gauge(base_key + 'time', elapsed)
         end
 
         def submit_general_stats(stats)
-          increment("sidekiq.processed")
+          increment('sidekiq.processed')
           {
-              enqueued: nil,
-              failed: nil,
-              scheduled_size: 'scheduled'
+            enqueued: nil,
+            failed: nil,
+            scheduled_size: 'scheduled'
           }.each do |method, name|
-            gauge("sidekiq.#{(name || method).to_s}", stats.send(method).to_i)
+            gauge("sidekiq.#{(name || method)}", stats.send(method).to_i)
           end
         end
       end

data/lib/sidekiq/instrumental/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Instrumental
-    VERSION = "0.2.3"
+    VERSION = '0.3.2'
   end
 end

data/lib/sidekiq/instrumental.rb

@@ -1,4 +1,6 @@
-require "sidekiq/instrumental/version"
+# frozen_string_literal: true
+
+require 'sidekiq/instrumental/version'
 require 'sidekiq/instrumental/configuration'
 require 'sidekiq/instrumental/middleware/base'
 require 'sidekiq/instrumental/middleware/client'
@@ -6,18 +8,18 @@ require 'sidekiq/instrumental/middleware/server'
 require 'sidekiq'
 
 module Sidekiq
-  module Instrumental
+  module Instrumental # :nodoc:
     def self.config
       @config ||= Sidekiq::Instrumental::Configuration.new
     end
 
     def self.configure
-      yield self.config if block_given?
-      self.register
+      yield config if block_given?
+      register
     end
 
     def self.register
-      new_config = self.config.dup
+      new_config = config.dup
 
       ::Sidekiq.configure_server do |config|
         config.server_middleware do |chain|

data/sidekiq-instrumental.gemspec

@@ -1,28 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sidekiq/instrumental/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sidekiq-instrumental"
-  spec.version       = Sidekiq::Instrumental::VERSION
-  spec.authors       = ["Edward Rudd"]
-  spec.email         = ["urkle@outoforder.cc"]
-
-  spec.summary       = %q{Send Sidekiq status into Instrumental after every job}
-  spec.homepage      = "https://github.com/NetsoftHoldings/sidekiq-instrumental/"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.test_files    = Dir['spec/**/*']
-
-  spec.add_runtime_dependency 'instrumental_agent', ">= 0.13"
-  spec.add_runtime_dependency 'sidekiq', '>= 3.5'
-
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "simplecov", "~> 0.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.name = 'sidekiq-instrumental'
+  spec.version = Sidekiq::Instrumental::VERSION
+  spec.authors = ['Edward Rudd']
+  spec.email = ['urkle@outoforder.cc']
+
+  spec.summary = 'Send Sidekiq status into Instrumental after every job'
+  spec.homepage = 'https://github.com/NetsoftHoldings/sidekiq-instrumental/'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`
+                 .split("\x0")
+                 .reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.test_files = Dir['spec/**/*']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_runtime_dependency 'instrumental_agent', '>= 0.13'
+  spec.add_runtime_dependency 'sidekiq', '>= 4.0', '< 6.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.37.1'
 end

data/spec/sidekiq/instrumental/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Sidekiq::Instrumental::Configuration do
@@ -59,23 +61,38 @@ RSpec.describe Sidekiq::Instrumental::Configuration do
         expect(subject.send(method, 'other')).to eq(false)
       end
     end
-
   end
 
   describe '#queue_in_whitelist' do
-    include_examples 'whitelist checks', :whitelist_queues, :queue_in_whitelist, ['default'], 'default'
+    include_examples 'whitelist checks',
+                     :whitelist_queues,
+                     :queue_in_whitelist,
+                     ['default'],
+                     'default'
   end
 
   describe '#queue_in_blacklist' do
-    include_examples 'blacklist checks', :blacklist_queues, :queue_in_blacklist, ['default'], 'default'
+    include_examples 'blacklist checks',
+                     :blacklist_queues,
+                     :queue_in_blacklist,
+                     ['default'],
+                     'default'
   end
 
   describe '#class_in_whitelist' do
-    include_examples 'whitelist checks', :whitelist_classes, :class_in_whitelist, ['Array'], []
+    include_examples 'whitelist checks',
+                     :whitelist_classes,
+                     :class_in_whitelist,
+                     ['Array'],
+                     []
   end
 
   describe '#class_in_blacklist' do
-    include_examples 'blacklist checks', :blacklist_classes, :class_in_blacklist, ['Array'], []
+    include_examples 'blacklist checks',
+                     :blacklist_classes,
+                     :class_in_blacklist,
+                     ['Array'],
+                     []
   end
 
   describe '#allowed_to_submit' do
@@ -83,4 +100,4 @@ RSpec.describe Sidekiq::Instrumental::Configuration do
       expect(subject.allowed_to_submit('default', [])).to eq(true)
     end
   end
-end
+end

data/spec/sidekiq/instrumental/middleware/client_spec.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Sidekiq::Instrumental::Middleware::Client do
+  let(:config) { Sidekiq::Instrumental::Configuration.new }
+  let(:middleware) { described_class.new(config) }
+  let(:sidekiq_stats) { double('Sidekiq::Stats') }
+  let(:worker) { {} }
+  let(:msg) { { 'class' => 'MyClassName' } }
+  let(:queue) { 'default' }
+
+  before do
+    allow(config).to receive(:enabled?).and_return(true)
+    allow(middleware).to receive(:increment)
+    allow(::Sidekiq::Stats).to receive(:new).and_return(sidekiq_stats)
+  end
+
+  subject { middleware.call(worker, msg, queue) {} }
+
+  it 'increments the queued metric' do
+    expect(middleware).to receive(:increment).with('sidekiq.queued')
+
+    subject
+  end
+
+  it 'checks if the worker class is allowed to submit detailed metrics' do
+    expect(config).to receive(:allowed_to_submit).with(queue, worker)
+
+    subject
+  end
+
+  it 'increments the queued metric for the queue' do
+    expect(middleware).to receive(:increment).with("sidekiq.#{queue}.queued")
+
+    subject
+  end
+
+  describe 'metric naming' do
+    context 'when the class name contains unsupported characters' do
+      let(:msg) { { 'class' => 'MyMailer#message/fun' } }
+
+      it 'changes them to _' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message_fun.queued")
+
+        subject
+      end
+    end
+
+    context 'when the class name causes more then one . in a row' do
+      let(:msg) { { 'class' => 'MyMailer..message' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer.message.queued")
+
+        subject
+      end
+    end
+
+    context 'trims a trailing .' do
+      let(:msg) { { 'class' => 'MyMailer#message.' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message.queued")
+
+        subject
+      end
+    end
+  end
+
+  it 'calls display_class to get the class name' do
+    expect_any_instance_of(::Sidekiq::Job)
+      .to receive(:display_class).and_call_original
+
+    subject
+  end
+
+  it 'increments the queued metric for the worker class name' do
+    expect(middleware).to receive(:increment)
+                            .with("sidekiq.#{queue}.my_class_name.queued")
+
+    subject
+  end
+
+  describe 'Unwrap sidekiq job class name' do
+    let(:msg) do
+      {
+        'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped' => wrapped_class,
+        'args' => [{ 'arguments' => %w[UserMailer confirm_account deliver_now User] }]
+      }
+    end
+
+    context "when sidekiq's wrapped class is set as a String" do
+      let(:wrapped_class) { 'ActionMailer::DeliveryJob' }
+
+      it 'unwraps the class name and increments the metric' do
+        expect(middleware)
+          .to receive(:increment)
+                .with("sidekiq.#{queue}.user_mailer_confirm_account.queued")
+
+        subject
+      end
+    end
+
+    context "when sidekiq's wrapped class is set as a Class" do
+      let(:wrapped_class) { stub_const('ActionMailer::DeliveryJob', Class.new).new }
+
+      it 'unwraps the class name and increments the metric' do
+        expect(middleware)
+          .to receive(:increment)
+                .with("sidekiq.#{queue}.user_mailer_confirm_account.queued")
+
+        subject
+      end
+    end
+  end
+end

data/spec/sidekiq/instrumental/middleware/server_spec.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Sidekiq::Instrumental::Middleware::Server do
+  let(:config) { Sidekiq::Instrumental::Configuration.new }
+  let(:middleware) { described_class.new(config) }
+  let(:sidekiq_stats) do
+    instance_double('Sidekiq::Stats',
+                    enqueued: 1,
+                    failed: 2,
+                    scheduled_size: 3,
+                    queues: { queue => 4 })
+  end
+  let(:sidekiq_queue) { instance_double('Sidekiq::Queue', latency: 5) }
+  let(:worker) { {} }
+  let(:msg) { { 'class' => 'MyClassName' } }
+  let(:queue) { 'default' }
+
+  before do
+    allow(config).to receive(:enabled?).and_return(true)
+    allow(middleware).to receive(:increment)
+    allow(middleware).to receive(:gauge)
+    allow(::Sidekiq::Stats).to receive(:new).and_return(sidekiq_stats)
+    allow(::Sidekiq::Queue).to receive(:new).and_return(sidekiq_queue)
+  end
+
+  subject do
+    Timecop.freeze do
+      middleware.call(worker, msg, queue) do
+        Timecop.travel(0.5)
+      end
+    end
+  end
+
+  it 'submits general stats' do
+    expect(middleware).to receive(:gauge)
+                            .with('sidekiq.enqueued', 1)
+    expect(middleware).to receive(:gauge)
+                            .with('sidekiq.failed', 2)
+    expect(middleware).to receive(:gauge)
+                            .with('sidekiq.scheduled', 3)
+
+    subject
+  end
+
+  it 'increments the processed metric' do
+    expect(middleware).to receive(:increment)
+                            .with('sidekiq.processed')
+
+    subject
+  end
+
+  it 'increments the processed metric for the queue' do
+    expect(middleware).to receive(:increment)
+                            .with("sidekiq.#{queue}.processed")
+
+    subject
+  end
+
+  it 'gauge the elapsed time metric for the queue' do
+    expect(middleware).to receive(:gauge)
+                            .with(
+                              "sidekiq.#{queue}.time",
+                              be_within(0.001).of(0.5)
+                            )
+
+    subject
+  end
+
+  it 'gauge the enqueued metric for the queue' do
+    expect(middleware).to receive(:gauge)
+                            .with("sidekiq.#{queue}.enqueued", 4)
+
+    subject
+  end
+
+  it 'gauge the latency metric for the queue' do
+    expect(middleware).to receive(:gauge)
+                            .with("sidekiq.#{queue}.latency", 5)
+
+    subject
+  end
+
+  it 'increments processed metric for the class' do
+    expect(middleware).to receive(:increment)
+                            .with("sidekiq.#{queue}.my_class_name.processed")
+
+    subject
+  end
+
+  describe 'metric naming' do
+    context 'when the class name contains unsupported characters' do
+      let(:msg) { { 'class' => 'MyMailer#message/fun' } }
+
+      it 'changes them to _' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message_fun.processed")
+
+        subject
+      end
+    end
+
+    context 'when the class name causes more then one . in a row' do
+      let(:msg) { { 'class' => 'MyMailer..message' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer.message.processed")
+
+        subject
+      end
+    end
+
+    context 'trims a trailing .' do
+      let(:msg) { { 'class' => 'MyMailer#message.' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message.processed")
+
+        subject
+      end
+    end
+  end
+
+  it 'gauge elapsed time metric for the class' do
+    expect(middleware).to receive(:gauge)
+                            .with(
+                              "sidekiq.#{queue}.my_class_name.time",
+                              be_within(0.001).of(0.5)
+                            )
+
+    subject
+  end
+
+  describe 'Unwrap sidekiq job class name' do
+    let(:msg) do
+      {
+        'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped' => wrapped_class,
+        'args' => [{ 'arguments' => %w[UserMailer confirm_account deliver_now User] }]
+      }
+    end
+
+    context "when sidekiq's wrapped class is set as a String" do
+      let(:wrapped_class) { 'ActionMailer::DeliveryJob' }
+
+      it 'unwraps the class name and increments the metric' do
+        expect(middleware)
+          .to receive(:increment)
+                .with("sidekiq.#{queue}.user_mailer_confirm_account.processed")
+
+        subject
+      end
+    end
+
+    context "when sidekiq's wrapped class is set as a Class" do
+      let(:wrapped_class) { stub_const('ActionMailer::DeliveryJob', Class.new).new }
+
+      it 'unwraps the class name and increments the metric' do
+        expect(middleware)
+          .to receive(:increment)
+                .with("sidekiq.#{queue}.user_mailer_confirm_account.processed")
+
+        subject
+      end
+    end
+  end
+end

data/spec/sidekiq/instrumental_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Sidekiq::Instrumental do
@@ -8,7 +10,8 @@ RSpec.describe Sidekiq::Instrumental do
   describe '::config' do
     describe '::config' do
       it 'should return a Configuration object' do
-        expect(described_class.config).to be_an_instance_of(described_class::Configuration)
+        expect(described_class.config)
+          .to be_an_instance_of(described_class::Configuration)
       end
     end
   end
@@ -22,7 +25,8 @@ RSpec.describe Sidekiq::Instrumental do
     end
 
     it 'should yield the configuration object' do
-      expect { |b| described_class.configure(&b) }.to yield_with_args(described_class.config)
+      expect { |b| described_class.configure(&b) }
+        .to yield_with_args(described_class.config)
     end
   end
 
@@ -39,8 +43,13 @@ RSpec.describe Sidekiq::Instrumental do
         allow(config).to receive(:client_middleware)
         allow(Sidekiq).to receive(:configure_server).and_yield(config)
 
-        expect(server_chain).to receive(:remove).with(described_class::Middleware::Server)
-        expect(server_chain).to receive(:add).with(described_class::Middleware::Server, an_instance_of(described_class::Configuration))
+        expect(server_chain).to receive(:remove)
+                                  .with(described_class::Middleware::Server)
+        expect(server_chain).to receive(:add)
+                                  .with(described_class::Middleware::Server,
+                                        an_instance_of(
+                                          described_class::Configuration
+                                        ))
 
         described_class.register
       end
@@ -52,8 +61,13 @@ RSpec.describe Sidekiq::Instrumental do
         allow(config).to receive(:client_middleware).and_yield(client_chain)
         allow(Sidekiq).to receive(:configure_server).and_yield(config)
 
-        expect(client_chain).to receive(:remove).with(described_class::Middleware::Client)
-        expect(client_chain).to receive(:add).with(described_class::Middleware::Client, an_instance_of(described_class::Configuration))
+        expect(client_chain).to receive(:remove)
+                                  .with(described_class::Middleware::Client)
+        expect(client_chain).to receive(:add)
+                                  .with(described_class::Middleware::Client,
+                                        an_instance_of(
+                                          described_class::Configuration
+                                        ))
 
         described_class.register
       end
@@ -66,8 +80,13 @@ RSpec.describe Sidekiq::Instrumental do
         allow(config).to receive(:client_middleware).and_yield(client_chain)
         allow(Sidekiq).to receive(:configure_client).and_yield(config)
 
-        expect(client_chain).to receive(:remove).with(described_class::Middleware::Client)
-        expect(client_chain).to receive(:add).with(described_class::Middleware::Client, an_instance_of(described_class::Configuration))
+        expect(client_chain).to receive(:remove)
+                                  .with(described_class::Middleware::Client)
+        expect(client_chain).to receive(:add)
+                                  .with(described_class::Middleware::Client,
+                                        an_instance_of(
+                                          described_class::Configuration
+                                        ))
 
         described_class.register
       end

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'simplecov'
 require 'sidekiq/instrumental'
+require 'timecop'
+
+Timecop.safe_mode = true
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrumental
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.2
 platform: ruby
 authors:
 - Edward Rudd
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -30,28 +30,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -67,50 +101,72 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-description: 
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+description:
 email:
 - urkle@outoforder.cc
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/prs.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".simplecov"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- circle.yml
+- bin/setup-rubygems.sh
+- bin/tag_check.sh
+- gemfiles/Gemfile.base
+- gemfiles/Gemfile.sidekiq4
+- gemfiles/Gemfile.sidekiq5
 - lib/sidekiq/instrumental.rb
 - lib/sidekiq/instrumental/configuration.rb
 - lib/sidekiq/instrumental/middleware/base.rb
@@ -119,13 +175,15 @@ files:
 - lib/sidekiq/instrumental/version.rb
 - sidekiq-instrumental.gemspec
 - spec/sidekiq/instrumental/configuration_spec.rb
+- spec/sidekiq/instrumental/middleware/client_spec.rb
+- spec/sidekiq/instrumental/middleware/server_spec.rb
 - spec/sidekiq/instrumental_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/NetsoftHoldings/sidekiq-instrumental/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,19 +191,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Send Sidekiq status into Instrumental after every job
 test_files:
-- spec/sidekiq/instrumental/configuration_spec.rb
-- spec/sidekiq/instrumental_spec.rb
 - spec/spec_helper.rb
+- spec/sidekiq/instrumental_spec.rb
+- spec/sidekiq/instrumental/middleware/client_spec.rb
+- spec/sidekiq/instrumental/middleware/server_spec.rb
+- spec/sidekiq/instrumental/configuration_spec.rb

data/circle.yml

@@ -1,17 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.5
-dependencies:
-  post:
-    - gem install geminabox
-test:
-  post:
-    - gem build sidekiq-instrumental.gemspec
-    - rm -rf pkg
-    - mkdir -p pkg
-    - mv *.gem pkg
-deployment:
-  release:
-    tag: /v[0-9]+(\.[0-9]+)+/
-    commands:
-      - gem inabox -g ${HUBSTAFF_GEM_SERVER}