eco-helpers 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b781e23d7538417c84762d636b8e10281adce9e5228cef561edf199aba5334
-  data.tar.gz: ab7284a1124a8bece11d8d72e8bdc2f532d746e1da3cfdc264270885d6f867d9
+  metadata.gz: '0904af2dd434adc72c1ca3e889d4e0b11595ce991f6de1c997f613d80c8866ce'
+  data.tar.gz: b21748a878327830d5c813340ab2fcfe69ebace8137480bc9dfc42f290296cbf
 SHA512:
-  metadata.gz: eb069c529b1f318f700672676178c52921b06dcaf2600c1b0f6c3ab5b388f781c17630a0ae4d0b815f206bc74cff8a528ab3f6df53ce5ea9068416b40174b3f2
-  data.tar.gz: 0fe617fa64e3bf666438ac6a8b6bf35eac83c9552280d16f9070443fe7e7b5e7e4c0e28185b5bcf853e6eac40fc465bb29d55c3112621b9d3d979dcac81436bc
+  metadata.gz: 2bccc140b8ec44d41aaccdffde8e5b51a1c755fc75dcede5e08526be6daed4482a5f733ceba6a75155f1dee74dbc8e2edc52ee9f2ab55f7ebf6521acfd3aac47
+  data.tar.gz: b362a14bf0a872ee04928ace6c05600df37ecfd56cb754b5f2a0cc3a417115cc8d9a889ce5f40de80ed41f281b16005eed78eadf04a330dc6fa80066baa56e63

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.6.2] - 2024-02-23
+
+### Added
+  - `Eco::API::Session::Config::TagTree`: added **benchmarks** to locations structure live retrieval
+  - To all **Ooze** cases that use register update
+    - `Eco::API::UseCases::OozeSamples::Helpers::Creatable` native helpers
+    - to draft entries
+    - `Eco::API::UseCases::OozeSamples::RegisterMigrationCase` -> removed code double-up due to this addition to the register update case.
+  - `Eco::API::Common::Loaders::Base` added **methods**
+    - `#simulate?` and `#dry_run?`
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - added **kpis** attempted updates and attempted creations
+
+### Changed
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - `#main` allows to tell it to just `yield`
+
+### Fixed
+  - `Eco::Data::Locations::NodeDiff::Selectors` `any?` (typo)
+  - `Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase`
+    - fixed **kpis** tracking
+
 ## [2.6.1] - 2024-02-11
 
 ### Added

data/lib/eco/api/common/loaders/base.rb

@@ -32,6 +32,11 @@ module Eco
 
           private
 
+          def simulate?
+            options.dig(:simulate) || options.dig(:dry_run)
+          end
+          alias_method :dry_run?, :simulate?
+
           def session
             @session ||= ASSETS.session
           end

data/lib/eco/api/session/config/tagtree.rb

@@ -93,9 +93,16 @@ module Eco
               includeArchivedNodes: include_archived
             }.merge(kargs)
 
+            start = Time.now
             return nil unless tree = graphql.currentOrganization.locationStructure(**kargs, &block)
+            end_time = Time.now
+            secs    = (end_time - start).round(3)
 
-            Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name)
+            Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name).tap do |eco_tree|
+              cnt     = eco_tree.count
+              per_sec = (cnt.to_f / secs).round(2)
+              session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
+            end
           end
 
           # Retrieves all the location structures of the organisation
@@ -110,11 +117,18 @@ module Eco
                 includeArchivedNodes: include_archived
               }.merge(kargs)
 
+              start = Time.now
               next unless trees = graphql.currentOrganization.locationStructures(**kargs, &block)
+              end_time = Time.now
+              secs     = (end_time - start).round(3)
+              cnt      = 0
               trees.each do |tree|
                 eco_tree = Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name)
+                cnt += eco_tree.count
                 eco_trees.push(eco_tree)
               end
+              per_sec = (cnt.to_f / secs).round(2)
+              session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
             end
           end
 

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

