dor-services 8.1.1 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef0bbc594a0540d23d3d7854fe746de6e78bec7a123979e27729e8185658e414
-  data.tar.gz: 61eefb4bf61d39d06b55008bd7cc15811e9dd403b7c92d40d10ab6f4865bfb71
+  metadata.gz: 55aca082954da26152f1a29b2212755d957a1d7fdf1d2dd87ff373555ab4d66e
+  data.tar.gz: ca157bb92f8dabe93a9d49e9d862f8cdfcaee9b7d59fe6510cfd8180b67cd19c
 SHA512:
-  metadata.gz: 5be82315538ea54e7dec4cfca937ab61e63abb7a1f14623d27be9f4f224d8755f4c1eba52ccb22dad351f1c928d4cf0f3ec66a2a96ffda4a6724650b1b00dd18
-  data.tar.gz: 5ce6a06eeeafd90849f22a835bb065e8913f2babfaed5b62f669e8d1f5d9e8379c1921b39ac3368b90b3f524e7db9f933ba8f5de8cece9889f22fb369b71484d
+  metadata.gz: a4ca1272b55af9e0c828fa678d6a51a669f3614c72b367a51c2bf22ba29dc69ccc1ad44482756c704bca319b3b7decc47a7a44a24ef62457062b38975c472a3c
+  data.tar.gz: 609b3cb8a631c40979aea5e37086ed50550fd42d3ea1e3bede01b10942c01942b0fc2db86fcaaf893d7fb8ad9389c93c6be25abbe34acca042527c79ab19e96e

data/lib/dor/datastreams/workflow_definition_ds.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dor
+  # @deprecated
   class WorkflowDefinitionDs < ActiveFedora::OmDatastream
     include SolrDocHelper
 

data/lib/dor/indexers/workflow_indexer.rb

@@ -10,75 +10,74 @@ module Dor
     MAX_ERROR_LENGTH = 32_768 - 2 - ERROR_OMISSION.length
     private_constant :MAX_ERROR_LENGTH
 
-    # @param [Dor::WorkflowDocument] document the workflow document to index
-    def initialize(document:)
-      @document = document
+    # @param [Workflow::Response::Workflow] workflow the workflow document to index
+    def initialize(workflow:)
+      @workflow = workflow
     end
 
     # @return [Hash] the partial solr document for the workflow document
     def to_solr
       WorkflowSolrDocument.new do |solr_doc|
-        wf_name = document.workflowId.first
-        solr_doc.name = wf_name
-        errors = processes.count(&:error?)
-
-        repo = document.repository.first
-        solr_doc.status = [wf_name, workflow_status, errors, repo].join('|')
+        definition = Dor::Config.workflow.client.workflow_template(workflow_name)
+        solr_doc.name = workflow_name
+        processes_names = definition['processes'].map { |p| p['name'] }
 
+        errors = 0 # The error count is used by the Report class in Argo
+        processes = processes_names.map do |process_name|
+          workflow.process_for_recent_version(name: process_name)
+        end
         processes.each do |process|
-          index_process(solr_doc, wf_name, process)
+          index_process(solr_doc, process)
+          errors += 1 if process.status == 'error'
         end
+        solr_doc.status = [workflow_name, workflow_status(processes), errors, repository].join('|')
       end
     end
 
     private
 
-    attr_reader :document
-    delegate :processes, to: :document
+    attr_reader :workflow
+    delegate :workflow_name, :repository, to: :workflow
 
-    def index_process(solr_doc, wf_name, process)
-      return unless process.status.present?
+    # @param [Workflow::Response::Process] process
+    def index_process(solr_doc, process)
+      return unless process.status
 
       # add a record of the robot having operated on this item, so we can track robot activity
-      solr_doc.add_process_time(wf_name, process.name, Time.parse(process.date_time)) if process_has_time?(process)
+      solr_doc.add_process_time(workflow_name, process.name, Time.parse(process.datetime)) if process_has_time?(process)
 
-      index_error_message(solr_doc, wf_name, process)
+      index_error_message(solr_doc, process)
 
       # workflow name, process status then process name
-      solr_doc.add_wsp("#{wf_name}:#{process.status}", "#{wf_name}:#{process.status}:#{process.name}")
+      solr_doc.add_wsp("#{workflow_name}:#{process.status}", "#{workflow_name}:#{process.status}:#{process.name}")
 
       # workflow name, process name then process status
-      solr_doc.add_wps("#{wf_name}:#{process.name}", "#{wf_name}:#{process.name}:#{process.status}")
+      solr_doc.add_wps("#{workflow_name}:#{process.name}", "#{workflow_name}:#{process.name}:#{process.status}")
 
       # process status, workflowname then process name
-      solr_doc.add_swp(process.status.to_s, "#{process.status}:#{wf_name}", "#{process.status}:#{wf_name}:#{process.name}")
-      return if process.state == process.status
-
-      solr_doc.add_wsp("#{wf_name}:#{process.state}:#{process.name}")
-      solr_doc.add_wps("#{wf_name}:#{process.name}:#{process.state}")
-      solr_doc.add_swp(process.state.to_s, "#{process.state}:#{wf_name}", "#{process.state}:#{wf_name}:#{process.name}")
+      solr_doc.add_swp(process.status.to_s, "#{process.status}:#{workflow_name}", "#{process.status}:#{workflow_name}:#{process.name}")
     end
 
     def process_has_time?(process)
