rspec-tracer 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f283b4a6ab3d0d2616f7dca4bac721906d36b4296ba1d64446937db1503dd5
-  data.tar.gz: 2922f96420e344603a472b4e67bb5f2c58c16e8bf798e13098eec8f8096434c5
+  metadata.gz: 43ff2641751b61443860449bb5857cfeb2a4028881e05a7c58001f1bc6a7681d
+  data.tar.gz: aabe43c08122caf4e0af52ba77ef5ec85443953803488aae5d5bba83af7cdf6e
 SHA512:
-  metadata.gz: 222031b5d7b0a6b01cad104fda83347a9e10af957c7a5d1dfede9f46cf8a275435c3e0c9dfb02ad7788b3dfc2d4c3b9513a60ee3ccf0d3bfd68a692758a38f1e
-  data.tar.gz: f2828567b26b580ffc66568f8b14581cb160f4bdf14a61622b605b5832d5d3bc86cff211190628c5480604f0ec1c758609ec8aa490b357016e3565615c635be2
+  metadata.gz: 90b4b9795ff2b78e8c8a167e90736d639a74a4b4b082e69813cbaf66f4001852e603ad81ad761bb03565d7d4a0319d52ee3d0d79857b7880a7de82c1932b8640
+  data.tar.gz: 8784ef81e6fc6e076b64d22372215feeba7cfb7b5349b79b2b2e1618a745cced55c29e24ae768b941bda4f3a3058b28420ef4533a8b343f4e112d3bc9b47723f

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [1.1.2] - 2026-04-24
+
+### Fixed
+
+- **Encoding crash on locale-unset shells** — legacy cache, report, and
+  coverage paths called `File.read` / `File.write` without an explicit
+  encoding. Ruby fell back to `Encoding.default_external`, which
+  resolves to `US-ASCII` on shells launched without `LANG` set (the
+  default for macOS GUI terminals and many LaunchAgent contexts). Any
+  spec description containing a non-ASCII byte (e.g. `§`, typographic
+  quotes) wrote UTF-8 into `all_examples.json`; the next warm run
+  crashed at `Cache#load_*_cache` with
+  `Encoding::InvalidByteSequenceError: "\xC2" on US-ASCII`, taking
+  `spec_helper` down before any example ran. Every legacy JSON / ERB /
+  Ruby-source read and write now pins `encoding: 'UTF-8'`;
+  `SourceFile.from_path` switches to `File.binread` so the MD5 digest
+  hashes raw bytes regardless of process locale.
+
+## [1.1.1] - 2026-04-23
+
+### Fixed
+
+- **parallel_tests at-exit deadlock** — `parallel_tests_last_process?`
+  relied on a lock file written during `RSpecTracer.start` to identify
+  the last worker. If a fast worker reached `at_exit` before a slower
+  peer had loaded `spec_helper` and registered its `TEST_ENV_NUMBER`,
+  both workers could self-elect as the last process, both entered
+  `::ParallelTests.wait_for_other_processes_to_finish`, and deadlocked
+  on each other's pid. The elector now delegates to
+  `::ParallelTests.first_process?`, which reads immutable env vars set
+  by the parent at worker spawn. Exactly one worker is elected per run,
+  regardless of boot-time ordering or runner CPU count. No public-API
+  change — the `rspec_tracer.lock` file is still written and cleaned
+  up, just no longer consulted.
+
 ## [1.1.0] - 2026-04-20
 
 ### Added

data/lib/rspec_tracer/cache.rb

@@ -98,7 +98,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      JSON.parse(File.read(file_name))['run_id']
+      JSON.parse(File.read(file_name, encoding: 'UTF-8'))['run_id']
     end
 
     def load_all_examples_cache(cache_dir, discard_run_reason: true)
@@ -106,7 +106,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @all_examples = JSON.parse(File.read(file_name)).transform_values do |examples|
+      @all_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).transform_values do |examples|
         examples.transform_keys(&:to_sym)
       end
 
@@ -121,7 +121,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @duplicate_examples = JSON.parse(File.read(file_name)).transform_values do |examples|
+      @duplicate_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).transform_values do |examples|
         examples.map { |example| example.transform_keys(&:to_sym) }
       end
     end
@@ -131,7 +131,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @interrupted_examples = JSON.parse(File.read(file_name)).to_set
+      @interrupted_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).to_set
     end
 
     def load_flaky_examples_cache(cache_dir)
@@ -139,7 +139,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @flaky_examples = JSON.parse(File.read(file_name)).to_set
+      @flaky_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).to_set
     end
 
     def load_failed_examples_cache(cache_dir)
@@ -147,7 +147,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @failed_examples = JSON.parse(File.read(file_name)).to_set
+      @failed_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).to_set
     end
 
     def load_pending_examples_cache(cache_dir)
@@ -155,7 +155,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @pending_examples = JSON.parse(File.read(file_name)).to_set
+      @pending_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).to_set
     end
 
     def load_skipped_examples_cache(cache_dir)
@@ -163,7 +163,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @skipped_examples = JSON.parse(File.read(file_name)).to_set
+      @skipped_examples = JSON.parse(File.read(file_name, encoding: 'UTF-8')).to_set
     end
 
     def load_all_files_cache(cache_dir)
@@ -171,7 +171,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @all_files = JSON.parse(File.read(file_name)).transform_values do |files|
+      @all_files = JSON.parse(File.read(file_name, encoding: 'UTF-8')).transform_values do |files|
         files.transform_keys(&:to_sym)
       end
     end
@@ -181,7 +181,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @dependency = JSON.parse(File.read(file_name)).transform_values(&:to_set)
+      @dependency = JSON.parse(File.read(file_name, encoding: 'UTF-8')).transform_values(&:to_set)
     end
 
     def load_examples_coverage_cache(cache_dir)
@@ -189,7 +189,7 @@ module RSpecTracer
 
       return unless File.file?(file_name)
 
-      @examples_coverage = JSON.parse(File.read(file_name))
+      @examples_coverage = JSON.parse(File.read(file_name, encoding: 'UTF-8'))
     end
   end
 end

data/lib/rspec_tracer/coverage_merger.rb

@@ -14,7 +14,8 @@ module RSpecTracer
       reports_dir.each do |report_dir|
         next unless File.directory?(report_dir)
 
-        cache_coverage = JSON.parse(File.read("#{report_dir}/coverage.json"))['RSpecTracer']['coverage']
+        raw = File.read("#{report_dir}/coverage.json", encoding: 'UTF-8')
+        cache_coverage = JSON.parse(raw)['RSpecTracer']['coverage']
 
         cache_coverage.each_pair do |file_name, line_coverage|
           unless @coverage.key?(file_name)

data/lib/rspec_tracer/coverage_reporter.rb

@@ -165,7 +165,7 @@ module RSpecTracer
 
     def jruby_line_stub(file_path)
       lines = File.foreach(file_path).map { nil }
-      root_node = ::JRuby.parse(File.read(file_path))
+      root_node = ::JRuby.parse(File.read(file_path, encoding: 'UTF-8'))
 
       visitor = org.jruby.ast.visitor.NodeVisitor.impl do |_name, node|
         if node.newline?

data/lib/rspec_tracer/coverage_writer.rb

@@ -15,7 +15,7 @@ module RSpecTracer
         }
       }
 
-      File.write(@file_name, JSON.pretty_generate(report))
+      File.write(@file_name, JSON.pretty_generate(report), encoding: 'UTF-8')
     end
 
     def print_stats(elapsed_time)

data/lib/rspec_tracer/html_reporter/reporter.rb

@@ -211,7 +211,7 @@ module RSpecTracer
       end
 
       def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), 'views/', "#{name}.erb")))
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'views/', "#{name}.erb"), encoding: 'UTF-8'))
       end
 
       def example_status_css_class(example_status)

data/lib/rspec_tracer/remote_cache/cache.rb

@@ -60,7 +60,7 @@ module RSpecTracer
 
         ref_list = @repo.branch_refs.merge(@repo.branch_ref => branch_ref_time.to_i)
 
-        File.write(file_name, JSON.pretty_generate(ref_list))
+        File.write(file_name, JSON.pretty_generate(ref_list), encoding: 'UTF-8')
       end
 
       def last_run_id
@@ -68,7 +68,7 @@ module RSpecTracer
 
         raise CacheError, 'Could not find any local cache to upload' unless File.file?(file_name)
 
-        JSON.parse(File.read(file_name))['run_id']
+        JSON.parse(File.read(file_name, encoding: 'UTF-8'))['run_id']
       end
     end
   end

data/lib/rspec_tracer/remote_cache/repo.rb

@@ -169,7 +169,7 @@ module RSpecTracer
         file_name = File.join(RSpecTracer.cache_path, 'branch_refs.json')
 
         if @aws.download_branch_refs(branch_name, file_name)
-          @branch_refs = JSON.parse(File.read(file_name)).transform_values(&:to_i)
+          @branch_refs = JSON.parse(File.read(file_name, encoding: 'UTF-8')).transform_values(&:to_i)
 
           return if @branch_refs.empty?
 

data/lib/rspec_tracer/report_merger.rb

@@ -57,7 +57,7 @@ module RSpecTracer
 
     def merge_last_run_report(cache_dir)
       file_name = File.join(cache_dir, 'last_run.json')
-      cached_last_run = JSON.parse(File.read(file_name), symbolize_names: true)
+      cached_last_run = JSON.parse(File.read(file_name, encoding: 'UTF-8'), symbolize_names: true)
       cached_last_run[:pid] = [cached_last_run[:pid]]
 
       cached_last_run.delete_if { |key, _| %i[run_id timestamp].include?(key) }

data/lib/rspec_tracer/report_writer.rb

@@ -68,74 +68,74 @@ module RSpecTracer
     def write_all_examples_report
       file_name = File.join(@cache_dir, 'all_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.all_examples))
+      File.write(file_name, JSON.pretty_generate(@reporter.all_examples), encoding: 'UTF-8')
     end
 
     def write_duplicate_examples_report
       file_name = File.join(@cache_dir, 'duplicate_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.duplicate_examples))
+      File.write(file_name, JSON.pretty_generate(@reporter.duplicate_examples), encoding: 'UTF-8')
     end
 
     def write_interrupted_examples_report
       file_name = File.join(@cache_dir, 'interrupted_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.interrupted_examples.sort.to_a))
+      File.write(file_name, JSON.pretty_generate(@reporter.interrupted_examples.sort.to_a), encoding: 'UTF-8')
     end
 
     def write_flaky_examples_report
       file_name = File.join(@cache_dir, 'flaky_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.flaky_examples.sort.to_a))
+      File.write(file_name, JSON.pretty_generate(@reporter.flaky_examples.sort.to_a), encoding: 'UTF-8')
     end
 
     def write_failed_examples_report
       file_name = File.join(@cache_dir, 'failed_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.failed_examples.sort.to_a))
+      File.write(file_name, JSON.pretty_generate(@reporter.failed_examples.sort.to_a), encoding: 'UTF-8')
     end
 
     def write_pending_examples_report
       file_name = File.join(@cache_dir, 'pending_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.pending_examples.sort.to_a))
+      File.write(file_name, JSON.pretty_generate(@reporter.pending_examples.sort.to_a), encoding: 'UTF-8')
     end
 
     def write_skipped_examples_report
       file_name = File.join(@cache_dir, 'skipped_examples.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.skipped_examples.sort.to_a))
+      File.write(file_name, JSON.pretty_generate(@reporter.skipped_examples.sort.to_a), encoding: 'UTF-8')
     end
 
     def write_all_files_report
       file_name = File.join(@cache_dir, 'all_files.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.all_files))
+      File.write(file_name, JSON.pretty_generate(@reporter.all_files), encoding: 'UTF-8')
     end
 
     def write_dependency_report
       file_name = File.join(@cache_dir, 'dependency.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.dependency))
+      File.write(file_name, JSON.pretty_generate(@reporter.dependency), encoding: 'UTF-8')
     end
 
     def write_reverse_dependency_report
       file_name = File.join(@cache_dir, 'reverse_dependency.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.reverse_dependency))
+      File.write(file_name, JSON.pretty_generate(@reporter.reverse_dependency), encoding: 'UTF-8')
     end
 
     def write_examples_coverage_report
       file_name = File.join(@cache_dir, 'examples_coverage.json')
 
-      File.write(file_name, JSON.pretty_generate(@reporter.examples_coverage))
+      File.write(file_name, JSON.pretty_generate(@reporter.examples_coverage), encoding: 'UTF-8')
     end
 
     def write_last_run_report
       file_name = File.join(@report_dir, 'last_run.json')
       last_run_data = @reporter.last_run.merge(run_id: @run_id, timestamp: Time.now.utc)
 
-      File.write(file_name, JSON.pretty_generate(last_run_data))
+      File.write(file_name, JSON.pretty_generate(last_run_data), encoding: 'UTF-8')
     end
   end
 end

data/lib/rspec_tracer/source_file.rb

@@ -12,7 +12,7 @@ module RSpecTracer
       {
         file_path: file_path,
         file_name: file_name(file_path),
-        digest: Digest::MD5.hexdigest(File.read(file_path))
+        digest: Digest::MD5.hexdigest(File.binread(file_path))
       }
     end
 

data/lib/rspec_tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSpecTracer
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
 end

data/lib/rspec_tracer.rb

@@ -336,7 +336,7 @@ module RSpecTracer
 
         next unless File.directory?(cache_dir)
 
-        run_id = JSON.parse(File.read(File.join(cache_dir, 'last_run.json')))['run_id']
+        run_id = JSON.parse(File.read(File.join(cache_dir, 'last_run.json'), encoding: 'UTF-8'))['run_id']
 
         reports_dir << File.join(cache_dir, run_id)
       end
@@ -416,18 +416,47 @@ module RSpecTracer
       true
     end
 
+    # Elects the worker that performs the per-run merge. Delegates to
+    # `::ParallelTests.first_process?`, which returns true iff
+    # `TEST_ENV_NUMBER.to_i <= 1` — i.e. for exactly one worker
+    # (TEST_ENV_NUMBER == '' or '1'), regardless of how many workers
+    # were actually spawned vs. how many CPUs the runner reports.
+    #
+    # Two previously attempted approaches do NOT work here:
+    #
+    #   1. The lock-file scheme below (each worker writing its
+    #      TEST_ENV_NUMBER to `rspec_tracer.lock` via
+    #      `track_parallel_tests_test_env_number`; last_process picked
+    #      the max) deadlocked under slow CI: worker 1 could finish
+    #      its examples before worker 2 even loaded spec_helper,
+    #      observe itself as the max, and enter
+    #      `::ParallelTests.wait_for_other_processes_to_finish`
+    #      concurrently with worker 2's own self-election — both
+    #      workers then spun on each other's pid.
+    #
+    #   2. `::ParallelTests.last_process?` compares TEST_ENV_NUMBER
+    #      against PARALLEL_TEST_GROUPS, which parallel_rspec sets to
+    #      the CPU-based *intended* process count — NOT the actual
+    #      worker count. When spec files < CPU count (common), no
+    #      TEST_ENV_NUMBER ever matches PARALLEL_TEST_GROUPS and the
+    #      merge is silently skipped.
+    #
+    # `first_process?` avoids both: set by the parent at spawn,
+    # immutable thereafter, and identifies exactly one worker
+    # regardless of CPU count. The elected worker still calls
+    # `wait_for_other_processes_to_finish` before merging so peer
+    # caches are guaranteed on disk.
+    #
+    # `track_parallel_tests_test_env_number` and the lock-file
+    # cleanup in `at_exit_behavior` are retained for backward
+    # compatibility with users who observe `rspec_tracer.lock` /
+    # set `RSPEC_TRACER_LOCK_FILE`; the file is still written and
+    # removed but is no longer consulted.
     def parallel_tests_last_process?
       return false unless parallel_tests?
+      return false unless defined?(::ParallelTests)
 
-      max_test_num = 0
-
-      File.open(RSpecTracer.lock_file, 'r') do |f|
-        f.flock(File::LOCK_SH)
-
-        max_test_num = f.read.to_i
-      end
-
-      ENV['TEST_ENV_NUMBER'].to_i == max_test_num
+      ::ParallelTests.first_process?
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-tracer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Abhimanyu Singh
@@ -111,7 +111,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/avmnu-sng/rspec-tracer
-  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v1.1.0
+  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v1.1.2
   changelog_uri: https://github.com/avmnu-sng/rspec-tracer/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/avmnu-sng/rspec-tracer/issues
 rdoc_options: []