postburner 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffbffc2cebbe2e83bfff21178b71d0b205756cd6ef05c6dc30c8029d073c70d7
-  data.tar.gz: 68136a8de901340817dcd60e0fbd3b6794eb6dea2f8da386af138576dbba6334
+  metadata.gz: f0c2a65b18596dafa8809d07924e2274f7adc05ce971fea1b82143c7132f2929
+  data.tar.gz: e3000b8fa490aec4fb1c8b49c54fe7ee78613b3e7e3849c2270d7a7dd01adecd
 SHA512:
-  metadata.gz: 319ebb136625b266efe9189c8f6114ee7153ad18503b6d38343609a8bcb62dc3ea814b4b22e60f685f90f68957a2c9647ff3c958e26983796fc2c40bb8cb981c
-  data.tar.gz: 0fb16c1e08994dc7676b1546dc9d492c51243a9bcf8ffa9a2367b0a4274ecd806c322f00b6304a637fbfa20ddb2bc0872bd5ccdb357bba1d518f60f589edbf46
+  metadata.gz: 87cb7aec3924346ab43b93f5886aebfb1b138a36b199eb3e10032404a23b07774c287cb96ed8c4889feabde1106aba63d23d6429cead43f3eec8211f257d6baa
+  data.tar.gz: 94e32291c4f00db869a630adeea7e44abb92c4938e2314fc5e46ea487b874acc4a74b80771bd8db8944f3a7c98e06101ef90a36f8da5bf72d7fecc82fbd14c3c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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

@@ -100,20 +100,22 @@ module Postburner
 
         self.log!('START')
 
-        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')
 
         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 +125,6 @@ module Postburner
 
       rescue Exception => exception
         self.log_exception!(exception)
-        self.log! '[Postburner] Exception raised during perform prevented completion.'
         raise exception
       end
 
@@ -191,12 +192,22 @@ module Postburner
       options[:level] = :error unless LOG_LEVELS.member?(options[:level])
 
       self.logs << [
-        Time.zone.now,
-        options[:level],
-        message,
+        Time.zone.now, # time
+        {
+          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
@@ -204,6 +215,16 @@ module Postburner
 
     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!(options={})
       response = Backburner::Worker.enqueue(
         Postburner::Job,
@@ -213,10 +234,9 @@ module Postburner
 
       self.log("QUEUED: #{response}")
 
-      update_columns(
+      persist_metadata!(
         queued_at:  Time.zone.now,
         bkid:       response[:id],
-        logs:       self.logs,
       )
 
       response

data/lib/postburner/version.rb

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

metadata

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