deprecation_collector 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02cc02dc5d90e6b304ac5dadfc7ee09c1ac684ced0d3e0657095a47ffdc88e82
-  data.tar.gz: ce2b0e299aed5c65f302ffb4fb72d49e7ea1f44772a5b6d61eeae1807eecb1fd
+  metadata.gz: 6f45c8742c0a83f697b04d7a99af54749b354c25cfcffb78f152a680f8224584
+  data.tar.gz: ab25a06b38f3ebfe82a48136c8a58da8d61e4db93614af0c66e283771f0b61b7
 SHA512:
-  metadata.gz: b468f3a95e56ced60c3de42996f1d6c4d9249588dfe972c321aaf3dcf80f81cf9048dc040b14c9a604f7c01d780385de2ec4e3ea1cb5dbda47ac541bd20d1a83
-  data.tar.gz: a245eb05033c494e514ba10e0ba63888bffb5e7fb86365a9e09cc425674be7c01df17d7c4870af60011c5a26600f07825e3a74971b5b690859762880f35b33e9
+  metadata.gz: d395dc4cedb786ab398911e5de19568f44317040352f1b85a6fc45a45fce465d6c82b8092c2f74e0a6b1d18e4dedfbc3284d59767dad2f3a2202143acd969b81
+  data.tar.gz: 0f9a6cd6f02b9b674710db839fcce21f69a2af31a41cc552ad3266b7cd1c3eaa21dac1ac7f94f0208833536e29c20d70e0261e6b087bc548597035c45bc47799

data/CHANGELOG.md

@@ -1,5 +1,12 @@
-== unreleased
+== 0.0.5 (unreleased)
+- 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)
+
+== 0.0.3
+- Fixed selective deprecation cleanup (`DeprecationCollector.instance.cleanup { |d| d[:message].include?('foo') }`)
 
 == 0.0.2
 

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.2)
-      redis (>= 2.0)
+    deprecation_collector (0.0.5)
+      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.6.0)
+    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

@@ -2,6 +2,8 @@
 [![Gem Version](https://badge.fury.io/rb/deprecation_collector.svg)](https://badge.fury.io/rb/deprecation_collector)
 
 Collects ruby and rails deprecation warnings.
+Designed to be suitable for use in production under load.
+
 (gem is a work-in-process, documentation will come later)
 
 ## Installation
@@ -17,15 +19,17 @@ bundle add deprecation_collector
 Add an initializer with configuration, like
 
 ```ruby
-  DeprecationCollector.create_instance(redis: your_redis_connection)
   Rails.application.config.to_prepare do
     DeprecationCollector.install do |instance|
+      instance.redis = Redis.new # default is $redis
       instance.app_revision = ::GIT_REVISION
       instance.count = false
       instance.save_full_backtrace = true
       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"
       ]
@@ -41,7 +45,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deprecation_collector.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Vasfed/deprecation_collector.
 
 ## License
 

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

@@ -3,7 +3,7 @@
 class DeprecationCollector
   # :nodoc:
   class Deprecation
-    attr_reader :message, :realm, :gem_traceline, :app_traceline, :occurences, :full_backtrace
+    attr_reader :message, :realm, :gem_traceline, :app_traceline, :occurences, :first_timestamp, :full_backtrace
 
     CLEANUP_REGEXES = {
       # rails views generated methods names are unique per-worker
@@ -20,6 +20,7 @@ class DeprecationCollector
       @occurences = 0
       @gem_traceline = find_gem_traceline(backtrace)
       @app_traceline = find_app_traceline(backtrace)
+      @first_timestamp = Time.now.to_i
 
       cleanup_prefixes.each do |path|
         @gem_traceline.delete_prefix!(path)
@@ -53,7 +54,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 = {})
@@ -68,6 +69,7 @@ class DeprecationCollector
         hostname: Socket.gethostname,
         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
       }.compact
     end

data/lib/deprecation_collector/version.rb

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

data/lib/deprecation_collector.rb

@@ -5,6 +5,7 @@ require_relative "deprecation_collector/deprecation"
 require_relative "deprecation_collector/collectors"
 require "time"
 require "redis"
+require "json"
 
 # singleton class for collector
 class DeprecationCollector
@@ -53,7 +54,8 @@ class DeprecationCollector
   attr_accessor :count, :raise_on_deprecation, :save_full_backtrace,
                 :exclude_realms,
                 :write_interval, :write_interval_jitter,
-                :app_revision, :app_root
+                :app_revision, :app_root,
+                :print_to_stderr, :print_recurring
   attr_writer :redis
 
   def initialize(mutex: nil)
@@ -96,8 +98,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?
@@ -163,6 +165,10 @@ class DeprecationCollector
     @redis.set("deprecations:enabled", "false")
   end
 
+  def dump
+    read_each.to_a.to_json
+  end
+
   def read_each
     return to_enum(:read_each) unless block_given?
 
@@ -185,10 +191,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
@@ -196,10 +202,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
 
@@ -210,7 +216,7 @@ class DeprecationCollector
       cursor, data_pairs = @redis.hscan("deprecations:data", cursor) # NB: some pages may be empty
       total += data_pairs.size
       removed += delete_deprecations(
-        data_pairs.select { |_digest, data| !block_given? || yield(JSON.parse(data, symbolize_names: true)) }.keys
+        data_pairs.to_h.select { |_digest, data| !block_given? || yield(JSON.parse(data, symbolize_names: true)) }.keys
       )
       break if cursor == "0"
     end
@@ -221,18 +227,22 @@ class DeprecationCollector
 
   def store_deprecation(deprecation)
     return if deprecation.ignored?
+    fresh = !@deprecations.key?(deprecation.digest)
 
     @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
@@ -242,7 +252,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
@@ -250,9 +265,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.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Vasily Fedoseyev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-09-02 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:
@@ -54,7 +54,7 @@ metadata:
   homepage_uri: https://github.com/Vasfed/deprecation_collector
   source_code_uri: https://github.com/Vasfed/deprecation_collector
   changelog_uri: https://github.com/Vasfed/deprecation_collector/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Collector for ruby/rails deprecations and warnings, suitable for production
 test_files: []