-      !process.date_time.blank? && process.status && (process.status == 'completed' || process.status == 'error')
+      process.datetime && process.status && (process.status == 'completed' || process.status == 'error')
     end
 
-    def workflow_status
+    def workflow_status(processes)
       return 'empty' if processes.empty?
 
       workflow_should_show_completed?(processes) ? 'completed' : 'active'
     end
 
     def workflow_should_show_completed?(processes)
-      processes.all? { |p| ['skipped', 'completed', '', nil].include?(p.status) }
+      processes.all? { |p| %w[skipped completed].include?(p.status) }
     end
 
     # index the error message without the druid so we hopefully get some overlap
     # truncate to avoid org.apache.lucene.util.BytesRefHash$MaxBytesLengthExceededException
-    def index_error_message(solr_doc, wf_name, process)
+    def index_error_message(solr_doc, process)
       return unless process.error_message
 
-      solr_doc.error = "#{wf_name}:#{process.name}:#{process.error_message}".truncate(MAX_ERROR_LENGTH, omission: ERROR_OMISSION)
+      solr_doc.error = "#{workflow_name}:#{process.name}:#{process.error_message}".truncate(MAX_ERROR_LENGTH, omission: ERROR_OMISSION)
     end
   end
 end

data/lib/dor/indexers/workflows_indexer.rb

@@ -12,7 +12,7 @@ module Dor
     def to_solr
       WorkflowSolrDocument.new do |combined_doc|
         workflows.each do |wf|
-          doc = WorkflowIndexer.new(document: wf).to_solr
+          doc = WorkflowIndexer.new(workflow: wf).to_solr
           combined_doc.merge!(doc)
         end
       end.to_h
@@ -20,15 +20,15 @@ module Dor
 
     private
 
-    # @return [Array<Dor::WorkflowDocument>]
+    # @return [Array<Workflow::Response::Workflow>]
     def workflows
-      # TODO: this could use the models in dor-workflow-service: https://github.com/sul-dlss/dor-workflow-client/pull/101
-      nodeset = Nokogiri::XML(all_workflows_xml).xpath('/workflows/workflow')
-      nodeset.map { |wf_node| Workflow::Document.new wf_node.to_xml }
+      all_workflows.workflows
     end
 
-    def all_workflows_xml
-      @all_workflows_xml ||= Dor::Config.workflow.client.all_workflows_xml resource.pid
+    # TODO: remove Dor::Workflow::Document
+    # @return [Workflow::Response::Workflows]
+    def all_workflows
+      @all_workflows ||= Dor::Config.workflow.client.workflow_routes.all_workflows pid: resource.pid
     end
   end
 end

data/lib/dor/models/workflow_object.rb

@@ -3,6 +3,7 @@
 require 'dor/datastreams/workflow_definition_ds'
 
 module Dor
+  # @deprecated
   class WorkflowObject < Dor::Abstract
     has_object_type 'workflow'
     has_metadata name: 'workflowDefinition', type: Dor::WorkflowDefinitionDs, label: 'Workflow Definition'

data/lib/dor/services/state_service.rb

@@ -7,13 +7,14 @@ module Dor
     # having version is preferred as without it, a call to
     # fedora will be made to retrieve it.
     def initialize(pid, version: nil)
+      Deprecation.warn(self, 'Dor::StateService is deprecated and will be removed in dor-services 9')
       @pid = pid
       @version = version || fetch_version
     end
 
     def allows_modification?
       !client.lifecycle('dor', pid, 'submitted') ||
-        client.active_lifecycle('dor', pid, 'opened') ||
+        client.active_lifecycle('dor', pid, 'opened', version: version) ||
         client.workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') == 'hold'
     end
 

data/lib/dor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dor
-  VERSION = '8.1.1'
+  VERSION = '8.2.0'
 end

data/lib/dor/workflow/document.rb

@@ -23,6 +23,7 @@ module Dor
       @@definitions = {}
 
       def initialize(node)
+        Deprecation.warn(self, 'Dor::Workflow::Document is deprecated and will be removed from dor-services version 9')
         self.ng_xml = Nokogiri::XML(node)
       end
 

data/lib/dor/workflow/process.rb

@@ -9,6 +9,7 @@ module Dor
       # @param workflow [String] the name of the workflow, e.g. 'assemblyWF'
       # @param attrs [Nokogiri::XML::Node, Hash]
       def initialize(repo, workflow, attrs)
+        Deprecation.warn(self, 'Dor::Workflow::Process is deprecated and will be removed from dor-services version 9')
         @workflow = workflow
         @repo = repo
         if attrs.is_a? Nokogiri::XML::Node

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 8.2.0
 platform: ruby
 authors:
 - Michael Klein
@@ -20,7 +20,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: druid-tools
   requirement: !ruby/object:Gem::Requirement