lyber-core 7.6.0 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ed0c812c1f67354df3b5a866533d133505b97a009fd564a28bd7b66fda7e4f
-  data.tar.gz: 2fd1a9458a2cb649c28ec0b9c7fe3f32486aa9ad55212be9dbd470fd06096f8c
+  metadata.gz: 06b40bbb06d992835959637eaab8a0319a8ea093cc9b8c883b39a6a0df6a1e70
+  data.tar.gz: d2ca21bec9e898cf98f72db0c21637d6f33fd48bc8e69fcc571d9b621679e802
 SHA512:
-  metadata.gz: a18f87bf3bdd09a609698b64e27f3e1093d90c0f8d1bb81ae94a4576002c0a14cc669c606c841a32061796a309610c0242f07173c58c50518565477c9af2959d
-  data.tar.gz: 10e08bd6f4804d7caa15fdf24adbc2fe73b6752f626458bebaeb42a5c2258e3205cf6a2038e2b6ffaaafd43c93f10cd1ee2af094f139785573d881d9a70c7c7e
+  metadata.gz: 796bb15551fa5bd9995237781b73dd78ff81ea0d9db36afa92ad7ebd4aa56a2552cc436d5759ca4d9c95ce66fb3a6e4cef3098ef3ec227e2430ddd93517999d0
+  data.tar.gz: a84a27a79cc73bd1e368352eae2a4412acc35d9d7951db5c61cfcf2e61b1760e641a7c8d7529acc5805df79d2a78830f35f91bc919fdcd18f332ea2302893b79

data/README.md

@@ -26,9 +26,7 @@ module Robots
         def perform_work
           cocina_object.shelve
         end
-
       end
-
     end
   end
 end
@@ -59,9 +57,27 @@ module Robots
 #           return LyberCore::ReturnState.new(status: 'skipped', note: 'some custom note to pass back to workflow') # set the final state to skipped with a custom note
           end
         end
-
       end
+    end
+  end
+end
+```
+
+By default, a robot will not retry. To enable retries for specific errors:
+```ruby
+module Robots
+  module DorRepo
+    module Accession
+
+      class Shelve < LyberCore::Robot
+        def initialize
+          super('accessionWF', 'shelve', retriable_exceptions: [Dor::Services::Client::Error])
+        end
 
+        def perform_work
+          cocina_object.shelve
+        end
+      end
     end
   end
 end

data/lib/lyber_core/robot.rb

@@ -3,19 +3,32 @@
 module LyberCore
   # Base class for all robots.
   # Subclasses should implement the #perform_work method.
+  # To enable retries provide the retriable exceptions in the initializer.
   class Robot
     include Sidekiq::Job
-    sidekiq_options retry: 0
+    # Setting sidekiq_options here won't work.
+    # Instead pass options when enqueueing the job with Sidekiq::Client.push. (Currently in Workflow's QueueService.)
+
+    sidekiq_retries_exhausted do |job, ex|
+      # When all the retries are exhausted, update the workflow to error.
+      robot = job['class'].constantize.new
+      workflow = Workflow.new(workflow_service: WorkflowClientFactory.build,
+                              druid: job['args'].first,
+                              workflow_name: robot.workflow_name,
+                              process: robot.process)
+      workflow.error!(ex.message, Socket.gethostname)
+    end
 
-    attr_reader :workflow_name, :process, :druid
+    attr_reader :workflow_name, :process, :druid, :retriable_exceptions
     attr_accessor :check_queued_status
 
     delegate :lane_id, to: :workflow
 
-    def initialize(workflow_name, process, check_queued_status: true)
+    def initialize(workflow_name, process, check_queued_status: true, retriable_exceptions: [])
       @workflow_name = workflow_name
       @process = process
       @check_queued_status = check_queued_status
+      @retriable_exceptions = retriable_exceptions
     end
 
     def workflow_service
@@ -43,7 +56,7 @@ module LyberCore
       Honeybadger.context(druid:, process:, workflow_name:)
 
       logger.info "#{druid} processing #{process} (#{workflow_name})"
-      return unless check_item_queued?
+      return unless check_item_queued_or_retry?
 
       # this is the default note to pass back to workflow service,
       # but it can be overriden by a robot that uses the Robots::ReturnState
@@ -73,8 +86,13 @@ module LyberCore
       workflow.complete!(workflow_state, elapsed, note) unless workflow_state == 'noop'
 
       logger.info "Finished #{druid} in #{format('%0.4f', elapsed)}s"
+    rescue *retriable_exceptions => e
+      handle_error(e)
+      workflow.retrying!
+      raise
     rescue StandardError => e
       handle_error(e)
+      workflow.error!(e.message, Socket.gethostname)
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
@@ -91,16 +109,10 @@ module LyberCore
 
     private
 
-    # rubocop:disable Metrics/AbcSize
     def handle_error(error)
       Honeybadger.notify(error)
       logger.error "#{error.message}\n#{error.backtrace.join("\n")}"
-      workflow.error!(error.message, Socket.gethostname)
-    rescue StandardError => e
-      logger.error "Cannot set #{druid} to status='error'\n#{e.message}\n#{e.backtrace.join("\n")}"
-      raise e # send exception to Sidekiq failed queue
     end
-    # rubocop:enable Metrics/AbcSize
 
     def workflow
       @workflow ||= Workflow.new(workflow_service:,
@@ -109,10 +121,11 @@ module LyberCore
                                  process:)
     end
 
-    def check_item_queued?
+    def check_item_queued_or_retry?
       return true unless check_queued_status
 
       return true if /queued/i.match?(workflow.status)
+      return true if /retrying/i.match?(workflow.status)
 
       msg = "Item #{druid} is not queued for #{process} (#{workflow_name}), " \
             "but has status of '#{workflow.status}'. Will skip processing"

data/lib/lyber_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LyberCore
-  VERSION = '7.6.0'
+  VERSION = '7.7.0'
 end

data/lib/lyber_core/workflow.rb

@@ -28,6 +28,15 @@ module LyberCore
                                      note:)
     end
 
+    def retrying!
+      workflow_service.update_status(druid:,
+                                     workflow: workflow_name,
+                                     process:,
+                                     status: 'retrying',
+                                     elapsed: 1.0,
+                                     note: nil)
+    end
+
     def error!(error_msg, error_text)
       workflow_service.update_error_status(druid:,
                                            workflow: workflow_name,

data/lib/lyber_core/workflow_client_factory.rb

@@ -3,7 +3,7 @@
 module LyberCore
   # Factory for creating a workflow client
   class WorkflowClientFactory
-    def self.build(logger:)
+    def self.build(logger: Sidekiq.logger)
       Dor::Workflow::Client.new(url: Settings.workflow.url, logger:, timeout: Settings.workflow.timeout)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyber-core
 version: !ruby/object:Gem::Version
-  version: 7.6.0
+  version: 7.7.0
 platform: ruby
 authors:
 - Alpana Pande
@@ -16,7 +16,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,30 +50,30 @@ dependencies:
   name: dor-services-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dor-workflow-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: '7.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: '7.6'
 - !ruby/object:Gem::Dependency
   name: druid-tools
   requirement: !ruby/object:Gem::Requirement
@@ -265,7 +265,8 @@ files:
 homepage: http://github.com/sul-dlss/lyber-core
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -281,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Core services used by the SUL Digital Library