eco-helpers 2.0.34 → 2.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 420f5871108edb8c66a534f60a4f8303352245a5080c68398ccd1dc34974a606
-  data.tar.gz: c176a43c046adf47520d18af6db7a92225786625051f2982b6ffdd1540c722e7
+  metadata.gz: b4d6a312dda42afc3e6ba2becccf69d42121024d9b81e2c37276719089521971
+  data.tar.gz: a3536e8fba79c1600135b4c4fd523a9c3a5262d605c39c751a3dc278d096b96e
 SHA512:
-  metadata.gz: 1e1b2828dc5ba988364eb04f9433fff624694d6371ba5e3aa80bc4d4ee3c6cc62eb90cd2693a1e324a630043e19666d1499e5e8fdfff69c03adccd777e387494
-  data.tar.gz: 5b2d6ba34b14b4164512e3ffd5c65ab2c4edac3c0452ff4dcd422b32537fcff47c244f85b815c4f55b0d313b546cf786dabe49d76cc5feaf374b1039cdc7c266
+  metadata.gz: 8fcb26823bc3b6e3d35522c13d410094ea056269c14dea3b47bcaf16991ff36cde9537507a6a21c952aa15f590fb1f5b1fc594e55d08f04782a8e2802c695d0c
+  data.tar.gz: fb2768c6e345da3dec034e7793876ecf25ae1cff76a059d98a38d9328c57884efb2a2f0b449eb28aea686ba074e477875fd8ba30201773170935f1c766fd45ae

data/CHANGELOG.md

@@ -1,7 +1,27 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.34] - 2021-08-xx
+## [2.0.35] - 2021-08-30
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase`
+    - `#new_target` optional warning when switching `target`
+      - `block` that is called when switching target and there were unsaved changes
+    - `#dirty?` helper method to check if there are changes
+    - `#before_loading_new_target` hook to allow child classes to anticipate when the `target` is going to change
+
+### Changed
+  - `Eco::API::UseCases::OozeSamples::Helpers::Shortcuts#object_reference` improved reference text
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - added resilience when switching target (i.e. from one stage to another stage in same entry)
+    - added `batch_queue`
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - actual `batch_size` updates
+    - actual safe switch of target (i.e. against another stage of same ooze)
+
+## [2.0.34] - 2021-08-28
 
 ### Added
   - `Eco::API::UseCases::OozeSamples::OozeBaseCase` refactored ooze base case
@@ -12,8 +32,6 @@ All notable changes to this project will be documented in this file.
   - `Eco::API::UseCases::OozeSamples::OozeUpdateCase` remove unnecessary code and helpers that are now inherited from `OoozeBaseCase`
   - `Eco::API::UseCases::OozeSamples::OozeFromDocCase` remove unnecessary code
 
-### Fixed
-
 
 ## [2.0.33] - 2021-08-16
 

data/eco-helpers.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.3', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.11', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.12', '< 0.9'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'

data/lib/eco/api/usecases/ooze_samples/helpers/shortcuts.rb

@@ -59,16 +59,16 @@ module Eco
               "".tap do |ref|
                 case obj
                 when Ecoportal::API::V2::Page::Stage
-                  ref << "Stage "
+                  ref << "Stage"
                 when Ecoportal::API::V2::Pages::PageStage
-                  ref << "StagePage "
+                  ref << "Page (#{obj.id}) (#{object_reference(obj.current_stage)})"
                 when Ecoportal::API::V2::Page
-                  ref << "Page "
+                  ref << "Page"
                 end
-                ref << "'#{obj.name}' " if obj.respond_to?(:name)
+                ref << " '#{obj.name}'" if obj.respond_to?(:name)
               end
             end
-            
+
           end
         end
       end

data/lib/eco/api/usecases/ooze_samples/ooze_base_case.rb

@@ -9,6 +9,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   attr_reader :target
 
   SAVE_PATCH = "ooze_patch_update.json"
+  DRY_COUNT  = 5
 
   def main(session, options, usecase)
     raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
@@ -26,8 +27,13 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   private
 
+  # Hook method to use before the target is switched
+  def before_loading_new_target(ooze_id)
+  end
+
   def ooze(ooze_id = nil, stage_id: nil)
     return target unless ooze_id
+    before_loading_new_target(ooze_id)
     apiv2.pages.get(ooze_id, stage_id: stage_id).tap do |ooze|
       if ooze
         new_target(ooze)
@@ -47,6 +53,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
     if stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
       return ooze if ooze.respond_to?(:current_stage_id) && (ooze.current_stage_id == stg.id)
+      before_loading_new_target(ooze_id)
       return apiv2.pages.get(ooze_id, stage_id: stg.id).tap do |stage|
         if stage
           new_target(stage)
@@ -61,12 +68,13 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   def update_ooze(ooze = target)
     if !options[:simulate]
+      return unless dirty?(ooze)
       apiv2.pages.update(ooze).tap do |response|
         if response.success?
           ooze.consolidate!
-          logger.info("Successful update of '#{ooze.name}' (#{ooze.id})")
+          logger.info("Successful update of #{object_reference(ooze)}")
         else
-          logger.error("Could not update '#{ooze.name}' (#{ooze.id}): #{response.body}")
+          logger.error("Could not update #{object_reference(ooze)} (created_at: #{ooze.created_at}: #{response.body}")
         end
       end
     else
@@ -76,17 +84,26 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
         end
       end
       backup_patch!(ooze)
-      exit(0) if dry_count > 5
+      exit(0) if dry_count > DRY_COUNT
     end
   end
 
-  def new_target(object)
-    if target && patch_doc(target)["page"]
-      logger.warn "You you are switching to a new target #{object_reference(object)} after doing unsaved changes to #{object_reference(target)}"
+  def new_target(object, warn_pending_changes: true)
+    if dirty?(target)
+      if warn_pending_changes
+        msg =  "You you are switching to a new target #{object_reference(object)}"
+        msg += " after doing unsaved changes to #{object_reference(target)}"
+        logger.warn msg
+      end
+      yield(target) if block_given?
     end
     @target = object
   end
 
+  def dirty?(object)
+    object && patch_doc(object)["page"]
+  end
+
   def backup_patch!(ooze = target)
     unless patch = (patch_doc(ooze) || {})["page"]
       logger.info "No changes to update for #{object_reference(ooze)}."

data/lib/eco/api/usecases/ooze_samples/register_update_case.rb

@@ -6,11 +6,11 @@
 class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::OozeSamples::OozeBaseCase
 
   class << self
-    attr_reader :batch_size
-
     # @return [Integer] the number of pages to be processed in each batch
-    def batch_size
-      @batch_size || 25
+    def batch_size(size = nil)
+      @batch_size ||= 25
+      return @batch_size unless size
+      @batch_size = size
     end
   end
 
@@ -31,39 +31,95 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   private
 
+  def before_loading_new_target(ooze_id)
+    if pending = queue_shift(ooze_id)
+      update_ooze(pending)
+    end
+  end
+
+  def new_target(object, warn_pending_changes: false)
+    enqueue(object)
+    super(object, warn_pending_changes: warn_pending_changes) do |pending|
+      #queue(pending)
+    end
+  end
+
   def with_each_entry
     batched_search_results do |page_results|
-      batched_oozes = page_results.map do |page_result|
-        # TODO: Logics to get the correct PageStage
-        if ooze = new_target(ooze(page_result.id))
-          yield(ooze)
+      page_results.each do |page_result|
+        if pending = queue_shift(page_result.id)
+          if dirty?(pending)
+            msg  = "Inconsistent search results. "
+            msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
+            console.warn msg
+            update_ooze(pending)
+          end
+        end
+        if ooz = ooze(page_result.id)
+          yield(ooz)
         end
-        ooze
       end
-      update_oozes(batched_oozes)
+      update_oozes
+    end
+  end
+
+  def enqueue(object)
+    return unless object && object.respond_to?(:id)
+    if elem = queue_get(object.id)
+      msg = "Something is wrong. Native case 'RegisterUpdateCase' is "
+      if (elem != object) && dirty?(elem)
+        msg << "trying to queue different objects with same page id:\n"
+        msg << " • already queued (changes will go): #{object_reference(elem)}\n"
+        msg << " • tried to queue (lost changes): #{object_reference(object)}"
+        logger.warn msg
+      end
+    else
+      batch_queue << object unless batch_queue.include?(object)
+    end
+  end
+
+  def queue_shift(id = nil)
+    if id
+      batch_queue.delete(queue_get(id))
+    else
+      batch_queue.shift
     end
   end
 
+  def queue_get(id)
+    batch_queue.find {|e| e.id == id}
+  end
+
+  def batch_queue
+    @batch_queue ||= []
+  end
+
   def batched_search_results
     raise "Missing block. It yields in slices of #{self.class.batch_size} results" unless block_given?
     results_preview
-    i = 0; results = []
+    results = []
     apiv2.registers.search(register_id, search_options) do |page_result|
-      i += 1
       results << page_result
-      if i <= self.class.batch_size
+      if results.length >= self.class.batch_size
         yield(results)
         results = []
-        i = 0
       end
     end
     yield(results) unless results.empty?
   end
 
-  def update_oozes(batched_oozes)
+  def update_oozes(batched_oozes = batch_queue)
     batched_oozes.each do |ooze|
       update_ooze(ooze)
     end
+    batched_oozes.clear
+  end
+
+  def backup_patch!(ooze = target)
+    unless patch = (patch_doc(ooze) || {})["page"]
+      logger.info "No changes to update for #{object_reference(ooze)}."
+      return
+    end
   end
 
   def results_preview

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.34"
+  VERSION = "2.0.35"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.34
+  version: 2.0.35
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: 0.8.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: 0.8.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'