startback-jobs 0.15.3 → 0.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a947c479c9fe7c096f69903b5aa7e2bcd869d1db2541c28202e3a85153d8b510
-  data.tar.gz: 196e2ba676c261e6b97e8204d4ca3590514f8863a6c4e9acbd4b0b10c2a63b5e
+  metadata.gz: dea8bb6951ccc73ca5eafdfea151129905ab26dfea75d1ea9dfc824204a6131f
+  data.tar.gz: 8a2e8ae265595a674bd8c2afcf43619df1bba338a0cde5900fe333ecee874013
 SHA512:
-  metadata.gz: 9fe2a92f2cbec6ea8e30a7378cbb14c5f5f17ef462613c9098aa152ee561d07fe33bf0ebaea37668526f20e5bf9cb03eb8bcefafc6035905aa19a14b443634bd
-  data.tar.gz: b1d7f4293b5fdb6bafc012ffc413edb91722c2ec688a119e0c0f5372635e211164b3599bcb035e3c3c84b9a8acc6086efb8c48e89d514a1206e1f074032c4fcc
+  metadata.gz: 627a7f6a0ddb28fe9a08120fbd2cf8240a29811fc8ae35151d65501a3f563c82fb265c18ad0f22d514ad5f8c6e2cd6ffb5c51c3ac6d212271ab3cdc4d725a126
+  data.tar.gz: 33362ef7e67b2f176f489e40aeb6a0b62ef90b231fb5bf079cef4ab243e55e04ebf72916dc2b7ba5801791a048b5c56382661ea229fa103abd6d6a2893d5007b

data/lib/startback/jobs/model/job.rb

@@ -18,6 +18,14 @@ module Startback
           !ready?
         end
 
+        def failed?
+          !!self[:hasFailed]
+        end
+
+        def succeeded?
+          !failed?
+        end
+
         def expired?
           self.expiredAt && self.expiredAt < Time.now
         end

data/lib/startback/jobs/operation/create_job.rb

@@ -15,6 +15,7 @@ module Startback
           strategy: 'NotReady',
           strategyOptions: {},
           expiresAt: nil,
+          hasFailed: false,
           refreshFreq: nil,
           refreshedAt: nil,
           consumeMax: nil,

data/lib/startback/jobs/operation/run_job.rb

@@ -14,12 +14,16 @@ module Startback
         job_class = ::Kernel.const_get(@job.op_class)
         job_input = @job.op_input
 
-        op_result = with_context(job_context) do
-          run job_class.new(job_input)
+        has_failed, op_result = with_context(job_context) do
+          op_result = run job_class.new(job_input)
+          [false, op_result]
+        rescue => err
+          [true, error_to_result(err) ]
         end
 
         services.update_job!(input, {
           opResult: op_result,
+          hasFailed: has_failed,
           isReady: true,
           strategy: 'Embedded',
         })
@@ -27,6 +31,14 @@ module Startback
         op_result
       end
 
+      def error_to_result(err)
+        {
+          errClass: err.class.name.to_s,
+          message: err.message,
+          backtrace: err.backtrace
+        }
+      end
+
       emits(Event::JobRan) do
         { id: @job.id }
       end

data/lib/startback/jobs/support/job_result/embedded.rb

@@ -4,12 +4,25 @@ module Startback
       class JobResult
         class Embedded < JobResult
 
+          # Non HTTP-standard special success code to
+          # indicate a job failure...
+          FAILURE_STATUS_CODE = 272
+
           def api_serve(api)
-            [
-              200,
-              {"Content-Type" => "application/json"},
-              [job.opResult.to_json]
-            ]
+            if job.failed?
+              payload = job.opResult.delete_if{|k| k == :backtrace }
+              [
+                FAILURE_STATUS_CODE,
+                {"Content-Type" => "application/json"},
+                [payload.to_json]
+              ]
+            else
+              [
+                200,
+                {"Content-Type" => "application/json"},
+                [job.opResult.to_json]
+              ]
+            end
           end
 
         end # class Embedded

data/lib/startback/jobs/support/job_result.rb

@@ -11,10 +11,10 @@ module Startback
         attr_reader :job
 
         def self.for(job)
-          unless job.is_ready?
-            JobResult::NotReady.new(job)
-          else
+          if job.is_ready?
             JobResult.const_get(job.strategy).new(job)
+          else
+            JobResult::NotReady.new(job)
           end
         end
 

data/lib/startback/jobs.fio

@@ -11,21 +11,22 @@ Job.Ref = {
 Job.Strategy = String(s | %w{Embedded NotReady Redirect}.include? s )
 
 Job.Full = {
-  id              : String
-  opClass         : ClassName
-  opInput         : DumpableHash
-  opContext       : DumpableHash
-  opResult        : .
-  isReady         : Boolean
-  strategy        : Job.Strategy
-  strategyOptions : DumpableHash
-  expiresAt       : DateTime|Time|Nil
-  refreshFreq     : String|Nil
-  refreshedAt     : DateTime|Time|Nil
-  consumeMax      : Integer|Nil
-  consumeCount    : Integer|Nil
-  createdAt       : DateTime|Time|Nil
-  createdBy       : String|Nil
+  id              :  String
+  opClass         :  ClassName
+  opInput         :  DumpableHash
+  opContext       :  DumpableHash
+  opResult        :  .
+  isReady         :  Boolean
+  hasFailed       :? Boolean
+  strategy        :  Job.Strategy
+  strategyOptions :  DumpableHash
+  expiresAt       :  DateTime|Time|Nil
+  refreshFreq     :  String|Nil
+  refreshedAt     :  DateTime|Time|Nil
+  consumeMax      :  Integer|Nil
+  consumeCount    :  Integer|Nil
+  createdAt       :  DateTime|Time|Nil
+  createdBy       :  String|Nil
 }
 
 Job.CreationRequest = {

data/spec/spec_helper.rb

@@ -15,10 +15,11 @@ RSpec.configure do |c|
       id: 'abcdef',
       isReady: false,
       opClass: 'CowSay',
-      opInput: { 'message' => 'Hello !!' },
+      opInput: { 'message' => 'Hello !!', 'crash' => false },
       opContext: {},
       opResult: nil,
       strategy: 'NotReady',
+      hasFailed: false,
       strategyOptions: {},
       expiresAt: nil,
       refreshFreq: nil,
@@ -37,6 +38,7 @@ class CowSay < Startback::Operation
   end
 
   def call
+    raise Startback::Errors::InternalServerError, "Something bad happened" if input.crash
     input.message
   end
 end

data/spec/unit/api/test_job_result.rb

@@ -64,10 +64,11 @@ module Startback
         end
       end
 
-      context 'when the job is ready' do
+      context 'when the job is ready and successful' do
         let(:override) do
           {
             isReady: true,
+            hasFailed: false,
             opResult: { "foo" => 'Hello!!' },
             strategy: 'Embedded'
           }
@@ -80,6 +81,30 @@ module Startback
         end
       end
 
+      context 'when the job failed' do
+        let(:override) do
+          {
+            isReady: true,
+            hasFailed: true,
+            opResult: {
+              errClass: 'AClass',
+              message: 'Something bad happened',
+              backtrace: ['private information'],
+            },
+            strategy: 'Embedded'
+          }
+        end
+
+        it 'works fine' do
+          res = subject
+          expect(res.status).to eql(272)
+          decoded = JSON.parse(res.body)
+          expect(decoded.keys).to eql(['errClass', 'message'])
+          expect(decoded['errClass']).to eql('AClass')
+          expect(decoded['message']).to eql('Something bad happened')
+        end
+      end
+
       context 'when the job is ready and has to redirect' do
         let(:override) do
           {

data/spec/unit/model/test_job.rb

@@ -17,6 +17,18 @@ module Startback
           expect(job[:id]).to eql('abcdef')
           expect(job.ready?).to eql(false)
         end
+
+        it 'recognizes failed jobs' do
+          job = Job.full(a_job_data.merge(hasFailed: true))
+          expect(job.id).to eql('abcdef')
+          expect(job.failed?).to eql(true)
+        end
+
+        it 'stays compatible with jobs without the hasFailed flag' do
+          job = Job.full(a_job_data.delete_if{|k| k == :hasFailed })
+          expect(job.id).to eql('abcdef')
+          expect(job.failed?).to eql(false)
+        end
       end
     end
   end

data/spec/unit/operation/test_run_job.rb

@@ -4,10 +4,6 @@ module Startback
   module Jobs
     describe RunJob do
 
-      let(:job_data) do
-        a_job_data
-      end
-
       let(:jobs_relvar) do
         Bmg.mutable([job_data])
       end
@@ -22,16 +18,42 @@ module Startback
         }).call
       end
 
-      it 'runs the job' do
-        expect(subject).to eql('Hello !!')
+      describe 'When job runs successfuly' do
+
+        let(:job_data) do
+          a_job_data
+        end
+
+        it 'runs the job' do
+          expect(subject).to eql('Hello !!')
+        end
+
+        it 'updates the job' do
+          subject
+          job_info = jobs_relvar.one
+          expect(job_info[:opResult]).to eql('Hello !!')
+          expect(job_info[:isReady]).to eql(true)
+        end
       end
 
-      it 'updates the job' do
-        subject
-        job_info = jobs_relvar.one
-        expect(job_info[:opResult]).to eql('Hello !!')
-        expect(job_info[:isReady]).to eql(true)
+      describe 'When job fails' do
+
+        let(:job_data) do
+          a_job_data({
+            opInput: { 'crash' => true },
+          })
+        end
+
+        it 'updates the job' do
+          subject
+          job_info = jobs_relvar.one
+          expect(job_info[:isReady]).to eql(true)
+          expect(job_info[:opResult][:errClass]).to eql('Startback::Errors::InternalServerError')
+          expect(job_info[:opResult][:message]).to eql('Something bad happened')
+          expect(job_info[:opResult][:backtrace]).to be_a(Array)
+        end
       end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback-jobs
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.15.5
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-30 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -118,14 +118,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.3
+        version: 0.15.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.3
+        version: 0.15.5
 description: Asynchronous jobs on top of the Startback framework
 email: blambeau@gmail.com
 executables: []
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Asynchronous jobs on top of Startback