plok 0.2.4 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f94b374b06ba10ec08b73dbe775778f4ab227a544bf3f3560181873c3c3c84e
-  data.tar.gz: dd0c619b49cfafe547bd23ff5a552a2c46a5d9367e8b230c21f92e7b8e6cb1b6
+  metadata.gz: e19b5d0848888824ff2eb0d4ec7a667dd745a10641abc54e82182296eaf0f02f
+  data.tar.gz: ec066ca66b5ea4cc671d540343d824794045e2b1741307ea1eb19897d35c9f9a
 SHA512:
-  metadata.gz: d2eede7ca6241841f363ea58e56c5497e4f157f2acfe18268303f12c25ebac1fb69921a66b62e7234fda7c847cb8abe9a43a0de672ee8611f093cfb584418783
-  data.tar.gz: 584ab4f9a271486dbae8ad323ef3860ca78241168f8f79cac7a0252753717c84336e4bac5d7e0a6444214766402922f4613cbbe090a15e7425de5760c140e088
+  metadata.gz: 2d59516ea8336cd4cf8ee48d94381862129ca87317d9db55c0031c6c560f4a857c83ca99e0f248f08bf49885d3fcb99db3ad6489a3261bfa13b827da6d45aa53
+  data.tar.gz: 82d00ed77cb76bcdf41df081c0e98f5a68ca7ccd78388298ad89a41e95ab8433763c5f084d97f27cbd2e2aa66a8815fee4528493cc586a5b405552d6fcf248d4

data/app/models/queued_task.rb

@@ -0,0 +1,84 @@
+class QueuedTask < ActiveRecord::Base
+  include Plok::Loggable
+
+  serialize :data, Hash
+
+  validates :klass, presence: true
+
+  scope :locked, -> { where(locked: true) }
+  scope :unlocked, -> { where('locked = 0 OR locked IS NULL') }
+  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)
+  end
+
+  def unlock!
+    update_attribute(:locked, false)
+  end
+
+  def unlocked?
+    !locked?
+  end
+
+  def execute!
+    klass.to_s.constantize.new(data).execute!
+  end
+
+  # 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, weight = DEFAULT_PRIORITY)
+    task = find_by(klass: klass, data: data, weight: weight)
+    return task if task.present?
+    self.queue(klass, data, weight)
+  end
+
+  def dequeue!
+    destroy
+  end
+
+  def increase_attempts!
+    update_column(:attempts, attempts + 1)
+  end
+
+  def process!
+    lock!
+
+    begin
+      execute!
+      dequeue!
+    rescue
+      raise
+    ensure
+      if persisted?
+        increase_attempts!
+        unlock!
+      end
+    end
+  end
+
+  def stuck?
+    return false if locked?
+    # Make sure task is past its perform_at timestamp.
+    return perform_at <= 30.minutes.ago if perform_at.present?
+    created_at <= 30.minutes.ago
+  end
+end

data/db/migrate/20211015141837_create_plok_queued_tasks.rb

@@ -0,0 +1,14 @@
+class CreatePlokQueuedTasks < ActiveRecord::Migration[6.1]
+  def change
+    return if table_exists?(:queued_tasks)
+
+    create_table :queued_tasks do |t|
+      t.string :klass
+      t.text :data
+      t.boolean :locked
+      t.datetime :perform_at
+
+      t.timestamps
+    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/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.4'
+  VERSION = '0.2.8'
 end

data/spec/factories/queued_tasks.rb

@@ -0,0 +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.4
+  version: 0.2.8
 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-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
@@ -82,13 +82,19 @@ files:
 - app/controllers/plok/version_controller.rb
 - app/models/concerns/plok/loggable.rb
 - app/models/log.rb
+- app/models/queued_task.rb
 - 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
 - lib/tasks/plok_tasks.rake
 - spec/factories/logs.rb
+- spec/factories/queued_tasks.rb
 - spec/support/plok/loggable.rb
 homepage: https://plok.blimp.be
 licenses: