plok 0.2.5 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4560c0f41784811539873f92cbda25d73197ac1403d3ee1c1b3f046b0e0a0d
-  data.tar.gz: 95a866614905153ac92414e9dd8e12a60e0d6539118fd4dbf5b9427db323bd3f
+  metadata.gz: 75df059f748c988f11b00cab9ebc496052a5da7c129dfeb84034cc08b4742abc
+  data.tar.gz: cb9fdcb200ea259378af6600ce6f906e1f89b19c41fb5185067c3f2643ba54a9
 SHA512:
-  metadata.gz: bc64c91c32ea195fdfab4596acdfbc1611d4790d71121ff083eb8297b1b59ac7b2427de5f02ce95ce3382f57bc679d30e147b70e31bd1fc5a142c06e6aba7528
-  data.tar.gz: 63bbbb1e6dadc2b8bd667e6172c59110f893050d6978707bb492807872f6aad702c73fb8b5f3f76e448f58f2c4dd24b3eaa0bfd58a4064734e51d324ef4a762c
+  metadata.gz: d9f558ae1cce6166ac50f3c229b25a874110e736ee93465708f776f83a2d23bc85c92ddb139b46cf5681f64bcdf4b221fbbc4847e0b9b5fdb77af869a27e3555
+  data.tar.gz: b3512d28ccdc1d53c90959376fa603efac9a6f297b99405fd4d0c330fedd0b97b095f3b36b4d77c28dbc07b118661a145bfd69b082c305d91704edef02cfe9dd

data/app/models/queued_task.rb

@@ -10,12 +10,15 @@ class QueuedTask < ActiveRecord::Base
   scope :in_past, -> { where(perform_at: nil).or(where('perform_at <= ?', Time.zone.now)) }
   scope :in_future, -> { where('perform_at > ?', Time.zone.now) }
 
+  DEFAULT_PRIORITY = 0
+  HIGH_PRIORITY = 10
+
   def lock!
-    update_attribute :locked, true
+    update_attribute(:locked, true)
   end
 
   def unlock!
-    update_attribute :locked, false
+    update_attribute(:locked, false)
   end
 
   def unlocked?
@@ -26,22 +29,36 @@ class QueuedTask < ActiveRecord::Base
     klass.to_s.constantize.new(data).execute!
   end
 
-  def self.queue(klass, data)
-    task = create!(klass: klass.to_s, data: data.except(:perform_at))
+  # TODO: Might be good to use named parameters for data and weight here.
+  # Might be able to use the data var to store weight like the perform_at key.
+  #
+  # TODO: Refactor to a separate class.
+  def self.queue(klass, data, weight = DEFAULT_PRIORITY)
+    task = create!(
+      klass: klass.to_s,
+      weight: weight,
+      attempts: 0,
+      data: data.except(:perform_at)
+    )
+
     task.update(perform_at: data[:perform_at]) if data[:perform_at].present?
     task
   end
 
-  def self.queue_unless_already_queued(klass, data)
-    task = find_by(klass: klass, data: data)
+  def self.queue_unless_already_queued(klass, data, weight = DEFAULT_PRIORITY)
+    task = find_by(klass: klass, data: data, weight: weight)
     return task if task.present?
-    self.queue(klass, data)
+    self.queue(klass, data, weight)
   end
 
   def dequeue!
     destroy
   end
 
+  def increase_attempts!
+    update_column(:attempts, attempts + 1)
+  end
+
   def process!
     lock!
 
@@ -51,7 +68,10 @@ class QueuedTask < ActiveRecord::Base
     rescue
       raise
     ensure
-      unlock! unless destroyed?
+      if persisted?
+        increase_attempts!
+        unlock!
+      end
     end
   end
 

data/db/migrate/20211119095633_add_weight_to_queued_tasks.rb

@@ -0,0 +1,7 @@
+class AddWeightToQueuedTasks < ActiveRecord::Migration[6.1]
+  def change
+    return if column_exists?(:queued_tasks, :weight)
+
+    add_column :queued_tasks, :weight, :integer, after: :locked, index: true
+  end
+end

data/db/migrate/20211119103846_add_attempts_to_queued_tasks.rb

@@ -0,0 +1,7 @@
+class AddAttemptsToQueuedTasks < ActiveRecord::Migration[6.1]
+  def change
+    return if column_exists?(:queued_tasks, :attempts)
+
+    add_column :queued_tasks, :attempts, :integer, after: :weight
+  end
+end

data/db/migrate/20211119123900_add_index_to_queued_tasks_locked.rb

@@ -0,0 +1,7 @@
+class AddIndexToQueuedTasksLocked < ActiveRecord::Migration[6.1]
+  def change
+    return if index_exists?(:queued_tasks, :locked)
+
+    add_index :queued_tasks, :locked
+  end
+end

data/db/migrate/20211203103118_add_file_to_logs.rb

@@ -0,0 +1,7 @@
+class AddFileToLogs < ActiveRecord::Migration[6.1]
+  def change
+    return if column_exists?(:logs, :file)
+
+    add_column :logs, :file, :string, after: :loggable_id
+  end
+end

data/lib/plok/engine.rb

@@ -1,6 +1,6 @@
 # Can't use Plok::Engine.root yet at this point.
 engine_root = File.expand_path('../..', __dir__)
-Dir.glob("#{engine_root}/app/models/**/*.rb").each { |file| require file }
+Dir.glob("#{engine_root}/app/models/**/*.rb").sort.each { |file| require file }
 
 module Plok
   class Engine < ::Rails::Engine
@@ -40,7 +40,7 @@ module Plok
     # You cannot call it in the engine itself, because RSpec won't have the same
     # context available when tests are ran.
     def load_spec_supports
-      Dir.glob("#{root}/spec/{factories,support}/**/*.rb").each { |f| require f }
+      Dir.glob("#{root}/spec/{factories,support}/**/*.rb").sort.each { |f| require f }
     end
   end
 end

data/lib/plok/version.rb

@@ -1,3 +1,3 @@
 module Plok
-  VERSION = '0.2.5'
+  VERSION = '0.2.9'
 end

data/spec/factories/queued_tasks.rb

@@ -1,5 +1,6 @@
 FactoryBot.define do
   factory :queued_task do
     klass { 'SomeClass' }
+    attempts { 0 }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plok
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.9
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -29,16 +29,16 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,10 @@ files:
 - config/routes.rb
 - db/migrate/20211008130809_create_plok_logs.rb
 - db/migrate/20211015141837_create_plok_queued_tasks.rb
+- db/migrate/20211119095633_add_weight_to_queued_tasks.rb
+- db/migrate/20211119103846_add_attempts_to_queued_tasks.rb
+- db/migrate/20211119123900_add_index_to_queued_tasks_locked.rb
+- db/migrate/20211203103118_add_file_to_logs.rb
 - lib/plok.rb
 - lib/plok/engine.rb
 - lib/plok/version.rb