belated 0.6.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0c28df2d6dffdff23e48d5fba469ca7a67378bebdf6538067f748ebc28d8a67
-  data.tar.gz: 1805135d97859dd9d399b3e46d636141b014e102630eefa1e7d0a9dc4a2a19bc
+  metadata.gz: 625adf33d85f1e94d4d7416db02a50e11fe66bfeb5fa265fa4de2c9b6f1c0750
+  data.tar.gz: 663fa5c0fcb7903b66324723a8cd19a771d596a88a396974d80060bf8c0bfd4a
 SHA512:
-  metadata.gz: '086a0dbc146fe3386a24bef59523aeca27dcb72506e83189f39553f63e20f867f6a094faab2ce07fdaadeb0f159bd740fde9bb8bc7f6bf8b2e4f04ea551f5e2e'
-  data.tar.gz: dea44b6d05c0eda6e5cb5d58c3b317c150d1d5b4399fcac55d80c8e044faecbfd1a21d6f96394950ab271e9db2eb346057c99de4cc02df4d25e8929f25487ff3
+  metadata.gz: e14413f88843ed9c80391987c5891f821ce0eb43e2759d5be034bb17a9cda78f4de7a67b97f44af933013dd4aef39e0d23d91df9ecfbbf3dbead38427a925450
+  data.tar.gz: aef2baada5a40a7da090e71e1c490d6f901e5178bd5be05001fb53c2863e9b03b86f9b997a53ced594d40aad8eb8700e25419b1378eba13b444b3b62f48d1b65

data/.github/workflows/main.yml

@@ -9,7 +9,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.6, 2.7, '3.0']
+        ruby: [2.7, '3.0']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.7] - 2021-09-04
+- ActiveJob support! Retries, exception rescuing should work as expected. 
+- Second Moderna jab took me out for a while... sorry for the long wait. 
 ## [0.6.7] - 2021-08-25
 
 - A bug fix for bad jobs bringing down client side. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.6.7)
+    belated (0.7.0)
       drb
       dry-configurable
       ruby2_keywords

data/README.md

@@ -17,7 +17,6 @@ Can be used if you're on a normal instance such as EC2 or Digital Ocean drop. No
 TODO LIST:
 
 - Use GDBM for queue storage? That way could maybe get rid of YAML dumping and make things a bit safer. Not ordered though, so maybe keep a list of the jobs as YAML and update it sometimes? Just as backup. Or RocksDB? Would need to be configurable if you don't have something installed.
-- Maybe support ActiveJob?
 - Have a web UI.
 - Have a job history
 - Do some performance testing.
@@ -48,7 +47,15 @@ Start up Belated!
 
     $ belated
 
