deprecation_collector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7936a3e78d550c3940f0abe364171df3b39cc1e19931cfba23b8cfdb060122ca
+  data.tar.gz: 2a4d06a0baee48c61c027c7791fef7894b5af5d1791fe0e3c1bd3afaf2fa61ab
+SHA512:
+  metadata.gz: c5a10c07173fe8b73003630c2fa0839b07c62f0471b72269aabdcece19935f6693fc6b0a3a3c8634b1731b7cc9db0aae186ff2067a43047692e15f32180d5210
+  data.tar.gz: b6e598c579eb46756b9a78336fd3b223d4224b01f5a677b55375732279564c9b609dc2e87083a6cb47cb5e86c567c73102465080e275818564d94c1d29b29408

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+
+
+== 0.0.1
+
+Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deprecation_collector.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "timecop"
+
+gem "rubocop", "~> 1.21"
+
+# TODO: appraisals
+gem "rails", '6.0'

data/Gemfile.lock

@@ -0,0 +1,184 @@
+PATH
+  remote: .
+  specs:
+    deprecation_collector (0.0.1)
+      redis (>= 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.6-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3.1)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.6.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    timecop (0.9.5)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  deprecation_collector!
+  rails (= 6.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  timecop
+
+BUNDLED WITH
+   2.3.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vasily Fedoseyev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Vasily Fedoseyev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# DeprecationCollector
+
+Collects ruby and rails deprecation warnings.
+(gem is a work-in-process, documentation will come later)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add deprecation_collector
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install deprecation_collector
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deprecation_collector.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/deprecation_collector.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/deprecation_collector/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "deprecation_collector"
+  spec.version = DeprecationCollector::VERSION
+  spec.authors = ["Vasily Fedoseyev"]
+  spec.email = ["vasilyfedoseyev@gmail.com"]
+
+  spec.summary = "Collector for ruby/rails deprecations and warnings, suitable for production"
+  spec.description = "Collects and aggregates warnings and deprecations. Optimized for production environment."
+  spec.homepage = "https://github.com/Vasfed/deprecation_collector"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Vasfed/deprecation_collector"
+  spec.metadata["changelog_uri"] = "https://github.com/Vasfed/deprecation_collector/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis", ">= 2.0" # TODO: check exact minimum version
+end

data/lib/deprecation_collector/version.rb

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

data/lib/deprecation_collector.rb

@@ -0,0 +1,395 @@
+# frozen_string_literal: true
+
+require_relative "deprecation_collector/version"
+require 'time'
+require 'redis'
+
+class DeprecationCollector
+  # NB: in production with hugreds of workers may easily overload redis with writes, so more delay needed:
+  FLUSH_INTERVAL = (::Rails.env.production? && 15.minutes) || 1.minute
+
+  @instance_mutex = Mutex.new
+  @installed = false
+  private_class_method :new
+
+  def self.instance
+    return @instance if defined?(@instance) && @instance
+
+    @instance_mutex.synchronize do
+      # переиспользовать мутекс не обязательно, но он используется ровно один раз
+      @instance ||= new($redis, mutex: @instance_mutex)
+    end
+    @instance
+  end
+
+  def self.collect(message, backtrace, realm)
+    instance.collect(message, backtrace, realm)
+  end
+
+  # inside dev env may be called multiple times
+  def self.install
+    instance # to make it created, configuration comes later
+
+    @instance_mutex.synchronize do
+      unless @installed
+        at_exit { instance.write_to_redis(force: true) }
+        @installed = true
+      end
+
+      yield instance if block_given?
+
+      # TODO: a more polite hook
+      ActiveSupport::Deprecation.behavior = lambda do |message, callstack, deprecation_horizon, gem_name|
+        # not polite to turn off all other possible behaviors, but otherwise may get duplicate calls
+        DeprecationCollector.collect(message, callstack, :rails)
+        ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[Rails.application&.config&.active_support&.deprecation || :log].call(
+          message, callstack, deprecation_horizon, gem_name
+        )
+      end
+
+      Kernel.class_eval do
+        # module is included in others thus prepend does not work
+        remove_method :warn
+        class << self
+          remove_method :warn
+        end
+        module_function(define_method(:warn) do |*messages, **kwargs|
+          KernelWarningCollector.warn(*messages, backtrace: caller, **kwargs)
+        end)
+      end
+
+      Warning.singleton_class.prepend(DeprecationCollector::WarningCollector)
+      Warning[:deprecated] = true if Warning.respond_to?(:[]=) # turn on ruby 2.7 deprecations
+    end
+
+    @instance
+  end
+
+  module MultipartWarningJoiner
+    module_function
+
+    # Ruby sometimes has two warnings for one actual occurence
+    # Example:
+    # caller.rb:1: warning: Passing the keyword argument as the last hash parameter is deprecated
+    # calleee.rb:1: warning: The called method `method_name' is defined here
+    def two_part_warning?(str)
+      # see ruby src - `rb_warn`, `rb_compile_warn`
+      str.end_with?(
+        "uses the deprecated method signature, which takes one parameter\n", # respond_to?
+        # 2.7 kwargs:
+        "maybe ** should be added to the call\n",
+        "Passing the keyword argument as the last hash parameter is deprecated\n", # бывает и не двойной
+        "Splitting the last argument into positional and keyword parameters is deprecated\n"
+      ) ||
+        str.include?("warning: already initialized constant") ||
+        str.include?("warning: method redefined; discarding old")
+    end
+
+    def handle(new_str)
+      old_str = Thread.current[:multipart_warning_str]
+      Thread.current[:multipart_warning_str] = nil
+      if old_str
+        return yield(old_str + new_str) if new_str.include?('is defined here') || new_str.include?(' was here')
+        yield(old_str)
+      end
+
+      if two_part_warning?(new_str)
+        Thread.current[:multipart_warning_str] = new_str
+        return
+      end
+
+      yield(new_str)
+    end
+  end
+
+  # taps into ruby core Warning#warn
+  module WarningCollector
+    def warn(str)
+      backtrace = caller
+      MultipartWarningJoiner.handle(str) do |multi_str|
+        DeprecationCollector.collect(multi_str, backtrace, :warning)
+      end
+    end
+  end
+
+  module KernelWarningCollector
+    module_function
+
+    def warn(*messages, backtrace: nil, **_kwargs)
+      backtrace ||= caller
+      str = messages.map(&:to_s).join("\n").strip
+      DeprecationCollector.collect(str, backtrace, :kernel)
+      # not passing to `super` - it will pass to Warning#warn, we do not want that
+    end
+  end
+
+  class Deprecation
+    attr_reader :message, :realm, :gem_traceline, :app_traceline, :occurences, :full_backtrace
+
+    def initialize(message, realm = nil, backtrace = [], cleanup_prefixes = [])
+      # backtrace is Thread::Backtrace::Location or array of strings for other realms
+      @message = message.dup
+      @realm = realm
+      @occurences = 0
+      @gem_traceline = backtrace.find { |line| !line.to_s.include?('kernel_warn') }&.to_s&.dup ||
+                       backtrace.first.to_s.dup
+      cleanup_prefixes.each do |path|
+        @gem_traceline.delete_prefix!(path)
+        @message.gsub!(path, '')
+      end
+
+      app_root = "#{DeprecationCollector.instance.app_root}/" # rubocop:disable Rails/FilePath
+      @app_traceline = backtrace.find do |line|
+        line = line.to_s
+        (!line.start_with?('/') || line.start_with?(app_root)) && !line.include?('/gems/')
+      end&.to_s&.dup&.delete_prefix(app_root)
+
+      # rails views generated methods names are unique per-worker
+      @gem_traceline&.gsub!(/_app_views_(\w+)__(\d+)_(\d+)/, "_app_views_\\1__")
+      @app_traceline&.gsub!(/_app_views_(\w+)__(\d+)_(\d+)/, "_app_views_\\1__")
+
+      # repl line numbers are not important, may be ignore all repl at all
+      @app_traceline&.gsub!(/\A\((pry|irb)\):\d+/, '(\1)')
+      @gem_traceline&.gsub!(/\A\((pry|irb)\):\d+/, '(\1)') # may contain app traceline, so filter too
+
+      @full_backtrace = backtrace.map(&:to_s) if DeprecationCollector.instance.save_full_backtrace
+    end
+
+    def touch
+      @occurences += 1
+    end
+
+    def ignored?
+      false
+    end
+
+    def message_for_digest
+      # some gems like rest-client put data in warnings, need to aggregate
+      # + some bactrace per-worker unique method names may be there
+      @message.gsub(/"(?:[^"\\]|\\.)*"/, '""').gsub(/__\d+_\d+/, '___').gsub(/\((pry|irb)\):\d+/, '(\1)')
+    end
+
+    def digest
+      @digest ||= Digest::MD5.hexdigest(digest_base)
+    end
+
+    def digest_base
+      "1:#{RUBY_VERSION}:#{Rails.version}:#{message_for_digest}:#{gem_traceline}:#{app_traceline}"
+    end
+
+    def as_json(_options = {})
+      {
+        message: message,
+        realm: realm,
+        app_traceline: app_traceline,
+        gem_traceline: (gem_traceline != app_traceline && gem_traceline) || nil,
+        full_backtrace: full_backtrace,
+        ruby_version: RUBY_VERSION,
+        rails_version: Rails.version,
+        hostname: Socket.gethostname,
+        revision: DeprecationCollector.instance.app_revision,
+        count: @occurences, # output anyway for frequency estimation (during write_interval inside single process)
+        digest_base: digest_base # for debug purposes
+      }.compact
+    end
+  end
+
+  attr_accessor :count, :raise_on_deprecation, :save_full_backtrace,
+                :exclude_realms,
+                :write_interval, :write_interval_jitter,
+                :app_revision, :app_root
+
+  def initialize(redis, mutex: nil)
+    @redis = redis
+    # on cruby hash itself is threadsafe, but we need to prevent races
+    @deprecations_mutex = mutex || Mutex.new
+    @deprecations = {}
+    @known_digests = Set.new
+    @last_write_time = current_time
+
+    # default config:
+    @count = false
+    @raise_on_deprecation = false
+    @exclude_realms = []
+    @write_interval = FLUSH_INTERVAL
+    @write_interval_jitter = 60
+    @enabled = true
+    @ignore_message_regexp = nil
+    @app_root = defined?(Rails) && Rails.root.present? || Dir.pwd
+
+    fetch_known_digests # prevent fresh process from wiring frequent already known messages
+  end
+
+  def ignored_messages=(val)
+    @ignore_message_regexp = (val && Regexp.union(val)) || nil
+  end
+
+  def cleanup_prefixes
+    @cleanup_prefixes ||= Gem.path + ["#{app_root}/"] # rubocop:disable Rails/FilePath
+  end
+
+  def collect(message, backtrace, realm = :unknown)
+    return unless @enabled
+    return if exclude_realms.include?(realm)
+    return if @ignore_message_regexp&.match?(message)
+    raise "Deprecation: #{message}" if @raise_on_deprecation
+
+    deprecation = Deprecation.new(message, realm, backtrace, cleanup_prefixes)
+    return if deprecation.ignored?
+
+    @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))
+
+    $stderr.puts(message) if Rails.env.development? # rubocop:disable Style/StderrPuts
+  end
+
+  def unsent_data?
+    @deprecations.any?
+  end
+
+  def count?
+    @count
+  end
+
+  def fetch_known_digests
+    @known_digests.merge(@redis.hkeys('deprecations:data'))
+  end
+
+  def write_to_redis(force: false)
+    return unless @enabled || force
+
+    deprecations_to_flush = nil
+    @deprecations_mutex.synchronize do
+      # check in this section to prevent multiple check requests
+      unless enabled_in_redis?
+        @enabled = false
+        @deprecations = {}
+        return
+      end
+
+      return unless force || current_time > @last_write_time + @write_interval
+
+      deprecations_to_flush = @deprecations
+      @deprecations = {}
+      @last_write_time = current_time
+    end
+
+    # count is expensive in production env (but possible if needed) - a lot of redis writes
+    if count?
+      @redis.pipelined do
+        deprecations_to_flush.each_pair do |digest, deprecation|
+          @redis.hincrby("deprecations:counter", digest, deprecation.occurences)
+        end
+      end
+    end
+
+    # make as few writes as possible, other workers may already have reported our warning
+    # TODO: at some point turn off writes?
+    fetch_known_digests
+    deprecations_to_flush.reject! { |digest, _val| @known_digests.include?(digest) }
+    return unless deprecations_to_flush.any?
+
+    @known_digests.merge(deprecations_to_flush.keys)
+    @redis.mapped_hmset("deprecations:data", deprecations_to_flush.transform_values(&:to_json))
+  end
+
+  def flush_redis(enable: false)
+    @redis.del("deprecations:data", "deprecations:counter", "deprecations:notes")
+    @redis.del("deprecations:enabled") if enable
+    @deprecations.clear
+    @known_digests.clear
+  end
+
+  def enabled_in_redis?
+    @redis.get("deprecations:enabled") != "false"
+  end
+
+  def enable
+    @enabled = true
+    @redis.set("deprecations:enabled", "true")
+  end
+
+  def disable
+    @enabled = false
+    @redis.set("deprecations:enabled", "false")
+  end
+
+  def read_each
+    return to_enum(:read_each) unless block_given?
+
+    cursor = 0
+    loop do
+      cursor, data_pairs = @redis.hscan("deprecations:data", cursor)
+
+      if data_pairs.any?
+        data_pairs.zip(
+          @redis.hmget("deprecations:counter", data_pairs.map(&:first)),
+          @redis.hmget("deprecations:notes", data_pairs.map(&:first))
+        ).each do |(digest, data), count, notes|
+          yield decode_deprecation(digest, data, count, notes)
+        end
+      end
+      break if cursor == "0"
+    end
+  end
+
+  def read_one(digest)
+    decode_deprecation(
+      digest,
+      @redis.hget("deprecations:data", digest),
+      @redis.hget("deprecations:counter", digest),
+      @redis.hget("deprecations:notes", digest)
+    )
+  end
+
+  def delete_deprecations(remove_digests)
+    @redis.pipelined do
+      @redis.hdel("deprecations:data", *remove_digests)
+      @redis.hdel("deprecations:notes", *remove_digests)
+      @redis.hdel("deprecations:counter", *remove_digests) if @count
+    end
+  end
+
+  def cleanup
+    cursor = 0
+    removed = 0
+    total = 0
+    loop do
+      cursor, data_pairs = @redis.hscan("deprecations:data", cursor)
+
+      if data_pairs.any?
+        remove_digests = []
+        total += data_pairs.size
+        data_pairs.each do |(digest, data)|
+          data = JSON.parse(data, symbolize_names: true)
+          remove_digests << digest if !block_given? || yield(data)
+        end
+
+        if remove_digests.any?
+          delete_deprecations(remove_digests)
+          removed += remove_digests.size
+        end
+      end
+      break if cursor == "0"
+    end
+    "#{removed} removed, #{total - removed} left"
+  end
+
+  private
+
+  def current_time
+    return Time.zone.now if Time.respond_to?(:zone) && Time.zone
+    Time.now
+  end
+
+  def decode_deprecation(digest, data, count, notes)
+    data = JSON.parse(data, symbolize_names: true)
+    data[:digest] = digest
+    data[:notes] = JSON.parse(notes, symbolize_names: true) if notes
+    data[:count] = count.to_i if count
+    data
+  end
+end

data/sig/deprecation_collector.rbs

@@ -0,0 +1,4 @@
+module DeprecationCollector
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: deprecation_collector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vasily Fedoseyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Collects and aggregates warnings and deprecations. Optimized for production
+  environment.
+email:
+- vasilyfedoseyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- deprecation_collector.gemspec
+- lib/deprecation_collector.rb
+- lib/deprecation_collector/version.rb
+- sig/deprecation_collector.rbs
+homepage: https://github.com/Vasfed/deprecation_collector
+licenses:
+- MIT
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Collector for ruby/rails deprecations and warnings, suitable for production
+test_files: []