postburner 0.5.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffbffc2cebbe2e83bfff21178b71d0b205756cd6ef05c6dc30c8029d073c70d7
-  data.tar.gz: 68136a8de901340817dcd60e0fbd3b6794eb6dea2f8da386af138576dbba6334
+  metadata.gz: a63bf3c67a22be147995ab0fbe4464052a3d1aa733a537154045cd9f877659e4
+  data.tar.gz: cada05ac83afe59868738069c37b2d0cd4146fccff113f8652457c63101de6e6
 SHA512:
-  metadata.gz: 319ebb136625b266efe9189c8f6114ee7153ad18503b6d38343609a8bcb62dc3ea814b4b22e60f685f90f68957a2c9647ff3c958e26983796fc2c40bb8cb981c
-  data.tar.gz: 0fb16c1e08994dc7676b1546dc9d492c51243a9bcf8ffa9a2367b0a4274ecd806c322f00b6304a637fbfa20ddb2bc0872bd5ccdb357bba1d518f60f589edbf46
+  metadata.gz: 1ef155f03796765abe928ca1bf4bad33d02baa477b89228ceb6a60b7dfd8f0fb53c971514f768f37d2da5d1c6e448979c1518d4432f41df52996cc0f7c5ec970
+  data.tar.gz: 195c508533acc42cef7d680b60af1ac2f7c29648ce4a3df5b2ba0cf866d2879d9410ea0f35f528d55ca173e5d02d5f536252621c935a557620fd0250d8f708e1

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## v0.6.3 - 2021-11-02
+
+### Fixed
+- fix #remove! to allow removal even if no beanstalkd job present.
+
+## v0.6.2 - 2021-11-01
+
+### Fixed
+- add #requeue method.
+- check if AlreadyProcessed.
+
+## v0.6.1 - 2021-11-01
+
+### Updated
+- update run_at logic to support only inserting after save commit.
+
+## v0.6.0 - 2021-11-01
+
+### Added
+- update exception handling to better show where the error was raised.
+- update logging to match errata format.
+- update documentation.
+
 ## v0.5.0 - 2021-10-27
 
 ### Added

data/README.md

@@ -47,6 +47,17 @@ RunDonation.create!(args: {donation_id: 123}).queue! delay: 1.hour
 => {:status=>"INSERTED", :id=>"1141"}
 ```
 
+### Mailers
+
+```ruby
+j = Postburner::Mailer.
+  delivery(UserMailer, :welcome)
+  .with(name: 'Freddy')
+
+j.queue!
+=> {:status=>"INSERTED", :id=>"1139"}
+```
+
 ### [Beaneater](https://github.com/beanstalkd/beaneater) and [beanstalkd](https://raw.githubusercontent.com/beanstalkd/beanstalkd/master/doc/protocol.txt) attributes and methods
 ```ruby
 # get the beanstalkd job id

data/app/models/postburner/job.rb

@@ -24,25 +24,42 @@ module Postburner
 
     before_validation :ensure_sid!
     before_destroy :delete!
+    after_save_commit :insert_if_queued!
 
     validates :sid, presence: {strict: true}
 
     def queue!(options={})
       return if self.queued_at.present? && self.bkid.present?
+      raise ActiveRecord::RecordInvalid, "Can't queue unless valid." unless self.valid?
+      raise AlreadyProcessed, "Processed at #{self.processed_at}" if self.processed_at
+
+      at = options.delete(:at)
+      now = Time.zone.now
+
+      self.queued_at = now
+      self.run_at = case
+                    when at.present?
+                      # this is rudimentary, add error handling
+                      options[:delay] ||= at.to_i - now.to_i
+                      at
+                    when options[:delay].present?
+                      now + options[:delay].seconds
+                    end
+
+      @_insert_options = options
 
       self.save!
+    end
 
-      case
-      when options[:at].present?
-        # this is rudimentary, add error handling
-        options[:delay] ||= options[:at].to_i - Time.zone.now.to_i
-        update_column :run_at, options[:at]
-        options.delete(:at)
-      when options[:delay].present?
-        update_column :run_at, Time.zone.now + options[:delay].seconds
-      end
+    def requeue!(options={})
+      self.delete!
+      self.bkid, self.queued_at = nil, nil
+
+      self.queue! options
+    end
 
