eco-helpers 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3323b0394649126c76ec4239eade6cca337049bd8f761f96aa7c66034717bd0
-  data.tar.gz: 3ddedb00b3b1e7674e014143e54e9cb46e52abb9482e9dfbc65dd4059fd0a70e
+  metadata.gz: ec05b98fd01a73712e5db28ef750583f57d96438f30a2e4e58fc531d007802e1
+  data.tar.gz: c1071fd1909830cfbb72838f9051234f9268a5bafa6e6b970a80790c05ef1ad5
 SHA512:
-  metadata.gz: 6b6126ec90b13ef1d2d985b384215a529b5818ff5d8139d96fe80d5c21c6a4a0b367cb9bb7bf8b92ff6ed61f3df525f35e2639b5160693cc0e2fd6109bfb02cb
-  data.tar.gz: d4b799b66943fda1cf7340f358520d1f30715e27866ba900615cedc5bab593200a53cb2ef72bb6ff04c8e8b4e7c4b1b6bd1b0240145240364f67f633fbb3fbd6
+  metadata.gz: 779aa495731d5e3abcb145c983c6a8271e9d4a41fb939f4a63dda4735b08b0dfc7fd2df1fcafbfade6e65651fa3af24c27b94cf18ea6977d752ef8c36abbb1da
+  data.tar.gz: edc3abd001e262f4ed9bab3867bcd9e8f4d9de108ae58b8a16f581bf054e546908c175d1bd24f8541977f65b44972226cae0b1b58ef20ad112cb2b90af591c1c

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.2.4] - 2025-08-xx
+## [3.2.5] - 2025-08-xx
 
 ### Added
 
@@ -10,6 +10,14 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.2.4] - 2025-08-26
+
+### Fixed
+
+- upgraded `ecoportal-api-graphql` **gem**
+- **DRAFTING**: made it so we don't fetch structure but when needed.
+  - This adjustment significantly mitigates performance downfall.
+
 ## [3.2.3] - 2025-08-21
 
 ### Added

data/eco-helpers.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.2.2'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(/^(test|spec|features)\//)
   end
 
   #spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
   spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.14'
-  spec.add_dependency 'ecoportal-api-graphql', '~> 1.3',  '>= 1.3.2'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 1.3',  '>= 1.3.3'
   spec.add_dependency 'ecoportal-api-v2',      '~> 3.3',  '>= 3.3.1'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages/diff_sortable/for_unarchive.rb

@@ -2,9 +2,11 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
   module Stages
     module DiffSortable
       module ForUnarchive
-        # we require the original tree to be able to track what ancestors
+        # We require the original tree to be able to track what ancestors
         # should be unarchived, with the aim of unarchiving a node that
-        # is target of update (i.e. revive and move somewhere else)
+        # is target of update (i.e. revive and move somewhere else).
+        # @note it is **IMPORTANT** to note, that only the original tree
+        #   is required. NO need to track the intermediate tree.
         def original_tree
           defined?(super)? super : @original_tree
         end

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages/diff_sortable.rb

@@ -7,6 +7,7 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
       class << self
         def included(base)
           super
+
           base.send(:include, Sortable)
         end
       end

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages/sortable/relation_safe_sort.rb

@@ -33,11 +33,13 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
           pending      = parents_hash.dup
           treeify      = proc do |item|
             next item unless (children = pending.delete(item))
+
             {item => children.map {|child| treeify.call(child)}}
           end
 
           sorted_tree = top_parents.each_with_object(unpaired) do |item, tree|
             next unless pending.key?(item)
+
             tree << treeify.call(item)
           end
 
@@ -87,10 +89,12 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
         def paired_related_nodes
           paired_combinations.each_with_object([]) do |pair, chained|
             next if (result = compare_two(*pair)).zero?
+
             chained << (result.negative?? pair : pair.reverse)
           end
         end
 
+        # @note non optimal... that's why `clusterer_class` would be used instead.
         def paired_combinations
           list.combination(2).to_a
         end

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages/sortable.rb

@@ -9,6 +9,7 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
       class << self
         def included(base)
           super
+
           base.extend(Stages)
         end
       end
@@ -16,7 +17,11 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
       private
 
       def diffs_sort(list, cluster_mode: nil, &block)
