belated 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0967c77874d3cfccf82411af59b4f1555c32edbbaf346dda078b710b4ed2232
-  data.tar.gz: 6336d152b4beb80c037d28ac6335a6018270f65d563195d74022c167e0cbeac8
+  metadata.gz: 3264ca317aa687386cf4f87b45a358b25197e0a8442d79c28116abbdf373cd5c
+  data.tar.gz: fc520d4de51b80b7ec87622f7ef66fd17a60423800a72a402fde7f7361e52a2e
 SHA512:
-  metadata.gz: 84b35ef9e1b317c9250960f90c377e5d8e45261cb8de8f71ed431418dd90ebdfd72625e9c85959b3b30db68131fd5f8ba0ebc10790a1651d334437f38610ef7e
-  data.tar.gz: 29c835bf366eb3f9d6304e12a85cef12e3fa13574c0502ba71aee5322bc9e0426f6ae2b8179dd26f8e7d544a4649cb30c0840633a257e62e030aef50fe2bcbfc
+  metadata.gz: 5512108388bf979973d471f9107b8f11f1af79320029324053ca748eeac3940635efdbff744410305e185e781de6732fa003ca7251d5d26be1c706e59818f960
+  data.tar.gz: 25045c09fbd423b0169cc4eda7a01a4cbf1e93c6a3ee13d0b574f24fabfd3fae9a58768eb6bef962b8613536c3585fb542e02151950eda82d6867c34a0d6e85f

data/.gitignore

@@ -11,4 +11,7 @@
 .rspec_status
 .byebug_history
 /dummy/tmp/cache/
-belated_dump
+/dummy/log/
+/dummy/log/test.log
+belated_dump
+stackprof*

data/.rubocop.yml

@@ -41,5 +41,8 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 200
 
+Metrics/MethodLength:
+  Max: 15
+
 Security/YAMLLoad:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [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. 
+- Does not save the jobs when you quit. 
+
+## [0.3.3] - 2021-08-01
+
+- Shutdown trapped signal thread, make sure :shutdown is not recorded as a job. 
+
+## [0.3.2] - 2021-07-31
+
+- Trap INT and TERM, so now the shutdown is a little bit more graceful. 
+
+## [0.3.1] - 2021-07-29
+
+- Remove dummy app from gem... size should go down quite a bit. 
+
 ## [0.3.0] - 2021-07-29
 
 - Now there is logging! By default logs to stdout, but you can configure the logger by setting a different one through `Belated.config.logger`. 

data/Gemfile

@@ -11,5 +11,8 @@ gem 'rspec', '~> 3.0'
 
 gem 'rubocop', '~> 1.7'
 
+gem 'database_cleaner-active_record'
 gem 'rails', '>= 6.1.3'
+gem 'rspec-rails'
 gem 'sqlite3'
+gem 'stackprof'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.3.0)
+    belated (0.4.0)
       drb
       dry-configurable
 
@@ -72,6 +72,10 @@ GEM
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
     diff-lcs (1.4.4)
     drb (2.0.4)
     dry-configurable (0.12.1)
@@ -145,6 +149,14 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
     rspec-support (3.10.2)
     rubocop (1.18.3)
       parallel (~> 1.10)
@@ -166,6 +178,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
+    stackprof (0.2.16)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -181,11 +194,14 @@ PLATFORMS
 DEPENDENCIES
   belated!
   byebug
+  database_cleaner-active_record
   rails (>= 6.1.3)
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec-rails
   rubocop (~> 1.7)
   sqlite3
+  stackprof
 
 BUNDLED WITH
    2.2.17

data/README.md

@@ -10,19 +10,25 @@ It uses dRuby to do the communication! Which is absolute great. No need for Redi
 
 TODO LIST:
 
-- ~~Marshal the job queue into a file so you don't lose all progress~~
-  (Ended up using YAML)
 - Catch SIGTERM and friends
-- ~~Support Rails~~ (Supported!)
-- ~~Parse options from command line, eg. `--workers 10`~~(Done!)
+  - Now supports it, partly. 
 - Don't crash on errors (Partially done)
-- ~~Add a logger~~
-- Make it possible to schedule jobs
+- Save jobs enqueued at a future date too when quitting (now it only saves the jobs in the queue)
+- Have multiple queues?
 - Maybe support ActiveJob?
 - Have a web UI
 - Do some performance testing
 - 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:
@@ -94,6 +100,12 @@ client.perform_belated(job)
 
 If you want to pass a job to Belated.
 
