belated 0.5.2 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad4adbecffc63b1e63591503cb333182b4f06238d88caa1dbb64972ca7ab3c3
-  data.tar.gz: 1a358d4ab8a37f77fcfb5a963b289631e67286d720096ca29c0925760a6b61a0
+  metadata.gz: 0ae6d21b68590fe6edb5ed817c1dd0806dadf5ee7320955cc3f4f652969f6501
+  data.tar.gz: 744ab565ddd144e5562ba39f675416e3dd17154b4ab70c916443d2711c148311
 SHA512:
-  metadata.gz: 61b201e5a85b59ba2da90183c8d5f547b1098f1600692285addfab5c656bb396ed4ab5edb798e5f73860b05c071fbb77c9644dca02695c3072c19001c372a3f2
-  data.tar.gz: 73735b1e25f3e51e26420e9d9294af135b46d8644d6a765213250a7c533f4f549f9332fb258b9615bbaeb3857db3e6c75dd193dafbf5c443d7cf63b5fee90b79
+  metadata.gz: b1baddc3b1a949af6420e6925e6e3b1565d006684d59333d89334f2e298c3f3eccdf0347402035417ee4faa300e643b4fc6824049cebabf8dab53fb2a49d0cf6
+  data.tar.gz: 065cd54c037f481a5d91a2da1800a721d40aceba6881315d261022b77d29898e6b738e72c885ef3876c6e8552fd2303a1b08270361fc624162c11c3b3b720ac2

data/.github/workflows/main.yml

@@ -10,7 +10,8 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.1
+        ruby-version: 3.0.2
         bundler-cache: true
+        cache-version: 1
     - name: Run the default task
       run: bundle exec rake

data/.rubocop.yml

@@ -1,6 +1,12 @@
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
+  Exclude:
+    - 'dummy/**/*'
+    - 'vendor/**/*'
+
+Lint/HashCompareByIdentity:
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: true
@@ -22,9 +28,6 @@ Style/AsciiComments:
 Style/ClassVars:
   Enabled: false
 
-Style/Documentation:
-  Enabled: false
-
 Style/GlobalVars:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 ## [Unreleased]
 
-## [0.5.1] - 2021-08-13
+
+## [0.5.6] - 2021-08-17
+
+- Now the client has a hash table that holds references to the objects you push through it. This is to get by GC, otherwise the objects are collected on clientside, but are still referenced on server side. This means that you do not want to use two instances of Client at the same time. Also, might need to write a way to close the client...
+- Should work a bit more safely now! Performance testing 0.5.5 online using a Rails project, it performed horribly, so it should be a bit better now. 
+## [0.5.5] - 2021-08-15
+
+- Use SortedSet for future jobs, to avoid having to go through the whole list every few seconds. 
+
+
+## [0.5.4] - 2021-08-13
+
+- Client was using 100% CPU when it had no connection. (on $5 Digital Ocean droplet) Should be fixed now. 
+
+## [0.5.3] - 2021-08-13
+
+- A bit less looping - better performance.
+## [0.5.2] - 2021-08-13
 
 - An error with shutdown handling was fixed.
 

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-discourse'
 gem 'sqlite3'
 gem 'stackprof'

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    belated (0.5.2)
+    belated (0.5.6)
       drb
       dry-configurable
+      sorted_set
 
 GEM
   remote: https://rubygems.org/
@@ -135,6 +136,7 @@ GEM
       thor (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.6)
+    rbtree (0.4.4)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -158,18 +160,28 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.10.2)
-    rubocop (1.18.3)
+    rubocop (1.19.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.10.0)
       parser (>= 3.0.1.1)