-        RelationSafeSort.new(list, cluster_mode: cluster_mode, &block).sort
+        RelationSafeSort.new(
+          list,
+          cluster_mode: cluster_mode,
+          &block
+        ).sort
       end
 
       # @note As can't update archived nodes, it happens before :id update (:prev),

data/lib/eco/api/usecases/graphql/helpers/location/command/end_points/optimizations.rb

@@ -3,32 +3,6 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
     module Optimizations
       DEFAULT_COMMANDS_PER_PAGE = 45
 
-      # Available options are:
-      #   - :per_request -> on each request
-      #   - :per_batch   -> at the end of each batch / stage (on last page)
-      #   - :once        -> only when the script starts to run
-      # @return [Symbol] the default tree tracking mode
-      def default_tree_tracking_mode
-        :per_request # :per_batch @todo per batch/stage is more plausible
-      end
-
-      # Helper to identify the commands payload block
-      # @note
-      #   1. Gives flexibility on at what time the structure should be retrieved
-      #   2. This increases performacne, as we don't retrieve the full tree on
-      #     each request unless necessary/specified
-      #   3. `nil` falls the block back to the `ecoportal-api-graphql` gem, which
-      #     has a default block that retrieves the structure
-      # @return [Proc, NilClass] the payload block
-      def scope_commands_block(track_tree_mode: default_tree_tracking_mode)
-        case track_tree_mode
-        when :per_request
-          nil
-        when :once, :per_batch
-          commands_payload_without_structure_block
-        end
-      end
-
       # Prevents each request from timing out
       def commands_per_page
         if self.class.const_defined?(:COMMANDS_PER_PAGE)
@@ -59,6 +33,47 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
           }
         }
       end
+
+      def create_payload_without_structure_block
+        proc {
+          # work-around:
+          clientMutationId
+          errors { # rubocop:disable Style/BlockDelimiters
+            details
+            fullMessages
+            messages
+          }
+          draft { # rubocop:disable Style/BlockDelimiters
+            ___Ecoportal__API__GraphQL__Fragment__LocationDraft
+          }
+        }
+      end
+
+      def publish_payload_without_structure_block
+        proc {
+          clientMutationId
+          ok
+          error { # rubocop:disable Style/BlockDelimiters
+            ___Ecoportal__API__GraphQL__Fragment__LocationsError
+          }
+          errors { # rubocop:disable Style/BlockDelimiters
+            details
+            fullMessages
+            messages
+          }
+          results { # rubocop:disable Style/BlockDelimiters
+            ok
+            command { # rubocop:disable Style/BlockDelimiters
+              id
+              state
+              __typename
+            }
+            error { # rubocop:disable Style/BlockDelimiters
+              ___Ecoportal__API__GraphQL__Fragment__LocationsError
+            }
+          }
+        }
+      end
     end
   end
 end

data/lib/eco/api/usecases/graphql/helpers/location/command/end_points.rb

@@ -7,21 +7,33 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
 
     include Optimizations
 
+    def fetch_draft(
+      draft_id,
+      structure_id:,
+      &block
+    )
+      log(:info) { "Going to fetch draft #{draft_id} (for #{structure_id})..." }
+
+      graphql.currentOrganization.locationDraftById(
+        id:          draft_id,
+        structureId: structure_id,
+        &block
+      )
+    end
+
     def create_draft(
       structure_id,
-      name:                   Time.now.iso8601,
-      notes:                  '',
-      include_archived_nodes: true
+      name:  Time.now.iso8601,
+      notes: ''
     )
       log(:info) { "Going to create draft (for #{structure_id})..." }
 
       graphql.locationStructure.draft.create(
-        input:                {
+        input: {
           structureId: structure_id,
           name:        name,
           notes:       notes
-        },
-        includeArchivedNodes: include_archived_nodes
+        }
       ).tap do |payload|
         unless payload.error?
           log(:info) { "Created draft '#{payload.draft&.id}' (for #{structure_id})" }
@@ -55,19 +67,17 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
 
     def publish_draft(
       draft_id,
-      preview:                false,
-      force:                  false,
-      include_archived_nodes: true
+      preview: false,
+      force:   false
     )
       log(:info) { "Going to publish draft #{draft_id}..." }
 
       graphql.locationStructure.draft.publish(
-        input:                {
+        input: {
           id:      draft_id,
           preview: preview,
           force:   force
-        },
-        includeArchivedNodes: include_archived_nodes
+        }
       ).tap do |payload|
         unless payload.error?
           log(:info) { "Published draft #{draft_id}" }
