chaotic_job 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a3e97903b960aad5ff163a8ea80d3d1c94d8427e86d0d06cb6c44ceffd7ad4
-  data.tar.gz: b4c2200a5436d1575f0f66d8647834514bd6563ac3fbf62a74014557d198ed90
+  metadata.gz: b82a52379f9efe41b3243e19904fa96e0cc8703bf813a42401b74128242ea6a2
+  data.tar.gz: b4979b0ba3ddec6e2c8ab680458853a7ffeda84e25af95e6858d16846f5d77b2
 SHA512:
-  metadata.gz: fa8f9e58bf1fa3eab4e4b6441e91824322e02043daea6fccb7f4d21844c739b34d376880ef03924fed43a7f7d49cf72fa536400698216ca58247cb287c49abd6
-  data.tar.gz: f8e83e868e13ed287f1ae9ff3b2560257b5c6fe1e6ba715bf400a93d2148c5a36d9372ac70aaadb5a498db198b3a0f0d9cd4bb3c00d138aa0ac4a8961c1e463a
+  metadata.gz: 0f38bed8995ac63a1755dcb316c3886dcf32cb5fb953aec4d3be8ce4b3b7690c76febacc458fc05ca2e30ef8b67947a4b639f7035e8cea7aac84d59bd1da37a3
+  data.tar.gz: 616f9d8543fa39d00e30f82bd20edb22ddae4578f4c0e9a7557135b599002f9dbdc29a64bba6c25471a76f489004556745e3708310789d6f716fe9c879ccd2ff

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.1] - 2024-11-06
+
+- Update `Journal` interface
+- Add top-level `ChaoticJob` methods to work with the journal
+- Fix bug with job sorting in the `Performer`
+- Fix bug with resolving time cutoffs in the `Performer`
+- Fix bug with using the `run_scenario` helper with a block
+
 ## [0.1.0] - 2024-11-06
 
 - Added `Journal` to log activity for tests

data/README.md

@@ -115,10 +115,10 @@ end
 > |---|---|
 > | `Journal.log` | log simply that something happened within the default scope |
 > | `Journal.log(thing, scope: :special)` | log a particular value within a particular scope |
-> | `Journal.total` | get the total number of logs under the default scope |
-> | `Journal.total(scope: :special)` | get the total number of logs under a particular scope |
-> | `Journal.all` | get all of the logged values under the default scope |
-> | `Journal.all(scope: :special)` | get all of the logged values under a particular scope |
+> | `Journal.size` | get the total number of logs under the default scope |
+> | `Journal.size(scope: :special)` | get the total number of logs under a particular scope |
+> | `Journal.entries` | get all of the logged values under the default scope |
+> | `Journal.entries(scope: :special)` | get all of the logged values under a particular scope |
 
 In this example, the job being tested is defined within the test case. You can, of course, also test jobs defined in your application. The key detail is the `glitch` keyword argument. A "glitch" is simply a tuple that describes precisely where you would like the failure to occur. The first element of the tuple is the location of the glitch, which can be either *before* or *after*. The second element is the location of the code that will be affected by the glitch, defined by its file path and line number. What this example scenario does is inject a glitch before the `step_3` method is called, here:
 

data/lib/chaotic_job/journal.rb

@@ -20,12 +20,16 @@ module ChaoticJob
       @logs[scope] << item
     end
 
-    def total(scope: :default)
+    def size(scope: :default)
       @logs[scope]&.size || 0
     end
 
-    def all(scope: :default)
+    def entries(scope: :default)
       @logs[scope]
     end
+
+    def top(scope: :default)
+      entries&.first
+    end
   end
 end

data/lib/chaotic_job/performer.rb

@@ -40,7 +40,17 @@ module ChaoticJob
 
     def enqueued_jobs_where(before: nil, after: nil)
       enqueued_jobs
-        .sort_by { |job| job["scheduled_at"] }
+        .sort do |ljob, rjob|
+          lat = ljob[:at]
+          rat = rjob[:at]
+
+          # sort by scheduled time, with nil values first
+          if lat && rat
+            lat <=> rat
+          else
+            lat ? 1 : -1
+          end
+        end
         .select do |job|
           scheduled_at = job[:at]
 
@@ -67,7 +77,7 @@ module ChaoticJob
       in Time
         cutoff
       end
-      delta = (Time.now - time).abs
+      delta = (Time.now - time).abs.floor
       changeset = case delta
       when 0..59                    # seconds
         {usec: 0}

data/lib/chaotic_job/scenario.rb

@@ -16,15 +16,15 @@ module ChaoticJob
       @events = []
     end
 
-    def run
+    def run(&block)
       @job.class.retry_on RetryableError, attempts: 10, wait: 1, jitter: 0
 
       ActiveSupport::Notifications.subscribed(->(event) { @events << event.dup }, @capture) do
         glitch.inject! do
-          if block_given?
-            yield
+          @job.enqueue
+          if block
+            block.call
           else
-            @job.enqueue
             Performer.perform_all
           end
         end

data/lib/chaotic_job/version.rb

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

data/lib/chaotic_job.rb

@@ -11,6 +11,34 @@ module ChaoticJob
   class RetryableError < StandardError
   end
 
+  def self.log_to_journal!(item = nil, scope: nil)
+    if item && scope
+      Journal.log(item, scope: scope)
+    elsif item
+      Journal.log(item)
+    elsif scope
+      Journal.log(scope: scope)
+    else
+      Journal.log
+    end
+  end
+
+  def self.journal_size(scope: nil)
+    if scope
+      Journal.size(scope: scope)
+    else
+      Journal.size
+    end
+  end
+
+  def self.top_journal_entry(scope: nil)
+    if scope
+      Journal.top(scope: scope)
+    else
+      Journal.top
+    end
+  end
+
   module Helpers
     def perform_all
       Performer.perform_all
@@ -36,11 +64,15 @@ module ChaoticJob
       Simulation.new(job, **kwargs).run(&block)
     end
 
-    def run_scenario(job, glitch: nil, glitches: nil, raise: nil, capture: nil)
+    def run_scenario(job, glitch: nil, glitches: nil, raise: nil, capture: nil, &block)
       kwargs = {glitches: glitches || [glitch]}
       kwargs[:raise] = raise if raise
       kwargs[:capture] = capture if capture
-      Scenario.new(job, **kwargs).run
+      if block
+        Scenario.new(job, **kwargs).run(&block)
+      else
+        Scenario.new(job, **kwargs).run
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chaotic_job
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stephen Margheim