plok 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f3772752bb79fb0e5c754451f428a38ffbc921f994c77baace8d553dc3c8534
-  data.tar.gz: 535cc01459273ea5486507ac0ac2c226462040985dc2aa4874170cf770ac568b
+  metadata.gz: e19b5d0848888824ff2eb0d4ec7a667dd745a10641abc54e82182296eaf0f02f
+  data.tar.gz: ec066ca66b5ea4cc671d540343d824794045e2b1741307ea1eb19897d35c9f9a
 SHA512:
-  metadata.gz: a7242f280f4bc453387b191685b8a1b8857e4371379e5e4f9520cd47bd743c083344e9d9f50911657a0f129db7ce9d0ae793eeca56304bb3d6e8d2aba60432c7
-  data.tar.gz: eacde236f96f7a4109dcda5cf3f1647813ab82a11e7f3ba2e65e541e2106485d4964f854f9f7cdf4cc2371dede4eeb6e84374a3dcb6353421c06f0b7cab26ba6
+  metadata.gz: 2d59516ea8336cd4cf8ee48d94381862129ca87317d9db55c0031c6c560f4a857c83ca99e0f248f08bf49885d3fcb99db3ad6489a3261bfa13b827da6d45aa53
+  data.tar.gz: 82d00ed77cb76bcdf41df081c0e98f5a68ca7ccd78388298ad89a41e95ab8433763c5f084d97f27cbd2e2aa66a8815fee4528493cc586a5b405552d6fcf248d4

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/lib/plok/version.rb

@@ -1,3 +1,3 @@
 module Plok
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 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.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2021-11-19 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,9 @@ 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
 - lib/plok.rb
 - lib/plok/engine.rb
 - lib/plok/version.rb