Module: AuditionHarness

Defined in:
lib/audition/dynamic/harness.rb

Defined Under Namespace

Classes: CapClassVar, CapIvar

Constant Summary collapse

MAX_CONSTS =

High enough for the largest targets: the sweep is the backstop for everything static analysis cannot prove, so it must reach every constant the boot defined. A hit is reported as truncated, never silent.

200_000
EXCLUDED_DIRS =

Directories under the target root that are not the target's own surface. Bundler's deployment mode (and bundler-cache in GitHub Actions) vendors every gem into /vendor/bundle, and attributing those constants to the target would flip its verdict from blocked to not_ready. Must mirror Audition::Target::EXCLUDED_DIRS (this file is a standalone subprocess script and cannot require the gem); a spec keeps the two lists in sync.

%w[
  vendor node_modules tmp log coverage pkg .git .bundle
].freeze
CAP_CONST =

Fixtures for capability probes.

[1, 2]
NATIVE = 
/\.(bundle|so)\z/
DECLARATION = 
"rb_ext_ractor_safe"
MACHINERY =

RubyGems, Bundler, and the VM mutate their own module state on every require; that is probe machinery, not the target's doing.

/\A(?:Gem|Bundler|RubyVM)(?:::|\z)/
PROC_SITE =

The deprecation names the Proc; its inspect carries the definition site, which is where the fix goes.

/#<Proc:0x\h+(?: \(lambda\))? (.+?):(\d+)>/

Class Method Summary collapse

Class Method Details

.arm_proc_gate(warnings, preload:) ⇒ Object

Rails 8.2 tries to make every callback block shareable once unshareable_proc_action is set, and reports each one it cannot as a deprecation naming the Proc. The probe arms :warn and collects those messages. Arming before boot covers apps that eager load while booting; the shim file only exists on 8.2, so older targets load nothing extra. Returns whether the gate is armed.



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/audition/dynamic/harness.rb', line 759

def arm_proc_gate(warnings, preload:)
  if preload
    begin
      require "active_support/ractors" # audition:disable runtime-require
      require "active_support" # audition:disable runtime-require
    rescue LoadError
      return false
    end
  end
  return false unless defined?(ActiveSupport::Ractors) &&
    ActiveSupport::Ractors.respond_to?(:unshareable_proc_action=)

  ActiveSupport::Ractors.unshareable_proc_action = :warn
  return true unless ActiveSupport.respond_to?(:deprecator)

  deprecator = ActiveSupport.deprecator
  collector = lambda do |message, _callstack|
    warnings << message.to_s
  end
  deprecator.behavior = [collector]
  deprecator.silenced = false if deprecator.respond_to?(:silenced=)
  if deprecator.respond_to?(:disallowed_warnings=)
    deprecator.disallowed_warnings = []
  end
  true
rescue Exception
  false
end

.backtrace_for(error) ⇒ Object

Enough frames to reach the target's code under framework wrappers; frames carry paths, which can carry arbitrary bytes.



105
106
107
108
109
110
111
 
# File 'lib/audition/dynamic/harness.rb', line 105

def backtrace_for(error)
  Array(error.backtrace).first(30).map do |frame|
    scrub(frame.to_s)[0, 300]
  end
rescue Exception
  []
end

.base_env ⇒ Object 



649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/audition/dynamic/harness.rb', line 649

def base_env
  {
    "REQUEST_METHOD" => "GET",
    "PATH_INFO" => "/",
    "QUERY_STRING" => "",
    "SERVER_NAME" => "localhost",
    "SERVER_PORT" => "80",
    "SERVER_PROTOCOL" => "HTTP/1.1",
    "rack.url_scheme" => "http",
    "rack.input" => StringIO.new(+""),
    "rack.errors" => StringIO.new(+"")
  }
end

.blocker_for(value, depth = 0) ⇒ Object

The innermost unshareable node of an unshareable value, with its depth: an unfrozen node with shareable contents just needs freezing, an inherently unshareable one needs replacing. Bounded, because shareability of each child is itself a recursive check.



518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/audition/dynamic/harness.rb', line 518

def blocker_for(value, depth = 0)
  return [describe_blocker(value), depth] if depth > 5

  child = children_of(value).find { |c| !safe_shareable?(c) }
  if child
    blocker_for(child, depth + 1)
  else
    [describe_blocker(value), depth]
  end
rescue Exception
  [describe_blocker(value), depth]
end

.bundler_setup ⇒ Object

The prober sets BUNDLE_GEMFILE to the target's Gemfile; the target's gems must resolve before its boot files load. A setup failure propagates: it is the true boot failure, and the standard reporting captures it. Bundler.setup is called directly because bundler/setup exits on failure, swallowing the message.



687
688
689
690
691
692
 
# File 'lib/audition/dynamic/harness.rb', line 687

def bundler_setup
  return unless ENV["BUNDLE_GEMFILE"]

  require "bundler" # audition:disable runtime-require
  Bundler.ui.silence { Bundler.setup }
end

.capabilities ⇒ Object

-- capabilities ------------------------------------------------



847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/audition/dynamic/harness.rb', line 847

def capabilities
  caps = {}
  capability_probes.each do |label, probe|
    probe.call
    caps[label] = {"ok" => true, "error" => nil}
  rescue Exception => e
    caps[label] = {"ok" => false,
                    "error" => unwrap(e).class.name}
  end
  {"capabilities" => caps}
end

.capability_probes ⇒ Object 



859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/audition/dynamic/harness.rb', line 859

def capability_probes
  {
    "global variable read" =>
      -> { Ractor.new { $audition_cap }.value }, # audition:disable
    "global variable write" =>
      -> { Ractor.new { $audition_cap = 1 }.value }, # audition:disable
    "class variable access" =>
      -> { Ractor.new { CapClassVar.read }.value },
    "class ivar write" =>
      -> { Ractor.new { CapIvar.write }.value },
    "class ivar read (mutable value)" =>
      -> { Ractor.new { CapIvar.read_mutable }.value },
    "unshareable constant read" =>
      -> { Ractor.new { CAP_CONST }.value },
    "constant set (unshareable value)" =>
      -> { Ractor.new { Object.const_set(:AUDITION_X, +"s") }.value },
    "ENV read" =>
      -> { Ractor.new { ENV.fetch("HOME", "none") }.value },
    "ENV write" =>
      -> { Ractor.new { ENV["AUD_CAP"] = "1" }.value }, # audition:disable
    "require inside Ractor" =>
      -> { Ractor.new { require "date" }.value }, # audition:disable
    "ObjectSpace.each_object" =>
      -> { Ractor.new { ObjectSpace.each_object(Class).first }.value },
    "Signal.trap" =>
      -> { Ractor.new { Signal.trap("USR2") {} }.value }, # audition:disable
    "Thread.current storage" =>
      -> { Ractor.new { Thread.current[:x] = 1 }.value },
    "Timeout.timeout" =>
      lambda do
        require "timeout" # audition:disable runtime-require
        Ractor.new { Timeout.timeout(2) { :ok } }.value
      end,
    "proc copied into Ractor" =>
      lambda do
        pr = proc { 1 }
        Ractor.new(pr) { |_p| :ok }.value
      end,
    "outer local capture" =>
      lambda do
        z = [1]
        Ractor.new { z }.value # audition:disable ractor-isolation
      end
  }
end

.children_of(value) ⇒ Object 



531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/audition/dynamic/harness.rb', line 531

def children_of(value)
  children =
    case value
    when Hash then value.keys + value.values
    when Array then value
    when Struct, Data then value.deconstruct
    else
      value.instance_variables.map do |ivar|
        value.instance_variable_get(ivar)
      end
    end
  children.first(1000)
end

.declares?(path) ⇒ Boolean

Returns:

  • (Boolean) 


367
368
369
370
371
 
# File 'lib/audition/dynamic/harness.rb', line 367

def declares?(path)
  File.binread(path).include?(DECLARATION)
rescue SystemCallError
  false
end

.describe_blocker(value) ⇒ Object

"unfrozen X" only when freezing would actually flip the verdict; a Proc or IO stays unshareable frozen, and naming it unfrozen would send the reader to a fix that cannot work.



