chaotic_job 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 970f6e59807e48fc6bc71581fe2a12cd0c890429879b079dc8205f73aa74f2d5
+  data.tar.gz: 3378067f6be89a0f2a715ea60a18ada92af2d430d555d96756c6d3024802b5be
+SHA512:
+  metadata.gz: 37a614599cc3b971ec6fb93b19d145be3cce82198bd631c945d996c1f1b30f0d0ac0f0bf643649548d780ffeecbb1a237fb5a5051043c394e087c7cbd04f94f8
+  data.tar.gz: 042ae03b7c80a1fc4570fb0617645f1d3801e331fa73dbd80b8a6bc11529136db4f99d8313bc2f7efb7f5808c66c792a419d8197d81734622cc174bf83bfe76c

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stephen Margheim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# 👾 Chaotic Job
+
+[![Gem Version](https://badge.fury.io/rb/chaotic_job.svg)](https://rubygems.org/gems/chaotic_job)
+[![Gem Downloads](https://img.shields.io/gem/dt/chaotic_job)](https://rubygems.org/gems/chaotic_job)
+![Tests](https://github.com/fractaledmind/chaotic_job/actions/workflows/main.yml/badge.svg)
+![Coverage](https://img.shields.io/badge/code%20coverage-98%25-success)
+[![Sponsors](https://img.shields.io/github/sponsors/fractaledmind?color=eb4aaa&logo=GitHub%20Sponsors)](https://github.com/sponsors/fractaledmind)
+[![Twitter Follow](https://img.shields.io/twitter/url?label=%40fractaledmind&style=social&url=https%3A%2F%2Ftwitter.com%2Ffractaledmind)](https://twitter.com/fractaledmind)
+
+## Installation
+
+TODO: Replace `chaotic_job` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add chaotic_job
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install chaotic_job
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chaotic_job. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chaotic_job/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ChaoticJob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chaotic_job/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/chaotic_job/glitch.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Glitch.new.before("job_crucible.rb:10") { do_anything }
+# Glitch.new.after("job_crucible.rb:11") { do_anything }
+# Glitch.new.inject! { execute code to glitch }
+
+module ChaoticJob
+  class Glitch
+    def initialize
+      @breakpoints = {}
+      @file_contents = {}
+    end
+
+    def before(path_with_line, &block)
+      set_breakpoint(path_with_line, :before, &block)
+    end
+
+    def after(path_with_line, &block)
+      set_breakpoint(path_with_line, :after, &block)
+    end
+
+    def inject!
+      prev_key = nil
+      trace = TracePoint.new(:line) do |tp|
+        key = "#{tp.path}:#{tp.lineno}"
+        # content = @file_contents[tp.path]
+        # line = content[tp.lineno - 1]
+        # next unless line.match? key
+
+        begin
+          execute_block(@breakpoints[prev_key][:after]) if prev_key && @breakpoints.key?(prev_key)
+
+          execute_block(@breakpoints[key][:before]) if @breakpoints.key?(key)
+        ensure
+          prev_key = key
+        end
+      end
+
+      trace.enable
+      yield if block_given?
+    ensure
+      trace.disable
+      execute_block(@breakpoints[prev_key][:after]) if prev_key && @breakpoints.key?(prev_key)
+    end
+
+    def all_executed?
+      @breakpoints.all? do |_location, handlers|
+        handlers.all? { |_position, handler| handler[:executed] }
+      end
+    end
+
+    # def inspect
+    #   @breakpoints.flat_map do |location, configs|
+    #     configs.keys.map { |position| "#{position}-#{location}" }
+    #   end.join("|>")
+    # end
+
+    private
+
+    def set_breakpoint(path_with_line, position, &block)
+      @breakpoints[path_with_line] ||= {}
+      # contents = File.read(file_path).split("\n") unless @file_contents.key?(path_with_line)
+      # @file_contents << contents
+      @breakpoints[path_with_line][position] = { block: block, executed: false }
+    end
+
+    def execute_block(handler)
+      return unless handler
+      return if handler[:executed]
+
+      handler[:executed] = true
+      handler[:block].call
+    end
+  end
+end

data/lib/chaotic_job/journal.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Journal.log
+# Journal.log(thing, scope: :special)
+# Journal.total
+# Journal.total(scope: :special)
+# Journal.all
+
+module ChaoticJob
+  module Journal
+    extend self
+
+    def reset!
+      @logs = {}
+    end
+
+    def log(item = 1, scope: :default)
+      @logs ||= {}
+      @logs[scope] ||= []
+      @logs[scope] << item
+    end
+
+    def total(scope: :default)
+      @logs[scope]&.size || 0
+    end
+
+    def all(scope: :default)
+      @logs[scope]
+    end
+  end
+end

data/lib/chaotic_job/performer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Performer.new(Job1).perform_all
+# Performer.new(Job1).perform_all_within(time)
+# Performer.new(Job1).perform_all_after(time)
+
+module ChaoticJob
+  class Performer
+    include ActiveJob::TestHelper
+
+    def initialize(job, retry_window: 4)
+      @job = job
+      @retry_window = retry_window
+    end
+
+    def perform_all
+      @job.enqueue
+      enqueued_jobs_with.sort_by(&:scheduled_at, nil: :first).each do |job|
+        perform_job(job)
+      end
+    end
+
+    def perform_all_after(2.seconds.from_now)
+    end
+
+    def perform_all_within(time)
+    end
+
+    private
+
+    def perform_enqueued_jobs_only_with_retries
+      retry_window = Time.now + @retry_window
+      flush_enqueued_jobs(at: retry_window) until enqueued_jobs_with(at: retry_window).empty?
+    end
+
+    def perform_any_enqueued_jobs_including_future_scheduled_ones
+      flush_enqueued_jobs until enqueued_jobs_with.empty?
+    end
+  end
+end

data/lib/chaotic_job/scenario.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Scenario.new(job).run { |scenario| ... }
+# Scenario.new(job).all_glitched?
+
+module ChaoticJob
+  class Scenario
+    attr_reader :events
+
+    def initialize(job, glitches:, raise: RetryableError, capture: /active_job/)
+      @job = job
+      @glitches = glitches
+      @raise = raise
+      @capture = capture
+      @glitch = nil
+      @events = []
+    end
+
+    def run
+      @job.class.retry_on RetryableError, attempts: 10, wait: 1, jitter: 0
+
+      ActiveSupport::Notifications.subscribed(->(event) { @events << event.dup }, @capture) do
+        glitch.inject! do
+          block_given? ? yield : Performance.rehearse(@job)
+        end
+      end
+
+      # TODO: assert that all glitches ran
+    end
+
+    def to_s
+      @glitches.map { |position, location| "#{position}-#{location}" }.join("|>")
+    end
+
+    def all_glitched?
+      @glitch.all_executed?
+    end
+
+    private
+
+    def glitch
+      @glitch ||= Glitch.new.tap do |glitch|
+        @glitches.each do |position, location, _description|
+          glitch.public_send(position, location) { raise @raise }
+        end
+      end
+    end
+  end
+end

data/lib/chaotic_job/simulation.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Simulation.new(job).run { |scenario| ... }
+# Simulation.new(job).permutations
+# Simulation.new(job).variants
+# Simulation.new(job).scenarios
+module ChaoticJob
+  class Simulation
+    def initialize(job, test: nil, variations: 100, seed: nil, depth: 3)
+      @template = job
+      @test = test
+      @variations = variations
+      @seed = seed || Random.new_seed
+      @random = Random.new(@seed)
+      @depth = depth
+    end
+
+    def run(&callback)
+      @template.class.retry_on RetryableError, attempts: @depth + 2, wait: 1, jitter: 0
+
+      debug "Running #{variants.size} simulations of the total #{permutations.size} possibilities..."
+
+      scenarios.map do |scenario|
+        run_scenario(scenario, &callback)
+      end
+    end
+
+    def permutations
+      callstack = capture_callstack.to_a
+      error_locations = callstack.each_cons(2).flat_map do |left, right|
+        lpath, lno = left
+        rpath, rno = right
+        key = "#{lpath}:#{lno}"
+        # inject an error before and after each non-adjacent line
+        if lpath == rpath && rno == lno + 1
+          [[:before, key]]
+        else
+          [[:before, key], [:after, key]]
+        end
+      end
+      final_key = callstack.last.join(":")
+      error_locations.push [:before, final_key], [:after, final_key]
+      error_locations.permutation(@depth)
+    end
+
+    def variants
+      return permutations if @variations.nil?
+
+      permutations.to_a.sample(@variations, random: @random)
+    end
+
+    def scenarios
+      variants.map do |glitches|
+        job = clone_job_template
+        scenario = Scenario.new(job, glitches: glitches)
+        job.job_id = scenario.to_s
+        scenario
+      end
+    end
+
+    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
+
+      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
+    end
+
+    def run_scenario(scenario, &callback)
+      debug "Running simulation with scenario: #{scenario}"
+      @test.before_setup
+      scenario.enact!
+      @test.after_teardown
+      callback.call(scenario)
+    end
+
+    def clone_job_template
+      serialized_template = @template.serialize
+      job = ActiveJob::Base.deserialize(serialized_template)
+      job.exception_executions = {}
+      job
+    end
+
+    def debug(...)
+      @template.logger.debug(...)
+    end
+  end
+end

data/lib/chaotic_job/version.rb

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

data/lib/chaotic_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "chaotic_job/version"
+
+module ChaoticJob
+  class RetryableError < StandardError; end
+
+  module Helpers
+    def run_simulation(job, ..., &block)
+      Simulation.new(job, test: self, ...).run(&block)
+    end
+
+    def run_scenario(job)
+      Scenario.new(job).run
+    end
+  end
+end

data/sig/chaotic_job.rbs

@@ -0,0 +1,4 @@
+module ChaoticJob
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: chaotic_job
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Margheim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- stephen.margheim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chaotic_job.rb
+- lib/chaotic_job/glitch.rb
+- lib/chaotic_job/journal.rb
+- lib/chaotic_job/performer.rb
+- lib/chaotic_job/scenario.rb
+- lib/chaotic_job/simulation.rb
+- lib/chaotic_job/version.rb
+- sig/chaotic_job.rbs
+homepage: https://github.com/fractaledmind/chaotic_job
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fractaledmind/chaotic_job
+  source_code_uri: https://github.com/fractaledmind/chaotic_job
+  changelog_uri: https://github.com/fractaledmind/chaotic_job/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: Test ActiveJobs for reliability and resilience.
+test_files: []