sidekiq-memory_logger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d86186cadbe56a86c0d9f503f95bffe809038454a011ebe2878a7caf9190cc
-  data.tar.gz: 74d82b63659d8562d314bd0c62eb75d54a1e58933ad37894b6335882d7a2713c
+  metadata.gz: fa6efe35a98202afd1bebd865fd1e5f2ee3caf51336f50b02e1748b265a3f980
+  data.tar.gz: 3c4cd8a910658205fdaa5d410a56deea983750c627c6e828d3a0d31a05948219
 SHA512:
-  metadata.gz: 03b7ae7daf959020bf30ea8dfafb7d77b4f2cf34ea32099c3954f8a811defec17ba2ab6db8f7cdc39615bf6b88ef5598d136677ab9c6d52e27e64af34975c7ca
-  data.tar.gz: 7daa948bfdf7310df265b7174aad891ba0cdc7af27c5f9015602ded35971cd0df3c127ad5c5c34d120ab94ca633cc191b4c2396a227b61c08cf7703616ffe3d9
+  metadata.gz: b7be75489aa198106891e28e854092e77176628a691c4eaf25cba301258163616355abf0edf86a482135ede7bc1c7d3bb5305ed544de69152686dc67c327ede6
+  data.tar.gz: 4a509383f8a7879ee634970f6c694340be534e1a179501dbafe8d4010cbcb5a06564311b298a69ea4fe21507f161077a8d6e4e24a0db239422e5e435113f64cb

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/benchmark.yml

@@ -27,7 +27,7 @@ jobs:
         ruby-version: ['3.4']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1

data/.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
         ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## [0.2.0]
+
+- Fixed compatibility with ActiveJob, we now correctly report the wrapped class
+- Removed Rails logger test mocks in favor of real integration testing
+
+## [0.1.1]
+
+- Renamed gem from `sidekiq-memory-logger` to `sidekiq-memory_logger` for consistency with Ruby naming conventions
+
+## [0.1.0]
+
+- Object allocation tracking using `GC.stat[:total_allocated_objects]`
+- Queue filtering configuration to selectively monitor specific queues
+- Performance benchmarking using sidekiqload tool
+- Support for custom callbacks (StatsD, New Relic, Datadog examples)
+at: `[MemoryLogger] job=MyJob queue=default memory_mb=15.2 objects=12345`
+

data/conductor.json

@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "setup": "mise exec -- bundle install"
+  }
+}

data/lib/sidekiq/memory_logger/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module MemoryLogger
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/sidekiq/memory_logger.rb

@@ -47,8 +47,6 @@ module Sidekiq
     end
 
     class Middleware
-      include Sidekiq::ServerMiddleware
-
       def initialize(config = nil)
         @memory_logger_config = config || MemoryLogger.configuration
       end
@@ -68,7 +66,7 @@ module Sidekiq
           objects_diff = end_objects - start_objects
 
           begin
-            @memory_logger_config.callback.call(job["class"], queue, memory_diff, objects_diff, job["args"])
+            @memory_logger_config.callback.call(job["wrapped"] || job["class"], queue, memory_diff, objects_diff, job["args"])
           rescue => e
             @memory_logger_config.logger.error("Sidekiq memory logger callback failed: #{e.message}")
           end

data/test/sidekiq/memory_logger/middleware_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "active_job"
 
 class TestSidekiqMemoryLoggerMiddleware < Minitest::Test
   def setup
@@ -180,4 +181,60 @@ class TestSidekiqMemoryLoggerMiddleware < Minitest::Test
     assert_equal "TestJob", job_class
     assert_equal "any_queue", queue
   end
+
+  def test_middleware_uses_wrapped_class_for_activejob
+    callback_calls = []
+    activejob_wrapped = {
+      "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
+      "wrapped" => "ProcessCompanyDataJob",
+      "args" => [{"job_class" => "ProcessCompanyDataJob"}]
+    }
+    config = Sidekiq::MemoryLogger::Configuration.new
+    config.callback = ->(job_class, queue, memory_diff, objects_diff, args) do
+      callback_calls << [job_class, queue, memory_diff, objects_diff, args]
+    end
+
+    middleware = Sidekiq::MemoryLogger::Middleware.new(config)
+    middleware.call(nil, activejob_wrapped, @queue) { sleep 0.01 }
+
+    assert_equal 1, callback_calls.length
+    job_class, _queue, _memory_diff, _objects_diff, _args = callback_calls.first
+    assert_equal "ProcessCompanyDataJob", job_class
+  end
+
+  def test_middleware_with_real_activejob_class
+    test_job_class = Class.new(ActiveJob::Base) do
+      queue_as :default
+
+      def perform(arg1, arg2)
+        arg1 + arg2
+      end
+
+      def self.name
+        "TestActiveJob"
+      end
+    end
+
+    callback_calls = []
+    config = Sidekiq::MemoryLogger::Configuration.new
+    config.callback = ->(job_class, queue, memory_diff, objects_diff, args) do
+      callback_calls << [job_class, queue, memory_diff, objects_diff, args]
+    end
+
+    serialized_job = test_job_class.new(1, 2).serialize
+    job_hash = {
+      "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
+      "wrapped" => "TestActiveJob",
+      "queue" => "default",
+      "args" => [serialized_job]
+    }
+
+    middleware = Sidekiq::MemoryLogger::Middleware.new(config)
+    middleware.call(nil, job_hash, "default") { sleep 0.01 }
+
+    assert_equal 1, callback_calls.length
+    job_class, queue, _memory_diff, _objects_diff, _args = callback_calls.first
+    assert_equal "TestActiveJob", job_class
+    assert_equal "default", queue
+  end
 end

data/test/sidekiq/memory_logger/rails_test.rb

@@ -1,76 +1,33 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "logger"
 require "rails"
 
 class TestSidekiqMemoryLoggerRails < Minitest::Test
-  def test_rails_is_available_and_responds_to_logger
-    # Verify Rails constant exists and has logger method
-    assert defined?(Rails), "Rails should be defined"
-    assert Rails.respond_to?(:logger), "Rails should respond to logger"
+  def setup
+    @original_logger = Rails.logger
+  end
+
+  def teardown
+    Rails.logger = @original_logger
   end
 
   def test_configuration_uses_rails_logger_when_rails_logger_available
-    # Create a mock Rails with a logger
-    original_logger_method = Rails.method(:logger) if Rails.respond_to?(:logger)
     test_logger = Logger.new(StringIO.new)
+    Rails.logger = test_logger
 
-    Rails.define_singleton_method(:logger) { test_logger }
-
-    # Create new configuration
     config = Sidekiq::MemoryLogger::Configuration.new
 
-    # Should use our test Rails.logger
     assert_equal test_logger, config.logger
-  ensure
-    # Restore original logger method
-    if original_logger_method
-      Rails.define_singleton_method(:logger, &original_logger_method)
-    end
   end
 
   def test_configuration_falls_back_when_rails_logger_nil
-    # Ensure Rails.logger returns nil (default state)
-    Rails.define_singleton_method(:logger) { nil }
-
-    # Create new configuration
-    config = Sidekiq::MemoryLogger::Configuration.new
-
-    # Should fall back to stdout logger since Rails.logger is nil
-    assert_instance_of Logger, config.logger
-    assert_equal $stdout, config.logger.instance_variable_get(:@logdev).dev
-  end
-
-  def test_configuration_falls_back_when_rails_not_available
-    # Temporarily hide Rails constant
-    rails_backup = Object.send(:remove_const, :Rails) if defined?(Rails)
-
-    # Create new configuration instance
-    config = Sidekiq::MemoryLogger::Configuration.new
-
-    # Should fall back to stdout logger
-    assert_instance_of Logger, config.logger
-    assert_equal $stdout, config.logger.instance_variable_get(:@logdev).dev
-  ensure
-    # Restore Rails constant
-    Object.const_set(:Rails, rails_backup) if rails_backup
-  end
-
-  def test_configuration_falls_back_when_rails_logger_unavailable
-    # Create mock Rails without logger method
-    rails_backup = Object.send(:remove_const, :Rails) if defined?(Rails)
-    rails_mock = Class.new
-    Object.const_set(:Rails, rails_mock)
+    Rails.logger = nil
 
-    # Create new configuration instance
     config = Sidekiq::MemoryLogger::Configuration.new
 
-    # Should fall back to stdout logger since Rails doesn't respond to logger
     assert_instance_of Logger, config.logger
     assert_equal $stdout, config.logger.instance_variable_get(:@logdev).dev
-  ensure
-    # Restore Rails constant
-    Object.send(:remove_const, :Rails)
-    Object.const_set(:Rails, rails_backup) if rails_backup
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-memory_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nate Berkopec
@@ -46,12 +46,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".custom_rubocop.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/benchmark.yml"
 - ".github/workflows/test.yml"
 - ".standard.yml"
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- conductor.json
 - lib/rubocop/cop/sidekiq_memory_logger.rb
 - lib/rubocop/cop/sidekiq_memory_logger/no_configure_in_tests.rb
 - lib/sidekiq-memory_logger.rb