chaotic_job 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b01482666de5069e40dbe4eeb828cb527e4dd31004b3900a134ceaec5cb42a
-  data.tar.gz: f3df1be0fa3192aa842b74fa56754e56ed071f48d3c2fd027ca88d05da3f5e90
+  metadata.gz: 0c4da24d7fc4aa39030976d4f7249a14c87995ef5d5b05c523ad5e1e83724f37
+  data.tar.gz: 0a7be90ecb5381a5c9e67c6673bb41bc3ad2997c904ca42bfedbb4c701ef6bf0
 SHA512:
-  metadata.gz: aff436f38402fddae8e62a7dbb441dc8949169abd1aa992fdf5e59f33e007f8dc3aba29787a3cea4bf3d421698ed1ac76c171388c26a3d2ab884e7880296ba84
-  data.tar.gz: 72986fa7274aade0e1fe7f9a5b71e4911467f18bf4929b90960ba62b03721611e46da8958c0536a92f92e98f4b4a2c7315e674db73bbcc6866cc177070a6f92f
+  metadata.gz: 11a054f050a3e95aa40c392e281b69bf2c43dbba3b91bce3d17473d589f4e2057d26a18af5071d7a5f4cb2b055775bbdd293af6c712792fbe1d042c4c99cca85
+  data.tar.gz: d6750f62adecc71334dd42cfb15e35e33fb36680be62a6c9d0d5f4e2ed29eb598f9f92fac6a09ec1a4636816789f13996bc0241faa5a1ef9eb4acac0577fc06f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-06-04
+
+- Add a Tracer class [#3](https://github.com/fractaledmind/chaotic_job/pull/3)
+
 ## [0.4.0] - 2025-05-27
 
 - Allow a Glitch to be defined for a method call or method return [#4](https://github.com/fractaledmind/chaotic_job/pull/4)

data/README.md

@@ -217,7 +217,24 @@ More specifically, it will create a scenario injecting a glitch before every lin
 
 It generates all possible glitch scenarios by performing your job once with a [`TracePoint`](https://docs.ruby-lang.org/en/master/TracePoint.html) that captures each line executed in your job. It then computes all possible glitch locations to produce a set of scenarios that will be run. The block that you pass to `run_simulation` will be called for each scenario, allowing you to make assertions about the behavior of your job under all scenarios.
 
-In your application tests, you will want to make assertions about the side-effects that your job performs, asserting that they are correctly idempotent (only occur once) and result in the correct state.
+If you want to have the simulation run against a larger collection of scenarios, you can capture a custom callstack using the `ChaoticJob::Tracer` class and pass it to the `run_simulation` method as the `callstack` parameter. A `Tracer` is initialized with a block that determines which `TracePoint` events to collect. You then call `capture` with a block that defines the code to be traced. The default `Simulation` tracer collects all events for the passed job and then traces the job execution, essentially like this:
+
+```ruby
+job_file_path = YourJob.instance_method(:perform).source_location&.first
+tracer = Tracer.new { |tp| tp.path == job_file_path || tp.defined_class == YourJob }
+tracer.capture { YourJob.perform_now }
+```
+
+To capture, for example, a custom callstack that includes all events within your application, you can use the `ChaoticJob::Tracer` class as follows:
+
+```ruby
+tracer = ChaoticJob::Tracer.new { |tp| tp.path.start_with?(Rails.root.to_s) }
+tracer.capture { YourJob.perform_now }
+```
+
+If you passed this callstack to your simulation, it would test what happens to your job whenever a transient glitch is injected anywhere in your application code called as a part of executing the job under test.
+
+Remember, in your application tests, you will want to make assertions about the side-effects that your job performs, asserting that they are correctly idempotent (only occur once) and result in the correct state.
 
 ## Development
 

data/lib/chaotic_job/simulation.rb

@@ -6,13 +6,16 @@
 # Simulation.new(job).scenarios
 module ChaoticJob
   class Simulation
-    def initialize(job, depth: 1, variations: 100, test: nil, seed: nil)
+    def initialize(job, callstack: nil, depth: 1, variations: 100, test: nil, seed: nil)
       @template = job
+      @callstack = callstack || capture_callstack
       @depth = depth
       @variations = variations
       @test = test
       @seed = seed || Random.new_seed
       @random = Random.new(@seed)
+
+      raise Error.new("callstack must be a generated via the ChaoticJob::Tracer") unless @callstack.is_a?(Stack)
     end
 
     def run(&callback)
@@ -27,9 +30,8 @@ module ChaoticJob
     end
 
     def permutations
-      callstack = capture_callstack.map { |path, line| "#{path}:#{line}" }
-      error_locations = callstack.map do |path, lineno|
-        [:before_line, "#{path}:#{lineno}"]
+      error_locations = @callstack.map do |event, key|
+        ["before_#{event}", key]
       end
       error_locations.permutation(@depth)
     end
@@ -52,23 +54,13 @@ module ChaoticJob
     private
 
     def capture_callstack
-      return @callstack if defined?(@callstack)
-
-      @callstack = Set.new
       job_class = @template.class
       job_file_path = job_class.instance_method(:perform).source_location&.first
+      tracer = Tracer.new { |tp| tp.path == job_file_path || tp.defined_class == job_class }
+      callstack = tracer.capture { @template.dup.perform_now }
 
-      trace = TracePoint.new(:line) do |tp|
-        next if tp.defined_class == self.class
-        next unless tp.path == job_file_path ||
-          tp.defined_class == job_class
-
-        @callstack << [tp.path, tp.lineno]
-      end
-
-      trace.enable { @template.dup.perform_now }
       @template.class.queue_adapter.enqueued_jobs = []
-      @callstack
+      callstack
     end
 
     def run_scenario(scenario, &callback)

data/lib/chaotic_job/tracer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Tracer.new { |tp| tp.path.start_with? "foo" }
+# Tracer.new.capture { code_execution_to_trace_callstack }
+
+module ChaoticJob
+  class Tracer
+    def initialize(&constraint)
+      @constraint = constraint
+      @callstack = Stack.new
+    end
+
+    def capture(&block)
+      trace = TracePoint.new(:line, :call, :return) do |tp|
+        # :nocov: SimpleCov cannot track code executed _within_ a TracePoint
+        next if tp.defined_class == self.class
+        next unless @constraint.call(tp)
+
+        case tp.event
+        when :line
+          key = line_key(tp)
+        when :call, :return
+          key = call_key(tp)
+        end
+
+        @callstack << [tp.event, key]
+        # :nocov:
+      end
+
+      trace.enable(&block)
+      @callstack
+    end
+
+    private
+
+    # :nocov: SimpleCov cannot track code executed _within_ a TracePoint
+    def line_key(event)
+      "#{event.path}:#{event.lineno}"
+    end
+
+    def call_key(event)
+      if Module === event.self
+        "#{event.self}.#{event.method_id}"
+      else
+        "#{event.defined_class}##{event.method_id}"
+      end
+    end
+    # :nocov:
+  end
+end

data/lib/chaotic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChaoticJob
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/chaotic_job.rb

@@ -3,13 +3,16 @@
 require_relative "chaotic_job/version"
 require_relative "chaotic_job/journal"
 require_relative "chaotic_job/performer"
+require_relative "chaotic_job/tracer"
 require_relative "chaotic_job/glitch"
 require_relative "chaotic_job/scenario"
 require_relative "chaotic_job/simulation"
+require "set"
 
 module ChaoticJob
-  class RetryableError < StandardError
-  end
+  Error = Class.new(StandardError)
+  RetryableError = Class.new(Error)
+  Stack = Set
 
   def self.log_to_journal!(item = nil, scope: nil)
     if item && scope
@@ -63,11 +66,12 @@ module ChaoticJob
       Performer.perform_all_after(time)
     end
 
-    def run_simulation(job, depth: nil, variations: nil, &block)
+    def run_simulation(job, depth: nil, variations: nil, callstack: nil, &block)
       seed = defined?(RSpec) ? RSpec.configuration.seed : Minitest.seed
       kwargs = {test: self, seed: seed}
       kwargs[:depth] = depth if depth
       kwargs[:variations] = variations if variations
+      kwargs[:callstack] = callstack if callstack
       self.simulation_scenario = nil
       Simulation.new(job, **kwargs).run(&block)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: chaotic_job
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stephen Margheim
 bindir: exe
 cert_chain: []
-date: 2025-05-27 00:00:00.000000000 Z
+date: 2025-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -41,6 +41,7 @@ files:
 - lib/chaotic_job/performer.rb
 - lib/chaotic_job/scenario.rb
 - lib/chaotic_job/simulation.rb
+- lib/chaotic_job/tracer.rb
 - lib/chaotic_job/version.rb
 - sig/chaotic_job.rbs
 homepage: https://github.com/fractaledmind/chaotic_job