+If you don't want the job to run right away, you can also pass it a keyword param `at:` like so:
+
+```ruby
+client.perform_belated(job, Time.now + 1.month)
+```
+
 # Settings
 
 Configuring Belated:
@@ -109,15 +121,15 @@ end
 
 From command line:
 
-$ bundle exec belated --rails=true
+    $ bundle exec belated --rails=true
 
 Use Rails or not.
 
-$ bundle exec belated --rails_path=/my_rails_project
+    $ bundle exec belated --rails_path=/my_rails_project
 
 Path to Rails project.
 
-$ bundle exec belated --workers=10
+    $ bundle exec belated --workers=10
 
 Number of workers.
 

data/belated.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|dummy|spec|features)/}) }
   end
   spec.bindir = 'bin'
   spec.executables   = ['belated']

data/lib/belated.rb

@@ -9,6 +9,7 @@ require 'singleton'
 require 'dry-configurable'
 require 'belated/client'
 require 'logger'
+require 'belated/queue'
 
 # Belated is a pure Ruby job backend.
 # It has limited functionality, as it only accepts
@@ -22,7 +23,7 @@ class Belated
   include Singleton unless $TESTING
   URI = 'druby://localhost:8788'
   FILE_NAME = 'belated_dump'
-  @@queue = Queue.new
+  @@queue = Belated::Queue.new
 
   setting :rails, true
   setting :rails_path, '.'
@@ -36,17 +37,17 @@ class Belated
   # Aliased for testing purposes.
   # This is only run from the bin file.
   def start
-    boot_app
-    load_jobs
+    boot_app && load_jobs
     @worker_list = []
-    Belated.config.workers.times do |_i|
-      @worker_list << Thread.new { Worker.new }
+    Belated.config.workers.times do |i|
+      @worker_list << Thread.new { Worker.new(number: i.next) }
     end
     return unless Belated.config.connect
 
     connect!
     banner_and_info
-    DRb.thread.join
+    trap_signals
+    enqueue_future_jobs
   end
   alias initialize start
 
@@ -55,10 +56,19 @@ class Belated
     DRb.start_service(URI, @@queue, verbose: true)
   rescue DRb::DRbConnError, Errno::EADDRINUSE
     Belated.logger.error 'Could not connect to DRb server.'
-    uri = "druby://localhost:#{Array.new(4) { rand(10) }.join}"
-    self.class.send(:remove_const, 'URI')
-    self.class.const_set('URI', uri)
-    retry
+  end
+
+  def trap_signals
+    %w[INT TERM].each do |signal|
+      Signal.trap(signal) do
+        @worker_list.length.times do
+          @@queue.push(:shutdown)
+        end
+        Thread.new { stop_workers }
+        sleep 0.1 until @@queue.empty? || $TESTING
+        exit
+      end
+    end
   end
 
   def boot_app
@@ -74,6 +84,19 @@ class Belated
     Belated.config.rails
   end
 
+  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 @@queue.future_jobs.delete_at(i)
+          @@queue.push(job[:klass])
+        end
+      end
+      sleep 0.01
+    end
+  end
+
   def load_jobs
     log "reloading... if file exists #{File.exist?(Belated::FILE_NAME)}"
     return unless File.exist?(Belated::FILE_NAME)
@@ -92,15 +115,17 @@ class Belated
 
   def stop_workers
     @worker_list&.each do |worker|
+      sleep 0.1 if worker.alive?
       Thread.kill(worker)
     end
     class_array = []
-    @@queue.size.times do |_i|
-      next if (klass = @@queue.pop).instance_of?(Proc)
-
-      class_array << klass
+    @@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)) }
+    exit unless $TESTING
   end
 
   def banner

data/lib/belated/client.rb

@@ -1,7 +1,16 @@
 class Belated
+  # The client class is responsible for managing the connection to the
+  # DRb server.
+  # 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
 
+    # Starts up the client.
+    # Connects to the queue through DRb.
+    # @return [void]
     def initialize
       server_uri = Belated::URI
       # @bank =
@@ -9,8 +18,12 @@ class Belated
       self.queue = DRbObject.new_with_uri(server_uri)
     end
 
-    def perform(job)
-      queue.push(job)
+    # The method that pushes the jobs to the queue.
+    # @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)
     end
     alias perform_belated perform
     alias perform_later perform

data/lib/belated/job.rb

@@ -0,0 +1 @@
+Job = Struct.new(:klass, :at)

data/lib/belated/queue.rb

