belated 0.4.4 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b946c5167a28af0cd73bad436d52c47ad19af699d88bd8a20c592b8fb2327ea1
-  data.tar.gz: da03cfda6b0c4ec8b9a9a7ef4cb52747294f3b582633ad023cc98aa5e88c697f
+  metadata.gz: 2e16dfb18af8fa012bede8622dba2328f725884870aa921f1759350350e50382
+  data.tar.gz: 522d6992077f9fcc93c250ccc3dd20d818d60633a3dcf9874d0cc469d225c283
 SHA512:
-  metadata.gz: 5add925bbaca101aef9a35c8d4ae6cc544b736ebbbcbae4e6603faf0e42a0a248bd04844b0af8fa6dceb32f021948c105bf18031fd0c97d12cfc85ac9d9cde3f
-  data.tar.gz: 13ac76b9f2b956e9b0b363d16ec3e615365ee39132fe788022c11c2ff90ed7fa9234c403903ac268efae0c63a51afbe6bc9893eb95cd8bbdf5d20b75e6a85aaf
+  metadata.gz: 28cc95841c797852585a165fabf2a9bab8d27da36d204e92daa7a3ec03db142a990d0e90647fef928d14e7520ad03499872187a6adfa10df8b1e55a15e1b0c88
+  data.tar.gz: 41b757722ecffe023764820b9992e3e0f007cd6bbe41ce473f8398aaf65d50a8d4e8e609acd61c79e0c6e58f3fdc8be57cc20424c1bf6bd11753be9cb95a5217

data/.rubocop.yml

@@ -1,3 +1,4 @@
+require: rubocop-performance
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.5.2] - 2021-08-13
+
+- An error with shutdown handling was fixed.
+
+## [0.5.1] - 2021-08-12
+
+- Requiring byebug in bin file. 😮
+
+## [0.5.0] - 2021-08-011
+
+- Job retries! The jobs now have ids, so you can follow the job and it's retries from the log. 
+- Quite a lot has changed internally, so if you were not using the Belated::Queue class to enqueue your jobs, you will need to update your code.
 
 ## [0.4.4] - 2021-08-07
 

data/Gemfile

@@ -9,10 +9,10 @@ gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
 
-gem 'rubocop', '~> 1.7'
-
 gem 'database_cleaner-active_record'
 gem 'rails', '>= 6.1.3'
 gem 'rspec-rails'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-performance', require: false
 gem 'sqlite3'
 gem 'stackprof'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.4.4)
+    belated (0.5.3)
       drb
       dry-configurable
 
@@ -169,6 +169,9 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.7.0)
       parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
@@ -200,8 +203,9 @@ DEPENDENCIES
   rspec (~> 3.0)
   rspec-rails
   rubocop (~> 1.7)
+  rubocop-performance
   sqlite3
   stackprof
 
 BUNDLED WITH
-   2.2.17
+   2.2.22

data/README.md

@@ -10,16 +10,21 @@ Note that Belated used to be called HardWorker. That name was already in use in
 
 It uses dRuby to do the communication! Which is absolute great. No need for Redis or PostgreSQL, just Ruby standard libraries.
 
+Note that currently the timezone is hardcoded to UTC. 
+
 Can be used with or without Rails. 
 
 TODO LIST:
 
-- Add retries for jobs
+- Don't use class instance variables.
+- Make port configurable.
+- Don't hardcode timezone.
 - Add some checks to the client for proper jobs.
 - Have multiple queues?
 - Maybe support ActiveJob?
-- Have a web UI
-- Do some performance testing
+- Have a web UI.
+- Have a job history
+- 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
@@ -50,15 +55,6 @@ Then, in another program, connect to Belated and give it a job to do.
 Sample below:
 
 ```ruby
-class DummyWorker
-  attr_accessor :queue
-
-  def initialize
-    server_uri = Belated::URI
-    self.queue = DRbObject.new_with_uri(server_uri)
-  end
-end
-
 class DumDum
   # classes need to have a perform method
   def perform
@@ -66,11 +62,14 @@ class DumDum
   end
 end
 
-# Need to start dRuby on the client side
-DRb.start_service
-dummy = DummyWorker.new
-dummy.queue.push(proc { 2 / 1 })
-dummy.queue.push(DumDum.new)
+client = Belated::Client.new
+client.perform_belated(proc { 2 / 1 })
+client.perform_belated(DumDum.new)
+# client.perform, client.perform_later are also good
+# if you want to do something later:
+client.perform_belated(DumDum.new, at: Time.now + 5 * 60)
+# max retries:
+client.perform_belated(DumDum.new, max_retries: 3) # default 5
 ```
 
 Belated runs on localhost, port 8788. 
@@ -137,9 +136,15 @@ 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+# Possible problems
+
+If you have the port 8788 already in use, you can check the ports in use in Linux with the following command:
+
+    $ sudo lsof -i -P -n | grep LISTEN
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/sampokuokkanen/belated. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sampokuokkanen/belated/blob/master/CODE_OF_CONDUCT.md).
+Bug reports, questions and pull requests are welcome on GitHub at https://github.com/sampokuokkanen/belated. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sampokuokkanen/belated/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/bin/belated

@@ -5,7 +5,6 @@ $TESTING = false
 $LOAD_PATH.unshift File.expand_path("#{File.dirname(__FILE__)}/../lib")
 require 'belated'
 require 'optparse'
-require 'byebug'
 
 OptionParser.new { |opts|
   opts.banner = 'Usage: belated [options]'

data/lib/belated.rb

@@ -4,6 +4,7 @@ require_relative 'belated/logging'
 require_relative 'belated/version'
 require_relative 'belated/worker'
 require 'belated/client'
+require 'belated/job_wrapper'
 require 'belated/queue'
 require 'drb'
 require 'dry-configurable'
@@ -90,13 +91,17 @@ class Belated
   def enqueue_future_jobs
     log 'starting future jobs thread'
     loop do
+      sleep 0.1
+      if @@queue.future_jobs.empty?
+        sleep 1
+        next
+      end
       @@queue.future_jobs.each_with_index do |job, i|
-        if job[:at] <= Time.now.utc
-          log @@queue.future_jobs.delete_at(i)
-          @@queue.push(job[:klass])
+        if job.at <= Time.now.utc
+          log "Deleting #{@@queue.future_jobs.delete_at(i)} from future jobs"
+          @@queue.push(job)
         end
       end
-      sleep 0.01
     end
   end
 
@@ -155,12 +160,16 @@ class Belated
     @@queue.clear
   end
 
+  def self.fetch_job
+    @@queue.pop
+  end
+
   def job_list
     @@queue
   end
 
-  def self.fetch_job
-    @@queue.pop
+  def self.job_list
+    @@queue
   end
 
   class Error < StandardError; end

data/lib/belated/client.rb

@@ -1,3 +1,4 @@
+require 'belated/job_wrapper'
 class Belated
   # The client class is responsible for managing the connection to the
   # DRb server. If it has no connection, it adds the jobs to a bank queue.
@@ -25,9 +26,9 @@ class Belated
     def start_banker_thread
       self.banker_thread = Thread.new do
         loop do
-          job, at = bank.pop
+          job = bank.pop
 
-          perform(job, at: at)
+          perform(job)
         end
       end
     end
@@ -36,13 +37,20 @@ class Belated
     # 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)
+    # @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)
+      job_wrapper = if job.is_a?(JobWrapper)
+                      job
+                    else
+                      JobWrapper.new(job: job, at: at, max_retries: max_retries)
+                    end
+      pp queue.push(job_wrapper)
+      job_wrapper
     rescue DRb::DRbConnError
-      bank.push([job, at])
+      bank.push(job_wrapper)
       start_banker_thread if banker_thread.nil?
-      # banker_thread.wakeup if banker_thread.status == 'sleep'
+      banker_thread.wakeup if banker_thread.status == 'sleep'
     end
     alias perform_belated perform
     alias perform_later perform

data/lib/belated/job_wrapper.rb

@@ -0,0 +1,44 @@
+require 'securerandom'
+require_relative 'logging'
+
+class Belated
+  class JobWrapper
+    include Logging
+    attr_accessor :retries, :max_retries, :id, :job, :at
+
+    def initialize(job:, max_retries: 5, at: nil)
+      self.retries = 0
+      self.max_retries = max_retries
+      self.id = SecureRandom.uuid
+      self.job = job
+      self.at = at
+    end
+
+    # rubocop:disable Lint/RescueException
+    def perform
+      if job.respond_to?(:call)
+        job.call
+      else
+        job.perform
+      end
+    rescue Exception => e
+      case e.class
+      when Interrupt, SignalException
+        raise e
+      else
+        retry_job
+        "Error while executing job, #{e.inspect}. Retry #{retries} of #{max_retries}"
+      end
+    end
+    # rubocop:enable Lint/RescueException
+
+    def retry_job
+      self.retries += 1
+      return if retries > max_retries
+
+      self.at = Time.now.utc + (retries.next**4)
+      log "Job #{id} failed, retrying at #{at}"
+      Belated.job_list.push(self)
+    end
+  end
+end

data/lib/belated/queue.rb

@@ -2,6 +2,7 @@
 
 require 'belated/job'
 require 'belated/logging'
+require 'belated/job_wrapper'
 class Belated
   class Queue
     include Logging
@@ -14,11 +15,12 @@ class Belated
       self.future_jobs = future_jobs
     end
 
-    def push(job, at: nil)
-      if at.nil?
+    def push(job)
+      if job == :shutdown || job.at.nil? ||
+         job.at <= Time.now.utc
         @queue.push(job)
       else
-        @future_jobs << Job.new(job, at)
+        @future_jobs << job
       end
     end
 
@@ -45,7 +47,7 @@ class Belated
 
       jobs = YAML.load(File.binread(FILE_NAME))
       jobs.each do |job|
-        if job.is_a?(Job)
+        if job.at && job.at > Time.now.utc
           future_jobs.push(job)
         else
           @queue.push(job)
@@ -73,7 +75,7 @@ class Belated
     private
 
     def proc_or_shutdown?(job)
-      job.instance_of?(Proc) || job == :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.4'
+  VERSION = '0.5.3'
 end

data/lib/belated/worker.rb

@@ -18,25 +18,9 @@ class Belated
 
         break if job == :shutdown
 
-        log call_job(job)
-      end
-    end
-
-    # rubocop:disable Lint/RescueException
-    def call_job(job)
-      if job.respond_to?(:call)
-        job.call
-      else
+        log "Worker #{@number} got job: #{job.inspect}"
         job.perform
       end
-    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.4
+  version: 0.5.3
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-07 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -81,6 +81,7 @@ files:
 - lib/belated.rb
 - lib/belated/client.rb
 - lib/belated/job.rb
+- lib/belated/job_wrapper.rb
 - lib/belated/logging.rb
 - lib/belated/queue.rb
 - lib/belated/rails.rb
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Run background jobs with Belated and dRuby!