lyber-core 7.6.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ed0c812c1f67354df3b5a866533d133505b97a009fd564a28bd7b66fda7e4f
-  data.tar.gz: 2fd1a9458a2cb649c28ec0b9c7fe3f32486aa9ad55212be9dbd470fd06096f8c
+  metadata.gz: 3a6235a3ac867ec3442859c157a359fe0b70456df20395331a1ef37c7a09bb64
+  data.tar.gz: 9985e87113e78f47f359568320eb66b4c7fb5fe052972e6b9e1d87248bab3dc9
 SHA512:
-  metadata.gz: a18f87bf3bdd09a609698b64e27f3e1093d90c0f8d1bb81ae94a4576002c0a14cc669c606c841a32061796a309610c0242f07173c58c50518565477c9af2959d
-  data.tar.gz: 10e08bd6f4804d7caa15fdf24adbc2fe73b6752f626458bebaeb42a5c2258e3205cf6a2038e2b6ffaaafd43c93f10cd1ee2af094f139785573d881d9a70c7c7e
+  metadata.gz: e0cf47f9c530cbae06937a55c789c32e49c181ef4aefa69a11b30931dcf69bcfd379649f0f0e35695874644a0b7a84d516d419ced310df5949ce7877d025be5e
+  data.tar.gz: ce6702bfd7041bd20139cf2e6468058b4d04fe3d87b81bbd3f125b462b7989696ecc2ee04ebbe2567d47d22d89d0a85b04977ac1daeadbfd625377edf7101a80

data/LICENSE

@@ -1,20 +1,174 @@
-Copyright (c) 2014 Stanford University Library
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README.md