548
549
550
551
552
553
554
555
556
557
 
# File 'lib/audition/dynamic/harness.rb', line 548

def describe_blocker(value)
  return value.class.to_s if value.frozen?

  frozen_helps = begin
    Ractor.shareable?(value.dup.freeze)
  rescue Exception
    false
  end
  frozen_helps ? "unfrozen #{value.class}" : value.class.to_s
end

.describe_error(error) ⇒ Object

Exception messages can carry arbitrary bytes (C extensions, binary filenames); scrubbed to UTF-8 so the report can print them.



96
97
98
99
100
101
 
# File 'lib/audition/dynamic/harness.rb', line 96

def describe_error(error)
  root = unwrap(error)
  {"class" => scrub(root.class.name.to_s),
   "message" => scrub(root.message.to_s)[0, 500],
   "backtrace" => backtrace_for(root)}
end

.emit(out, result) ⇒ Object

One Marshal document: the prober loads it back into the same strings, arrays, and hashes, binary bytes included.



87
88
89
90
91
 
# File 'lib/audition/dynamic/harness.rb', line 87

def emit(out, result)
  out.binmode
  out.write(Marshal.dump(result))
  out.flush
end

.entry_candidates(feature, load_paths) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/audition/dynamic/harness.rb', line 218

def entry_candidates(feature, load_paths)
  candidates = []
  slashed = feature.tr("-", "/")
  candidates << slashed if slashed != feature
  files = load_paths.flat_map do |path|
    Dir[File.join(realpath(path), "*.rb")]
  end
  candidates << files.first.delete_suffix(".rb") if files.size == 1
  candidates
end

.excluded?(path, root) ⇒ Boolean

Matches the static scanner's exclusion rule: any excluded or dot-prefixed component in the root-relative path means the file is not the target's own code.

Returns:

  • (Boolean) 


338
339
340
341
342
343
 
# File 'lib/audition/dynamic/harness.rb', line 338

def excluded?(path, root)
  relative = path.delete_prefix(root + File::SEPARATOR)
  relative.split(File::SEPARATOR).any? do |part|
    EXCLUDED_DIRS.include?(part) || part.start_with?(".")
  end
end

.in_ractor(*args, &block) ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/audition/dynamic/harness.rb', line 127

def in_ractor(*args, &block)
  ractor = Ractor.new(*args, &block)
  {"ok" => true, "value" => plain_value(ractor.value)}
rescue Exception => e
  {"ok" => false, "error" => describe_error(e)}
end

.inspect_module(full, mod, origin, class_state, class_vars) ⇒ Object 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/audition/dynamic/harness.rb', line 388

def inspect_module(full, mod, origin, class_state, class_vars)
  ivars = mod.instance_variables
  if ivars.any?
    shareability = ivars.map do |ivar|
      value = mod.instance_variable_get(ivar)
      [ivar.to_s, safe_shareable?(value)]
    end
    class_state << origin.merge(
      "const" => full,
      "ivars" => shareability.map(&:first),
      "unshareable" => shareability.reject(&:last).map(&:first)
    )
  end
  cvars = mod.class_variables(false)
  if cvars.any?
    class_vars << origin.merge(
      "const" => full, "cvars" => cvars.map(&:to_s)
    )
  end
  0
rescue Exception
  1
end

.known_paths(paths) ⇒ Object

The target's own compiled files, realpathed like everything the sweep compares against them.



191
192
193
 
# File 'lib/audition/dynamic/harness.rb', line 191

def known_paths(paths)
  Array(paths).map { |path| realpath(path) }
end

.library(payload) ⇒ Object

-- libraries ---------------------------------------------------



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/audition/dynamic/harness.rb', line 162

def library(payload)
  Array(payload["load_paths"]).each do |lp|
    $LOAD_PATH.unshift(lp) # audition:disable global-variables
  end
  root = payload["root"]
  limit = payload["max_constants"]
  known = known_paths(payload["known_compiled"])
  baseline = module_state_snapshot
  before = Object.constants
  features = $LOADED_FEATURES.dup # audition:disable global-variables
  require_target(payload.fetch("feature"),
    Array(payload["load_paths"]))
  merge_reopened(
    scan(top_level(before), root: root, limit: limit, known: known),
    baseline, root: root, limit: limit, known: known
  ).merge(
    "native_extensions" => native_extensions(
      features, root, payload["known_compiled"]
    )
  )
end

.main(mode, payload, out:) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/audition/dynamic/harness.rb', line 63

def main(mode, payload, out:)
  result =
    case mode
    when "script_main" then script_main(payload.fetch("path"))
    when "script_ractor" then script_ractor(payload.fetch("path"))
    when "require" then library(payload)
    when "rack" then rack(payload)
    when "rails" then rails(payload)
    when "capabilities" then capabilities
    else {"error" => {"class" => "ArgumentError",
                      "message" => "unknown mode #{mode}"}}
    end
  emit(out, result)
rescue Exception => e
  begin
    emit(out, "error" => describe_error(e))
  rescue Exception
    emit(out, "error" => {"class" => "HarnessFailure",
                          "message" => "unreportable error"})
  end
end

.main_request(app) ⇒ Object 



839
840
841
842
843
 
# File 'lib/audition/dynamic/harness.rb', line 839

def main_request(app)
  {"ok" => true, "status" => plain_value(app.call(base_env).first)}
rescue Exception => e
  {"ok" => false, "error" => describe_error(e)}
end

.merge_reopened(result, snapshot, root: nil, limit: nil, known: []) ⇒ Object

State the boot added to pre-existing modules, reported through the same channels as freshly defined class state, and the constants it added under them, swept like top-level ones (Ractor::Dispatch lives under the core Ractor class, and the new-constants sweep never looks there). No source location exists for a reopen, and unknown origins count as own.



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/audition/dynamic/harness.rb', line 464

def merge_reopened(result, snapshot, root: nil, limit: nil,
  known: [])
  origin = {"path" => nil, "line" => nil, "own" => true}
  added = []
  snapshot.each do |mod, (ivars, cvars, consts)|
    full = mod.name || mod.inspect
    next if full.match?(MACHINERY)

    unless mod.equal?(Object)
      new_consts = begin
        mod.constants(false) - consts
      rescue Exception
        []
      end
      new_consts.each { |name| added << [mod, name.to_s] }
    end
    new_ivars = mod.instance_variables - ivars
    new_cvars = mod.class_variables(false) - cvars
    next if new_ivars.empty? && new_cvars.empty?

    if new_ivars.any?
      unshareable = new_ivars.reject do |ivar|
        safe_shareable?(mod.instance_variable_get(ivar))
      end
      result["class_state"] << origin.merge(
        "const" => full,
        "ivars" => new_ivars.map(&:to_s),
        "unshareable" => unshareable.map(&:to_s)
      )
    end
    if new_cvars.any?
      result["class_variables"] << origin.merge(
        "const" => full, "cvars" => new_cvars.map(&:to_s)
      )
    end
  end
  return result if added.empty?

  extra = scan(added, root: root, limit: limit, known: known)
  %w[unshareable_constants proven_constants class_state
    class_variables].each do |key|
    result[key] = Array(result[key]) + extra[key]
  end
  result["scanned"] = result["scanned"].to_i + extra["scanned"]
  result["errors"] = result["errors"].to_i + extra["errors"]
  result["truncated"] ||= extra["truncated"]
  result
end

.module_state_snapshot(limit = 50_000) ⇒ Object

Ivar/cvar state of every module defined before the boot. The new-constants sweep never revisits these, so state the boot plants on reopened core and stdlib classes is diffed against this snapshot instead. Autoload stubs are left untouched: forcing them here would load code behind the back of the before/after constant accounting.



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/audition/dynamic/harness.rb', line 424

def module_state_snapshot(limit = 50_000)
  snap = {}
  seen = {}
  queue = Object.constants.map { |name| [Object, name.to_s] }
  until queue.empty? || snap.size >= limit
    owner, name = queue.shift
    begin
      next if owner.autoload?(name, false)

      value = owner.const_get(name, false)
    rescue Exception
      next
    end
    next unless value.is_a?(Module)
    next if seen[value.object_id]

    seen[value.object_id] = true
    begin
      snap[value] = [value.instance_variables,
        value.class_variables(false), value.constants(false)]
    rescue Exception
      next
    end
    value.constants(false).each do |child|
      queue << [value, child.to_s]
    end
  end
  snap
end

.native_extensions(before, root, known) ⇒ Object

Compiled extensions the require pulled in, with the one fact that decides their Ractor behavior: whether the file imports rb_ext_ractor_safe. Ruby's own extensions (archdir) are flagged so the prober can leave them to Ruby, and files the static check already covers are flagged as known.



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/audition/dynamic/harness.rb', line 353

def native_extensions(before, root, known)
  root = realpath(root)
  known = Array(known).map { |path| realpath(path) }
  archdir = RbConfig::CONFIG["archdir"] + File::SEPARATOR
  loaded = $LOADED_FEATURES - before # audition:disable global-variables
  loaded.grep(NATIVE).map do |path|
    {"path" => path,
     "declares" => declares?(path),
     "ruby" => path.start_with?(archdir),
     "known" => known.include?(path),
     "own" => known.include?(path) || own_path?(path, root)}
  end
end

.origin_for(owner, name, root, known = []) ⇒ Object

Where was this constant defined, and does that location belong to the audited target (as opposed to a dependency it loaded)? Unknown locations (core) count as own so nothing gets silently downgraded, and so does the target's own compiled extension, which RubyGems installs outside the gem's root.



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/audition/dynamic/harness.rb', line 310

def origin_for(owner, name, root, known = [])
  path, line = begin
    owner.const_source_location(name)
  rescue Exception
    nil
  end
  # The separator matters: /x/app must not claim /x/app-helpers.
  own = root.nil? || path.nil? || path == root ||
    own_compiled?(path, root, known) ||
    (path.start_with?(root + File::SEPARATOR) &&
      !excluded?(path, root))
  {"path" => path, "line" => line, "own" => own}
end

.own_compiled?(path, root, known) ⇒ Boolean

A compiled file the target listed, or the copy of it RubyGems built into its extensions directory, which sits outside the gem's root under a directory named after the gem (extensions///stringio-3.2.0/stringio.bundle).

Returns:

  • (Boolean) 


328
329
330
331
332
333
 
# File 'lib/audition/dynamic/harness.rb', line 328

def own_compiled?(path, root, known)
  return true if known.include?(path) || known.include?(realpath(path))
  return false unless path.match?(NATIVE) && root

  path.include?(File::SEPARATOR + File.basename(root) + File::SEPARATOR)
end

.own_path?(path, root) ⇒ Boolean

Returns:

  • (Boolean) 


373
374
375
376
377
378
 
# File 'lib/audition/dynamic/harness.rb', line 373

def own_path?(path, root)
  return false unless root

  path == root ||
    (path.start_with?(root + File::SEPARATOR) && !excluded?(path, root))
end

.plain_value(value) ⇒ Object

Only primitives cross the pipe; anything else is described.



135
136
137
138
139
140
 
# File 'lib/audition/dynamic/harness.rb', line 135

def plain_value(value)
  case value
  when Numeric, String, Symbol, true, false, nil then value
  else value.inspect[0, 200]
  end
end

.rack(payload) ⇒ Object

App objects built in config.ru are almost never shareable (the file is instance_eval'd inside Rack::Builder, so every lambda's self is the Builder). Ractor web servers therefore boot the app once per Ractor; the probe mirrors that model: parse config.ru and serve one request entirely inside a Ractor.



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/audition/dynamic/harness.rb', line 566