@@ -81,16 +91,11 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       end
     end
 
-    def apply_commands(
-      input,
-      final:           false,
-      track_tree_mode: nil,
-      &block
-    )
-      block ||= scope_commands_block(track_tree_mode: track_tree_mode)
-      block   = nil if final
-
-      graphql.locationStructure.draft.addCommands(input: input, &block)
+    def add_commands(input, &block)
+      graphql.locationStructure.draft.addCommands(
+        input: input,
+        &block
+      )
     end
   end
 end

data/lib/eco/api/usecases/graphql/helpers/location/command/results.rb

@@ -2,18 +2,23 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
   # Final ressults of the full run.
   class Results
     attr_accessor :draft
+    attr_accessor :target_tree
+
+    def initialize(target_tree)
+      @target_tree = target_tree
+    end
 
     def draft_id
       draft&.id
     end
 
     def parent_structure
-      draft&.parent_structure
+      draft&.parent_structure || target_tree
     end
 
     # @note target parent structure id
     def structure_id
-      draft&.structure_id
+      parent_structure&.id
     end
 
     # @note the result of the draft
@@ -160,7 +165,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
     end
 
     def some_applied?
-      applied.count.positive?
+      applied.any?
     end
 
     def last_applied

data/lib/eco/api/usecases/graphql/helpers/location/command.rb

@@ -7,13 +7,11 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
     include Eco::API::UseCases::GraphQL::Helpers::Location::Command::EndPoints
 
     # @note it does the API call.
-    # @param track_tree_mode [Symbol] when should updates happen
     # @return see #with_sliced_input
     def sliced_batches(
       batch_input,
-      size:            commands_per_page,
-      desc:            :input,
-      track_tree_mode: default_tree_tracking_mode
+      size: commands_per_page,
+      desc: :input
     )
       dry_run_msg = simulate? ? '(dry-run) ' : ''
 
@@ -32,10 +30,9 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
         log(:info) { msg }
 
         unless simulate? && !options.dig(:requests, :backup)
-          backup(
-            sliced_input,
-            type: "tree_update_#{desc}_request_#{page}_of_#{pages}"
-          )
+          watermark = "tree_update_#{desc}_response_#{page}_of_#{pages}"
+
+          backup(sliced_input, type: watermark)
         end
 
         if simulate? && page < 3
@@ -45,18 +42,15 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
         end
 
         # fetch structure? (by using default, when curr_block == nil)
-        response = apply_commands(
+        # We should only fetch at the very end (last standard stage)
+        #   - We will explicitly fetch the draft structure before re-archive.
+        response = add_commands(
           sliced_input,
-          final:           (page == pages),
-          track_tree_mode: track_tree_mode
+          &commands_payload_without_structure_block
         )
 
-        unless simulate?
-          backup(
-            response,
-            type: "tree_update_#{desc}_response_#{page}_of_#{pages}"
-          )
-        end
+        watermark = "tree_update_#{desc}_response_#{page}_of_#{pages}"
+        backup(response, type: watermark) unless simulate?
 
         done += count
         yield(sliced_input, response, page, pages, done, total) if block_given?

data/lib/eco/api/usecases/graphql/samples/location/command/dsl.rb

@@ -9,34 +9,15 @@ class Eco::API::UseCases::GraphQL::Samples::Location
       false
     end
 
-    # Default tree tacking behaviour
-    # @note
-    #   1. This aims to optimize the time run
-    #   2. Based on update stage, there are differentiated tracking needs
-    # @note Available options are:
-    #   - :per_request -> on each request
-    #   - :per_batch   -> at the end of each batch / stage (on last page)
-    #   - :once        -> only when the script starts to run
-    # @return [Symbol] the tracking mode
-    def batch_tree_track_mode(stage)
-      case stage
-      when :unarchive, :archive
-        :once
-      when :id, :id_name
-        :per_request
-      when :insert, :move
-        :per_batch
-      else
-        default_tree_tracking_mode
-      end
-    end
-
     # With given the commands, it generates the input of the endpoint mutation.
     # @param commands [Array<Hash>]
     def input(commands, force_continue: force_continue?)
       return unless (commands || []).any?
 
-      results.draft ||= create_draft(current_tree.id).draft
+      results.draft ||= create_draft(
+        current_tree.id,
+        &create_payload_without_structure_block
+      ).draft
 
       {
         clientMutationId: '',
@@ -79,23 +60,27 @@ class Eco::API::UseCases::GraphQL::Samples::Location
 
     # MAIN PROCESSOR
     def process
-      self.error = false
+      self.error  = false
+      some_update = false
 
       with_error_handling do
         super if defined?(super)
 
-        # this may trigger a backup of the tagtree
+        # The very first track of the current structure.
+        #   - This may trigger a backup of the tagtree.
         self.current_tree ||= live_tree
+        results(current_tree)
 
         inputs(
           force_continue: force_continue?
         ) do |input, stage|
           next unless input
 
+          some_update = true
+
           sliced_batches(
             input,
-            desc:            stage,
-            track_tree_mode: batch_tree_track_mode(stage),
+            desc: stage,
             &results_tracking_block(stage: stage)
           )
 
@@ -106,7 +91,13 @@ class Eco::API::UseCases::GraphQL::Samples::Location
         end
       end
     ensure
-      rescued { rearchive } unless exception
+      rescued do
+        next if exception
+
+        refetch_draft if some_update
+        rearchive
+      end
+
       rescued { delete_or_publish_draft }
       rescued { manage_remaps_table     }
     end
@@ -126,10 +117,6 @@ class Eco::API::UseCases::GraphQL::Samples::Location
         input_response
       )
 
-      # @todo: might need to set the name and the id by treeifying here.
-      #   Alternatively, add named arguments id and name.
-      track_current_tree(results.structure)
-
       # early detection of errors
       self.error ||= page_errors?(
         input_response,
@@ -160,7 +147,11 @@ class Eco::API::UseCases::GraphQL::Samples::Location
     rearchive_commands = rearchive_comparer.stage_commands(:archive)
     return unless rearchive_commands.any?
 
-    results.draft ||= create_draft(current_tree.id).draft
+    # create draft, just in case it wasn't already created
+    results.draft ||= create_draft(
+      results.structure_id,
+      &create_payload_without_structure_block
+    ).draft
 
     stage = :rearchive
 
@@ -172,8 +163,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
 
       sliced_batches(
         archive_input,
-        desc:            stage,
-        track_tree_mode: :once,
+        desc: stage,
         &results_tracking_block(stage: stage)
       )
     rescue StandardError => err
@@ -182,6 +172,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
     end
   end
 
+  # @note this is the 2nd and last spot where we do require a current tree structure.
   def rearchive_comparer
     @rearchive_comparer ||= nodes_diff_class.new(
       as_nodes_json(current_tree), # hash_list(current_tree),
@@ -192,6 +183,19 @@ class Eco::API::UseCases::GraphQL::Samples::Location
   end
   alias_method :rearchive_diffs, :rearchive_comparer
 
+  def refetch_draft
+    return unless results.draft
+
+    results.draft = fetch_draft(
+      results.draft_id,
+      structure_id: results.structure_id
+    )
+
+    track_current_tree(results.structure)
+
+    results.draft
+  end
+
   def delete_or_publish_draft
     return unless results.draft_id
 
@@ -206,7 +210,10 @@ class Eco::API::UseCases::GraphQL::Samples::Location
       delete_draft(results.draft_id) if delete
     else
       results.final_response(
-        publish_draft(results.draft_id)
+        publish_draft(
+          results.draft_id,
+          &publish_payload_without_structure_block
+        )
       )
     end
   end

data/lib/eco/api/usecases/graphql/samples/location/command/results.rb

@@ -18,8 +18,8 @@ class Eco::API::UseCases::GraphQL::Samples::Location
     end
 
     # Capture results
-    def results
-      @results ||= run_results_class.new
+    def results(target_tree = nil)
+      @results ||= run_results_class.new(target_tree)
     end
 
     # Errors tracking/logging.

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

@@ -69,6 +69,7 @@ class Eco::Data::Locations::NodeDiff::NodesDiff
           %i[unarchive? id? id_name? insert? move? archive?].each do |stage|
             puts "Stage #{stage}: #{diff.send(stage)}"
           end
+
           msg = "Node '#{id}' seems to be parent of itself"
           raise DataIntegrityError, msg
         end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.2.3'.freeze
+  VERSION = '3.2.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-21 00:00:00.000000000 Z
+date: 2025-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -263,7 +263,7 @@ dependencies:
         version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -273,7 +273,7 @@ dependencies:
         version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-v2
   requirement: !ruby/object:Gem::Requirement