deprecation_collector 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2342f445e6c89ba4ea74094dd39894d99ad6e546781405fe43a6ecba71396264
-  data.tar.gz: d5d6edaa942f57a726f9336a06541dabc3eadae2731d01953443a88d84fc7c2e
+  metadata.gz: edc00d8d4dd22e076dd0c331bd65ee2a6caad48e28ee0f2a79253f94d6d5a1b3
+  data.tar.gz: a8d0a71ada4d0eae355f853f685ea4548124e5090bcac361bb4363ef69b8faaa
 SHA512:
-  metadata.gz: 9ac2e881d1687dc3756904840f21f98cc62dc497cac31804fcfeac8e4e01c780b5370497ed52da2d1ec22ca14a68ee3be4dc163c5d48cd47c38b775ef0df7b1c
-  data.tar.gz: 5725ea9137d79a83ea8d1df1ae9b458fe0f94479d5e7c9643ac15368ef853f75fac38cce3b7e8543fd4d03df884fa3999019d08902ba437a196f6b5b3c78dd06
+  metadata.gz: b7f467b251d4e04f9d23f5524f1c0e36d6ab363090664178ef82d78d261e118d7f30511f6711ebde8205cde3fe46e871f870752c8be867f4f0bd743344589e5b
+  data.tar.gz: 2c3b8f59fc2adb43a04a39f3fb39f02bcd752ebbc9d7a1974a77a8441dfeb1daaf65ec87704d7159a1b31a443c20df5a202ff1872e08a28e709baccd84657998

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+== 0.0.6
+- added custom context saving ability
+
+== 0.0.5
+- options `print_to_stderr`, `print_recurring`
+- fix redis deprecated `pipelined` block arity (support for redis 5)
+
 == 0.0.4
 - added first_timestamp to deprecations (unix timestamp of first occurrence, not accurate because a worker with later timestamp may dump its deprecations earlier)
 

data/Gemfile

@@ -18,3 +18,5 @@ gem "rubocop-rspec"
 
 # TODO: appraisals
 gem "rails", "6.0"