-      insert!(options)
+    def will_insert?
+      @_insert_options.is_a? Hash
     end
 
     # tube: backburner.worker.queue.backburner-jobs
@@ -98,22 +115,24 @@ module Postburner
           return
         end
 
-        self.log!('START')
+        self.log!("START (bkid #{self.bkid})")
 
-        self.perform(args)
+        begin
+          self.perform(args)
+        rescue Exception => exception
+          self.persist_metadata!
+          self.log! '[Postburner] Exception raised during perform prevented completion.'
+          raise exception
+        end
 
-        self.log!('DONE')
+        self.log!("DONE (bkid #{self.bkid})")
 
         begin
           now = Time.zone.now
           _duration =  (now - self.processing_at) * 1000 rescue nil
-          self.update_columns(
+          persist_metadata!(
             processed_at: now,
             duration:     _duration,
-            errata:       self.errata,
-            error_count:  self.errata.length,
-            logs:         self.logs,
-            log_count:    self.logs.length,
           )
         rescue Exception => e
           self.log_exception!(e)
@@ -123,7 +142,6 @@ module Postburner
 
       rescue Exception => exception
         self.log_exception!(exception)
-        self.log! '[Postburner] Exception raised during perform prevented completion.'
         raise exception
       end
 
@@ -148,12 +166,9 @@ module Postburner
     end
 
     def remove!
-      if self.beanstalk_job
-        self.delete!
-        self.update_column(:removed_at, Time.zone.now)
-      else
-        false
-      end
+      return if self.removed_at
+      self.delete!
+      self.update_column(:removed_at, Time.zone.now)
     end
 
     def beanstalk_job
@@ -174,6 +189,7 @@ module Postburner
       self.errata << [
         Time.zone.now,
         {
+          bkid:       self.bkid,
           class:      exception.class,
           message:    exception.message,
           backtrace:  exception.backtrace,
@@ -191,34 +207,67 @@ module Postburner
       options[:level] = :error unless LOG_LEVELS.member?(options[:level])
 
       self.logs << [
-        Time.zone.now,
-        options[:level],
-        message,
+        Time.zone.now, # time
+        {
+          bkid:     self.bkid,
+          level:    options[:level], # level
+          message:  message, # message
+          elapsed:  self.elapsed_ms, # ms from start
+        }
       ]
     end
 
+    # ms from attempting_at
+    #
+    def elapsed_ms
+      return unless self.attempting_at
+      (Time.zone.now - self.attempting_at) * 1000
+    end
+
     def log!(message, options={})
       self.log(message, options)
       self.update_column :logs, self.logs
     end
 
+    def intended_at
+      self.run_at ? self.run_at : self.queued_at
+    end
+
+    class AlreadyProcessed < StandardError; end
+
     private
 
+    def persist_metadata!(data={})
+      self.update_columns({
+        errata:       self.errata,
+        error_count:  self.errata.length,
+        logs:         self.logs,
+        log_count:    self.logs.length,
+      }.merge(data))
+    end
+
+    def insert_if_queued!
+      return unless self.will_insert?
+      insert!(@_insert_options)
+    end
+
     def insert!(options={})
-      response = Backburner::Worker.enqueue(
-        Postburner::Job,
-        self.id,
-        options
-      )
+      response = nil
+
+      Job.transaction do
+        response = Backburner::Worker.enqueue(
+          Postburner::Job,
+          self.id,
+          options
+        )
+
+        persist_metadata!(
+          bkid: response[:id],
+        )
+      end
 
       self.log("QUEUED: #{response}")
 
-      update_columns(
-        queued_at:  Time.zone.now,
-        bkid:       response[:id],
-        logs:       self.logs,
-      )
-
       response
     end
 
@@ -226,14 +275,10 @@ module Postburner
       now = Time.zone.now
       self.attempts << now
       self.attempting_at ||= now
-      self.lag ||= (self.attempting_at - self.intended_at) * 1000
+      self.lag ||= (self.attempting_at - self.intended_at) * 1000 rescue nil
       now
     end
 
-    def intended_at
-      self.run_at ? self.run_at : self.queued_at
-    end
-
     def ensure_sid!
       self.sid ||= SecureRandom.uuid
     end

data/lib/postburner/version.rb

@@ -1,3 +1,3 @@
 module Postburner
-  VERSION = '0.5.0'
+  VERSION = '0.6.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postburner
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Matt Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails