- Modules: Version + Modules: Utils, Version diff --git a/docs/TurboTests/Runner.html b/docs/TurboTests/Runner.html index bf08336..837751f 100644 --- a/docs/TurboTests/Runner.html +++ b/docs/TurboTests/Runner.html @@ -126,6 +126,42 @@
%i[warnings stream buffered quiet].freeze
Shared wall-clock budget, in seconds, for draining a worker’s stdout and
+stderr readers after the child has exited. Normally the pipe EOFs in
+milliseconds, so this is not on the hot path; the bound exists only for a
+wedged pipe whose write end is still held open (e.g. by a grandchild),
+which can never EOF. Shared across both streams so teardown cannot take
+twice the budget.
1Short join used only after the pipe is force-closed, to give the reader a
+moment to notice EOF before it is killed.
0.1-214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 232 233 234 @@ -525,10 +543,28 @@+253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271250 251 252 -253
# File 'lib/turbo_tests/runner.rb', line 214 +# File 'lib/turbo_tests/runner.rb', line 232 def initialize(**opts) @formatters = opts[:formatters] @@ -597,19 +633,19 @@
-20 -21 -22 -23 -24 -25 -26 -27 -28 -29+31 +32 +33 +34 +35 +36 +37 +38 +39 +40
# File 'lib/turbo_tests/runner.rb', line 20 +# File 'lib/turbo_tests/runner.rb', line 31 def create(count) # We are unable to load parallel tests' tasks in the normal way (top of file) @@ -641,12 +677,12 @@
-156 -157 -158+167 +168 +169
# File 'lib/turbo_tests/runner.rb', line 156 +# File 'lib/turbo_tests/runner.rb', line 167 def generate_seed (Random.new_seed % 65_535).to_s @@ -694,16 +730,16 @@
-148 -149 -150 -151 -152 -153 -154+159 +160 +161 +162 +163 +164 +165
# File 'lib/turbo_tests/runner.rb', line 148 +# File 'lib/turbo_tests/runner.rb', line 159 def normalize_order(order) order = order.to_s.strip.downcase @@ -732,23 +768,23 @@
-108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 119 120 -121+121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132
# File 'lib/turbo_tests/runner.rb', line 108 +# File 'lib/turbo_tests/runner.rb', line 119 def normalize_rspec_file_selection(files) selectors = {} @@ -807,19 +843,19 @@
-97 -98 -99 -100 -101 -102 -103 -104 -105 -106+108 +109 +110 +111 +112 +113 +114 +115 +116 +117
# File 'lib/turbo_tests/runner.rb', line 97 +# File 'lib/turbo_tests/runner.rb', line 108 def normalize_worker_output_mode(mode) value = mode.to_s.strip.downcase.tr("-", "_") @@ -851,17 +887,17 @@
-204 -205 -206 -207 -208 -209 -210 -211+222 +223 +224 +225 +226 +227 +228 +229
# File 'lib/turbo_tests/runner.rb', line 204 +# File 'lib/turbo_tests/runner.rb', line 222 def (root = Dir.pwd) %w[.rspec .rspec-local].flat_map do |path| @@ -891,27 +927,34 @@
-160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 171 172 173 174 175 176 -177+177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195
# File 'lib/turbo_tests/runner.rb', line 160 +# File 'lib/turbo_tests/runner.rb', line 171 def rspec_configured_files_to_run configuration = RSpec::Core::Configuration.new @@ -924,11 +967,18 @@# walking to the nearest .rspec would strip those to bare # member-relative "spec/..." paths that do not exist at the root, # crashing File.stat during group sizing. - root = File.(Dir.pwd).tr("\\", "/") - root_prefix = "#{root}/" + # + # Compare paths by filesystem identity (File.identical?) rather than by + # string. On the Windows CI runner Dir.pwd reports the 8.3 short name + # (C:/Users/RUNNER~1/...) while Dir.glob, which RSpec uses to expand + # --pattern, reports the long name (C:/Users/runneradmin/...). Both + # spellings name the same directory, but File.realpath does NOT expand + # 8.3 names, so neither a string prefix nor Pathname#relative_path_from + # can reconcile them. The same class of mismatch arises from a symlinked + # ancestor. See TurboTests::Utils::Paths. + root = File.(Dir.pwd) configuration.files_to_run.map do |path| - = File.(path.to_s, root).tr("\\", "/") - .start_with?(root_prefix) ? [root_prefix.length..-1] : + TurboTests::Utils::Paths.relative_from(File.(path.to_s, root), root) end end
-31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 42 43 44 @@ -1015,10 +1054,21 @@+95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +10692 93 94 -95
# File 'lib/turbo_tests/runner.rb', line 31 +# File 'lib/turbo_tests/runner.rb', line 42 def run(opts = {}) default_file_discovery = !opts.key?(:files) || opts[:files].nil? @@ -1105,23 +1155,23 @@
-133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 144 145 -146+146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157
# File 'lib/turbo_tests/runner.rb', line 133 +# File 'lib/turbo_tests/runner.rb', line 144 def runtime_log_from_example_status(example_status_log) statuses = RSpec::Core::ExampleStatusPersister.load_from(example_status_log) @@ -1157,18 +1207,18 @@
-123 -124 -125 -126 -127 -128 -129 -130 -131+134 +135 +136 +137 +138 +139 +140 +141 +142
# File 'lib/turbo_tests/runner.rb', line 123 +# File 'lib/turbo_tests/runner.rb', line 134 def split_rspec_location(entry) value = entry.to_s @@ -1199,33 +1249,33 @@
-179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 197 198 199 200 201 -202+202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220
# File 'lib/turbo_tests/runner.rb', line 179 +# File 'lib/turbo_tests/runner.rb', line 197 def worker_spec_opts(spec_opts) args = + Array(spec_opts) @@ -1277,24 +1327,6 @@
-255 -256 -257 -258 -259 -260 -261 -262 -263 -264 -265 -266 -267 -268 -269 -270 -271 -272 273 274 275 @@ -1342,10 +1374,28 @@+320 +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338317 318 319 -320
# File 'lib/turbo_tests/runner.rb', line 255 +# File 'lib/turbo_tests/runner.rb', line 273 def run = @parallel_options.reject { |key, _value| key == :only_group } diff --git a/docs/TurboTests/Utils.html b/docs/TurboTests/Utils.html new file mode 100644 index 0000000..ef8843d --- /dev/null +++ b/docs/TurboTests/Utils.html @@ -0,0 +1,118 @@ + + + + + ++ Module: TurboTests::Utils + + — Documentation by YARD 0.9.45 + + + + + + + + + + + + + + + + + + + + + +++ + diff --git a/docs/TurboTests/Utils/Paths.html b/docs/TurboTests/Utils/Paths.html new file mode 100644 index 0000000..e78067c --- /dev/null +++ b/docs/TurboTests/Utils/Paths.html @@ -0,0 +1,508 @@ + + + + + ++ + ++ ++ + + + + + ++ ++ + + +Module: TurboTests::Utils + + + +
++ + + + + + + + + + + ++ ++
+ +- Defined in:
+- lib/turbo_tests/utils/paths.rb +
+Defined Under Namespace
++ + + Modules: Paths + + + + +
+ + + + + + + + + ++ Module: TurboTests::Utils::Paths + + — Documentation by YARD 0.9.45 + + + + + + + + + + + + + + + + + + + + + +++ + diff --git a/docs/_index.html b/docs/_index.html index 7c5faae..a57248d 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -172,6 +172,21 @@+ + ++ ++ + + + + + ++ ++ + + +Module: TurboTests::Utils::Paths + + + +
++ + + + + + + + + + + ++ ++
+ +- Defined in:
+- lib/turbo_tests/utils/paths.rb +
+Overview
++ + + + + + + + +++Makes discovered spec paths relative to the cwd that owns the RSpec
+ +
+configuration, in a way that survives the same directory being spelled
+two different ways.== Why string comparison of paths is not safe here
+ +A path string is a name, not an identity. One directory can have
+ +
+several valid names, and the two names can reach this module from
+different APIs within the same process.On the Windows CI runner (windows-latest, github/actions) this is not
+ +
+hypothetical. Measured from the runner itself:Dir.pwd => “C:/Users/RUNNER~1/AppData/Local/Temp/turbo-tests2-…-ujisy2”
+ +
+ ENV[“TEMP”] => “C:\Users\RUNNER~1\AppData\Local\Temp”
+ Dir.tmpdir => “C:/Users/RUNNER~1/AppData/Local/Temp”
+ Dir.glob result => “C:/Users/runneradmin/AppData/Local/Temp/turbo-tests2-…-ujisy2/gems/example/spec/example_spec.rb”+ +
RUNNER~1is an 8.3 short name;runneradminis the long name of the
+same directory.Dir.pwdand the environment report the short form while
+Dir.glob— which RSpec uses to expand--pattern— reports the long
+form. Both are correct, and they are never equal as strings.In this codebase the mismatch has a second, platform-independent face:
+ +
+a symlinked ancestor. On Fedora,/home/pbolingis a symlink to
+/var/home/pboling, soDir.pwdcan report one form while a path built
+from an ENV var or a stored fixture reports the other. That is what makes
+this bug reproducible in specs without a Windows runner.== Approaches that do NOT work, and why
+ +All four were tried on this branch and all failed. Recorded so nobody
+ +
+repeats the sequence.+
+ +- +
+String prefix, the original code:
+ +root_prefix = “#{root}/”
+ +
+ expanded.start_with?(root_prefix)Never matches when the two spellings differ, so the absolute temp path
+
+leaks through. parallel_tests then calls File.stat on it during group
+sizing. It also wrongly reports “project-other/spec” as inside
+“project”, which is why spec/utils/paths_spec.rb covers siblings.- +
+Canonicalize with File.realpath, then compare:
+ +File.realpath(path) == File.realpath(root) # conceptually
+ +WRONG PREMISE: File.realpath does NOT expand 8.3 short names. Measured
+ +
+on the runner, realpath of the short path returns the short path
+unchanged:root_realpath => “C:/Users/RUNNER~1/AppData/Local/Temp/turbo-tests2-…”
+ +Canonicalization therefore cannot reconcile the two spellings at all.
+ +
+(kettle-dev’s Kettle::Dev::Paths.canonical documents realpath as
+expanding 8.3 names; that comment is inaccurate. Worth correcting if
+this module is ever extracted to a shared gem.)realpath also resolves symlinks, which introduces a second failure
+
+mode: root and file can legitimately traverse different symlink paths
+to one directory, and canonicalizing only one side makes them diverge.- +
+Component-wise comparison of the canonicalized parts (split on
+
+File::SEPARATOR, compare element by element, case-insensitively on
+Windows). Built on the same false premise as #2, so it fails
+identically —RUNNER~1never equalsrunneradminin any case
+folding. It additionally depended on File::ALT_SEPARATOR, which
+measured as “” (empty string, not nil) on that runner, making the
+separator-normalizingtra silent no-op. Do not trust ALT_SEPARATOR
+to be present.- +
+Pathname#relative_path_from, Ruby’s own stdlib helper:
+ +Pathname.new(file).relative_path_from(Pathname.new(root)).to_s
+ +It is purely lexical. With differing spellings it walks all the way up
+ +
+and back down, producing:”../../../../../runneradmin/AppData/Local/Temp/…/example_spec.rb”
+ +Note it does not raise, so a
+rescue ArgumentErrorguard cannot catch
+it. The result is a plausible-looking but wrong relative path, which is
+worse than the leak in #1 because it silently selects the wrong files.
+The same nonsense appears on the symlink case:
+“../../../../../../var/home/pboling/src/my/…”.== The approach that works
+ +File.identical? asks the filesystem whether two names denote one object,
+ +
+by inode on Unix and by file index on Windows. It is spelling-agnostic,
+which is exactly the property needed. Measured on the runner:File.identical?(root, root) => true
+ +
+ File.identical?(file, file) => trueand a walk-up from the long-name file to the short-name root produced the
+ +
+correct “gems/example/spec/example_spec.rb”, while the string-prefix and
+Pathname baselines both failed in the same run.So: ascend from the file, asking at each level “is this the root?”, and
+ +
+re-join the basenames on the way back down. The relative path is built
+from the file’s spelling, which is what the caller needs, since
+parallel_tests stats these paths and spawns workers from this cwd.== How this was finally diagnosed
+ +The failure only reproduced on the Windows CI runner, and its output was
+ +
+swallowed: these discovery specs run a subprocess via Open3.capture3 whose
+stderr is only surfaced when the status check fails, and the assertion
+that failed was the JSON comparison. Four blind fixes failed in a row.What resolved it was a temporary, Windows-guarded spec
+ +
+(if: Gem.win_platform?) that deliberately failed with the diagnostic
+JSON embedded in the expectation message, so the runner’s real path forms
+printed into the CI log. Guarding it kept the other 22 checks green while
+one job reported the data. That spec is deleted; the findings it produced
+are this comment plus spec/utils/paths_spec.rb.Lesson: when a bug is environment-specific and the environment is not
+ + +
+available locally, spend the iteration on instrumenting the real
+environment rather than on another hypothesized fix.+ Class Method Summary + collapse +
+ ++ +
+ + + + + +- + + + .relative_from(file, root) ⇒ String + + + + + + + + + + + + + +
+ + ++ +Returns the path of +file+ relative to +root+ when +file+ is +root+ itself or lives inside it, compared by filesystem identity rather than by string.
+- + + + .within?(file, root) ⇒ Boolean + + + + + + + + + + + + + +
+ + ++ +Returns true when +file+ is +root+ itself or lives inside it, compared by filesystem identity.
+++ +Class Method Details
+ + +++ ++ + .relative_from(file, root) ⇒ String + + + + + +
++++Returns the path of +file+ relative to +root+ when +file+ is +root+
+ +
+itself or lives inside it, compared by filesystem identity rather than
+by string.Returns the expanded +file+ unchanged when it is not inside +root+
+ + +
+(there is nothing to strip) or when identity cannot be established,
+e.g. because one side does not exist. That matches the long-standing
+behavior of passing through paths outside the root untouched.+
++ ++ ++ + +145 +146 +147 +148 +149 +150++ +# File 'lib/turbo_tests/utils/paths.rb', line 145 + +def relative_from(file, root) + = File.(file.to_s) + relative = relative_to_root(, root) + + relative || +end+++ ++ + .within?(file, root) ⇒ Boolean + + + + + +
++++Returns true when +file+ is +root+ itself or lives inside it, compared
+ +
+by filesystem identity.Unlike a string prefix test this does not treat a sibling directory
+ + +
+that merely shares a prefix (“project-other”) as being inside “project”.+
++ ++ ++ + +161 +162 +163 +164 +165++ +# File 'lib/turbo_tests/utils/paths.rb', line 161 + +def within?(file, root) + return false if blank?(file) || blank?(root) + + relative_to_root(File.(file.to_s), root).is_a?(String) +end+Namespace Listing A-Z
+
rspec_configured_files_to_run: normalize discovered spec paths against the root cwd instead of the nearest ancestor .rspec. In stacked monorepos (root .rspec aggregating gems/*/spec via –pattern, where each gem also has its own .rspec), the nearest-ancestor walk stripped aggregated specs to bare member-relative spec/… paths that do not exist at the root, crashing parallel_tests File.stat during group sizing and aborting the whole run. Regression introduced in 3.2.13.
+Fix a teardown race that intermittently dropped a worker’s results. The exit-watcher thread previously signaled process exit as soon as the child was reaped, before the stdout/stderr readers had drained the pipe. Under CI contention handle_messages could reach process_count exits and stop while that worker’s rows were still queued behind the exit signal, so they were never reported. Symptom was a nested run reporting “1 example, 0 failures” instead of “4 examples, 0 failures, 3 pending”, with which worker vanished varying run to run (spec/integration/multi_process_spec.rb failed at :46 on one run and :52-54 on the next). Readers are now drained to EOF before the watcher signals exit, and the exit/error messages are a deduped fallback for a reader force-stopped before EOF. Drain uses one shared monotonic deadline across both streams (READER_DRAIN_TIMEOUT) so a wedged pipe whose write end stays open cannot double teardown time or hang; force-stop still closes the pipe and kills the reader as before.
+Fix spec discovery returning absolute paths on Windows, which crashed parallel_tests’ File.stat during group sizing. rspec_configured_files_to_run made discovered paths relative to the cwd with a string prefix check. On Windows the cwd and the discovered files can name the same directory with two different spellings: Dir.pwd and ENV[“TEMP”] report the 8.3 short name (C:/Users/RUNNER~1/AppData/Local/Temp) while Dir.glob, which RSpec uses to expand –pattern, reports the long name (C:/Users/runneradmin/AppData/Local/Temp). The prefix therefore never matched and the absolute temp path leaked through. File.realpath does not expand 8.3 short names, so canonicalizing first cannot reconcile the two spellings, and Pathname#relative_path_from returns nonsense such as “../../../../../runneradmin/…”. The same class of mismatch arises from a symlinked ancestor on any platform, e.g. a Dir.pwd of /var/home/u/proj against a path spelled /home/u/proj/… Discovered paths are now made relative by walking up from the file and comparing each ancestor with File.identical?, which compares by filesystem identity (inode on Unix, file index on Windows) and so treats every spelling of one directory as equal. Extracted as TurboTests::Utils::Paths.relative_from/.within?.
+
+ 
+