sidekiq-instrumental 0.3.3.beta1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2014d2899db54a56adf4eba1b904e2535f1913ab8cf85cca87b2c0e2c3d70d3d
-  data.tar.gz: 8075a76ffa10c9ab9a7c9665d32997fa7cbf0d5d462ff13a1899f15fe3181239
+  metadata.gz: d14f250c271b145a6c61534eff188d74ed8f8382d57ab5528222a3a2bb924756
+  data.tar.gz: 8dddb6c4aa02f3d71f6e43ed09e78d9f3da62f6ab3c453eed266ca15fa7c4ef7
 SHA512:
-  metadata.gz: ad52c52631e1721a628a0381df96efc1f6ddb6336d898abdd0695366fa70581fc5924d045434b8ac67903d6c460b64902d18a06330a53655ad5166f615b08fe6
-  data.tar.gz: 9c38a6c7a8744885651773321d523f012f1584685c9b9c021fb4986403a0e778f3003ce7f18b322e797f68e764ee1fcb587fec66510537c185270f4fd78b40b3
+  metadata.gz: f4e2f11e879c4c6af1fc88a1df84cc8ce2bb373ba7c1c7c8ce2674e1997a793c361ecd77fe9d539002e387aebae8e66cfe48d186a4ba889da2f7e978776c8b4a
+  data.tar.gz: dcaa77759c298e69e5400b72cf0cddcdb479430e21786a15a020c6b647393fd773c9359aa950a38b127714644aa398708d0756220c159bb3dc5693cc620d3cc7

data/CHANGELOG.md

@@ -9,6 +9,10 @@ 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.

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

@@ -74,7 +74,7 @@ module Sidekiq
             # The class name was not unwrapped correctly by the +display_class+ method
             job.args[0]['arguments'][0..1].join('#')
           else
-            display_class
+            display_class.to_s
           end
         end
       end

data/lib/sidekiq/instrumental/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Instrumental
-    VERSION = '0.3.3.beta1'
+    VERSION = '0.3.4'
   end
 end

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

@@ -69,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
@@ -89,32 +99,66 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Client do
     let(:msg) do
       {
         'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
-        'wrapped' => wrapped_class,
-        'args' => [{ 'arguments' => %w[UserMailer confirm_account deliver_now User] }]
+        'wrapped' => passed_class,
+        'args' => args
       }
     end
+    let(:args) { [] }
 
-    context "when sidekiq's wrapped class is set as a String" do
-      let(:wrapped_class) { 'ActionMailer::DeliveryJob' }
+    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] }] }
 
-      it 'unwraps the class name and increments the metric' do
-        expect(middleware)
-          .to receive(:increment)
-                .with("sidekiq.#{queue}.user_mailer_confirm_account.queued")
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
 
-        subject
+        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 set as a Class" do
-      let(:wrapped_class) { stub_const('ActionMailer::DeliveryJob', Class.new) }
+    context "when sidekiq's wrapped class is not a mail delivery job" do
+      let(:wrapped_class) { stub_const('Jobs::Job', Class.new) }
 
-      it 'unwraps the class name and increments the metric' do
-        expect(middleware)
-          .to receive(:increment)
-                .with("sidekiq.#{queue}.user_mailer_confirm_account.queued")
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
 
-        subject
+        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

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

@@ -122,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
@@ -138,32 +148,66 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Server do
     let(:msg) do
       {
         'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
-        'wrapped' => wrapped_class,
-        'args' => [{ 'arguments' => %w[UserMailer confirm_account deliver_now User] }]
+        'wrapped' => passed_class,
+        'args' => args
       }
     end
+    let(:args) { [] }
 
-    context "when sidekiq's wrapped class is set as a String" do
-      let(:wrapped_class) { 'ActionMailer::DeliveryJob' }
+    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] }] }
 
-      it 'unwraps the class name and increments the metric' do
-        expect(middleware)
-          .to receive(:increment)
-                .with("sidekiq.#{queue}.user_mailer_confirm_account.processed")
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
 
-        subject
+        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 set as a Class" do
-      let(:wrapped_class) { stub_const('ActionMailer::DeliveryJob', Class.new) }
+    context "when sidekiq's wrapped class is not a mail delivery job" do
+      let(:wrapped_class) { stub_const('Jobs::Job', Class.new) }
 
-      it 'unwraps the class name and increments the metric' do
-        expect(middleware)
-          .to receive(:increment)
-                .with("sidekiq.#{queue}.user_mailer_confirm_account.processed")
+      context 'when passed as a String' do
+        let(:passed_class) { wrapped_class.to_s }
 
-        subject
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrumental
 version: !ruby/object:Gem::Version
-  version: 0.3.3.beta1
+  version: 0.3.4
 platform: ruby
 authors:
 - Edward Rudd
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -194,9 +194,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: