rspec-tracer 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ff2641751b61443860449bb5857cfeb2a4028881e05a7c58001f1bc6a7681d
-  data.tar.gz: aabe43c08122caf4e0af52ba77ef5ec85443953803488aae5d5bba83af7cdf6e
+  metadata.gz: 9bb2eb98496bfbfaf3582dd4fd91830e35dd9cfd54f242f53c2f445e9957c884
+  data.tar.gz: a91f7c646270ec4e7402885d37702f65f3117497dc77ae66afd253075cf8a687
 SHA512:
-  metadata.gz: 90b4b9795ff2b78e8c8a167e90736d639a74a4b4b082e69813cbaf66f4001852e603ad81ad761bb03565d7d4a0319d52ee3d0d79857b7880a7de82c1932b8640
-  data.tar.gz: 8784ef81e6fc6e076b64d22372215feeba7cfb7b5349b79b2b2e1618a745cced55c29e24ae768b941bda4f3a3058b28420ef4533a8b343f4e112d3bc9b47723f
+  metadata.gz: 1f205945ef89b10918091f2c2b01ca3634df82ccae6b30b4250053438890d8f8f513551b2b7f50814edfd4bd48f8bac47df97e1ad3758b78260784ec6034abe2
+  data.tar.gz: 7ebf412bbce22cba94546e4935691e65cbc47e23304adf178a7cd8b44f3464b1194a6132badf48866d0562b7df4dda1ee4c56466c25d60f77e94067082c82369

data/CHANGELOG.md

@@ -1,3 +1,86 @@
+## [1.2.1] - 2026-05-01
+
+### Fixed
+
+- **Parallel-tests merge silently dropped peer caches and left worker
+  directories behind** when the spawned-worker count exceeded
+  `ENV['PARALLEL_TEST_GROUPS']`. The merge + purge call-sites in
+  `lib/rspec_tracer.rb` (`merge_parallel_tests_reports`,
+  `merge_parallel_tests_coverage_reports`,
+  `purge_parallel_tests_reports`) iterated `1..ENV['PARALLEL_TEST_GROUPS']`
+  to construct per-worker directory names. But parallel_tests sets
+  `PARALLEL_TEST_GROUPS = num_processes.to_s` for each child, where
+  `num_processes` is the user-requested process count
+  (`Parallel.processor_count` by default) — not the actual worker
+  count. When `num_processes < spawned_worker_count` (e.g. when the
+  spec-count partition produces more non-empty groups than
+  `num_processes`, or shared-runner CPU detection drifts mid-run),
+  peer caches with `TEST_ENV_NUMBER` above the env bound were silently
+  dropped from the merge (warm-run skip decisions get made against
+  an under-sampled merged manifest) and left behind by the purge
+  (visible as straggler `parallel_tests_<N>/` directories under
+  `rspec_tracer_cache/`). The same gem behaviour was documented on
+  v1.1.1's `last_process?` fix
+  ([PR #101](https://github.com/avmnu-sng/rspec-tracer/pull/101)) but
+  the iteration call-sites kept the buggy bound. Each method now globs
+  the actual `parallel_tests_*` subdirectories under its base path,
+  making the merge + purge robust to whatever count parallel_tests
+  spawned. No cache format change.
+
+## [1.2.0] - 2026-04-24
+
+### Added
+
+- **`USE_TEST_SUITE_ID_CACHE` env flag** for per-suite remote-cache
+  validation. When set to the exact string `"true"`, the validator
+  accepts the current `TEST_SUITE_ID`'s cache independently of peer
+  suites' state — so an aborted suite on one CI run no longer forces
+  a cold run across every suite on the next. Default unset preserves
+  1.1.x behaviour byte-for-byte. Ports
+  [upstream PR #70](https://github.com/avmnu-sng/rspec-tracer/pull/70)
+  (kirpalsangha), with credit to the interviewstreet fork
+  ([PR #1](https://github.com/interviewstreet/rspec-tracer/pull/1))
+  where the same fix was shipped to HackerRank's production CI in 2024.
+
+### Fixed
+
+- **`SourceFile#file_path` silently dropped dependencies on external
+  absolute paths** (closes the issue behind upstream PRs
+  [#37](https://github.com/avmnu-sng/rspec-tracer/pull/37) and
+  [#67](https://github.com/avmnu-sng/rspec-tracer/pull/67)). When a
+  spec's `metadata[:file_path]` resolved to an absolute path **outside**
+  `RSpecTracer.root` — typical for shared examples from vendored gems
+  (`/opt/bundle/gems/rspec-rails-X/lib/shared_examples/...`) or for
+  monorepo spec files adjacent to the project tree — the method stripped
+  the leading `/` and expanded against `RSpecTracer.root`, producing a
+  non-existent path like `<root>/opt/bundle/...`. `File.file?` returned
+  false, `from_path` returned nil, and the tracer **silently skipped
+  dependency registration** for that file. Cache-staleness silent-
+  correctness bug: shared examples from external gems never appeared as
+  dependencies, so changes to them never invalidated the cache. The fix
+  returns the input unchanged only when it's an absolute path to an
+  existing file outside `RSpecTracer.root`; all other inputs (relative
+  paths, stripped-root forms, in-root absolute paths) continue through
+  the existing project-relative expansion, preserving byte-for-byte
+  behaviour for 1.1.x configurations.
+- **`ValidationError` constant now defined.** `remote_cache/validator.rb`
+  previously referenced `ValidationError` in its XOR-guard `raise` but
+  the constant was never declared anywhere. Tripping the guard
+  (setting exactly one of `TEST_SUITE_ID` / `TEST_SUITES`) raised
+  `NameError: uninitialized constant` instead of the intended
+  error class. Added `class ValidationError < StandardError` inside
+  `Validator`, mirroring `Aws::AwsError`.
+- **Typo in the XOR-guard error message** — `"enviornment"` →
+  `"environment"`.
+- **Single-suite `@cached_files_regex` now anchored** — `$` appended
+  so the pattern no longer matches extraneous-extension files like
+  `/ref/hash/foo.json.backup`. Multi-suite regex was already anchored
+  in 1.1.x.
+- **`remote_cache/aws.rb#upload_dir` error message** — reported
+  `"Failed to download files from …"` when the upload failed. Closes
+  upstream [PR #64](https://github.com/avmnu-sng/rspec-tracer/pull/64)
+  (C3).
+
 ## [1.1.2] - 2026-04-24
 
 ### Fixed

data/README.md

@@ -149,6 +149,22 @@ uses cache for specific test suites and not merge them.
   TEST_SUITE_ID=2 bundle exec rspec spec/helpers
   ```
 
+- **`USE_TEST_SUITE_ID_CACHE`** (optional, default unset) changes how the remote
+cache validator treats per-suite caches. When set to the exact string `"true"`,
+the validator accepts the current `TEST_SUITE_ID`'s cache independently of the
+other suites' state — so if one suite aborts mid-CI, the remaining suites can
+still reuse their own cached results on the next run. When unset (the default),
+1.1.x behaviour is preserved byte-for-byte: the validator requires every
+`TEST_SUITES` slot to be present before accepting any cache.
+  ```sh
+  export TEST_SUITES=3
+  export TEST_SUITE_ID=1
+  export USE_TEST_SUITE_ID_CACHE=true
+  bundle exec rspec spec/models
+  ```
+  Only the literal string `"true"` activates the flag; `"1"`, `"yes"`, or any
+  other truthy value keeps the default behaviour.
+
 ## Advanced Configuration
 
 Configuration settings must be defined in **`.rspec-tracer`** file:

data/lib/rspec_tracer/remote_cache/aws.rb

@@ -8,6 +8,8 @@ module RSpecTracer
       def initialize
         @s3_bucket, @s3_path = setup_s3
         @aws_cli = RSpecTracer.use_local_aws ? 'awslocal' : 'aws'
+        @use_test_suite_id_cache = ENV.fetch('USE_TEST_SUITE_ID_CACHE', nil) == 'true'
+        @test_suite_id = ENV.fetch('TEST_SUITE_ID', nil) if @use_test_suite_id_cache
       end
 
       def branch_refs?(branch_name)
@@ -60,7 +62,11 @@ module RSpecTracer
       end
 
       def cache_files_list(ref)
-        prefix = "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/"
+        prefix = if @use_test_suite_id_cache && !@test_suite_id.nil?
+                   "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/#{@test_suite_id}/"
+                 else
+                   "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/"
+                 end
 
         `#{@aws_cli} s3 ls #{prefix} --recursive`.chomp.split("\n")
       end
@@ -125,7 +131,7 @@ module RSpecTracer
         remote_dir = s3_dir(ref, run_id)
         local_dir = File.join(RSpecTracer.cache_path, run_id)
 
-        raise AwsError, "Failed to download files from #{local_dir}" unless system(
+        raise AwsError, "Failed to upload files from #{local_dir}" unless system(
           @aws_cli,
           's3',
           'cp',

data/lib/rspec_tracer/remote_cache/validator.rb

@@ -3,16 +3,19 @@
 module RSpecTracer
   module RemoteCache
     class Validator
+      class ValidationError < StandardError; end
+
       CACHE_FILES_PER_TEST_SUITE = 11
 
       def initialize
         @test_suite_id = ENV.fetch('TEST_SUITE_ID', nil)
         @test_suites = ENV.fetch('TEST_SUITES', nil)
+        @use_test_suite_id_cache = ENV.fetch('USE_TEST_SUITE_ID_CACHE', nil) == 'true'
 
         if @test_suite_id.nil? ^ @test_suites.nil?
           raise(
             ValidationError,
-            'Both the enviornment variables TEST_SUITE_ID and TEST_SUITES are not set'
+            'Both the environment variables TEST_SUITE_ID and TEST_SUITES are not set'
           )
         end
 
@@ -20,13 +23,11 @@ module RSpecTracer
       end
 
       def valid?(ref, cache_files)
-        last_run_regex = Regexp.new(format(@last_run_files_regex, ref: ref))
-
-        return false if cache_files.count { |file| file.match?(last_run_regex) } != @last_run_files_count
-
-        cache_regex = Regexp.new(format(@cached_files_regex, ref: ref))
-
-        cache_files.count { |file| file.match?(cache_regex) } == @cached_files_count
+        if @use_test_suite_id_cache
+          test_suite_id_specific_validation?(ref, cache_files)
+        else
+          general_validation?(ref, cache_files)
+        end
       end
 
       private
@@ -36,7 +37,7 @@ module RSpecTracer
           @last_run_files_count = 1
           @last_run_files_regex = '/%<ref>s/last_run.json$'
           @cached_files_count = CACHE_FILES_PER_TEST_SUITE
-          @cached_files_regex = '/%<ref>s/[0-9a-f]{32}/.+.json'
+          @cached_files_regex = '/%<ref>s/[0-9a-f]{32}/.+.json$'
         else
           @test_suites = @test_suites.to_i
           @test_suites_regex = (1..@test_suites).to_a.join('|')
@@ -47,6 +48,25 @@ module RSpecTracer
           @cached_files_regex = "/%<ref>s/(#{@test_suites_regex})/[0-9a-f]{32}/.+.json$"
         end
       end
+
+      def general_validation?(ref, cache_files)
+        last_run_regex = Regexp.new(format(@last_run_files_regex, ref: ref))
+
+        return false if cache_files.count { |file| file.match?(last_run_regex) } != @last_run_files_count
+
+        cache_regex = Regexp.new(format(@cached_files_regex, ref: ref))
+
+        cache_files.count { |file| file.match?(cache_regex) } == @cached_files_count
+      end
+
+      def test_suite_id_specific_validation?(ref, cache_files)
+        last_run_regex = Regexp.new("/#{ref}/#{@test_suite_id}/last_run.json$")
+        cache_regex = Regexp.new("/#{ref}/#{@test_suite_id}/[0-9a-f]{32}/.+.json$")
+
+        return false unless cache_files.any? { |file| file.match?(last_run_regex) }
+
+        cache_files.any? { |file| file.match?(cache_regex) }
+      end
     end
   end
 end

data/lib/rspec_tracer/source_file.rb

@@ -25,7 +25,15 @@ module RSpecTracer
     end
 
     def file_path(file_name)
+      return file_name if absolute_external_file?(file_name)
+
       File.expand_path(file_name.sub(%r{^/}, ''), RSpecTracer.root)
     end
+
+    def absolute_external_file?(file_name)
+      file_name.start_with?('/') &&
+        !file_name.start_with?(RSpecTracer.root) &&
+        File.file?(file_name)
+    end
   end
 end

data/lib/rspec_tracer/version.rb

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

data/lib/rspec_tracer.rb

@@ -330,12 +330,7 @@ module RSpecTracer
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       reports_dir = []
 
-      1.upto(ENV['PARALLEL_TEST_GROUPS'].to_i) do |test_num|
-        cache_path = File.dirname(RSpecTracer.cache_path)
-        cache_dir = File.join(cache_path, "parallel_tests_#{test_num}")
-
-        next unless File.directory?(cache_dir)
-
+      parallel_tests_peer_dirs(File.dirname(RSpecTracer.cache_path)).each do |cache_dir|
         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)
@@ -365,14 +360,8 @@ module RSpecTracer
       return unless parallel_tests_executed? && !simplecov?
 
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      reports_dir = []
 
-      1.upto(ENV['PARALLEL_TEST_GROUPS'].to_i) do |test_num|
-        coverage_path = File.dirname(RSpecTracer.coverage_path)
-        coverage_dir = File.join(coverage_path, "parallel_tests_#{test_num}")
-
-        reports_dir << coverage_dir if File.directory?(coverage_dir)
-      end
+      reports_dir = parallel_tests_peer_dirs(File.dirname(RSpecTracer.coverage_path))
 
       coverage_merger.merge(reports_dir)
 
@@ -401,13 +390,34 @@ module RSpecTracer
     def purge_parallel_tests_reports
       return unless parallel_tests_executed?
 
-      1.upto(ENV['PARALLEL_TEST_GROUPS'].to_i) do |test_num|
-        [RSpecTracer.cache_path, RSpecTracer.coverage_path, RSpecTracer.report_path].each do |path|
-          FileUtils.rm_rf(File.join(File.dirname(path), "parallel_tests_#{test_num}"))
+      [RSpecTracer.cache_path, RSpecTracer.coverage_path, RSpecTracer.report_path].each do |path|
+        parallel_tests_peer_dirs(File.dirname(path)).each do |worker_dir|
+          FileUtils.rm_rf(worker_dir)
         end
       end
     end
 
+    # Returns every `parallel_tests_*` subdirectory directly under
+    # `base_path`. Used by the parallel_tests merge + purge paths.
+    #
+    # Earlier patches iterated `1..ENV['PARALLEL_TEST_GROUPS'].to_i`
+    # to construct dir names, but parallel_tests's own runner sets
+    # PARALLEL_TEST_GROUPS to the user-requested process count
+    # (`Parallel.processor_count` by default), NOT the actual worker
+    # count. When num_processes < spawned_worker_count, the upper
+    # bound was too small: peer caches with TEST_ENV_NUMBER above the
+    # bound were silently dropped from the merge AND left behind by
+    # the purge. PR #101's commit message documented this gem
+    # behaviour for `last_process?` detection but did not extend the
+    # fix to the iteration call-sites; this method closes that gap.
+    # Globbing the actual filesystem state is robust to the env
+    # discrepancy regardless of how the gem partitions specs.
+    def parallel_tests_peer_dirs(base_path)
+      Dir.glob(File.join(base_path, 'parallel_tests_*')).select do |path|
+        File.directory?(path)
+      end
+    end
+
     def parallel_tests_executed?
       return false unless parallel_tests? && parallel_tests_last_process?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-tracer
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 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.2
+  source_code_uri: https://github.com/avmnu-sng/rspec-tracer/tree/v1.2.1
   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: []