sidekiq-instrumental 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3b5be832d57b3a1a67741a65b46b983f0580b56a7ff24db58fb8da85b59ee8
-  data.tar.gz: e2465ae0bad37bd73903c6cd7e4c518c1e3350d508684a30178a6f9929d8a393
+  metadata.gz: d14f250c271b145a6c61534eff188d74ed8f8382d57ab5528222a3a2bb924756
+  data.tar.gz: 8dddb6c4aa02f3d71f6e43ed09e78d9f3da62f6ab3c453eed266ca15fa7c4ef7
 SHA512:
-  metadata.gz: 90e026453667bb00ebf30e992a3b38e1cca3aeb6273e914ef68fb6cdff4340c1e9a8129def78672a9bd64b58d0d71f7f5c9a022a83ea250e59310f412bb9a64d
-  data.tar.gz: f3050927c14134accfba8316f4394bd8ef6bd35aafef32a5ca7c7b1145491a9ab67996e13c6d2c27514e61369ba85ebec8893407b11d6077f658ae819eef3583
+  metadata.gz: f4e2f11e879c4c6af1fc88a1df84cc8ce2bb373ba7c1c7c8ce2674e1997a793c361ecd77fe9d539002e387aebae8e66cfe48d186a4ba889da2f7e978776c8b4a
+  data.tar.gz: dcaa77759c298e69e5400b72cf0cddcdb479430e21786a15a020c6b647393fd773c9359aa950a38b127714644aa398708d0756220c159bb3dc5693cc620d3cc7

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/CHANGELOG.md

@@ -9,6 +9,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 ### Fixed
 
+## [0.3.4]
+### Fixed
+- cover multiple possible returns types of display_class
+
+## [0.3.3]
+### Fixed
+- Fix unwrap_class_name, it was wrongly expecting an instance not a class.
+
+## [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

data/bin/setup-rubygems.sh

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

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/middleware/base.rb

@@ -41,12 +41,42 @@ module Sidekiq
         end
 
         def build_class_key(klass_name)
-          key = klass_name.underscore
+          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.to_s)
+            # The class name was not unwrapped correctly by the +display_class+ method
+            job.args[0]['arguments'][0..1].join('#')
+          else
+            display_class.to_s
+          end
+        end
       end
     end
   end

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

@@ -13,7 +13,8 @@ module Sidekiq
           base_key = "sidekiq.#{queue}."
           increment(base_key + 'queued')
 
-          base_key += build_class_key(msg.display_class) + '.'
+          display_class = unwrap_class_name(msg)
+          base_key += build_class_key(display_class) + '.'
 
           increment(base_key + 'queued')
         end

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

@@ -18,7 +18,9 @@ module Sidekiq
           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 += build_class_key(msg.display_class) + '.'
+
+          display_class = unwrap_class_name(msg)
+          base_key += build_class_key(display_class) + '.'
 
           increment(base_key + 'processed')
           gauge(base_key + 'time', elapsed)

data/lib/sidekiq/instrumental/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Instrumental
-    VERSION = '0.3.1'
+    VERSION = '0.3.4'
   end
 end

data/sidekiq-instrumental.gemspec

@@ -24,10 +24,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3'
 
   spec.add_runtime_dependency 'instrumental_agent', '>= 0.13'
-  spec.add_runtime_dependency 'sidekiq', '>= 3.5'
+  spec.add_runtime_dependency 'sidekiq', '>= 4.0', '< 6.0'
 
-  spec.add_development_dependency 'activesupport', '~> 5.0'
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  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'

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

@@ -2,8 +2,6 @@
 
 require 'spec_helper'
 
-require 'active_support/core_ext/string/inflections'
-
 RSpec.describe Sidekiq::Instrumental::Middleware::Client do
   let(:config) { Sidekiq::Instrumental::Configuration.new }
   let(:middleware) { described_class.new(config) }
@@ -71,6 +69,16 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Client do
         subject
       end
     end
+
+    context 'when the class is not passed as a string' do
+      let(:msg) { { 'class' => stub_const('MyClassName', Class.new) } }
+
+      it 'increments the queued metric for the queue' do
+        expect(middleware).to receive(:increment).with("sidekiq.#{queue}.queued")
+
+        subject
+      end
+    end
   end
 
   it 'calls display_class to get the class name' do
@@ -86,4 +94,72 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Client do
 
     subject
   end
+
+  describe 'Unwrap sidekiq job class name' do
+    let(:msg) do
+      {
+        'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped' => passed_class,
+        'args' => args
+      }
+    end
+    let(:args) { [] }
+
+    context "when sidekiq's wrapped class is a mail delivery job" do
+      let(:wrapped_class) { stub_const('ActionMailer::DeliveryJob', Class.new) }
+      let(:args) { [{ 'arguments' => %w[UserMailer confirm_account deliver_now User] }] }
+
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
+
+        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 passed as a Class' do
+        let(:passed_class) { wrapped_class }
+
+        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
+
+    context "when sidekiq's wrapped class is not a mail delivery job" do
+      let(:wrapped_class) { stub_const('Jobs::Job', Class.new) }
+
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
+
+        it 'unwraps the class name and increments the metric' do
+          expect(middleware)
+            .to receive(:increment)
+                  .with("sidekiq.#{queue}.jobs_job.queued")
+
+          subject
+        end
+      end
+
+      context 'when passed as a Class' do
+        let(:passed_class) { wrapped_class }
+
+        it 'unwraps the class name and increments the metric' do
+          expect(middleware)
+            .to receive(:increment)
+                  .with("sidekiq.#{queue}.jobs_job.queued")
+
+          subject
+        end
+      end
+    end
+  end
 end

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

@@ -2,8 +2,6 @@
 
 require 'spec_helper'
 
-require 'active_support/core_ext/string/inflections'
-
 RSpec.describe Sidekiq::Instrumental::Middleware::Server do
   let(:config) { Sidekiq::Instrumental::Configuration.new }
   let(:middleware) { described_class.new(config) }
@@ -124,6 +122,16 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Server do
         subject
       end
     end
+
+    context 'when the class is not passed as a string' do
+      let(:msg) { { 'class' => stub_const('MyClassName', Class.new) } }
+
+      it 'increments the queued metric for the queue' do
+        expect(middleware).to receive(:increment).with("sidekiq.#{queue}.processed")
+
+        subject
+      end
+    end
   end
 
   it 'gauge elapsed time metric for the class' do
@@ -135,4 +143,72 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Server do
 
     subject
   end
+
+  describe 'Unwrap sidekiq job class name' do
+    let(:msg) do
+      {
+        'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped' => passed_class,
+        'args' => args
+      }
+    end
+    let(:args) { [] }
+
+    context "when sidekiq's wrapped class is a mail delivery job" do
+      let(:wrapped_class) { stub_const('ActionMailer::DeliveryJob', Class.new) }
+      let(:args) { [{ 'arguments' => %w[UserMailer confirm_account deliver_now User] }] }
+
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
+
+        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 passed as a Class' do
+        let(:passed_class) { wrapped_class }
+
+        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
+
+    context "when sidekiq's wrapped class is not a mail delivery job" do
+      let(:wrapped_class) { stub_const('Jobs::Job', Class.new) }
+
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
+
+        it 'unwraps the class name and increments the metric' do
+          expect(middleware)
+            .to receive(:increment)
+                  .with("sidekiq.#{queue}.jobs_job.processed")
+
+          subject
+        end
+      end
+
+      context 'when passed as a Class' do
+        let(:passed_class) { wrapped_class }
+
+        it 'unwraps the class name and increments the metric' do
+          expect(middleware)
+            .to receive(:increment)
+                  .with("sidekiq.#{queue}.jobs_job.processed")
+
+          subject
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrumental
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Edward Rudd
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -30,42 +30,34 @@ 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'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,14 +142,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.37.1
-description: 
+description:
 email:
 - urkle@outoforder.cc
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/prs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -171,6 +164,9 @@ files:
 - bin/setup
 - 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
