ruby_memcheck 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d995f1c581f36353698de1ed410eb6c7728ff11313b59992f7c935f98a73e960
-  data.tar.gz: f499de55cd5d482a60cd33cb393c1cac415374188f19c97ae42545a884b6bb5d
+  metadata.gz: f2a9e15e7960c9c0a8094be720d2ad74fa3104eecb91fba0e9e0e3618c882c08
+  data.tar.gz: 836ed52bab1fd322d7eb0fac48159560a68266b554a5f55f865c3d62f25564f0
 SHA512:
-  metadata.gz: 61add3f638205732ea2e17dac9b970b18dcaa9177543321d6f6cf9f0fcdb2c9498f631e9d8cb40e1626f043e68864fe7995356c63d130c854b56554c9c5cd5c1
-  data.tar.gz: f089633851cf9d95ffc383dce6b8f62abb28f80adcf10f6d049fd0446cbca2202632ab4439e1bf5133de62d395552ae426a8f41dda59c7199ca8cecd4d33a55b
+  metadata.gz: 29de912221a25bbda4d389c72b352d5cbb24518068e127a7583e9bb08fe512a18a63b127066121f7b0f1de2d305cc8b225531993b32dc5e2ea6238aca0d78290
+  data.tar.gz: f1d492816966602826019d6980617399cc6199ab4f0f69ab4841a6112468def380f799f642c2d1757d403003e23dc38499882fdc5da7026ec0ea7671b95ae6a6

data/.github/workflows/lint.yml

@@ -6,7 +6,5 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0'
       - run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
       - run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -10,6 +10,7 @@ jobs:
           - { ruby: '3.0', allowed-failure: false }
           - { ruby: '3.1', allowed-failure: false }
           - { ruby: '3.2', allowed-failure: false }
+          - { ruby: '3.3', allowed-failure: false }
           - { ruby: ruby-head, allowed-failure: false }
     name: ruby ${{ matrix.entry.ruby }}
     steps:

data/.gitignore

@@ -1,5 +1,3 @@
-Gemfile.lock
-
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -2,7 +2,6 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
   SuggestExtensions: false
 
 Style/GlobalVars:

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    ruby_memcheck (2.3.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.5)
+    minitest (5.22.3)
+    minitest-parallel_fork (1.3.1)
+      minitest (>= 5.15.0)
+    nokogiri (1.16.3)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.16.3-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rake-compiler (1.2.7)
+      rake
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-shopify (2.15.1)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-parallel_fork (~> 1.2)
+  rake (~> 13.0)
+  rake-compiler (~> 1.1)
+  rspec-core
+  rubocop (~> 1.22)
+  rubocop-shopify (~> 2.3)
+  ruby_memcheck!
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -163,6 +163,7 @@ If you want to override any of the default configurations you can call `RubyMemc
 - `temp_dir`: Optional. The directory to store temporary files. It defaults to a temporary directory. This is present for development debugging, so you shouldn't have to use it.
 - `output_io`: Optional. The `IO` object to output Valgrind errors to. Defaults to standard error.
 - `filter_all_errors`: Optional. Whether to filter all kinds of Valgrind errors (not just memory leaks). This feature should only be used if you're encountering a large number of illegal memory accesses coming from Ruby. If you need to use this feature, you may have found a bug inside of Ruby. Consider reporting it to the [Ruby bug tracker](https://bugs.ruby-lang.org/projects/ruby-master/issues/new). Defaults to `false`.
+- `use_only_ruby_free_at_exit`: Optional. Use only the [`RUBY_FREE_AT_EXIT`](https://bugs.ruby-lang.org/issues/19993) feature introduced in Ruby 3.3 and disables most of the heuristics inside of ruby_memcheck. Disable this if you want to use the original heuristics. Defaults to `true` for Ruby 3.4 and later, `false` otherwise. Note: while `RUBY_FREE_AT_EXIT` was introduced in Ruby 3.3, there are bugs which prevents it from working well, so it is only enabled by default for Ruby 3.4 and later.
 
 ## Suppression files
 

data/lib/ruby_memcheck/configuration.rb

@@ -31,6 +31,7 @@ module RubyMemcheck
       /\Arb_thread_create\z/, # Threads are relased to a cache, so they may be reported as a leak
       /\Arb_yield/,
     ].freeze
+    RUBY_FREE_AT_EXIT_SUPPORTED = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0")
 
     attr_reader :binary_name
     attr_reader :ruby
@@ -43,9 +44,11 @@ module RubyMemcheck
     attr_reader :loaded_features_file
     attr_reader :output_io
     attr_reader :filter_all_errors
+    attr_reader :use_only_ruby_free_at_exit
 
     alias_method :valgrind_generate_suppressions?, :valgrind_generate_suppressions
     alias_method :filter_all_errors?, :filter_all_errors
+    alias_method :use_only_ruby_free_at_exit?, :use_only_ruby_free_at_exit
 
     def initialize(
       binary_name: nil,
@@ -57,7 +60,8 @@ module RubyMemcheck
       skipped_ruby_functions: DEFAULT_SKIPPED_RUBY_FUNCTIONS,
       temp_dir: Dir.mktmpdir,
       output_io: $stderr,
-      filter_all_errors: false
+      filter_all_errors: false,
+      use_only_ruby_free_at_exit: RUBY_FREE_AT_EXIT_SUPPORTED
     )
       @binary_name = binary_name
       @ruby = ruby
@@ -83,6 +87,8 @@ module RubyMemcheck
       ]
 
       @loaded_features_file = Tempfile.create("", @temp_dir)
+
+      @use_only_ruby_free_at_exit = use_only_ruby_free_at_exit
     end
 
     def command(*args)

data/lib/ruby_memcheck/stack.rb

@@ -10,6 +10,32 @@ module RubyMemcheck
     end
 
     def skip?
+      if @configuration.use_only_ruby_free_at_exit?
+        skip_using_ruby_free_at_exit?
+      else
+        skip_using_original_heuristics?
+      end
+    end
+
+    private
+
+    def skip_using_ruby_free_at_exit?
+      if configuration.binary_name.nil?
+        false
+      else
+        in_binary = false
+
+        frames.each do |frame|
+          if frame.in_binary?
+            in_binary = true
+          end
+        end
+
+        !in_binary
+      end
+    end
+
+    def skip_using_original_heuristics?
       in_binary = false
 
       frames.each do |frame|

data/lib/ruby_memcheck/test_task_reporter.rb

@@ -21,6 +21,7 @@ module RubyMemcheck
     def setup
       ENV["RUBY_MEMCHECK_LOADED_FEATURES_FILE"] = File.expand_path(configuration.loaded_features_file)
       ENV["RUBY_MEMCHECK_RUNNING"] = "1"
+      ENV["RUBY_FREE_AT_EXIT"] = "1"
     end
 
     def report_valgrind_errors

data/lib/ruby_memcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyMemcheck
-  VERSION = "2.2.1"
+  VERSION = "3.0.0"
 end

data/ruby_memcheck.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Use Valgrind memcheck without going crazy"
   spec.homepage      = "https://github.com/Shopify/ruby_memcheck"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Peter Zhu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -135,7 +135,9 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -167,14 +169,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy