aeternitas 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c1d90d4cf7395ae79d96e09c0e3ba2ff163d96a31c3283eef8ec516ca2e2645
-  data.tar.gz: 1a245a59727f923ce5e1054e7c043c684f7d14e9b37f4ec65265b30843ff41b1
+  metadata.gz: 072e9c223b68767bac14dab82e9f490910d67b38d472eb539a62e63989599437
+  data.tar.gz: d4d1314d44369bf830804018da841cdafc79365eb9da057e9a3b2ad1771297d4
 SHA512:
-  metadata.gz: 8764240e6d8e929f4ed351886daf38df7a3d76bb09b41631ee344be52cb8322b600eec8750aeb20b2cb3f3397c819b3b3fdf930dc47641aca9bc57a97597bc80
-  data.tar.gz: fd450bbf6f00ea6341987974741809fcf0a78c6ef7909ac29af9aeae8c87a603e5d36824748bef7f2cce01d9658b14f8d3222aa8d41a3fb5b2f8b70313c9e4bd
+  metadata.gz: 44ff2e37d3138379473d31728f4b0ecbe1918d7573c350cbf5b0413901d0473b586c33b8b57d40191d880fe9d34b3f2fa0b819950f08bff7f8e2bb96d3b6ad1d
+  data.tar.gz: f71e7d7baad36c2dc46894b60f2846025a9f5ca39e301de7e6a5f4a7e2554e30c08e4bab7948b53b5b8faf745bdb89f8002a73e8283affd283a97d5608b913e6

data/CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [2.0.0] - Unreleased
+## [2.0.0] - 2025-08-11
 
 This is a major rewrite of Æternitas with the primary goals of removing the Redis and Sidekiq dependencies and simplifying the core functionality.
 
@@ -24,6 +24,7 @@ This is a major rewrite of Æternitas with the primary goals of removing the Red
 - Thundering Herd Prevention: The `PollJob` now intelligently staggers retries when a `GuardIsLocked` error occurs, preventing many jobs from retrying simultaneously and overwhelming a resource.
 - Configurable Metrics: Added `Aeternitas.config.metrics_enabled` and `Aeternitas.config.metric_retention_period` to give users control over metrics collection and data retention.
 - Built-in Maintenance Jobs: Added `Aeternitas::CleanupStaleLocksJob` and `Aeternitas::CleanupOldMetricsJob` to provide a clear, easy way to schedule necessary database cleanup.
+- Test Mode: Added `Aeternitas::Test.test_mode`, which sets all cooldowns, retry delays, and sleep durations to zero to simplify writing tests.
 
 ### Removed
 - Removed direct gem dependencies on `sidekiq`, `sidekiq-unique-jobs`, `redis`, `connection_pool`, and `tabstabs`.

data/README.md

@@ -220,6 +220,20 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Testing
+
+Æternitas provides a test mode to help write tests. When enabled, all cooldowns, retry delays, and sleep durations are set to zero. This prevents your test suite from having to wait for scheduled delays.
+
+To enable test mode for a specific block of code, use the `Aeternitas::Test.test_mode` helper:
+
+```ruby
+Aeternitas::Test.test_mode do
+  # ...
+end
+```
+
+This ensures that test mode is enabled only for the duration of the block and is automatically disabled afterward.
+
 ## Contributing
 
 Bug reports and spec backed pull requests are welcome on GitHub at https://github.com/Dietech-Group/aeternitas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/aeternitas/guard.rb

@@ -35,7 +35,7 @@ module Aeternitas
     # @return [Aeternitas::Guard] Creates a new Instance
     def initialize(id, cooldown, timeout = 10.minutes)
       @id = id
-      @cooldown = cooldown
+      @cooldown = Aeternitas.test_mode? ? 0.seconds : cooldown
       @timeout = timeout
       @token = SecureRandom.hex(10)
     end
@@ -134,6 +134,7 @@ module Aeternitas
     # @param [Time] sleep_timeout for how long will the guard sleep
     # @param [String] msg hint why the guard sleeps
     def sleep(sleep_timeout, msg = nil)
+      sleep_timeout = Time.now if Aeternitas.test_mode?
       Aeternitas::GuardLock.transaction do
         lock = Aeternitas::GuardLock.where(lock_key: @id).lock.first_or_initialize
 

data/lib/aeternitas/poll_job.rb

@@ -56,9 +56,10 @@ module Aeternitas
       meta_data.enqueue!
 
       if pollable_config.sleep_on_guard_locked
-        if base_delay > 0
+        delay = Aeternitas.test_mode? ? 0 : base_delay
+        if delay > 0
           ActiveJob::Base.logger.warn "[Aeternitas::PollJob] Guard locked for #{arguments.first}. Sleep for #{base_delay.round(2)}s."
-          sleep(base_delay)
+          sleep(delay)
         end
         retry_job
       else
@@ -78,17 +79,20 @@ module Aeternitas
         jitter = rand(0.0..2.0)
         total_wait = base_delay + stagger_delay + jitter
 
-        if total_wait > 0
-          retry_job(wait: total_wait.seconds)
+        if total_wait > 0 || Aeternitas.test_mode?
+          wait_time = Aeternitas.test_mode? ? 0.seconds : total_wait.seconds
+          retry_job(wait: wait_time)
           ActiveJob::Base.logger.info "[Aeternitas::PollJob] Guard locked for #{arguments.first}. Retry in #{total_wait.round(2)}s."
         else
           # GuardLock expired, retry with minimal delay
-          retry_job(wait: jitter.seconds)
+          wait_time = Aeternitas.test_mode? ? 0.seconds : jitter.seconds
+          retry_job(wait: wait_time)
         end
       end
     end
 
     def self.execution_wait_time(executions)
+      return 0.seconds if Aeternitas.test_mode?
       wait_index = executions - 1
       RETRY_DELAYS[wait_index] || RETRY_DELAYS.last
     end

data/lib/aeternitas/test.rb

@@ -0,0 +1,13 @@
+module Aeternitas
+  # Provides test helpers for aeternitas
+  module Test
+    # Executes a block of code in test mode; all cooldowns and wait times are set to 0.
+    def self.test_mode
+      original_mode = Aeternitas.test_mode?
+      Aeternitas.test_mode = true
+      yield
+    ensure
+      Aeternitas.test_mode = original_mode
+    end
+  end
+end

data/lib/aeternitas/version.rb

@@ -1,3 +1,3 @@
 module Aeternitas
-  VERSION = "2.0.0.rc1"
+  VERSION = "2.0.0"
 end

data/lib/aeternitas.rb

@@ -17,6 +17,7 @@ require "aeternitas/aeternitas_job"
 require "aeternitas/poll_job"
 require "aeternitas/cleanup_stale_locks_job"
 require "aeternitas/cleanup_old_metrics_job"
+require "aeternitas/test"
 
 # Aeternitas
 module Aeternitas
@@ -33,6 +34,18 @@ module Aeternitas
     yield(config)
   end
 
+  # Returns true if aeternitas is in test mode.
+  # @return [Boolean]
+  def self.test_mode?
+    @test_mode == true
+  end
+
+  # Sets the test mode.
+  # @param [Boolean] value
+  def self.test_mode=(value)
+    @test_mode = value
+  end
+
   # Enqueues all active pollables for which next polling is lower than the current time
   def self.enqueue_due_pollables
     Aeternitas::PollableMetaData.due.find_each do |pollable_meta_data|

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: aeternitas
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Michael Prilop
 - Max Kießling
 - Louis Franzke
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -177,6 +178,7 @@ files:
 - lib/aeternitas/source.rb
 - lib/aeternitas/storage_adapter.rb
 - lib/aeternitas/storage_adapter/file.rb
+- lib/aeternitas/test.rb
 - lib/aeternitas/unique_job_lock.rb
 - lib/aeternitas/version.rb
 - lib/generators/aeternitas/install_generator.rb
@@ -186,6 +188,7 @@ homepage: https://github.com/Dietech-Group/aeternitas
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,7 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: æternitas - version 2
 test_files: []