belated 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae5f827cc80ba5fba59161a50ae5797ef774be28feeb478ea641dda6bca79b3a
-  data.tar.gz: 01a61d9a44ae2b76ad27827e58dd8ba81e2040753925dc7172458c04495f010a
+  metadata.gz: 535f6d7f0af3565867c6f621fb328966d35ff524e38ffc22813e4410fd66eb2f
+  data.tar.gz: ace8cc58b9519d07e7bce2f12c5b1e45eba570f75a0a5f34b0496a5acfac679d
 SHA512:
-  metadata.gz: 73a7fe76eacd1334186ef70628a78f193a20a72373d4faaa6bc9b8688ff0d9786156a69b44c3dfb9405837f0f5d980d1317277ad87c33d239d5d8c13b73207a4
-  data.tar.gz: bcc797637c63a712e81b77189ecd93c325a67fb67f91b392a86d8231b685394341447539c12012280fee392a52a71a6fb20713fdb0ae0be32201c2b2670f5a33
+  metadata.gz: '058ed5f47971a9f39d7ec39997f23bdfeb54221b516ee9162330e9a0c783dc9ec6d7633ad029b7d96792e08bd317d5efced10ca2ea97b0e8322507a6e5f9a045'
+  data.tar.gz: c5ef2e3ad64ecda5e1fa2cb0feab2dda1b50388a523e571fe3be829af76e864973429bb95d0433353dd5a58bf97f2f366d19bd19a7ae0d6d578030646156f542

data/.rubocop.yml

@@ -37,6 +37,9 @@ Style/BlockDelimiters:
 Style/ModuleFunction:
   EnforcedStyle: extend_self
 
+Metrics/AbcSize:
+  Max: 17
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.6.4] - 2021-08-22
+- Inline jobs for testing!
+```ruby
+`belated/testing`
+Belated::Testing.inline!
+```
+- Very much inspired by how Sidekiq is doing this. 
+- Read more in the testing part of README.md
+
 ## [0.6.3] - 2021-08-21
 
 - Needed to have the hash inside the mutex when going over it; otherwise you still the get can't add key into hash during iteration error. Of course.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.6.3)
+    belated (0.6.4)
       drb
       dry-configurable
       sorted_set

data/README.md

@@ -18,8 +18,7 @@ Can be used if you're on a normal instance such as EC2 or Digital Ocean drop. No
 
 TODO LIST:
 
-- Improve thread safety. 
-- 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? 
+- 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.
 - Make DRb port configurable.
 - Don't hardcode timezone to UTC.
 - Add some checks to the client for proper jobs.
@@ -140,6 +139,22 @@ Path to Rails project.
 
 Number of workers.
 
+## Testing
+
+When testing, you can require `belated/testing` and then call `Belated::Testing.inline!` to make your jobs perform inline.
+
+```ruby
+`belated/testing`
+c = Belated::Client.instance
+c.start
+c.perform(proc { 2/ 1}) # Tries to push the job to the drb backend
+# <Belated::JobWrapper:0x00005654bc2db1f0 @at=nil, @completed=false, @id="95e4dc6a-1876-4adf-ae0f-5ae902f5f024", @job=#<Proc:0x00005654bc2db330 (irb):3>, @max_retries=5, @proc_klass=true, @retries=0>
+Belated::Testing.inline! # Sidekiq-inspired, now jobs run inline
+c.perform(proc { 2/ 1}) # Returns 2 right away
+# 2
+Belated::Client.test_mode_off! # Turn off inline job processing
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/belated.rb

@@ -29,7 +29,7 @@ class Belated
   setting :rails_path, '.'
   setting :workers, 1
   setting :connect, true
-  setting :environment, 'development'
+  setting :environment, 'development', reader: true
   setting :logger, Logger.new($stdout), reader: true
   setting :log_level, :info, reader: true
 

data/lib/belated/client.rb

@@ -16,6 +16,8 @@ class Belated
     # Connects to the queue through DRb.
     # @return [void]
     def start
+      return if started?
+
       server_uri = Belated::URI
       DRb.start_service
       self.proc_table = {}
@@ -30,18 +32,22 @@ class Belated
       @started
     end
 
+    # Makes it possible to reset the client
+    def turn_off
+      @started = false
+      banker_thread&.kill
+    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
+      Thread.new do
         loop do
-          delete_from_table if proc_table.length > 20
-          if bank.empty?
-            sleep 10
-            next
-          end
+          delete_from_table
+          sleep 10 and next if bank.empty?
+
           until bank.empty?
             begin
               queue.push(wrapper = bank.pop)
@@ -55,7 +61,7 @@ class Belated
     end
 
     def delete_from_table
-      return if proc_table.empty?
+      return if proc_table.length < 25
 
       @mutex.synchronize do
         proc_table.select { |_k, v| v.completed }.each do |key, _value|
@@ -71,12 +77,14 @@ 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 'Call .start on the client instance first!' unless started?
+
       job_wrapper = wrap_job(job, at: at, max_retries: max_retries)
       bank.push(job_wrapper)
       @mutex.synchronize do
         proc_table[job_wrapper.object_id] = job_wrapper if job_wrapper.proc_klass
       end
-      start_banker_thread if banker_thread.nil?
+      self.banker_thread = start_banker_thread if banker_thread.nil?
       job_wrapper
     end
     alias perform_belated perform

data/lib/belated/testing.rb

@@ -0,0 +1,37 @@
+class Belated
+  # Testing helpers
+  # Enable or disable testing
+  class Testing
+    @@testing = false
+
+    def self.inline?
+      @@testing == true
+    end
+
+    def self.inline!
+      @@testing = true
+    end
+
+    def self.test_mode_off!
+      @@testing = false
+    end
+  end
+end
+
+class Belated
+  # A client that can perform jobs inline
+  class Client
+    alias old_perform perform
+    def perform(job, at: nil, max_retries: 5)
+      if Belated::Testing.inline?
+        if job.respond_to?(:call)
+          job.call
+        else
+          job.perform
+        end
+      else
+        old_perform(job, at: at, max_retries: max_retries)
+      end
+    end
+  end
+end

data/lib/belated/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-21 00:00:00.000000000 Z
+date: 2021-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -99,6 +99,7 @@ files:
 - lib/belated/logging.rb
 - lib/belated/queue.rb
 - lib/belated/rails.rb
+- lib/belated/testing.rb
 - lib/belated/version.rb
 - lib/belated/worker.rb
 homepage: https://github.com/sampokuokkanen/belated