@@ -0,0 +1,62 @@
+module Eco
+  module API
+    class UseCases
+      class OozeSamples
+        module Helpers
+          # set of helpers to create entries from a template
+          module Creatable
+            module InstanceMethods
+              private
+
+              def creating_new_page(draft_reference = "new entry", template_id:)
+                page_id = nil
+                drafting_entry(template_id) do |draft|
+                  yield(draft) if block_given?
+
+                  if page_id = create_entry(draft, reference: draft_reference)
+                    log(:info) { "Page '#{page_id}' created successfully -- #{draft_reference}" }
+                  elsif options.dig(:dry_run)
+                    log(:info) { "Simulated launch for #{draft_reference}" }
+                  end
+                end
+                page_id
+              end
+
+              # @return [Page] a draft of `template_id` (still not saved)
+              def drafting_entry(template_id)
+                raise ArgumentError, "Expecting block, but not given" unless block_given?
+                draft = apiv2.pages.get_new(template_id)
+                yield(draft)
+              end
+
+              # Does the actual creation of the entry
+              def create_entry(draft, reference: "new entry from #{draft&.template_id}")
+                with_rescue(reference) do
+                  if result = create_ooze(draft, template_id: draft.template_id)
+                    return result.page_id
+                  end
+                end
+              end
+            end
+
+            class << self
+              def included(base)
+                super
+                validate_base_type!(base)
+                base.include(InstanceMethods)
+              end
+
+              def validate_base_type!(base)
+                return super if defined?(super)
+                msg  = "#{self} can only be included in Eco::API::UseCases::OozeSamples::RegisterUpdateCase"
+                msg << "\nCan't be included in #{base}"
+                raise LoadError, msg unless base <= Eco::API::UseCases::OozeSamples::RegisterUpdateCase
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Eco
+  module API
+    class UseCases
+      class OozeSamples
+        module Helpers
+          module Rescuable
+            module InstanceMethods
+              private
+
+              # Helper to prevent script from stopping
+              def with_rescue(reference)
+                raise ArgumentError, "Expecting block, but not given" unless block_given?
+                yield
+              rescue StandardError => e
+                log(:error) {
+                  [reference, e.message].join(' => \n')
+                }
+                lines = []
+                lines << "\nThere was an error. Choose one option:\n"
+                lines << "  (C)      - Continue/resume. Just ignore this one."
+                lines << "  (A)      - Abort. Just break this run."
+
+                session.prompt_user('Type one option (C/a):', explanation: lines.join("\n"), default: 'C') do |res|
+                  res = res.upcase
+                  case
+                  when res.start_with?("A")
+                    raise
+                  else res.start_with?("C")
+                    log(:warn) {
+                      msg  = "Script resumed after error..."
+                      msg << "\n  • #{reference}"
+                    }
+                    nil
+                  end
+                end
+              end
+            end
+
+            class << self
+              def included(base)
+                super
+                validate_base_type!(base)
+                base.include(InstanceMethods)
+              end
+
+              def validate_base_type!(base)
+                return super if defined?(super)
+                msg  = "#{self} can only be included in Eco::API::Common::Loaders::Base"
+                msg << "\nCan't be included in #{base}"
+                raise LoadError, msg unless base <= Eco::API::Common::Loaders::Base
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 require_relative 'helpers/shortcuts'
 require_relative 'helpers/filters'
+require_relative 'helpers/rescuable'
+require_relative 'helpers/creatable'
 
 module Eco
   module API

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

@@ -4,6 +4,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   type :other
 
   include Eco::API::UseCases::OozeSamples::Helpers
+  include Eco::API::UseCases::OozeSamples::Helpers::Rescuable
 
   attr_reader :target
 
@@ -145,7 +146,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   # 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]
+    if dry_run?
       dry_run_feedback(ooze)
       false
     else

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

@@ -66,8 +66,8 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
 
   def process_ooze
     with_target_stage(self.class::SOURCE_STAGE) do |source|
-      drafting_entry(self.class::TEMPLATE_ID) do |draft|
-        draft_reference = object_reference(source)
+      draft_reference = object_reference(source)
+      creating_new_page(draft_reference, template_id: elf.class::TEMPLATE_ID) do |draft|
         draft.base_tags << ["IMPORTED", "MIGRATED"]
 
         pairing_tracking = copy_pairings(source, draft)
@@ -89,13 +89,6 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
         if msg = pairing_tracking.report_dst_unpaired(only_required: false, exclude_ximport: !self.class::REPORT_DST_XIMPORT)
           logger.warn(msg)
         end
-
-        if page_id = create_entry(draft, reference: draft_reference)
-          csv << [source.id, page_id]
-          logger.info("Page '#{page_id}' created successfully.")
-        elsif options.dig(:dry_run)
-          logger.info("Simulated launch for #{draft_reference}")
-        end
       end
     end
   end
@@ -153,23 +146,6 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
     "#{sym}_callback".to_sym
   end
 
-  def create_entry(draft, reference:, from: self.class::TEMPLATE_ID)
-    with_rescue(reference) do
-      if !options[:dry_run]
-        create_ooze(draft, template_id: from).page_id
-      else
-        logger.info("Creation sample follows...")
-        dry_run_feedback(draft)
-        false
-      end
-    end
-  end
-
-  def drafting_entry(template_id = selfTEMPLATE_ID)
-    draft = apiv2.pages.get_new(template_id)
-    yield(draft)
-  end
-
   def with_target_stage(name)
     if stg = target_stage(name)
       yield(stg)

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

@@ -4,6 +4,8 @@
 #   - You need to define the `process_ooze` method
 # This case expects `options[:source][:register_id]`
 class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::OozeSamples::OozeBaseCase
+  include Eco::API::UseCases::OozeSamples::Helpers::Creatable
+
   class << self
     # @return [Integer] the number of pages to be processed in each batch
     def batch_size(size = nil)
@@ -18,31 +20,25 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   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, :created_oozes
+  attr_reader :ooze_result_ids
+  attr_reader :updated_oozes, :failed_update_oozes, :attempted_ooze_updates
+  attr_reader :created_oozes, :ooze_create_attempts
 
-  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
-    @created_oozes       = 0
+  def main(session, options, usecase, mode: :legacy, &block)
+    init_kpis
 
     super(session, options, usecase) do
-      with_each_entry do |ooze|
-        process_ooze(&block)
+      if mode == :legacy
+        with_each_entry do |ooze|
+          process_ooze(&block)
+        end
+      elsif mode == :delegate
+        raise "You need to pass a block when running main in `:delegate` mode" unless block_given?
+        yield
       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.\n"
-    msg += "    - Failed update on #{failed_update_oozes} oozes.\n"
-    msg += "  • Created #{created_oozes} oozes.\n"
-    logger.info(msg)
+
+    log_kpis
   end
 
   def process_ooze(ooze = target)
@@ -51,29 +47,6 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   private
 
-  def with_rescue(reference)
-    begin
-      yield
-    rescue StandardError => e
-      logger.error([reference, e.message].join(" => \n"))
-      lines = []
-      lines << "\nThere was an error. Choose one option:\n"
-      lines << '  (C)      - Continue/resume. Just ignore this one.'
-      lines << '  (A)      - Abort. Just break this run.'
-
-      session.prompt_user('Type one option (C/a):', explanation: lines.join("\n"), default: 'C') do |res|
-        res = res.upcase
-        case
-        when res.start_with?("A")
-          raise
-        else res.start_with?("C")
-          logger.warn "Script resumed after error..."
-          nil
-        end
-      end
-    end
-  end
-
   def before_loading_new_target(ooze_id)
     if pending = queue_shift(ooze_id)
       update_ooze(pending).tap do |result|
@@ -95,6 +68,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     end
   end
 
+  # Main looper (invoked from `main`)
   def with_each_entry
     batched_search_results do |page_results|
       page_results.each do |page_result|
@@ -172,12 +146,26 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     yield(results) unless results.empty?
   end
 
+  # Launches the actual request to create the entry
   def create_ooze(draft, template_id:)
-    apiv2.pages.create(draft, from: template_id).tap do |result|
-      @created_oozes += 1
+    @ooze_create_attempts += 1
+
+    if dry_run?
+      dry_run_feedback(ooze)
+      false
+    else
+      apiv2.pages.create(draft, from: template_id).tap do |result|
+        @created_oozes += 1
+      end
     end
   end
 
+  # Capture the attempts count
+  def update_ooze(*args, **kargs, &block)
+    @attempted_ooze_updates += 1 if dirty?(ooze)
+    super
+  end
+
   def update_oozes(batched_oozes = batch_queue)
     batched_oozes.each do |ooze|
       update_ooze(ooze).tap do |result|
@@ -215,10 +203,39 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     end
   end
 
+  def init_kpis
+    @retrieved_oozes        = 0
+    @non_retrieved_oozes    = 0
+    @dupped_search_oozes    = 0
+    @ooze_result_ids        = {}
+    @updated_oozes          = 0
+    @failed_update_oozes    = 0
+    @attempted_ooze_updates = 0
+    @created_oozes          = 0
+    @ooze_create_attempts   = 0
+  end
+
+  def log_kpis
+    log(:info) { kpis_message }
+  end
+
+  def kpis_message
+    msg  = []
+    msg << "Run end:"
+    msg << "  • Search results: #{total_search_oozes}"
+    msg << "  • Duplicated search results #{dupped_search_oozes}"
+    msg << "  • Retrieved a total of #{retrieved_oozes}"
+    msg << "  • Could not get #{non_retrieved_oozes} oozes."
+    msg << "  • Updated #{updated_oozes} oozes (attempted: #{attempted_ooze_updates})."
+    msg << "    - Failed update on #{failed_update_oozes} oozes."
+    msg << "  • Created #{created_oozes} oozes (out of: #{ooze_create_attempts})."
+    msg.join("\n")
+  end
+
   def search_options
     @search_options ||= {}.tap do |opts|
-      opts.merge!(sort: "created_at")
-      opts.merge!(dir:  "asc")
+      opts.merge!(sort:   'created_at')
+      opts.merge!(dir:    'asc')
       opts.merge!(query:   conf_search) if conf_search
       opts.merge!(filters: conf_filters)
     end

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

@@ -19,7 +19,11 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
           end
         end
         if ooz = ooze(id)
+          @retrieved_oozes += 1
           yield(ooz)
+        else
+          @non_retrieved_oozes += 1
+          logger.warn "Could not get page #{id}"
         end
       end
       update_oozes
@@ -42,8 +46,12 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
 
   def target_ids_preview
     dups = target_ids.select {|id| target_ids.count(id) > 1}
+    @total_search_oozes  = target_ids.count
+    @dupped_search_oozes = dups.count
+
     dups_str = dups.count > 0 ? "There are #{dups.count} duplicated ids" : "No duplicates detected"
     msg = "Total target entries: #{target_ids.count} (#{dups_str})"
+
     session.prompt_user("Do you want to proceed (y/N):", explanation: msg, default: "N", timeout: 10) do |res|
       unless res.upcase.start_with?("Y")
         puts "..."

data/lib/eco/data/locations/node_diff/nodes_diff.rb

@@ -50,30 +50,32 @@ class Eco::Data::Locations::NodeDiff
     end
 
     def diffs_summary
-      return "There were no differences identified" if diffs.empty?
-      msg  = "Identified #{diffs.count} differences:\n"
+      comp = "(#{source2.count} vs #{source1.count} nodes)"
+      return "There were no differences identified #{comp}" if diffs.empty?
+      msg  = []
+      msg << "Identified #{diffs.count} differences  #{comp}:"
       msg << when_present(insert, '') do |count|
-        "  • #{count} nodes to insert\n"
+        "  • #{count} nodes to insert"
       end
       msg << when_present(update, '') do |count|
-        "  • #{count} nodes to update\n"
+        "  • #{count} nodes to update"
       end
       # msg << when_present(id, '') do |count|
       #   "    • #{count} nodes to change id\n"
       # end
       msg << when_present(name, '') do |count|
-        "    • #{count} nodes to change name\n"
+        "    • #{count} nodes to change name"
       end
       msg << when_present(move, '') do |count|
-        "    • #{count} nodes to move\n"
+        "    • #{count} nodes to move"
       end
       msg << when_present(unarchive, '') do |count|
-        "    • #{count} nodes to unarchive\n"
+        "    • #{count} nodes to unarchive"
       end
       msg << when_present(archive, '') do |count|
-        "  • #{count} nodes to archive\n"
+        "  • #{count} nodes to archive"
       end
-      msg
+      msg.join("\n")
     end
 
     private

data/lib/eco/data/locations/node_diff/selectors.rb

@@ -12,7 +12,7 @@ class Eco::Data::Locations::NodeDiff
         end
 
         define_method methq do
-          diffs.any(&methq)
+          diffs.any?(&methq)
         end
       end
     end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.6.1"
+  VERSION = "2.6.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Oscar Segura
@@ -694,10 +694,12 @@ files:
 - lib/eco/api/usecases/ooze_cases/export_register_case.rb
 - lib/eco/api/usecases/ooze_samples.rb
 - lib/eco/api/usecases/ooze_samples/helpers.rb
+- lib/eco/api/usecases/ooze_samples/helpers/creatable.rb
 - lib/eco/api/usecases/ooze_samples/helpers/exportable_ooze.rb
 - lib/eco/api/usecases/ooze_samples/helpers/exportable_register.rb
 - lib/eco/api/usecases/ooze_samples/helpers/filters.rb
 - lib/eco/api/usecases/ooze_samples/helpers/ooze_handlers.rb
+- lib/eco/api/usecases/ooze_samples/helpers/rescuable.rb
 - lib/eco/api/usecases/ooze_samples/helpers/shortcuts.rb
 - lib/eco/api/usecases/ooze_samples/helpers_migration.rb
 - lib/eco/api/usecases/ooze_samples/helpers_migration/copying.rb