+
+gem 'redis', '~>4.8'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    deprecation_collector (0.0.4)
-      redis (>= 2.0)
+    deprecation_collector (0.0.6)
+      redis (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -84,8 +84,12 @@ GEM
       nokogiri (~> 1)
       rake
     mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
     minitest (5.15.0)
     nio4r (2.5.8)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
     nokogiri (1.13.6-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
@@ -123,7 +127,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    redis (4.7.1)
+    redis (4.8.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -181,12 +185,14 @@ GEM
     zeitwerk (2.5.4)
 
 PLATFORMS
+  ruby
   x86_64-darwin-21
 
 DEPENDENCIES
   deprecation_collector!
   rails (= 6.0)
   rake (~> 13.0)
+  redis (~> 4.8)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   rubocop-performance

data/README.md

@@ -28,9 +28,15 @@ Add an initializer with configuration, like
       instance.raise_on_deprecation = false
       instance.write_interval = (::Rails.env.production? && 15.minutes) || 1.minute
       instance.exclude_realms = %i[kernel] if Rails.env.production?
+      instance.print_to_stderr = true if Rails.env.development?
+      instance.print_recurring = false
       instance.ignored_messages = [
         "Ignoring db/schema_cache.yml because it has expired"
       ]
+      instance.context_saver do
+        # this will only be called for new deprecations, return value must be json-compatible
+        { some: "custom", context: "for example request.id" }
+      end
     end
   end
 ```

data/deprecation_collector.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "redis", ">= 2.0" # TODO: check exact minimum version
+  spec.add_dependency "redis", ">= 3.0"
 end

data/lib/deprecation_collector/deprecation.rb

@@ -4,6 +4,7 @@ class DeprecationCollector
   # :nodoc:
   class Deprecation
     attr_reader :message, :realm, :gem_traceline, :app_traceline, :occurences, :first_timestamp, :full_backtrace
+    attr_accessor :context
 
     CLEANUP_REGEXES = {
       # rails views generated methods names are unique per-worker
@@ -54,7 +55,7 @@ class DeprecationCollector
     end
 
     def digest_base
-      "1:#{RUBY_VERSION}:#{Rails.version}:#{message_for_digest}:#{gem_traceline}:#{app_traceline}"
+      "1:#{RUBY_VERSION}:#{defined?(Rails) && Rails.version}:#{message_for_digest}:#{gem_traceline}:#{app_traceline}"
     end
 
     def as_json(_options = {})
@@ -70,7 +71,8 @@ class DeprecationCollector
         revision: DeprecationCollector.instance.app_revision,
         count: @occurences, # output anyway for frequency estimation (during write_interval inside single process)
         first_timestamp: first_timestamp, # this may not be accurate, a worker with later timestamp may dump earlier
-        digest_base: digest_base # for debug purposes
+        digest_base: digest_base, # for debug purposes
+        context: context
       }.compact
     end
 

data/lib/deprecation_collector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DeprecationCollector
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/deprecation_collector.rb

@@ -54,8 +54,9 @@ class DeprecationCollector
   attr_accessor :count, :raise_on_deprecation, :save_full_backtrace,
                 :exclude_realms,
                 :write_interval, :write_interval_jitter,
-                :app_revision, :app_root
-  attr_writer :redis
+                :app_revision, :app_root,
+                :print_to_stderr, :print_recurring
+  attr_writer :redis, :context_saver
 
   def initialize(mutex: nil)
     # on cruby hash itself is threadsafe, but we need to prevent races
@@ -78,12 +79,19 @@ class DeprecationCollector
     # NB: in production with hugreds of workers may easily overload redis with writes, so more delay needed:
     @write_interval = 900 # 15.minutes
     @write_interval_jitter = 60
+    @context_saver = nil
   end
 
   def ignored_messages=(val)
     @ignore_message_regexp = (val && Regexp.union(val)) || nil
   end
 
+  def context_saver(&block)
+    return @context_saver unless block_given?
+
+    @context_saver = block
+  end
+
   def app_root_prefix
     "#{app_root}/"
   end
@@ -97,8 +105,8 @@ class DeprecationCollector
     raise "Deprecation: #{message}" if @raise_on_deprecation
 
     deprecation = Deprecation.new(message, realm, backtrace, cleanup_prefixes)
-    store_deprecation(deprecation)
-    log_deprecation_if_needed(deprecation)
+    fresh = store_deprecation(deprecation)
+    log_deprecation_if_needed(deprecation, fresh)
   end
 
   def unsent_data?
@@ -190,10 +198,10 @@ class DeprecationCollector
   def read_one(digest)
     decode_deprecation(
       digest,
-      *@redis.pipelined do
-        @redis.hget("deprecations:data", digest)
-        @redis.hget("deprecations:counter", digest)
-        @redis.hget("deprecations:notes", digest)
+      *@redis.pipelined do |pipe|
+        pipe.hget("deprecations:data", digest)
+        pipe.hget("deprecations:counter", digest)
+        pipe.hget("deprecations:notes", digest)
       end
     )
   end
@@ -201,10 +209,10 @@ class DeprecationCollector
   def delete_deprecations(remove_digests)
     return 0 unless remove_digests.any?
 
-    @redis.pipelined do
-      @redis.hdel("deprecations:data", *remove_digests)
-      @redis.hdel("deprecations:notes", *remove_digests)
-      @redis.hdel("deprecations:counter", *remove_digests) if @count
+    @redis.pipelined do |pipe|
+      pipe.hdel("deprecations:data", *remove_digests)
+      pipe.hdel("deprecations:notes", *remove_digests)
+      pipe.hdel("deprecations:counter", *remove_digests) if @count
     end.first
   end
 
@@ -226,18 +234,23 @@ class DeprecationCollector
 
   def store_deprecation(deprecation)
     return if deprecation.ignored?
+    fresh = !@deprecations.key?(deprecation.digest)
+    deprecation.context = context_saver.call if context_saver
 
     @deprecations_mutex.synchronize do
       (@deprecations[deprecation.digest] ||= deprecation).touch
     end
 
     write_to_redis if current_time - @last_write_time > (@write_interval + rand(@write_interval_jitter))
+    fresh
   end
 
-  def log_deprecation_if_needed(deprecation)
-    return unless defined?(Rails) && Rails.env.development? && !deprecation.ignored?
-
-    $stderr.puts(deprecation.message) # rubocop:disable Style/StderrPuts
+  def log_deprecation_if_needed(deprecation, fresh)
+    return unless print_to_stderr && !deprecation.ignored?
+    return unless fresh || print_recurring
+    msg = deprecation.message
+    msg = "DEPRECATION: #{msg}" unless msg.start_with?('DEPRECAT')
+    $stderr.puts(msg) # rubocop:disable Style/StderrPuts
   end
 
   def current_time
@@ -247,7 +260,12 @@ class DeprecationCollector
   end
 
   def decode_deprecation(digest, data, count, notes)
+    return nil unless data
     data = JSON.parse(data, symbolize_names: true)
+    unless data.is_a?(Hash)
+      binding.irb
+      return nil
+    end
     data[:digest] = digest
     data[:notes] = JSON.parse(notes, symbolize_names: true) if notes
     data[:count] = count.to_i if count
@@ -255,9 +273,9 @@ class DeprecationCollector
   end
 
   def write_count_to_redis(deprecations_to_flush)
-    @redis.pipelined do
+    @redis.pipelined do |pipe|
       deprecations_to_flush.each_pair do |digest, deprecation|
-        @redis.hincrby("deprecations:counter", digest, deprecation.occurences)
+        pipe.hincrby("deprecations:counter", digest, deprecation.occurences)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_collector
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: Collects and aggregates warnings and deprecations. Optimized for production
   environment.
 email:
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Collector for ruby/rails deprecations and warnings, suitable for production