-Then, in another program, connect to Belated and give it a job to do.
+If you're using Rails, just set Belated to be the ActiveJob adapter like below:
+
+```ruby
+config.active_job.adapter = :belated
+```
+
+And you're good to go!
+
+If not, in your non-ActiveJob using program, connect to Belated and give it a job to do.
 Sample below:
 
 ```ruby

data/lib/active_job/queue_adapters/belated_adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'belated'
+
+module ActiveJob # :nodoc:
+  module QueueAdapters # :nodoc:
+    # The adapter in charge of handling ActiveJob integration.
+    # WIP
+    class BelatedAdapter
+      def instance
+        @instance ||= Belated::Client.instance
+      rescue StandardError
+        @instance = Belated::Client.new
+      end
+
+      def enqueue(job) # :nodoc:
+        Rails.logger.info "Belated got job #{job}"
+        instance.perform(job, active_job: true)
+      end
+
+      def enqueue_at(job, timestamp) # :nodoc:
+        Rails.logger.info "Belated got job #{job} to be performed at #{Time.at(timestamp)}"
+        instance.perform_belated(job, at: timestamp, active_job: true)
+      end
+    end
+  end
+end

data/lib/belated/client.rb

@@ -74,11 +74,11 @@ class Belated
     # @param at [Date] - The time at which the job should be executed.
     # @param max_retries [Integer] - Times the job should be retried if it fails.
     # @return [JobWrapper] - The job wrapper for the queue.
-    def perform(job, at: nil, max_retries: 5)
+    def perform(job, at: nil, max_retries: 5, active_job: false)
       start unless started?
       return unless proper_job?(job)
 
-      job_wrapper = wrap_job(job, at: at, max_retries: max_retries)
+      job_wrapper = wrap_job(job, at: at.to_f, max_retries: max_retries, active_job: active_job)
       bank.push(job_wrapper)
       @mutex.synchronize do
         proc_table[job_wrapper.object_id] = job_wrapper if job_wrapper.proc_klass
@@ -98,10 +98,10 @@ class Belated
       false
     end
 
-    def wrap_job(job, at:, max_retries:)
+    def wrap_job(job, at:, max_retries:, active_job:)
       return job if job.is_a?(JobWrapper)
 
-      JobWrapper.new(job: job, at: at, max_retries: max_retries)
+      JobWrapper.new(job: job, at: at, max_retries: max_retries, active_job: active_job)
     end
 
     def drb_connected?

data/lib/belated/job_wrapper.rb

@@ -13,16 +13,17 @@ class Belated
   class JobWrapper
     include Comparable
     include Logging
-    attr_accessor :retries, :max_retries, :id, :job, :at, :completed, :proc_klass
+    attr_accessor :retries, :max_retries, :id, :job, :at, :completed, :proc_klass, :error, :active_job
 
-    def initialize(job:, max_retries: 5, at: nil)
+    def initialize(job:, max_retries: 5, at: nil, active_job: false)
       self.retries = 0
       self.max_retries = max_retries
-      self.id = SecureRandom.uuid
+      self.id = job.respond_to?(:job_id) ? job.job_id : SecureRandom.uuid
       self.job = job
       self.at = at
       self.completed = false
       self.proc_klass = job.instance_of?(Proc)
+      self.active_job = active_job
     end
 
     def <=>(other)
@@ -31,11 +32,7 @@ class Belated
 
     # rubocop:disable Lint/RescueException
     def perform
-      resp = if job.respond_to?(:call)
-               job.call
-             else
-               job.perform
-             end
+      resp = execute
       self.completed = true
       resp
     rescue Exception => e
@@ -43,17 +40,33 @@ class Belated
       when Interrupt, SignalException
         raise e
       else
-        retry_job
-        "Error while executing job, #{e.inspect}. Retry #{retries} of #{max_retries}"
+        retry_job(e)
+        "Error while executing job #{job.inspect}, #{e.inspect}. Retry #{retries} of #{max_retries}"
       end
     end
+
     # rubocop:enable Lint/RescueException
+    def execute
+      if active_job
+        ActiveJob::Base.execute job.serialize
+      elsif job.respond_to?(:call)
+        job.call
+      elsif job.respond_to?(:arguments)
+        job.perform(*job.arguments)
+      else
+        job.perform
+      end
+    end
 
-    def retry_job
+    def retry_job(error)
       self.retries += 1
-      return if retries > max_retries
+      if retries > max_retries
+        self.error = error
+        return
+      end
 
-      self.at = Time.now + (retries.next**4)
+      seconds_to_retry = $TESTING ? 0.05 : retries.next**4
+      self.at = (Time.now + seconds_to_retry).to_f
       log "Job #{id} failed, retrying at #{at}"
       Belated.job_list.push(self)
     end

data/lib/belated/queue.rb

@@ -25,7 +25,7 @@ class Belated
 
     def push(job)
       if job.is_a?(Symbol) || job.at.nil? ||
-         job.at <= Time.now.utc
+         job.at <= Time.now.to_f
         @queue.push(job)
       else
         @mutex.synchronize do
@@ -57,7 +57,7 @@ class Belated
 
       jobs = YAML.load(File.binread(FILE_NAME))
       jobs.each do |job|
-        if job.at && job.at > Time.now.utc
+        if job.at && job.at > Time.now.to_f
           future_jobs.push(job)
         else
           @queue.push(job)

data/lib/belated/testing.rb

@@ -22,7 +22,7 @@ class Belated
   # A client that can perform jobs inline
   class Client
     alias old_perform perform
-    def perform(job, at: nil, max_retries: 5)
+    def perform(job, at: nil, max_retries: 5, active_job: false)
       if Belated::Testing.inline?
         if job.respond_to?(:call)
           job.call
@@ -30,7 +30,7 @@ class Belated
           job.perform
         end
       else
-        old_perform(job, at: at, max_retries: max_retries)
+        old_perform(job, at: at, max_retries: max_retries, active_job: active_job)
       end
     end
   end

data/lib/belated/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Belated
-  VERSION = '0.6.7'
+  VERSION = '0.7.0'
 end

data/lib/belated.rb

@@ -65,6 +65,7 @@ class Belated
   end
 
   def trap_signals
+    pp 'trap'
     %w[INT TERM].each do |signal|
       Signal.trap(signal) do
         @worker_list.length.times do
@@ -101,7 +102,7 @@ class Belated
         sleep Belated.heartbeat
         next
       end
-      if job.at <= Time.now
+      if job.at <= Time.now.to_f
         log "Deleting #{@@queue.future_jobs.delete(job)} from future jobs"
         @@queue.push(job)
       end
@@ -156,19 +157,25 @@ class Belated
     }
   end
 
-  def self.kill_and_clear_queue!
-    @worker_list&.each do |worker|
-      Thread.kill(worker)
+  class << self
+    def find(job_id)
+      @@queue.future_jobs.find { |job| job.id == job_id }
     end
-    clear_queue!
-  end
 
-  def self.clear_queue!
-    @@queue.clear
-  end
+    def kill_and_clear_queue!
+      @worker_list&.each do |worker|
+        Thread.kill(worker)
+      end
+      clear_queue!
+    end
+
+    def clear_queue!
+      @@queue.clear
+    end
 
-  def self.fetch_job
-    @@queue.pop
+    def fetch_job
+      @@queue.pop
+    end
   end
 
   def job_list
@@ -179,5 +186,4 @@ class Belated
     @@queue
   end
 end
-
-require 'belated/rails' if defined?(::Rails::Engine)
+require 'active_job/queue_adapters/belated_adapter' if defined?(::Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.7.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -106,6 +106,7 @@ files:
 - bin/bundle
 - bin/console
 - bin/setup
+- lib/active_job/queue_adapters/belated_adapter.rb
 - lib/belated.rb
 - lib/belated/client.rb
 - lib/belated/exceptions.rb