def rack(payload)
  config_ru = payload.fetch("config_ru")
  root = payload["root"] || File.dirname(config_ru)
  bundler_setup
  begin
    require "rack" # audition:disable runtime-require
  rescue LoadError
    return {"rack_available" => false}
  end

  out = {"rack_available" => true}
  baseline = module_state_snapshot
  before = Object.constants
  features = $LOADED_FEATURES.dup # audition:disable global-variables
  begin
    app = Rack::Builder.parse_file(config_ru)
    app = app.first if app.is_a?(Array)
    out["app_class"] = app.class.name
    out["shareable"] = Ractor.shareable?(app)
  rescue Exception => e
    out["main_boot_error"] = describe_error(e)
  end
  # The main-process boot defines the app's constant graph;
  # sweeping it gives rack targets the same backstop as require
  # and rails targets. A failed boot still sweeps what loaded.
  limit = payload["max_constants"]
  known = known_paths(payload["known_compiled"])
  out.merge!(merge_reopened(
    scan(top_level(before), root: root, limit: limit, known: known),
    baseline, root: root, limit: limit, known: known
  ))
  out["native_extensions"] = native_extensions(
    features, root, payload["known_compiled"]
  )

  out["ractor_boot_call"] = rack_in_ractor(config_ru)
  if out["ractor_boot_call"]["ok"]
    out["concurrency"] = rack_concurrent(
      config_ru,
      payload.fetch("ractors", 4),
      payload.fetch("requests", 25)
    )
  end
  out
end

.rack_concurrent(config_ru, workers, requests) ⇒ Object

Real failures (races on shared state, require-proxy serialization) only show up under load: boot the app in N Ractors and serve M requests from each.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/audition/dynamic/harness.rb', line 615

def rack_concurrent(config_ru, workers, requests)
  ractors = workers.times.map do
    Ractor.new(config_ru, requests) do |path, n|
      require "rack" # audition:disable runtime-require
      require "stringio" # audition:disable runtime-require
      builder = Rack::Builder.new
      builder.instance_eval(File.read(path), path, 1)
      app = builder.to_app
      statuses = Hash.new(0)
      n.times do
        statuses[app.call(AuditionHarness.base_env).first] += 1
      end
      statuses
    end
  end
  results = ractors.map do |ractor|
    {"ok" => true, "statuses" => ractor.value}
  rescue Exception => e
    {"ok" => false, "error" => describe_error(e)}
  end

  merged = Hash.new(0)
  results.each do |result|
    next unless result["ok"]

    result["statuses"].each { |code, n| merged[code.to_s] += n }
  end
  {"workers" => workers,
   "requests_per_worker" => requests,
   "failures" => results.count { |r| !r["ok"] },
   "first_error" => results.find { |r| !r["ok"] }&.dig("error"),
   "statuses" => merged}
end

.rack_in_ractor(config_ru) ⇒ Object

Rack::Builder.parse_file cannot run inside a Ractor at all on rack 3.2 (Rack::BUILDER_TOPLEVEL_BINDING holds an unshareable Binding), so the per-Ractor boot rebuilds the app by instance_eval'ing config.ru into a fresh Builder; same DSL, no poisoned constant.



668
669
670
671
672
673
674
675
676
677
 
# File 'lib/audition/dynamic/harness.rb', line 668

def rack_in_ractor(config_ru)
  in_ractor(config_ru) do |path|
    require "rack" # audition:disable runtime-require
    require "stringio" # audition:disable runtime-require
    builder = Rack::Builder.new
    builder.instance_eval(File.read(path), path, 1)
    app = builder.to_app
    app.call(AuditionHarness.base_env).first
  end
end

.ractorize_application ⇒ Object

Rails 8.2 adds Application#ractorize!, which deep-freezes the application graph. One GET / on the main Ractor afterwards surfaces lazy memoization on now-frozen objects (FrozenError), and one inside a Ractor surfaces state a worker cannot reach.



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/audition/dynamic/harness.rb', line 813

def ractorize_application
  app = Rails.application
  version = Rails.respond_to?(:version) ? Rails.version.to_s : nil
  result = {"rails" => version}
  return result.merge("available" => false) unless
    app.respond_to?(:ractorize!)

  result["available"] = true
  begin
    app.ractorize!
  rescue Exception => e
    return result.merge("ok" => false, "error" => describe_error(e))
  end
  result["ok"] = true
  result["main_request"] = main_request(app)
  if result["main_request"]["ok"]
    result["ractor_request"] = in_ractor do
      require "stringio" # audition:disable runtime-require
      Rails.application.call(AuditionHarness.base_env).first
    end
  end
  result
rescue Exception => e
  {"available" => true, "ok" => false, "error" => describe_error(e)}
end

.rails(payload) ⇒ Object

A boot failure does not abandon the sweep: everything defined before the failure is still scanned, so the probe reports what it could reach alongside the boot error.



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/audition/dynamic/harness.rb', line 697

def rails(payload)
  environment = payload.fetch("environment")
  root = payload["root"]
  bundler_setup
  # The post-freeze requests need it; loaded before the snapshot
  # so the sweep never attributes it to the target.
  require "stringio" # audition:disable runtime-require
  baseline = module_state_snapshot
  before = Object.constants
  features = $LOADED_FEATURES.dup # audition:disable global-variables
  started = Time.now
  boot_error = nil
  proc_warnings = []
  armed = arm_proc_gate(proc_warnings, preload: true)
  begin
    # Absolute requires keep the path as given; realpathing it
    # keeps own-vs-dependency attribution honest under symlinked
    # roots (macOS /var).
    require realpath(environment) # audition:disable runtime-require
    # Boot may have replaced the deprecation behavior, and an
    # app that only defines the shim during boot is armed here.
    arm_proc_gate(proc_warnings, preload: false) || armed
    begin
      Rails.application.eager_load!
    rescue Exception
      nil
    end
  rescue Exception => e
    boot_error = describe_error(e)
  end
  boot =
    if boot_error
      {"ok" => false, "error" => boot_error}
    else
      {"ok" => true, "seconds" => (Time.now - started).round(1)}
    end
  # Freezing first lets the sweep see warmed state as shareable.
  ractorize = boot_error ? nil : ractorize_application
  limit = payload["max_constants"]
  known = known_paths(payload["known_compiled"])
  merge_reopened(
    scan(top_level(before), root: root, limit: limit, known: known),
    baseline, root: root, limit: limit, known: known
  ).merge(
    "boot" => boot,
    "ractorize" => ractorize,
    "unshareable_procs" => unshareable_procs(proc_warnings, root),
    "native_extensions" => native_extensions(
      features, root, payload["known_compiled"]
    )
  )
rescue Exception => e
  {"boot" => {"ok" => false, "error" => describe_error(e)}}
end

.realpath(path) ⇒ Object 



380
381
382
383
384
385
386
 
# File 'lib/audition/dynamic/harness.rb', line 380

def realpath(path)
  return path if path.nil?

  File.realpath(path)
rescue SystemCallError
  path
end

.require_target(feature, load_paths) ⇒ Object

Gem names and entry files diverge in two conventional ways: dashed names ship slashed files (rspec-mocks provides rspec/mocks), and squashed names ship snake_case files (activesupport provides active_support). The second has no rule to invert, so when the target ships exactly one top-level file on its load paths, that file is the entry, required by absolute path. An absolute require keeps the path as given, and scan compares constant origins against the realpathed root, so the candidate is built from the realpath too (a symlinked tmpdir, macOS /var, otherwise turns own findings into dependency ones). The error reported is the last one seen: a candidate that loads but fails inside says more than "cannot load such file".



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/audition/dynamic/harness.rb', line 207

def require_target(feature, load_paths)
  require feature # audition:disable runtime-require
rescue LoadError => error
  entry_candidates(feature, load_paths).each do |candidate|
    return require candidate # audition:disable runtime-require
  rescue LoadError => e
    error = e
  end
  raise error
end

.safe_shareable?(value) ⇒ Boolean

Returns:

  • (Boolean) 


412
413
414
415
416
 
# File 'lib/audition/dynamic/harness.rb', line 412

def safe_shareable?(value)
  Ractor.shareable?(value)
rescue Exception
  false
end

.scan(roots, root: nil, limit: nil, known: []) ⇒ Object

Breadth-first walk of every constant the require introduced: plain values get a Ractor.shareable? verdict; classes and modules are inspected for class-level ivars and class variables, then descended into. const_get can raise (autoload failures) and anything can lie; every step is rescued and counted.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/audition/dynamic/harness.rb', line 234