@@ -1,6 +1,5 @@
 [![CircleCI](https://circleci.com/gh/sul-dlss/lyber-core/tree/main.svg?style=svg)](https://circleci.com/gh/sul-dlss/lyber-core/tree/main)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/472f67659e513e3d8ffa/test_coverage)](https://codeclimate.com/github/sul-dlss/lyber-core/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/472f67659e513e3d8ffa/maintainability)](https://codeclimate.com/github/sul-dlss/lyber-core/maintainability)
+[![codecov](https://codecov.io/github/sul-dlss/lyber-core/graph/badge.svg?token=FxCjczsxpG)](https://codecov.io/github/sul-dlss/lyber-core)
 [![Gem Version](https://badge.fury.io/rb/lyber-core.svg)](https://badge.fury.io/rb/lyber-core)
 
 # lyber_core
@@ -26,9 +25,7 @@ module Robots
         def perform_work
           cocina_object.shelve
         end
-
       end
-
     end
   end
 end
@@ -59,9 +56,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
@@ -123,4 +138,4 @@ Robots can be invoked with:
 ```
 test_perform(robot, druid)
 ```
-to avoid the workflow updates in `perform()`.
+to avoid the workflow updates in `perform()`.

data/lib/lyber_core/robot.rb

@@ -3,23 +3,36 @@
 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
+      druid = job['args'].first
+      workflow = Workflow.new(object_client: Dor::Services::Client.object(druid),
+                              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
+    # These methods are delegated to the workflow ivar as a convenient way for child classes to interact
+    # with the workflow service (to e.g. to create workflows, update status, set error status, etc). See
+    # dor-services-client readme and code (or robot subclass implementations) for suggestions on specific
+    # usages.
+    delegate :lane_id, :object_workflow, :workflow_process, :workflow_response, :process_response, 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
-    end
-
-    def workflow_service
-      @workflow_service ||= WorkflowClientFactory.build(logger:)
+      @retriable_exceptions = retriable_exceptions
     end
 
     def object_client
@@ -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,28 +109,20 @@ 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:,
-                                 druid:,
-                                 workflow_name:,
-                                 process:)
+      @workflow ||= Workflow.new(object_client:, workflow_name:, 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 = '8.0.0'
 end

data/lib/lyber_core/workflow.rb

@@ -3,58 +3,62 @@
 module LyberCore
   # This encapsulates the workflow operations that lyber-core does
   class Workflow
-    def initialize(workflow_service:, druid:, workflow_name:, process:)
-      @workflow_service = workflow_service
-      @druid = druid
+    def initialize(object_client:, workflow_name:, process:)
+      @object_client = object_client
       @workflow_name = workflow_name
       @process = process
     end
 
+    # @return [Dor::Services::Client::ObjectWorkflow] for druid/workflow/step on which this instance was initialized
+    def object_workflow
+      object_client.workflow(workflow_name)
+    end
+
+    # @return [Dor::Services::Client::Process] for druid/workflow/step on which this instance was initialized
+    def workflow_process
+      object_workflow.process(process)
+    end
+
+    # @return [Dor::Services::Response::Workflow] for druid/workflow/step on which this instance was initialized
+    def workflow_response
+      object_workflow.find
+    end
+
+    # @return [Dor::Services::Response::Process] for druid/workflow/step on which this instance was initialized
+    def process_response
+      workflow_response.process_for_recent_version(name: process)
+    end
+
     def start!(note)
-      workflow_service.update_status(druid:,
-                                     workflow: workflow_name,
-                                     process:,
-                                     status: 'started',
-                                     elapsed: 1.0,
-                                     note:)
+      workflow_process.update(status: 'started', elapsed: 1.0, note:)
     end
 
     def complete!(status, elapsed, note)
-      workflow_service.update_status(druid:,
-                                     workflow: workflow_name,
-                                     process:,
-                                     status:,
-                                     elapsed:,
-                                     note:)
+      workflow_process.update(status:, elapsed:, note:)
+    end
+
+    def retrying!
+      workflow_process.update(status: 'retrying', elapsed: 1.0, note: nil)
     end
 
     def error!(error_msg, error_text)
-      workflow_service.update_error_status(druid:,
-                                           workflow: workflow_name,
-                                           process:,
-                                           error_msg:,
-                                           error_text:)
+      workflow_process.update_error(error_msg:, error_text:)
     end
 
     # @return [Hash] any workflow context associated with the workflow
     def context
-      @context ||= workflow_service.process(pid: druid,
-                                            workflow_name:,
-                                            process:).context
+      @context ||= process_response.context
     end
 
     def status
-      @status ||= workflow_service.workflow_status(druid:,
-                                                   workflow: workflow_name,
-                                                   process:)
+      @status ||= workflow_process.status
     end
 
+    # @return [String,nil]
     def lane_id
-      @lane_id ||= workflow_service.process(pid: druid, workflow_name:, process:).lane_id
+      @lane_id ||= process_response.lane_id
     end
 
-    private
-
-    attr_reader :workflow_service, :druid, :workflow_name, :process
+    attr_reader :object_client, :workflow_name, :process
   end
 end

data/lib/lyber_core.rb

@@ -7,7 +7,6 @@ require 'active_support/core_ext/object/blank' # String#blank?
 require 'active_support/core_ext/module/delegation'
 require 'sidekiq'
 require 'honeybadger'
-require 'dor/workflow/client'
 require 'dor/services/client'
 require 'druid-tools'
 require 'zeitwerk'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyber-core
 version: !ruby/object:Gem::Version
-  version: 7.6.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Alpana Pande
@@ -13,10 +13,9 @@ authors:
 - Michael Klein
 - Darren Weber
 - Peter Mangiafico
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,32 +47,18 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: dor-services-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '15.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '15.0'
-- !ruby/object:Gem::Dependency
-  name: dor-workflow-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: druid-tools
   requirement: !ruby/object:Gem::Requirement
@@ -261,12 +246,11 @@ files:
 - lib/lyber_core/rspec.rb
 - lib/lyber_core/version.rb
 - lib/lyber_core/workflow.rb
-- lib/lyber_core/workflow_client_factory.rb
 homepage: http://github.com/sul-dlss/lyber-core
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -281,8 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.15
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Core services used by the SUL Digital Library
 test_files: []

data/lib/lyber_core/workflow_client_factory.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module LyberCore
-  # Factory for creating a workflow client
-  class WorkflowClientFactory
-    def self.build(logger:)
-      Dor::Workflow::Client.new(url: Settings.workflow.url, logger:, timeout: Settings.workflow.timeout)
-    end
-  end
-end