@@ -0,0 +1,37 @@
+require 'belated/job'
+
+class Belated
+  class Queue
+    attr_accessor :future_jobs
+
+    def initialize(queue: Thread::Queue.new, future_jobs: [])
+      @queue = queue
+      self.future_jobs = future_jobs
+    end
+
+    def push(job, at: nil)
+      if at.nil?
+        @queue.push(job)
+      else
+        @future_jobs << Job.new(job, at)
+      end
+    end
+
+    def pop
+      @queue.pop
+    end
+
+    def clear
+      @queue.clear
+      self.future_jobs = []
+    end
+
+    def empty?
+      @queue.empty?
+    end
+
+    def length
+      @queue.length
+    end
+  end
+end

data/lib/belated/version.rb

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

data/lib/belated/worker.rb

@@ -1,21 +1,24 @@
 require_relative 'logging'
 class Belated
   # The worker class that actually gets the jobs from the queue
-  # and calls them. Expects the jobs to be procs.
+  # and calls them. Expects the jobs to be procs or
+  # classes that have a perform method.
   class Worker
     include Logging
 
-    def initialize
+    def initialize(number: 1)
+      @number = number
       start_working
     end
 
     def start_working
       loop do
-        job = Belated.fetch_job
-        next unless job
+        log "Worker #{@number} fetching jobs!"
+        next unless (job = Belated.fetch_job)
+
+        break if job == :shutdown
 
         log call_job(job)
-        log 'fetching jobs...'
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -78,76 +78,11 @@ files:
 - bin/bundle
 - bin/console
 - bin/setup
-- dummy/Rakefile
-- dummy/app/assets/config/manifest.js
-- dummy/app/assets/images/.keep
-- dummy/app/assets/stylesheets/application.css
-- dummy/app/channels/application_cable/channel.rb
-- dummy/app/channels/application_cable/connection.rb
-- dummy/app/controllers/application_controller.rb
-- dummy/app/controllers/concerns/.keep
-- dummy/app/helpers/application_helper.rb
-- dummy/app/javascript/packs/application.js
-- dummy/app/jobs/application_job.rb
-- dummy/app/mailers/application_mailer.rb
-- dummy/app/models/application_record.rb
-- dummy/app/models/concerns/.keep
-- dummy/app/models/user.rb
-- dummy/app/views/application/index.html.erb
-- dummy/app/views/layouts/application.html.erb
-- dummy/app/views/layouts/mailer.html.erb
-- dummy/app/views/layouts/mailer.text.erb
-- dummy/bin/rails
-- dummy/bin/rake
-- dummy/bin/setup
-- dummy/config.ru
-- dummy/config/application.rb
-- dummy/config/boot.rb
-- dummy/config/cable.yml
-- dummy/config/credentials.yml.enc
-- dummy/config/database.yml
-- dummy/config/environment.rb
-- dummy/config/environments/development.rb
-- dummy/config/environments/production.rb
-- dummy/config/environments/test.rb
-- dummy/config/initializers/application_controller_renderer.rb
-- dummy/config/initializers/backtrace_silencers.rb
-- dummy/config/initializers/content_security_policy.rb
-- dummy/config/initializers/cookies_serializer.rb
-- dummy/config/initializers/filter_parameter_logging.rb
-- dummy/config/initializers/inflections.rb
-- dummy/config/initializers/mime_types.rb
-- dummy/config/initializers/permissions_policy.rb
-- dummy/config/initializers/wrap_parameters.rb
-- dummy/config/locales/en.yml
-- dummy/config/master.key
-- dummy/config/puma.rb
-- dummy/config/routes.rb
-- dummy/config/storage.yml
-- dummy/db/migrate/20210613015406_create_users.rb
-- dummy/db/production.sqlite3
-- dummy/db/schema.rb
-- dummy/db/test.sqlite3
-- dummy/lib/assets/.keep
-- dummy/log/.keep
-- dummy/log/development.log
-- dummy/log/production.log
-- dummy/log/test.log
-- dummy/public/404.html
-- dummy/public/422.html
-- dummy/public/500.html
-- dummy/public/apple-touch-icon-precomposed.png
-- dummy/public/apple-touch-icon.png
-- dummy/public/favicon.ico
-- dummy/storage/.keep
-- dummy/tmp/.keep
-- dummy/tmp/development_secret.txt
-- dummy/tmp/pids/.keep
-- dummy/tmp/storage/.keep
-- hard_worker_dump
 - lib/belated.rb
 - lib/belated/client.rb
+- lib/belated/job.rb
 - lib/belated/logging.rb
+- lib/belated/queue.rb
 - lib/belated/rails.rb
 - lib/belated/version.rb
 - lib/belated/worker.rb