def scan(roots, root: nil, limit: nil, known: [])
  # Loaded features are realpathed by require; the target root
  # must be too, or symlinked paths (macOS /var vs /private/var)
  # break the own-vs-dependency comparison.
  root = realpath(root)
  limit = (limit || MAX_CONSTS).to_i
  unshareable = []
  proven = []
  class_state = []
  class_vars = []
  errors = 0
  truncated = false
  seen = {}
  queue = roots.map { |owner, name| [owner, name.to_s] }
  visited = 0

  until queue.empty?
    if visited >= limit
      truncated = true
      break
    end
    owner, name = queue.shift
    visited += 1

    begin
      value = owner.const_get(name, false)
    rescue Exception
      errors += 1
      next
    end
    full = owner.equal?(Object) ? name : "#{owner}::#{name}"
    origin = origin_for(owner, name, root, known)

    if value.is_a?(Module)
      next if seen[value.object_id]

      seen[value.object_id] = true
      errors += inspect_module(full, value, origin,
        class_state, class_vars)
      value.constants(false).each do |child|
        queue << [value, child.to_s]
      end
    else
      begin
        if Ractor.shareable?(value)
          # Proof the static pass can retire its guesses with.
          proven << [origin["path"], origin["line"]] if origin["path"]
        else
          blocker, blocker_depth = blocker_for(value)
          unshareable << origin.merge(
            "const" => full, "class" => value.class.name,
            "blocker" => blocker,
            "blocker_nested" => blocker_depth.positive?
          )
        end
      rescue Exception
        errors += 1
      end
    end
  end

  {"unshareable_constants" => unshareable,
   "proven_constants" => proven,
   "class_state" => class_state,
   "class_variables" => class_vars,
   "scanned" => visited,
   "truncated" => truncated,
   "limit" => limit,
   "errors" => errors}
end

.script_main(path) ⇒ Object

-- scripts -----------------------------------------------------



144
145
146
147
148
149
 
# File 'lib/audition/dynamic/harness.rb', line 144

def script_main(path)
  load path # audition:disable runtime-require
  {"ok" => true}
rescue Exception => e
  {"ok" => false, "error" => describe_error(e)}
end

.script_ractor(path) ⇒ Object

load is not proxied to the main Ractor (unlike require on Ruby 4.0), so the script body truly executes inside the Ractor.



153
154
155
156
157
158
 
# File 'lib/audition/dynamic/harness.rb', line 153

def script_ractor(path)
  in_ractor(path) do |p|
    load p # audition:disable runtime-require
    :ok
  end
end

.scrub(text) ⇒ Object 



113
114
115
116
117
 
# File 'lib/audition/dynamic/harness.rb', line 113

def scrub(text)
  text.dup.force_encoding(Encoding::UTF_8).scrub
rescue Exception
  "(unprintable)"
end

.top_level(before) ⇒ Object

The top-level constants a load introduced, as scan roots.



185
186
187
 
# File 'lib/audition/dynamic/harness.rb', line 185

def top_level(before)
  (Object.constants - before).map { |name| [Object, name.to_s] }
end

.unshareable_procs(warnings, root) ⇒ Object 



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/audition/dynamic/harness.rb', line 792

def unshareable_procs(warnings, root)
  warnings.filter_map do |message|
    next unless message.include?("Ractor shareable")

    match = message.match(PROC_SITE)
    path = match && match[1]
    path = File.expand_path(path, root) if path && root &&
      !path.start_with?("/")
    shown = match ? match[0] : message.lines.last.to_s.strip
    shown = shown.sub("#{root}/", "") if root
    {"proc" => shown,
     "path" => path,
     "line" => match && Integer(match[2], 10),
     "own" => path.nil? || own_path?(path, root)}
  end
end

.unwrap(error) ⇒ Object 



119
120
121
122
123
124
125
 
# File 'lib/audition/dynamic/harness.rb', line 119

def unwrap(error)
  if error.is_a?(Ractor::RemoteError) && error.cause
    error.cause
  else
    error
  end
end