litejob 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9235b916ceb5620f30e307e23adb1c3baf256625a3d3cedde1c2851faa9ed490
-  data.tar.gz: 553500fbb22d4ef729a6059277cb56738c87b671e4009ac9c3b7174293f7bfb8
+  metadata.gz: bc3982eaa19478a86cd8b4c4a798ad53753e6352aef0a1ce8b71eb80f2583f9a
+  data.tar.gz: 2588cc9f482cd5b90711d732cc70f4e09b2291a105e44dfeba91ec6ce2e0de30
 SHA512:
-  metadata.gz: 86125548df029a4a0035314ff34f3a429394079d56b88075e7b05ec72a4975a9b7ee32ed130bef939cfe4edd6a6cbc02b46458e011df847fd942efbbdbd36562
-  data.tar.gz: 50f38790e97d1b19462a5926bd2a92fbcbc9485ccadf2c89a9c1f1effc4ccd566650bea57400793d3d11aec0390c647f81e04d2ead1963aa0889f9522918654a
+  metadata.gz: d2169928b281facd7d75ceff0c471ec9446d8376505acc78087996a51ebd2060669f5059ece4e75ea7f6e2a9423ba872d76d7465de476dd88f9b9ee9615c46a3
+  data.tar.gz: f3484b76fd14d868370934bb0bd919ce336fc394df830cb7236f6b3afe3e242be30f256a6598af9c7bef0881bf48562939bfd9267e335a0af2206bf70e5061c0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.3] - 2023-08-14
+
+- Make queues and queue priorities optional when initializing a Server instance
+
+## [0.2.2] - 2023-08-14
+
+- Add logging
+
 ## [0.2.1] - 2023-08-13
 
 - Fix some bugs with Litejob::Server

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    litejob (0.2.1)
-      litequeue (>= 0.2.0)
+    litejob (0.2.3)
+      litequeue (>= 0.2.1)
       litescheduler (>= 0.2.1)
 
 GEM
@@ -16,7 +16,7 @@ GEM
     litedb (0.2.1)
       litescheduler (>= 0.2.0)
       sqlite3 (>= 1.5.0)
-    litequeue (0.2.0)
+    litequeue (0.2.1)
       litedb (>= 0.2.1)
     litescheduler (0.2.1)
     minitest (5.19.0)

data/README.md

@@ -3,27 +3,71 @@
 [![Gem Version](https://badge.fury.io/rb/litejob.svg)](https://rubygems.org/gems/litejob)
 [![Gem Downloads](https://img.shields.io/gem/dt/litejob)](https://rubygems.org/gems/litejob)
 ![Tests](https://github.com/litestack-ruby/litejob/actions/workflows/main.yml/badge.svg)
-![Coverage](https://img.shields.io/badge/code_coverage-100%25-brightgreen)
+![Coverage](https://img.shields.io/badge/code_coverage-70%25-red)
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/litejob`. To experiment with that code, run `bin/console` for an interactive prompt.
+Litejob is a Ruby module that enables seamless integration of the Litequeue job queueing system into Ruby applications. By including the Litejob module in a class and implementing the `#perform` method, developers can easily enqueue and process jobs asynchronously.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add litejob
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install litejob
 
 ## Usage
 
-TODO: Write usage instructions here
+When a job is enqueued, Litejob creates a new instance of the class and passes it any necessary arguments. The class's `#perform` method is then called asynchronously to process the job. This allows the application to continue running without waiting for the job to finish, improving overall performance and responsiveness.
+
+One of the main benefits of using Litejob is its simplicity. Because it integrates directly with Litequeue, developers do not need to worry about managing job queues or processing logic themselves. Instead, they can focus on implementing the `#perform` method to handle the specific job tasks.
+
+Litejob also provides a number of useful features, including the ability to set job priorities, retry failed jobs, and limit the number of retries. These features can be configured using simple configuration options in the class that includes the Litejob module.
+
+Overall, Litejob is a powerful and flexible module that allows developers to easily integrate Litequeue job queueing into their Ruby applications. By enabling asynchronous job processing, Litejob can help improve application performance and scalability, while simplifying the development and management of background job processing logic.
+
+```ruby
+class EasyJob
+  include ::Litejob
+
+  def perform(params)
+    # do stuff
+  end
+end
+```
+
+Then later you can perform a job asynchronously:
+
+```ruby
+EasyJob.perform_async(params) # perform a job synchronously
+```
+
+Or perform it at a specific time:
+
+```ruby
+EasyJob.perform_at(time, params) # perform a job at a specific time
+```
+
+Or perform it after a certain delay:
+
+```ruby
+EasyJob.perform_in(delay, params) # perform a job after a certain delay
+```
+
+You can also specify a specific queue to be used
+
+```ruby
+class EasyJob
+  include ::Litejob
+
+  self.queue = :urgent
+
+  def perform(params)
+    # do stuff
+  end
+end
+```
 
 ## Development
 
@@ -33,7 +77,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/litejob. 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/[USERNAME]/litejob/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/litestack-ruby/litejob. 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/litestack-ruby/litejob/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -41,4 +85,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Litejob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/litejob/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Litejob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/litestack-ruby/litejob/blob/main/CODE_OF_CONDUCT.md).

data/lib/litejob/client.rb

@@ -15,11 +15,14 @@ module Litejob
       attempts = options[:attempts] || 5
       queue = options[:queue]
       payload = JSON.dump({class: jobclass, params: params, attempts: attempts, queue: queue})
-      atomic_push(payload, delay, queue)
+      job_id, job_queue = atomic_push(payload, delay, queue)
+      Litejob.logger.info("[litejob]:[ENQ] queue=#{job_queue} class=#{jobclass} job=#{job_id}")
+      [job_id, job_queue]
     end
 
     def delete(id)
       payload = @queue.delete(id)
+      Litejob.logger.info("[litejob]:[DEL] job=#{id}")
       JSON.parse(payload)
     end
 

data/lib/litejob/concern.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "client"
+
+module Litejob
+  # Litejob::Concern is responsible for providing an interface to job classes
+  module Concern
+    def perform_async(*params)
+      @litejob_options ||= {}
+      client.push(name, params, @litejob_options.merge(delay: 0, queue: queue_name))
+    end
+
+    def perform_at(time, *params)
+      @litejob_options ||= {}
+      delay = time.to_i - Time.now.to_i
+      client.push(name, params, @litejob_options.merge(delay: delay, queue: queue_name))
+    end
+
+    def perform_in(delay, *params)
+      @litejob_options ||= {}
+      client.push(name, params, @litejob_options.merge(delay: delay, queue: queue_name))
+    end
+    alias_method :perform_after, :perform_in
+
+    def delete(id)
+      client.delete(id)
+    end
+
+    def queue_as(queue_name)
+      @queue_name = queue_name.to_s
+    end
+
+    def litejob_options(options)
+      @litejob_options = options
+    end
+
+    private
+
+    def queue_name
+      @queue_name || "default"
+    end
+
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/litejob/processor.rb

@@ -6,36 +6,67 @@ require "litequeue"
 module Litejob
   # Litejob::Processor is responsible for processing job payloads
   class Processor
-    def initialize(payload)
-      @payload = payload
-      @queue = Litequeue.instance
+    def initialize(queue, id, serialized_job)
+      @queue = queue
+      @id = id
+      @serialized_job = serialized_job
+      @job_hash = JSON.parse(@serialized_job)
+      @litequeue = Litequeue.instance
+
+      set_log_context!(queue: @queue, class: @job_hash["class"], job: @id)
     end
 
     def repush(id, job, delay = 0, queue = nil)
-      @queue.repush(id, JSON.dump(job), queue: queue, delay: delay)
+      @litequeue.repush(id, JSON.dump(job), queue: queue, delay: delay)
     end
 
     def process!
-      id, serialized_job = @payload
-      job_hash = JSON.parse(serialized_job)
-      klass = Object.const_get(job_hash["class"])
+      log(:deq)
+      klass = Object.const_get(@job_hash["class"])
       instance = klass.new
 
       begin
-        instance.perform(*job_hash["params"])
-      rescue
-        if job_hash["retries_left"] == 0
-          repush(id, job_hash, 0, "_dead")
+        instance.perform(*@job_hash["params"])
+        log(:end)
+      rescue => e
+        if @job_hash["retries_left"] == 0
+          err(e, "retries exhausted, moving to _dead queue")
+          repush(@id, @job_hash, 0, "_dead")
         else
-          job_hash["retries_left"] ||= job_hash["attempts"]
-          job_hash["retries_left"] -= 1
-          retry_delay = (job_hash["attempts"] - job_hash["retries_left"]) * 0.1
-          repush(id, job_hash, retry_delay, job_hash["queue"])
+          @job_hash["retries_left"] ||= @job_hash["attempts"]
+          @job_hash["retries_left"] -= 1
+          retry_delay = (@job_hash["attempts"] - @job_hash["retries_left"]) * 0.1
+          err(e, "retrying in #{retry_delay} seconds")
+          repush(@id, @job_hash, retry_delay, @job_hash["queue"])
         end
       end
-    rescue => exception # standard:disable Lint/UselessRescue
+    rescue => e
       # this is an error in the extraction of job info, retrying here will not be useful
-      raise exception
+      err(e, "while processing job=#{@serialized_job}")
+      raise e
+    end
+
+    private
+
+    def set_log_context!(**attributes)
+      @log_context = attributes.map { |k, v| [k, v].join("=") }.join(" ")
+    end
+
+    def log(event, msg: nil)
+      prefix = "[litejob]:[#{event.to_s.upcase}]"
+
+      Litejob.logger.info [prefix, @log_context, msg].compact.join(" ")
+    end
+
+    def err(exception, msg = nil)
+      prefix = "[litejob]:[ERR]"
+      error_context = if exception.message == exception.class.name
+        "failed with #<#{exception.class.name}>"
+      else
+        "failed with #{exception.inspect}"
+      end
+
+      Litejob.logger.error [prefix, @log_context, error_context, msg].compact.join(" ")
     end
   end
 end

data/lib/litejob/server.rb

@@ -6,16 +6,14 @@ require_relative "processor"
 
 module Litejob
   # Litejob::Server is responsible for popping job payloads from the SQLite queue.
-  # :nocov:
   class Server
-    # TODO: make queues use [["default", 1]]
-    # TODO: make queue priorities optional
-    def initialize(queues)
+    def initialize(queues = ["default"])
       @queue = Litequeue.instance
       @scheduler = Litescheduler.instance
       @queues = queues
       # group and order queues according to their priority
       @prioritized_queues = queues.each_with_object({}) do |(name, priority, spawns), memo|
+        priority ||= 5
         memo[priority] ||= []
         memo[priority] << [name, spawns == "spawn"]
       end.sort_by do |priority, _|
@@ -37,6 +35,7 @@ module Litejob
 
     def run!
       @scheduler.spawn do
+        Litejob.logger.info("[litejob]:[RUN] id=#{@scheduler.context.object_id}")
         worker_sleep_index = 0
         while @running
           processed = 0
@@ -47,7 +46,8 @@ module Litejob
                 batched += 1
                 processed += 1
 
-                processor = Processor.new(payload)
+                id, serialized_job = payload
+                processor = Processor.new(queue, id, serialized_job)
                 processor.process!
 
                 # give other contexts a chance to run here
@@ -66,5 +66,4 @@ module Litejob
       end
     end
   end
-  # :nocov:
 end

data/lib/litejob/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Litejob
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

data/lib/litejob.rb

@@ -1,53 +1,28 @@
 # frozen_string_literal: true
 
 require_relative "litejob/version"
-require_relative "litejob/client"
+require_relative "litejob/concern"
 require_relative "litejob/server"
+require "logger"
 
-# Litejob is responsible for providing an interface to job classes
 module Litejob
   def self.included(klass)
-    klass.extend(ClassMethods)
+    klass.extend(Concern)
   end
 
-  module ClassMethods
-    def perform_async(*params)
-      @litejob_options ||= {}
-      client.push(name, params, @litejob_options.merge(delay: 0, queue: queue_name))
-    end
+  Configuration = Struct.new(:logger)
 
-    def perform_at(time, *params)
-      @litejob_options ||= {}
-      delay = time.to_i - Time.now.to_i
-      client.push(name, params, @litejob_options.merge(delay: delay, queue: queue_name))
-    end
-
-    def perform_in(delay, *params)
-      @litejob_options ||= {}
-      client.push(name, params, @litejob_options.merge(delay: delay, queue: queue_name))
-    end
-    alias_method :perform_after, :perform_in
-
-    def delete(id)
-      client.delete(id)
-    end
-
-    def queue_as(queue_name)
-      @queue_name = queue_name.to_s
-    end
-
-    def litejob_options(options)
-      @litejob_options = options
-    end
-
-    private
+  def self.configuration
+    @configuration ||= Configuration.new(
+      _logger = Logger.new($stdout)
+    )
+  end
 
-    def queue_name
-      @queue_name || "default"
-    end
+  def self.configure
+    yield(configuration)
+  end
 
-    def client
-      @client ||= Client.new
-    end
+  def self.logger
+    configuration.logger
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: litejob
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Mohamed Hassan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: litescheduler
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - Rakefile
 - lib/litejob.rb
 - lib/litejob/client.rb
+- lib/litejob/concern.rb
 - lib/litejob/processor.rb
 - lib/litejob/server.rb
 - lib/litejob/version.rb