@@ -187,7 +183,7 @@ homepage: https://github.com/NetsoftHoldings/sidekiq-instrumental/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,8 +198,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Send Sidekiq status into Instrumental after every job
 test_files:

data/.circleci/config.yml

@@ -1,135 +0,0 @@
-version: 2
-
-defaults: &defaults
-  docker: &ruby_image
-    - &ruby_image
-      image: circleci/ruby:2.5-stretch
-      environment:
-        RUBYOPT: '-KU -E utf-8:utf-8'
-        BUNDLE_PATH: vendor/bundle
-        BUNDLE_VERSION: 1.17.3
-        BUNDLE_JOBS: 4
-        BUNDLE_RETRY: 3
-
-filters:
-  test: &filter_test
-    filters:
-      tags:
-        ignore: /^v.*/
-  beta: &filter_beta
-    filters:
-      branches:
-        ignore: /.*/
-      tags:
-        only: /^v[0-9]+(\.[0-9]+)+(\.[a-z].+).*/
-  release: &filter_release
-    filters:
-      branches:
-        ignore: /.*/
-      tags:
-        only: /^v[0-9]+(\.[0-9]+)+/
-
-workflows:
-  version: 2
-  build_test:
-    jobs:
-      - "Checkout":
-          <<: *filter_test
-          context: org-global
-      - "Test":
-          <<: *filter_test
-          context: org-global
-          requires:
-            - "Checkout"
-  build_test_beta:
-    jobs:
-      - "Checkout":
-          <<: *filter_beta
-          context: org-global
-      - "Test":
-          <<: *filter_beta
-          context: org-global
-          requires:
-            - "Checkout"
-      - "Publish":
-          <<: *filter_beta
-          context: org-global
-          requires:
-            - "Test"
-  build_test_release:
-    jobs:
-      - "Checkout":
-          <<: *filter_release
-          context: org-global
-      - "Test":
-          <<: *filter_release
-          context: org-global
-          requires:
-            - "Checkout"
-      - "Publish":
-          <<: *filter_release
-          context: org-global
-          requires:
-            - "Test"
-
-jobs:
-  "Checkout":
-    <<: *defaults
-    steps:
-      - attach_workspace:
-          at: .
-      - checkout
-
-      - restore_cache:
-          keys:
-            - sidekiq-instrumental-bundle-v2-{{ checksum "Gemfile" }}-{{ checksum "sidekiq-instrumental.gemspec" }}
-      - run:
-          name: Install bundler
-          command: gem install bundler --version=$BUNDLE_VERSION
-      - run:
-          name: Bundle Install
-          command: |-
-            bundle _${BUNDLE_VERSION}_ check || bundle _${BUNDLE_VERSION}_ install --retry=$BUNDLE_RETRY
-      - save_cache:
-          key: sidekiq-instrumental-bundle-v2-{{ checksum "Gemfile" }}-{{ checksum "sidekiq-instrumental.gemspec" }}
-          paths:
-            - vendor/bundle
-            - Gemfile.lock
-
-      - persist_to_workspace:
-          root: .
-          paths: .
-  "Test":
-    <<: *defaults
-    steps:
-      - attach_workspace:
-          at: .
-      - run:
-          name: Install bundler
-          command: gem install bundler --version=$BUNDLE_VERSION
-      - run:
-          name: RSpec
-          command: bundle exec rspec
-      - run:
-          name: Rubocop
-          command: bundle exec rubocop
-      - run:
-          name: Build gem
-          command: |-
-            gem build *.gemspec
-  "Publish":
-    <<: *defaults
-    steps:
-      - attach_workspace:
-          at: .
-      - run:
-          name: Install bundler
-          command: gem install bundler --version=$BUNDLE_VERSION
-      - run:
-          name: Deploy to gem server
-          command: |-
-            ./bin/tag_check.sh
-            ./bin/setup-rubygems.sh
-            rm -rf pkg
-            rake build
-            gem push pkg/*.gem