belated 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3264ca317aa687386cf4f87b45a358b25197e0a8442d79c28116abbdf373cd5c
-  data.tar.gz: fc520d4de51b80b7ec87622f7ef66fd17a60423800a72a402fde7f7361e52a2e
+  metadata.gz: b946c5167a28af0cd73bad436d52c47ad19af699d88bd8a20c592b8fb2327ea1
+  data.tar.gz: da03cfda6b0c4ec8b9a9a7ef4cb52747294f3b582633ad023cc98aa5e88c697f
 SHA512:
-  metadata.gz: 5512108388bf979973d471f9107b8f11f1af79320029324053ca748eeac3940635efdbff744410305e185e781de6732fa003ca7251d5d26be1c706e59818f960
-  data.tar.gz: 25045c09fbd423b0169cc4eda7a01a4cbf1e93c6a3ee13d0b574f24fabfd3fae9a58768eb6bef962b8613536c3585fb542e02151950eda82d6867c34a0d6e85f
+  metadata.gz: 5add925bbaca101aef9a35c8d4ae6cc544b736ebbbcbae4e6603faf0e42a0a248bd04844b0af8fa6dceb32f021948c105bf18031fd0c97d12cfc85ac9d9cde3f
+  data.tar.gz: 13ac76b9f2b956e9b0b363d16ec3e615365ee39132fe788022c11c2ff90ed7fa9234c403903ac268efae0c63a51afbe6bc9893eb95cd8bbdf5d20b75e6a85aaf

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+
+## [0.4.4] - 2021-08-07
+
+- Now if you pass something with a syntax error in it as a job, it should not bring down the whole app! 
+
+## [0.4.3] - 2021-08-06
+
+- Client now starts the banker thread to execute jobs that were enqueued when there was no connection to Belated only if necessary. 
+## [0.4.2] - 2021-08-05
+
+- Client also handles no connection, now it saves jobs to a bank and adds them to the queue once it has a connection.  
+## [0.4.1] - 2021-08-05
+
+- Now handles saving future jobs too! So if you have a job enqueued for tomorrow, and restart Belated, it should still be enqueued. 
+
 ## [0.4.0] - 2021-08-03
 
 - Now you can enqueue jobs to be done at a later time. Just pass an `at:` keyword param to the client. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.4.0)
+    belated (0.4.4)
       drb
       dry-configurable
 

data/README.md

@@ -2,33 +2,28 @@
 
 [![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 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.
+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.
+
+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. 
 
 It uses dRuby to do the communication! Which is absolute great. No need for Redis or PostgreSQL, just Ruby standard libraries.
 
+Can be used with or without Rails. 
+
 TODO LIST:
 
-- Catch SIGTERM and friends
-  - Now supports it, partly. 
-- Don't crash on errors (Partially done)
-- Save jobs enqueued at a future date too when quitting (now it only saves the jobs in the queue)
+- Add retries for jobs
+- Add some checks to the client for proper jobs.
 - Have multiple queues?
 - Maybe support ActiveJob?
 - Have a web UI
 - Do some performance testing
+- Deploy a Rails app to production that is using Belated
+  and mention it in the readme. (Capistrano support?)
 - Add a section telling people to use Sidekiq if they can
 
-DONE
-
-- ~~Make it possible to schedule jobs~~
-- ~~Marshal the job queue into a file so you don't lose all progress~~
-  (Ended up using YAML)
-- ~~Add a logger~~
-- ~~Support Rails~~ (Supported!)
-- ~~Parse options from command line, eg. `--workers 10`~~(Done!)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -95,6 +90,7 @@ and you can use the client!
 Call
 
 ```ruby
+job = proc { 2 / 1 }
 client.perform_belated(job)
 ```
 
@@ -106,6 +102,8 @@ If you don't want the job to run right away, you can also pass it a keyword para
 client.perform_belated(job, Time.now + 1.month)
 ```
 
+Note that you probably want to memoize the client, as it always creates a 'banker thread' now if you have no connection and there is the overhead of connecting to dRuby. Maybe even use it as a global!(`$client`)
+
 # Settings
 
 Configuring Belated:

data/lib/belated.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'belated/logging'
 require_relative 'belated/version'
 require_relative 'belated/worker'
-require_relative 'belated/logging'
+require 'belated/client'
+require 'belated/queue'
 require 'drb'
-require 'yaml'
-require 'singleton'
 require 'dry-configurable'
-require 'belated/client'
 require 'logger'
-require 'belated/queue'
+require 'singleton'
+require 'yaml'
 
 # Belated is a pure Ruby job backend.
 # It has limited functionality, as it only accepts
@@ -22,7 +22,6 @@ class Belated
   include Logging
   include Singleton unless $TESTING
   URI = 'druby://localhost:8788'
-  FILE_NAME = 'belated_dump'
   @@queue = Belated::Queue.new
 
   setting :rails, true
@@ -37,7 +36,7 @@ class Belated
   # Aliased for testing purposes.
   # This is only run from the bin file.
   def start
-    boot_app && load_jobs
+    boot_app && @@queue.load_jobs
     @worker_list = []
     Belated.config.workers.times do |i|
       @worker_list << Thread.new { Worker.new(number: i.next) }
@@ -65,7 +64,11 @@ class Belated
           @@queue.push(:shutdown)
         end
         Thread.new { stop_workers }
-        sleep 0.1 until @@queue.empty? || $TESTING
+        # Max 30 seconds to shutdown
+        timeout = 0
+        until (timeout += 0.1) >= 30 || @@queue.empty? || $TESTING
+          sleep 0.1
+        end
         exit
       end
     end
@@ -97,20 +100,9 @@ class Belated
     end
   end
 
-  def load_jobs
-    log "reloading... if file exists #{File.exist?(Belated::FILE_NAME)}"
-    return unless File.exist?(Belated::FILE_NAME)
-
-    jobs = YAML.load(File.binread(FILE_NAME))
-    jobs.each do |job|
-      @@queue.push(job)
-    end
-    File.delete(Belated::FILE_NAME)
-  end
-
   def reload
     log 'reloading...'
-    load_jobs
+    @@queue.load_jobs
   end
 
   def stop_workers
@@ -118,13 +110,7 @@ class Belated
       sleep 0.1 if worker.alive?
       Thread.kill(worker)
     end
-    class_array = []
-    @@queue.length.times do |_i|
-      unless (klass = @@queue.pop).instance_of?(Proc) || klass == :shutdown
-        class_array << klass
-      end
-    end
-    pp File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
+    @@queue.save_jobs
     exit unless $TESTING
   end
 

data/lib/belated/client.rb

@@ -1,29 +1,48 @@
 class Belated
   # The client class is responsible for managing the connection to the
-  # DRb server.
+  # DRb server. If it has no connection, it adds the jobs to a bank queue.
   # You can enqueue jobs to be processed by the server.
   # Example:
   #   client = Belated::Client.new
   #   client.enqueue(JubJub.new, at: Time.now + 5.seconds)
   class Client
-    attr_accessor :queue
+    attr_accessor :queue, :bank, :banker_thread
 
     # Starts up the client.
     # Connects to the queue through DRb.
     # @return [void]
     def initialize
       server_uri = Belated::URI
-      # @bank =
       DRb.start_service
+      self.bank = Thread::Queue.new
       self.queue = DRbObject.new_with_uri(server_uri)
     end
 
+    # Thread in charge of handling the bank queue.
+    # You probably want to memoize the client in order to avoid
+    # having many threads in the sleep state.
+    # @return [void]
+    def start_banker_thread
+      self.banker_thread = Thread.new do
+        loop do
+          job, at = bank.pop
+
+          perform(job, at: at)
+        end
+      end
+    end
+
     # The method that pushes the jobs to the queue.
+    # If there is no connection, it pushes the job to the bank.
     # @param job [Object] - The the job to be pushed.
     # @param at [Date] - The time at which the job should be executed.
     # @return [Object] - The job that was pushed.
     def perform(job, at: nil)
       queue.push(job, at: at)
+    rescue DRb::DRbConnError
+      bank.push([job, at])
+      start_banker_thread if banker_thread.nil?
+      # banker_thread.wakeup if banker_thread.status == 'sleep'
     end
     alias perform_belated perform
     alias perform_later perform

data/lib/belated/queue.rb

@@ -1,9 +1,14 @@
-require 'belated/job'
+# frozen_string_literal: true
 
+require 'belated/job'
+require 'belated/logging'
 class Belated
   class Queue
+    include Logging
     attr_accessor :future_jobs
 
+    FILE_NAME = 'belated_dump'
+
     def initialize(queue: Thread::Queue.new, future_jobs: [])
       @queue = queue
       self.future_jobs = future_jobs
@@ -33,5 +38,42 @@ class Belated
     def length
       @queue.length
     end
+
+    def load_jobs
+      log "reloading... if file exists #{File.exist?(FILE_NAME)}"
+      return unless File.exist?(FILE_NAME)
+
+      jobs = YAML.load(File.binread(FILE_NAME))
+      jobs.each do |job|
+        if job.is_a?(Job)
+          future_jobs.push(job)
+        else
+          @queue.push(job)
+        end
+      end
+      File.delete(FILE_NAME)
+    end
+
+    def save_jobs
+      class_array = []
+      @queue.length.times do |_i|
+        unless proc_or_shutdown?(klass = @queue.pop)
+          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
+
+    private
+
+    def proc_or_shutdown?(job)
+      job.instance_of?(Proc) || job == :shutdown
+    end
   end
 end

data/lib/belated/version.rb

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

data/lib/belated/worker.rb

@@ -22,14 +22,21 @@ class Belated
       end
     end
 
+    # rubocop:disable Lint/RescueException
     def call_job(job)
       if job.respond_to?(:call)
         job.call
       else
         job.perform
       end
-    rescue StandardError => e
-      e.inspect
+    rescue Exception => e
+      case e.class
+      when Interrupt, SignalException
+        raise e
+      else
+        e.inspect
+      end
     end
+    # rubocop:enable Lint/RescueException
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb