lev 5.0.0 → 6.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGNhMzZiZWRhNDllMzMwYjBhMmFkZTQ5YzJiYWNkNjYxMzQ4NmMzMg==
+    YmVhODFiNzc4NGRkZTAxYTg5MmVjZjg5OWRlMDVlNDUwMmVlNDIyYg==
   data.tar.gz: !binary |-
-    NTdmM2U2NWY0YjlkNDM3N2ViZWU5NzQ3NmYyYjkyZDVkZDUwMzMyNw==
+    ZDU5YjNkMDRjYmE1N2VkYzQ1Njg5OWZjMDJlNzgyMjlmZDFiMzU1Yg==
 SHA512:
   metadata.gz: !binary |-
-    NDMyM2UzNzY2MDQxODlkNmNlMWJhOTRjYjJkZmI2OWE3ZWM1ZDAyZDU1OWZk
-    ZmRhOWVjZWI5MGNhYWJmNWViMzJlNzlmMTQ0ZjVlMDNjODA1YzJkMDYwMzNj
-    OTc4NGVmYzI2ZDUzOWUwNTVmM2E5NzMyOGQ0MjQ5MWMzMTJhNjM=
+    NDRlMDY4Y2NjMTg2OWJlNjVjZDVjNWVmYzRlNDRiOGYyZGEwNzFmYWUwNWRm
+    YWEwODRjZjcxNTU3ZjExNTYxYWZkYzI4NDRmMjUzZDk3ZWMyN2UzMjE4MDA1
+    NDU0YmI1MDljNGNkZDlhMTI5YWUzN2ZkMGZiMjYzMjVhMzhhMzk=
   data.tar.gz: !binary |-
-    M2I4ODI3Mjg0MWJiYzYyZGM0ZDA0OTVmMmJhOTZmMjk0NGIxMDA5ZjUxNTlm
-    NmI2ZmZhMTFmMWUyMDU0NzUwMjFlOGRkYjVhNWE3YjBhNTBkYmM0MmIxYTI0
-    ZDAzYzMyNWYyOTExNjA1NTJjMTJhM2RlZjY3YzNhNzU4NzdkZGE=
+    NzJjOGNjZmEyZDJmYWQxY2U1Y2I5Yjc5Y2I3NzIxYzE3YjAxNDQ1ZjMzMjdj
+    MTJlNzRkN2U1MGU4MDM2NWRlMGYzNTlkZWI5N2UyZjc4M2RlODAxYmZmZjFj
+    YTc5MjExNjdhMzM2NWMyYTliYjNhZDA5N2RlM2Q3MDk1MjFhZTc=

data/README.md

@@ -100,10 +100,7 @@ end
 
 Additionally, see below for a discussion on how to transfer errors from ActiveRecord models.
 
-Any `StandardError` raised within a routine will be caught and transformed into a fatal error with `:kind` set to `:exception`.  The caller of this routine can choose to reraise this exception by calling `reraise_exception!` on the returned errors object:
-
-    result = MyRoutine.call(42)
-    result.errors.reraise_exception! # does nothing if there were no exception errors
+If an exception is raised in a routine, it will bubble out.  It will also fail the job status and add information about the exception to the job error list.
 
 Relatedly, a convenience method is provided if the caller wants to raise an exception if there were any errors returned (whether or not they themselves were caused by an exception)
 

data/lib/lev/background_job.rb

@@ -23,7 +23,7 @@ module Lev
     def initialize(attrs = {})
       @id = attrs[:id] || attrs['id'] || SecureRandom.uuid
       @status = attrs[:status] || attrs['status'] || STATE_UNKNOWN
-      @progress = attrs[:progress] || attrs['progress'] || set_progress(0)
+      @progress = attrs[:progress] || attrs['progress'] || 0
       @errors = attrs[:errors] || attrs['errors'] || []
 
       set({ id: id,
@@ -35,8 +35,8 @@ module Lev
     def self.find(id)
       attrs = { id: id }
 
-      if job = store.fetch(job_key(id))
-        attrs.merge!(JSON.parse(job))
+      if job = fetch_and_parse(job_key(id))
+        attrs.merge!(job)
       else
         attrs.merge!(status: STATE_UNKNOWN)
       end
@@ -59,17 +59,22 @@ module Lev
       progress
     end
 
-    STATES.each do |state|
+    (STATES - [STATE_COMPLETED]).each do |state|
       define_method("#{state}!") do
         set(status: state)
       end
     end
 
+    def completed!
+      set({status: STATE_COMPLETED, progress: 1.0})
+    end
+
     def add_error(error, options = { })
       options = { is_fatal: false }.merge(options)
       @errors << { is_fatal: options[:is_fatal],
                    code: error.code,
-                   message: error.message }
+                   message: error.message,
+                   data: error.data }
       set(errors: @errors)
     end
 
@@ -103,6 +108,7 @@ module Lev
     RESERVED_KEYS = [:id, :status, :progress, :errors]
 
     def set(incoming_hash)
+      incoming_hash = incoming_hash.stringify_keys
       incoming_hash = stored.merge(incoming_hash)
       incoming_hash.each { |k, v| instance_variable_set("@#{k}", v) }
       self.class.store.write(job_key, incoming_hash.to_json)
@@ -113,22 +119,25 @@ module Lev
       Lev.configuration.job_store
     end
 
+    def self.fetch_and_parse(job_key)
+      fetched = store.fetch(job_key)
+      return nil if fetched.nil?
+      JSON.parse(fetched).stringify_keys!
+    end
+
     def self.job_ids
       store.fetch(job_key('lev_job_ids')) || []
     end
 
     def stored
-      if found = self.class.store.fetch(job_key)
-        JSON.parse(found)
-      else
-        {}
-      end
+      self.class.fetch_and_parse(job_key) || {}
     end
 
     def track_job_id
       ids = self.class.job_ids
+      return if ids.include?(@id)
       ids << @id
-      self.class.store.write(self.class.job_key('lev_job_ids'), ids.uniq)
+      self.class.store.write(self.class.job_key('lev_job_ids'), ids)
     end
 
     def job_key

data/lib/lev/error_transferer.rb

@@ -7,11 +7,11 @@ module Lev
       when ActiveRecord::Base, Lev::Paramifier
         source.errors.each_with_type_and_message do |attribute, type, message|
           target_routine.nonfatal_error(
-            code: type, 
+            code: type,
             data: {
               model: source,
               attribute: attribute
-            }, 
+            },
             kind: :activerecord,
             message: message,
             offending_inputs: input_mapper.map(attribute)
@@ -38,4 +38,4 @@ module Lev
 
   end
 
-end
+end

data/lib/lev/errors.rb

@@ -22,7 +22,8 @@ module Lev
         routine_job.failed!
 
         if raise_fatal_errors
-          raise StandardError, args.to_a.map { |i| i.join(' ') }.join(' - ')
+          # Use special FatalError type so Routine doesn't re-add job errors
+          raise Lev::FatalError, args.to_a.map { |i| i.join(' ') }.join(' - ')
         else
           throw :fatal_errors_encountered
         end

data/lib/lev/exceptions.rb

@@ -3,3 +3,4 @@ class Lev::SecurityTransgression < StandardError; end
 class Lev::AlgorithmError < StandardError; end
 class Lev::AbstractMethodCalled < StandardError; end
 class Lev::IllegalArgument < StandardError; end
+class Lev::FatalError < StandardError; end

data/lib/lev/routine.rb

@@ -269,9 +269,9 @@ module Lev
 
       job.working!
 
-      in_transaction do
-        catch :fatal_errors_encountered do
-          begin
+      begin
+        in_transaction do
+          catch :fatal_errors_encountered do
             if self.class.delegates_to
               run(self.class.delegates_to, *args, &block)
             else
@@ -279,10 +279,22 @@ module Lev
             end
           end
         end
-      end
 
-      @after_transaction_blocks.each do |block|
-        block.call
+        @after_transaction_blocks.each do |block|
+          block.call
+        end
+      rescue Exception => e
+        # Let exceptions escape but make sure to note the error in the job
+        # if not already done
+        if !e.is_a?(Lev::FatalError)
+          error = Error.new(code: :exception,
+                            message: e.message,
+                            data: e.backtrace.first)
+          job.add_error(error, is_fatal: true)
+          job.failed!
+        end
+
+        raise e
       end
 
       job.completed! if !errors?

data/lib/lev/version.rb

@@ -1,3 +1,3 @@
 module Lev
-  VERSION = "5.0.0"
+  VERSION = "6.0.0"
 end

data/spec/active_job_routines_spec.rb

@@ -33,4 +33,44 @@ RSpec.describe 'ActiveJob routines' do
       expect(Lev::BackgroundJob.send(:job_ids)).to eq([job_id1])
     end
   end
+
+  it 'does not duplicate BackgroundJobs in `all`' do
+    # Previous track_job_id implementation changed string objects in job_ids
+    # resulting in duplicate objects in `all`
+    Lev.configuration.job_store.clear
+    LaterRoutine.perform_later
+    expect(Lev::BackgroundJob.all.count).to eq 1
+  end
+
+  context 'exception raised' do
+    before { ::ActiveJob::Base.queue_adapter = :inline }
+    after { ::ActiveJob::Base.queue_adapter = :test }
+
+    class ExceptionalRoutine
+      lev_routine
+
+      protected
+      def exec
+        raise TypeError, 'howdy there'
+      end
+    end
+
+    it 'lets exception escape, job is failed and has error details' do
+      Lev.configuration.job_store.clear
+
+      expect{
+        ExceptionalRoutine.perform_later
+      }.to raise_error(TypeError)
+
+      job = Lev::BackgroundJob.all.first
+
+      expect(job.status).to eq Lev::BackgroundJob::STATE_FAILED
+
+      error = job.errors.first
+
+      expect(error["code"]).to eq "exception"
+      expect(error["message"]).to eq "howdy there"
+      expect(error["data"]).to be_a String
+    end
+  end
 end

data/spec/background_job_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Lev::BackgroundJob do
+
+  context 'delayed routine' do
+    class DelayedRoutine
+      lev_routine
+      protected
+      def exec; end
+    end
+
+    subject(:job) { described_class.all.last }
+
+    before do
+      Lev.configuration.job_store.clear
+      allow(SecureRandom).to receive(:uuid) { '123abc' }
+      DelayedRoutine.perform_later
+    end
+
+    it 'behaves as a nice ruby object' do
+      expect(job.id).to eq('123abc')
+      expect(job.status).to eq(Lev::BackgroundJob::STATE_QUEUED)
+      expect(job.progress).to eq(0.0)
+    end
+
+    it 'is unknown when not found' do
+      foo = described_class.find('noooooo')
+      expect(foo.status).to eq(Lev::BackgroundJob::STATE_UNKNOWN)
+    end
+
+    it 'uses as_json' do
+      json = job.as_json
+
+      expect(json).to eq({
+        'id' => '123abc',
+        'status' => Lev::BackgroundJob::STATE_QUEUED,
+        'progress' => 0.0,
+        'errors' => []
+      })
+
+      job.save(foo: :bar)
+      json = job.as_json
+
+      expect(json['foo']).to eq('bar')
+    end
+  end
+
+  it 'sets progress to 100% when completed' do
+    job = Lev::BackgroundJob.new
+    job.completed!
+    expect(job.progress).to eq 1
+  end
+
+end

data/spec/statused_routines_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe 'Statused Routines' do
         id = StatusedRoutine.perform_later
         job = Lev::BackgroundJob.find(id)
         expect(job.status).to eq(Lev::BackgroundJob::STATE_COMPLETED)
-        expect(job.progress).to eq(0.9)
+        expect(job.progress).to eq(1.0)
       end
     end
   end
@@ -51,7 +51,8 @@ RSpec.describe 'Statused Routines' do
       job.add_error(errors)
       expect(job.errors).to eq([{ is_fatal: false,
                                      code: 'bad',
-                                     message: 'awful' }])
+                                     message: 'awful',
+                                     data: nil }])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lev
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -240,11 +240,10 @@ files:
 - lib/lev/utilities.rb
 - lib/lev/version.rb
 - spec/active_job_routines_spec.rb
+- spec/background_job_spec.rb
 - spec/create_sprocket_spec.rb
 - spec/deep_merge_spec.rb
 - spec/delegates_to_spec.rb
-- spec/errors_spec.rb
-- spec/lev/status_spec.rb
 - spec/outputs_spec.rb
 - spec/paramify_handler_spec.rb
 - spec/routine_spec.rb
@@ -286,11 +285,10 @@ specification_version: 4
 summary: Ride the rails but don't touch them.
 test_files:
 - spec/active_job_routines_spec.rb
+- spec/background_job_spec.rb
 - spec/create_sprocket_spec.rb
 - spec/deep_merge_spec.rb
 - spec/delegates_to_spec.rb
-- spec/errors_spec.rb
-- spec/lev/status_spec.rb
 - spec/outputs_spec.rb
 - spec/paramify_handler_spec.rb
 - spec/routine_spec.rb

data/spec/errors_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe Lev::Errors do
-
-end

data/spec/lev/status_spec.rb

@@ -1,44 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Lev::BackgroundJob do
-  class DelayedRoutine
-    lev_routine
-    protected
-    def exec; end
-  end
-
-  subject(:job) { described_class.all.last }
-
-  before do
-    Lev.configuration.job_store.clear
-    allow(SecureRandom).to receive(:uuid) { '123abc' }
-    DelayedRoutine.perform_later
-  end
-
-  it 'behaves as a nice ruby object' do
-    expect(job.id).to eq('123abc')
-    expect(job.status).to eq(Lev::BackgroundJob::STATE_QUEUED)
-    expect(job.progress).to eq(0.0)
-  end
-
-  it 'is unknown when not found' do
-    foo = described_class.find('noooooo')
-    expect(foo.status).to eq(Lev::BackgroundJob::STATE_UNKNOWN)
-  end
-
-  it 'uses as_json' do
-    json = job.as_json
-
-    expect(json).to eq({
-      'id' => '123abc',
-      'status' => Lev::BackgroundJob::STATE_QUEUED,
-      'progress' => 0.0,
-      'errors' => []
-    })
-
-    job.save(foo: :bar)
-    json = job.as_json
-
-    expect(json['foo']).to eq('bar')
-  end
-end