belated 0.6.6 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628f04309c824751bd90f72163d29738f5600f7ed5b759b0106d09b9eccbf23e
-  data.tar.gz: 1318b353fb2047ae6e185f0af720a987a3d8c784a483df04a79601fb595ff28f
+  metadata.gz: e9ffd4fd7fb145286210861d0b2977e20ec4ed28cf776d753b887c6b8cfe384d
+  data.tar.gz: e9b006476fa67f3acdcae7a8dfff4da8275f7af4e4ecbada93b462f803fab4e7
 SHA512:
-  metadata.gz: de9793daf6f3987be47b798916dbdfa16e7be92211f46395ed4d63eabf7ae127420952c047df749de584404cd18e80a002f5fadb40896421583e80f3ebe9bf2a
-  data.tar.gz: 3a09388e73a833d3230787f6191cd02a86cc4ebf3e58ba950d8631eba31a67fe4cf319bfaa448bc471b5fe1a933d9564c7d846d3416d91832a7b5331c78e62b9
+  metadata.gz: a1dd51345d62775d2920abf015e804c8cb85c01155e9df75d59e2282d13c892270e0346b661c7896c226862f808d584157c898aa2e6b6a7247f877447842307b
+  data.tar.gz: 57a1cd7805029a009d2d0b7495eba264325813868c0c3a30984fc6a3b4bb8fcdd400257f1d31ce8277d17848f36c61e19d223e15f429161dcd5d190258809151

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-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']
     runs-on: ${{ matrix.os }}

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.8.1] - 2021-09-09
+- Now you can delete jobs from the future jobs queue. This is useful if you want to delete a job that is scheduled for a future date.
+
+## [0.8] - 2021-09-08
+- Using PStore for future jobs backup and job history. Job history is rotated daily, future jobs cannot at the moment. 
+- PStore has ultrasafe mode, should test whether that makes things very slow. If not, might be worth using it for the peace of mind. Or at least have it as an option. 
+- ActiveJob support is a bit more natural now code-wise. 
+
+## [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. 
+- Heartbeat option for server side. It only affects jobs in the wait list, it's used to determine how often to check the future jobs queue. 
 ## [0.6.6] - 2021-08-25
 
 - Tests now run agains Ruby 2.6, so relaxing the version constraint. 

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    belated (0.6.6)
+    belated (0.8.1)
       drb
       dry-configurable
+      pstore
       ruby2_keywords
       sorted_set
 
@@ -111,6 +112,7 @@ GEM
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pstore (0.1.1)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)

data/README.md

@@ -2,11 +2,9 @@
 
 [![CodeFactor](https://www.codefactor.io/repository/github/sampokuokkanen/belated/badge)](https://www.codefactor.io/repository/github/sampokuokkanen/belated) [![Gem Version](https://badge.fury.io/rb/belated.svg)](https://badge.fury.io/rb/belated)
 
-This is Belated, a new Ruby backend job library! It supports running procs, lambdas and classes in the background. To deal with restarts, it uses YAML to load the queue into a file, which it then calls at startup to find the previous jobs. There is no way in Ruby to save procs or lambdas to a file, so they are discarded when the process restarts.
+This is Belated, a new Ruby backend job library! It supports running procs, lambdas and classes in the background. To deal with restarts, it uses YAML for the current jobs in the queue waiting to be processed and PStore for the future jobs to load the queues into a file, which it then calls at startup to find the previous jobs. There is no way in Ruby to save procs or lambdas to a file, so they are discarded when the process restarts.
 
-Belated uses the Ruby Queue class, so it's First In, First Out (FIFO). 
-
-Note that Belated used to be called HardWorker. That name was already in use in Sidekiq documentation and a bit too generic anyway. 
+Belated uses the Ruby Queue class, so it's First In, First Out (FIFO), unless of course you want to run the job in the future. In that case the order is decided by the time the job is scheduled to be executed. 
 
 It uses dRuby to do the communication! Which is absolute great. No need for Redis or PostgreSQL, just Ruby standard libraries.
 
@@ -16,15 +14,14 @@ 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.
+- Have a web UI with job history.
 - Deploy a Rails app to production that is using Belated
   and mention it in the readme. (Capistrano support?)
-  ([Wasurechatta](https://wasurechatta.com/))
-- Add a section telling people to use Sidekiq if they can
+  ([Wasurechatta](https://wasurechatta.com/) deployed, still need to setup Capistrano)
+
+# Why not Sidekiq? 
+
+If you can, definitely use Sidekiq!!! Belated is supposed to be used if you can't get anything else to work. Like if you want to use SQLite in a Rails app and don't want to have Redis running. Or maybe you just want to run procs in the background? 
 
 ## Installation
 
@@ -48,7 +45,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
@@ -69,8 +74,17 @@ client.perform_belated(DumDum.new, at: Time.now + 5 * 60)
 client.perform_belated(DumDum.new, max_retries: 3) # default 5
 ```
 
-Belated runs on localhost, port 8788. 
-Going to make that an option in the future.
+You can also fetch jobs from the future jobs queue:
+
+```ruby
+job = client.perform_belated(proc { 0 / 0 }, at: Time.now + 5 * 60)
+Belated.find job.id # Find the job if it's in the future queue
+# Oh no, that job looks a bit weird!
+# Let's delete it:
+Belated.delete job.id
+```
+
+Belated runs on localhost, port 8788 by default, but the port is configurable, see below. 
 
 ## Rails
 

data/belated.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'drb'
   spec.add_dependency 'dry-configurable'
   spec.add_dependency 'ruby2_keywords'
+  spec.add_dependency 'pstore'
   spec.add_dependency 'sorted_set'
   spec.add_development_dependency 'byebug'
 

data/lib/active_job/queue_adapters/belated_adapter.rb

@@ -0,0 +1,34 @@
+# 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
+
+      # JobWrapper that overwrites perform for ActiveJob
+      class JobWrapper < Belated::JobWrapper
+        def perform
+          Base.execute job.serialize
+        end
+      end
+    end
+  end
+end

data/lib/belated/client.rb

@@ -74,10 +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?
-      check_if_proper_job!(job)
-      job_wrapper = wrap_job(job, at: at, max_retries: max_retries)
+      return unless proper_job?(job)
+
+      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
@@ -90,16 +91,22 @@ class Belated
 
     private
 
-    def check_if_proper_job!(job)
-      return if job.respond_to?(:call) || job.respond_to?(:perform)
+    def proper_job?(job)
+      return true if job.respond_to?(:call) || job.respond_to?(:perform)
 
-      raise JobError, 'job does not implement .call nor .perform!'
+      warn 'job does not implement .call nor .perform!'
+      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)
+      wrapper = if active_job
+                  ActiveJob::QueueAdapters::BelatedAdapter::JobWrapper
+                else
+                  JobWrapper
+                end
+      wrapper.new(job: job, at: at, max_retries: max_retries, active_job: active_job)
     end
 
     def drb_connected?

data/lib/belated/job_wrapper.rb

@@ -13,47 +13,60 @@ 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, active_job: false)
+      raise 'JobError' unless job.respond_to?(:call) || job.respond_to?(:perform)
 
-    def initialize(job:, max_retries: 5, at: nil)
       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)
-      at <=> other.at
+      at <=> (other&.at || other&.scheduled_at)
     end
 
     # 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
       case e.class
-      when Interrupt, SignalException
+      when Interrupt, SignalException, NoMethodError
         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 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

@@ -4,7 +4,7 @@ require 'belated/job'
 require 'belated/logging'
 require 'belated/job_wrapper'
 require 'sorted_set'
-
+require 'pstore'
 class Belated
   # Job queues that Belated uses.
   # queue is the jobs that are currenly
@@ -13,21 +13,43 @@ class Belated
   # to be added to queue at some point in the future.
   class Queue
     include Logging
-    attr_accessor :future_jobs
+    attr_accessor :future_jobs, :future_jobs_db
 
     FILE_NAME = 'belated_dump'
 
     def initialize(queue: Thread::Queue.new, future_jobs: SortedSet.new)
       @queue = queue
+      @mutex = Mutex.new
       self.future_jobs = future_jobs
+      self.future_jobs_db = PStore.new('future_jobs.pstore', true) # pass true for thread safety
+    end
+
+    def enqueue_future_jobs
+      loop do
+        job = future_jobs.min
+        if job.nil?
+          sleep Belated.heartbeat
+          next
+        end
+        if job.at <= Time.now.to_f
+          delete_job(job)
+          push(job)
+        end
+      rescue DRb::DRbConnError
+        error 'DRb connection error!!!!!!'
+        log stats
+      end
     end
 
     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
-        @future_jobs << job
+        @mutex.synchronize do
+          @future_jobs << job
+          insert_into_future_jobs_db(job) unless job.proc_klass
+        end
       end
     end
 
@@ -49,16 +71,16 @@ class Belated
     end
 
     def load_jobs
-      log "reloading... if file exists #{File.exist?(FILE_NAME)}"
+      future_jobs_db.transaction(true) do
+        future_jobs_db.roots.each do |id|
+          future_jobs << future_jobs_db[id]
+        end
+      end
       return unless File.exist?(FILE_NAME)
 
       jobs = YAML.load(File.binread(FILE_NAME))
       jobs.each do |job|
-        if job.at && job.at > Time.now.utc
-          future_jobs.push(job)
-        else
-          @queue.push(job)
-        end
+        @queue.push(job)
       end
       File.delete(FILE_NAME)
     end
@@ -70,12 +92,6 @@ class Belated
           class_array << klass
         end
       end
-      future_jobs.each do |_job|
-        unless proc_or_shutdown?(klass = future_jobs.pop)
-          class_array << klass
-        end
-      end
-
       pp File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
     end
 
@@ -88,5 +104,18 @@ class Belated
     def proc_or_shutdown?(job)
       job.is_a?(Symbol) || job.job.instance_of?(Proc)
     end
+
+    def delete_job(job)
+      log "Deleting #{future_jobs.delete(job)} from future jobs"
+      future_jobs_db.transaction do
+        future_jobs_db.delete(job.id)
+      end
+    end
+
+    def insert_into_future_jobs_db(job)
+      future_jobs_db.transaction do
+        future_jobs_db[job.id] = job
+      end
+    end
   end
 end

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.6'
+  VERSION = '0.8.1'
 end

data/lib/belated/worker.rb

@@ -1,4 +1,6 @@
 require_relative 'logging'
+require 'pstore'
+
 class Belated
   # The worker class that actually gets the jobs from the queue
   # and calls them. Expects the jobs to be procs or
@@ -20,9 +22,27 @@ class Belated
 
         log "Worker #{@number} got job: #{job.inspect}"
         log job.perform
+        history_insert(job) unless job.proc_klass || !job.completed
       rescue DRb::DRbConnError, Errno::ECONNREFUSED, RangeError => e
         log e
       end
     end
+
+    private
+
+    def history_insert(job)
+      store.transaction do
+        store[job.id] = job
+      end
+    rescue StandardError => e
+      error e
+    end
+
+    def store
+      today = Time.now.strftime('%F')
+      return @store if @store&.path&.include?(today)
+
+      @store = PStore.new("history-#{today}.pstore", true)
+    end
   end
 end

data/lib/belated.rb

@@ -33,6 +33,7 @@ class Belated
   setting :log_level, :info, reader: true
   setting :host, 'localhost', reader: true
   setting :port, '8788', reader: true
+  setting :heartbeat, 1, reader: true
   setting :client_heartbeat, 5, reader: true
   URI = "druby://#{Belated.host}:#{Belated.port}"
 
@@ -50,18 +51,21 @@ class Belated
     connect!
     banner_and_info
     trap_signals
-    enqueue_future_jobs
+    @@queue.enqueue_future_jobs
   end
   alias initialize start
 
   # Handles connection to DRb server.
   def connect!
+    i = 0
     DRb.start_service(URI, @@queue, verbose: true)
   rescue DRb::DRbConnError, Errno::EADDRINUSE
+    sleep 0.1 and retry if (i += 1) < 5
     error 'Could not connect to DRb server.'
   end
 
   def trap_signals
+    pp 'trap'
     %w[INT TERM].each do |signal|
       Signal.trap(signal) do
         @worker_list.length.times do
@@ -91,24 +95,6 @@ class Belated
     Belated.config.rails
   end
 
-  def enqueue_future_jobs
-    loop do
-      sleep 0.1
-      job = @@queue.future_jobs.min
-      if job.nil?
-        sleep 5
-        next
-      end
-      if job.at <= Time.now
-        log "Deleting #{@@queue.future_jobs.delete(job)} from future jobs"
-        @@queue.push(job)
-      end
-    rescue DRb::DRbConnError
-      error 'DRb connection error!!!!!!'
-      log stats
-    end
-  end
-
   def reload
     log 'reloading...'
     @@queue.load_jobs
@@ -154,19 +140,30 @@ 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 delete(job_id)
+      job = find(job_id)
+      @@queue.future_jobs.delete(job)
+    end
+
+    def kill_and_clear_queue!
+      @worker_list&.each do |worker|
+        Thread.kill(worker)
+      end
+      clear_queue!
+    end
 
-  def self.fetch_job
-    @@queue.pop
+    def clear_queue!
+      @@queue.clear
+    end
+
+    def fetch_job
+      @@queue.pop
+    end
   end
 
   def job_list
@@ -177,5 +174,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.6
+  version: 0.8.1
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pstore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorted_set
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,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