belated 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b95920fe6206f0b3e71b6916e5509a734339273606a4caafc97ceef67fa3b15
-  data.tar.gz: 774c8a40d06c925f15369a4273e5b6981d8b0a0f0f90afc74e6b064f1a381a55
+  metadata.gz: 639e202c5feb0ecb2af5bcd7f22815128f670f36c2aa793ce5bc0c107477a92f
+  data.tar.gz: 65864414d040a9b1cd3e92897a97b5f596683c42cb6941c5cdbaee731502a622
 SHA512:
-  metadata.gz: fea65e9066049c19b6f5b9acc338613a142c837f74bedbb86e6f696f312871a5804b551a022d570d343979f632929a4e6e3ca9a53da308ce4d125f6b69e7026d
-  data.tar.gz: 18527ddca7ec452049e4a3c6bfddf4031d9659edd8a1b6f0950ec45033ade4da4984877afc19c031aaa9b5ae3cf7aa66646cf40634bf49d7f1d3d0524efb1ef8
+  metadata.gz: bda697be3405328560b19afbf9a90cc8cac0a8487e627ba0d6ee02ef2bbd6bf933cf3235fa312a1f817224ade6837da390d6794742a5110b255ca6052cafb838
+  data.tar.gz: da4c2c0b49901ca28aed07eff2d279293c28a3121031500cc4846627d01619fbd24c52b0c382c8c4091d46238df53d827449c7092a85286072a1b74600402313

data/.gitignore

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

data/.rubocop.yml

@@ -31,6 +31,9 @@ Style/GlobalVars:
 Style/BlockDelimiters:
   EnforcedStyle: braces_for_chaining
 
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
@@ -38,5 +41,8 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 200
 
+Metrics/MethodLength:
+  Max: 15
+
 Security/YAMLLoad:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [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`. 
 ## [0.2.0] - 2021-07-25
 
 - Workers now rescue StandardError and keep on working! 

data/Gemfile.lock

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

data/README.md

@@ -10,18 +10,23 @@ 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)
-- ~~Support Rails~~ (Supported!)
-- ~~Parse options from command line, eg. `--workers 10`~~(Done!)
-- Don't crash on errors
-- Add a logger
+- Catch SIGTERM and friends
+  - Now supports it, partly. 
+- Don't crash on errors (Partially done)
 - Make it possible to schedule jobs
 - Maybe support ActiveJob?
 - Have a web UI
 - Do some performance testing
 - Add a section telling people to use Sidekiq if they can
 
+DONE
+
+- ~~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:

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

@@ -2,11 +2,13 @@
 
 require_relative 'belated/version'
 require_relative 'belated/worker'
+require_relative 'belated/logging'
 require 'drb'
 require 'yaml'
 require 'singleton'
 require 'dry-configurable'
 require 'belated/client'
+require 'logger'
 
 # Belated is a pure Ruby job backend.
 # It has limited functionality, as it only accepts
@@ -16,8 +18,9 @@ require 'belated/client'
 # and reloads them when started again.
 class Belated
   extend Dry::Configurable
+  include Logging
   include Singleton unless $TESTING
-  URI = "druby://localhost:#{$TESTING ? Array.new(4) { rand(10) }.join : "8788"}"
+  URI = 'druby://localhost:8788'
   FILE_NAME = 'belated_dump'
   @@queue = Queue.new
 
@@ -26,25 +29,48 @@ class Belated
   setting :workers, 1
   setting :connect, true
   setting :environment, 'development'
+  setting :logger, Logger.new($stdout), reader: true
+  setting :log_level, :info, reader: true
 
   # Since it's running as a singleton, we need something to start it up.
   # 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 }
     end
     return unless Belated.config.connect
 
-    DRb.start_service(URI, @@queue, verbose: true)
-    puts banner_and_info
+    connect!
+    banner_and_info
+    trap_signals
     DRb.thread.join
   end
   alias initialize start
 
+  # Handles connection to DRb server.
+  def connect!
+    DRb.start_service(URI, @@queue, verbose: true)
+  rescue DRb::DRbConnError, Errno::EADDRINUSE
+    Belated.logger.error 'Could not connect to DRb server.'
+    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?
+        exit
+      end
+    end
+  end
+
   def boot_app
     return unless rails?
 
@@ -59,6 +85,7 @@ class Belated
   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))
@@ -69,40 +96,28 @@ class Belated
   end
 
   def reload
+    log 'reloading...'
     load_jobs
   end
 
   def stop_workers
-    @worker_list.each do |worker|
-      Thread.kill(worker)
-    end
-    return if @@queue.empty?
-
-    class_array = []
-
-    @@queue.size.times do |_i|
-      next if (klass_or_proc = @@queue.pop).instance_of?(Proc)
-
-      class_array << klass_or_proc
-    end
-    File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
-  end
-
-  def self.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_or_proc = @@queue.pop).instance_of?(Proc)
-
-      class_array << klass_or_proc
+      unless (klass = @@queue.pop).instance_of?(Proc) || klass == :shutdown
+        class_array << klass
+      end
     end
-    File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
+    pp File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
+    exit unless $TESTING
   end
 
   def banner
     <<-'BANNER'
+
     .----------------. .----------------. .----------------. .----------------. .----------------. .----------------. .----------------.
     | .--------------. | .--------------. | .--------------. | .--------------. | .--------------. | .--------------. | .--------------. |
     | |   ______     | | |  _________   | | |   _____      | | |      __      | | |  _________   | | |  _________   | | |  ________    | |
@@ -118,9 +133,9 @@ class Belated
   end
 
   def banner_and_info
-    puts banner
-    puts "Currently running Belated version #{Belated::VERSION}"
-    puts %(Belated running #{@worker_list&.length.to_i} workers on #{URI}...)
+    log banner
+    log "Currently running Belated version #{Belated::VERSION}"
+    log %(Belated running #{@worker_list&.length.to_i} workers on #{URI}...)
   end
 
   def stats
@@ -130,6 +145,13 @@ class Belated
     }
   end
 
+  def self.kill_and_clear_queue!
+    @worker_list&.each do |worker|
+      Thread.kill(worker)
+    end
+    clear_queue!
+  end
+
   def self.clear_queue!
     @@queue.clear
   end

data/lib/belated/client.rb

@@ -4,13 +4,15 @@ class Belated
 
     def initialize
       server_uri = Belated::URI
+      # @bank =
       DRb.start_service
       self.queue = DRbObject.new_with_uri(server_uri)
     end
 
-    def perform_belated(job)
+    def perform(job)
       queue.push(job)
     end
-    alias perform_later perform_belated
+    alias perform_belated perform
+    alias perform_later perform
   end
 end

data/lib/belated/logging.rb

@@ -0,0 +1,17 @@
+class Belated
+  module Logging
+    extend self
+
+    def logger
+      @logger ||= Belated.logger
+    end
+
+    def log(message)
+      logger.__send__(Belated.log_level, message)
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+end

data/lib/belated/version.rb

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

data/lib/belated/worker.rb

@@ -1,29 +1,33 @@
+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.
   class Worker
+    include Logging
+
     def initialize
       start_working
     end
 
     def start_working
       loop do
-        job = Belated.fetch_job
-        next unless job
+        next unless (job = Belated.fetch_job)
+
+        break if job == :shutdown
 
-        call_job(job)
-        puts 'fetching jobs...'
+        log call_job(job)
+        log 'fetching jobs...'
       end
     end
 
     def call_job(job)
       if job.respond_to?(:call)
-        pp job.call
+        job.call
       else
-        pp job&.perform
+        job.perform
       end
     rescue StandardError => e
-      pp e.inspect
+      e.inspect
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-25 00:00:00.000000000 Z
+date: 2021-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -78,75 +78,9 @@ 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/logging.rb
 - lib/belated/rails.rb
 - lib/belated/version.rb
 - lib/belated/worker.rb