eco-helpers 2.0.45 → 2.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f85bd156250d1f44ca911d98007005cbbb2281ff4a40a2fc07a80680fd42a408
-  data.tar.gz: 4ccda90fbf7d1bbfc814d18cd033110b7af2ae366687af1fa2db10370788c52d
+  metadata.gz: fd9b2a6564e5ce38fa3ed762ab04f5e4e79b1a6580738d9091b846233c6fb66e
+  data.tar.gz: ac0200ad60b30fc0d40997b4975f016daee8cd48c881bfecae106ca0867ff123
 SHA512:
-  metadata.gz: f4b7add6e04fb8b4dfa0c56371bc3f85e791659754e937f60586b88dec06186723f9286c87482144bd9b012298dbc03251388c49f1245008026a186cd6d16a88
-  data.tar.gz: 7a0bfda7154a8c0e7bb7e18100a96cd2a45f26a6d45309725e7d796dd9d0ad48cefb35be551c031706757d1241fab7505d74f401cf6a04764547bbe8c582e076
+  metadata.gz: f72270169fd60eaee60b27d333391bc6d2235fe856752d9f7dcd5d5aca18fd129e148cd0830bea37cd86833cabc64f10e4fb09e71c4ba2ba9b6912313da82b4a
+  data.tar.gz: 690b338d062020a6d80794d794f00f8ce9c263bb8b12a84f774f50193bd49ff474b6a49f670a1e05df9a2db88f70d3639c54582fc8706617c44123753c0a7b9e

data/CHANGELOG.md

@@ -1,17 +1,40 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.45] - 2021-11-xx
+## [2.0.46] - 2021-12-24
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - added counter of retrieved entries (to be able to compare with matched initially scoped results)
+    - added also counter of failed to retrieve oozes
+    - added also counter of double ups in search pagination
+    - counter for updated pages and pages that failed update
+  - `Eco::API::Session#enviro_name`: to identify in whic environment we are running
+
+### Changed
+  - upgraded `ecoportal-api-v2` dependency
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase#update_ooze`
+    - To return `false` if there was request made to the server
+    - To return `Reponse` if there was request made to the server
+
+### Fixed
+  - Changed the `workflow` in
+    - `on(:end)` to do not recache people if there were no `:sync` or `:transform` cases
+  - `Eco::API::UseCases::OozeSamples::OozeRunBaseCase#update_ooze`
+    - It's parent had parameter (it as a child should so)
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase#process_ooze`
+    - It was not retrieving the `ooze` unless explicitly passed as parameter
+    - This did not play well with child implementations that expect it to retrieve it based on `ooze_id` cli argument
+
+## [2.0.45] - 2021-12-15
 
 ### Added
   - `Eco::API::UseCases::OozeSamples::RegisterExportCase`
-  
+
 ### Changed
   - Upgrade `ecoportal-api` dependency
   - Upgrade `ecoportal-api-v2` dependency
 
-### Fixed
-
 ## [2.0.44] - 2021-11-25
 
 ### Changed

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.4', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.21', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.23', '< 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/microcases/people_load.rb

@@ -30,7 +30,7 @@ module Eco
             people_load(modifier: modifier - [:newest, :file])
           end
         when modifier.include?(:api)
-          logger.info("Going to get all the people via API")
+          logger.info("Going to get all the people via API (load)")
 
           start = Time.now
           session.batch.get_people.tap do |people|

data/lib/eco/api/session.rb

@@ -17,6 +17,11 @@ module Eco
         logger.debug("LINE COMMAND: #{$0} #{ARGV.join(" ")}")
       end
 
+      # @retrun [String] the name of the current environment
+      def enviro_name
+        config.active_enviro
+      end
+
       # @return [Eco::API::Session::Batch] provides helper to launch batch operations.
       def batch
         @batch  ||= Batch.new(enviro)

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

@@ -20,10 +20,11 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   # Write here your script
-  def process_ooze(ooze = target)
+  def process_ooze(ooz = target)
+    ooz ||= ooze
     raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
-    yield(ooze)
-    update_ooze(ooze)
+    yield(ooz)
+    update_ooze(ooz)
   end
 
   protected
@@ -109,10 +110,12 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     exit_error "Stage '#{id_name}' doesn't exist in ooze '#{ooze_id}'"
   end
 
+  # It fill update the ooze only if it's dirty (it carries changes)
+  # @return [Boolean, Response] `false` if there was not request against the server, `Response` otherwise
   def update_ooze(ooze = target)
     if !options[:simulate]
-      return unless dirty?(ooze)
-      
+      return false unless dirty?(ooze)
+
       ooze.validate.tap do |validation|
         raise validation if validation.is_a?(String)
       end
@@ -133,6 +136,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
       end
       backup_patch!(ooze)
       exit(0) if dirty?(ooze) && dry_count > DRY_COUNT
+      false
     end
   end
 

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

@@ -39,9 +39,9 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
     options.dig(:source, :stage_id)
   end
 
-  def update_ooze
+  def update_ooze(ooz = target)
     prompt_to_confirm!
-    super
+    super(ooz)
   end
 
   def exit_if_no_changes!

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

@@ -17,12 +17,30 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   name "register-update-case"
   type :other
 
+  attr_reader :retrieved_oozes, :non_retrieved_oozes
+  attr_reader :total_search_oozes, :dupped_search_oozes
+  attr_reader :ooze_result_ids, :updated_oozes, :failed_update_oozes
+
   def main(session, options, usecase, &block)
+    @retrieved_oozes = 0
+    @non_retrieved_oozes = 0
+    @dupped_search_oozes = 0
+    @ooze_result_ids     = {}
+    @updated_oozes       = 0
+    @failed_update_oozes = 0
+
     super(session, options, usecase) do
       with_each_entry do |ooze|
         process_ooze(&block)
       end
     end
+    msg  = "Run end:\n"
+    msg += "  • Search results: #{total_search_oozes}\n"
+    msg += "  • Duplicated search results #{dupped_search_oozes}\n"
+    msg += "  • Retrieved a total of #{retrieved_oozes}\n"
+    msg += "  • Could not get #{non_retrieved_oozes} oozes.\n"
+    msg += "  • Updated #{updated_oozes} oozes (failed update on #{failed_update_oozes} oozes).\n"
+    logger.info(msg)
   end
 
   def process_ooze(ooze = target)
@@ -47,7 +65,14 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   def with_each_entry
     batched_search_results do |page_results|
       page_results.each do |page_result|
+        if ooze_result_ids[page_result.id]
+          @dupped_search_oozes += 1
+        else
+          ooze_result_ids[page_result.id] = true
+        end
+
         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"
@@ -56,7 +81,11 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
           end
         end
         if ooz = ooze(page_result.id)
+          @retrieved_oozes += 1
           yield(ooz)
+        else
+          @non_retrieved_oozes += 1
+          console.warn "Could not get page #{page_result.id}"
         end
       end
       update_oozes
@@ -113,7 +142,15 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   def update_oozes(batched_oozes = batch_queue)
     batched_oozes.each do |ooze|
-      update_ooze(ooze)
+      update_ooze(ooze).tap do |result|
+        if result.is_a?(Ecoportal::API::Common::Response)
+          if result.success?
+            @updated_oozes += 1
+          else
+            @failed_update_oozes +=1
+          end
+        end
+      end
     end
     batched_oozes.clear
   end
@@ -127,6 +164,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   def results_preview
     apiv2.registers.search(register_id, search_options.merge(only_first: true)).tap do |search_results|
+      @total_search_oozes = search_results.total
       str_results = "Total target entries: #{search_results.total} (out of #{search_results.total_before_filtering})"
       session.prompt_user("Do you want to proceed (y/N):", explanation: str_results, default: "N", timeout: 10) do |res|
         unless res.upcase.start_with?("Y")

data/lib/eco/cli/config/default/workflow.rb

@@ -3,6 +3,8 @@ ASSETS.cli.config do |config|
 
     io = nil
     rescued = false
+    cases_with_input  = nil
+    cases_with_output = nil
 
     # default rescue
     wf.rescue do |exception, io|
@@ -165,9 +167,16 @@ ASSETS.cli.config do |config|
     wf.on(:end) do |wf_end, io|
       get_people     = io.options.dig(:people, :get)
       partial_update = get_people && get_people.dig(:type) == :partial
+
       unless !io.options[:end_get] || io.options[:dry_run] || partial_update
-        # Prevent getting people when there were no use cases that used them
-        unless io.people
+        people_update_cases = config.usecases.active(io: io).any? do |usecase, data|
+          [:transform, :sync].any? {|type| usecase.type == type}
+        end
+
+        if !people_update_cases
+          # Prevent getting people when there were no use cases that used them
+          io.session.logger.info("Won't be recaching people, as there haven't been any targetted updates")
+        elsif !io.people
           people = io.session.micro.people_cache
           io     = io.new(people: people)
         end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.45"
+  VERSION = "2.0.46"
 end

metadata

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