+    rubocop-discourse (2.4.2)
+      rubocop (>= 1.1.0)
+      rubocop-rspec (>= 2.0.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
+    set (1.0.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -200,6 +212,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rspec-rails
   rubocop (~> 1.7)
+  rubocop-discourse
   sqlite3
   stackprof
 

data/README.md

@@ -16,8 +16,10 @@ Can be used with or without Rails.
 
 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. 
+- Rescue `DRb::DRbRemoteError` when shutting down, might not need to if using GDBM?
 - Don't use class instance variables.
-- Make port configurable.
+- Make DRb port configurable.
 - Don't hardcode timezone.
 - Add some checks to the client for proper jobs.
 - Have multiple queues?
@@ -27,6 +29,7 @@ TODO LIST:
 - Do some performance testing.
 - 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
 
 ## Installation
@@ -101,7 +104,9 @@ 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`)
+Note that you probably want to memoize the client, as it always creates a 'banker thread' and there is the overhead of connecting to dRuby. Maybe even use it as a global!(`$client`).
+
+The client also holds references to the jobs that have been pushed so that they are not collected by GC.
 
 # Settings
 
@@ -136,9 +141,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/belated.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'drb'
   spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'sorted_set'
   spec.add_development_dependency 'byebug'
 
   # For more information and examples about making a new gem, checkout our

data/lib/belated.rb

@@ -91,13 +91,17 @@ class Belated
   def enqueue_future_jobs
     log 'starting future jobs thread'
     loop do
-      @@queue.future_jobs.each_with_index do |job, i|
-        if job.at <= Time.now.utc
-          log "Deleting #{@@queue.future_jobs.delete_at(i)} from future jobs"
-          @@queue.push(job)
-        end
+      sleep 0.1
+      job = @@queue.future_jobs.min
+      if job.nil?
+        sleep 5
+        next
+      end
+
+      if job.at <= Time.now.utc
+        log "Deleting #{@@queue.future_jobs.delete(job)} from future jobs"
+        @@queue.push(job)
       end
-      sleep 0.01
     end
   end
 

data/lib/belated/client.rb

@@ -7,7 +7,7 @@ class Belated
   #   client = Belated::Client.new
   #   client.enqueue(JubJub.new, at: Time.now + 5.seconds)
   class Client
-    attr_accessor :queue, :bank, :banker_thread
+    attr_accessor :queue, :bank, :banker_thread, :table
 
     # Starts up the client.
     # Connects to the queue through DRb.
@@ -15,8 +15,10 @@ class Belated
     def initialize
       server_uri = Belated::URI
       DRb.start_service
+      self.table = {}
       self.bank = Thread::Queue.new
       self.queue = DRbObject.new_with_uri(server_uri)
+      start_banker_thread
     end
 
     # Thread in charge of handling the bank queue.
@@ -26,13 +28,27 @@ class Belated
     def start_banker_thread
       self.banker_thread = Thread.new do
         loop do
-          job = bank.pop
+          sleep 0.01
 
-          perform(job)
+          delete_from_table
+
+          if bank.empty?
+            sleep 10
+          else
+            perform(bank.pop)
+          end
         end
       end
     end
 
+    def delete_from_table
+      return if table.empty?
+
+      table.select { |_k, v| v.completed }.each do |key, _value|
+        table.delete(key)
+      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.
@@ -40,19 +56,27 @@ class Belated
     # @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)
+      log 'Passing a proc and at time is deprecated and will be removed in 0.6' if job.instance_of?(Proc) && !at.nil?
+
       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
+      queue.push(job_wrapper)
+      table[job_wrapper.object_id] = job_wrapper
     rescue DRb::DRbConnError
       bank.push(job_wrapper)
-      start_banker_thread if banker_thread.nil?
-      banker_thread.wakeup if banker_thread.status == 'sleep'
     end
     alias perform_belated perform
     alias perform_later perform
+
+    private
+
+    def drb_connected?
+      queue.connected?
+    rescue StandardError
+      false
+    end
   end
 end

data/lib/belated/job_wrapper.rb

@@ -2,9 +2,18 @@ require 'securerandom'
 require_relative 'logging'
 
 class Belated
+  # JobWrapper is a wrapper for a job. It is responsible for
+  # - logging
+  # - error handling
+  # - job execution
+  # - job result handling
+  # - job result logging
+  # - job retries
+  # - job retry delay
   class JobWrapper
+    include Comparable
     include Logging
-    attr_accessor :retries, :max_retries, :id, :job, :at
+    attr_accessor :retries, :max_retries, :id, :job, :at, :completed
 
     def initialize(job:, max_retries: 5, at: nil)
       self.retries = 0
@@ -12,15 +21,22 @@ class Belated
       self.id = SecureRandom.uuid
       self.job = job
       self.at = at
+      self.completed = false
+    end
+
+    def <=>(other)
+      at <=> other.at
     end
 
     # rubocop:disable Lint/RescueException
     def perform
-      if job.respond_to?(:call)
-        job.call
-      else
-        job.perform
-      end
+      resp = if job.respond_to?(:call)
+               job.call
+             else
+               job.perform
+             end
+      self.completed = true
+      resp
     rescue Exception => e
       case e.class
       when Interrupt, SignalException

data/lib/belated/logging.rb

@@ -1,4 +1,6 @@
 class Belated
+  # Logger for Belated.
+  # Include this module in your class to get a logger.
   module Logging
     extend self
 

data/lib/belated/queue.rb

@@ -3,20 +3,27 @@
 require 'belated/job'
 require 'belated/logging'
 require 'belated/job_wrapper'
+require 'sorted_set'
+
 class Belated
+  # Job queues that Belated uses.
+  # queue is the jobs that are currenly
+  # waiting for a worker to start working on them.
+  # future_jobs is a SortedSet of jobs that are going
+  # to be added to queue at some point in the future.
   class Queue
     include Logging
     attr_accessor :future_jobs
 
     FILE_NAME = 'belated_dump'
 
-    def initialize(queue: Thread::Queue.new, future_jobs: [])
+    def initialize(queue: Thread::Queue.new, future_jobs: SortedSet.new)
       @queue = queue
       self.future_jobs = future_jobs
     end
 
     def push(job)
-      if job == :shutdown || job.at.nil? ||
+      if job.is_a?(Symbol) || job.at.nil? ||
          job.at <= Time.now.utc
         @queue.push(job)
       else
@@ -72,10 +79,14 @@ class Belated
       pp File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
     end
 
+    def connected?
+      true
+    end
+
     private
 
     def proc_or_shutdown?(job)
-      job.job.instance_of?(Proc) || job == :shutdown
+      job.is_a?(Symbol) || job.job.instance_of?(Proc)
     end
   end
 end

data/lib/belated/version.rb

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

data/lib/belated/worker.rb

@@ -16,10 +16,12 @@ class Belated
         log "Worker #{@number} fetching jobs!"
         next unless (job = Belated.fetch_job)
 
-        break if job == :shutdown
+        break if job.is_a?(Symbol)
 
         log "Worker #{@number} got job: #{job.inspect}"
-        job.perform
+        log job.perform
+      rescue RangeError => e
+        log e
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.6
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorted_set
+  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: byebug
   requirement: !ruby/object:Gem::Requirement