eco-helpers 3.0.6 → 3.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d17b73673167619a4e704756a4e59f5d81d61a97e495721e100fe3e10d2374
-  data.tar.gz: a873e8e8970c5d67aa224ac226bec8194f81e2025bcd434b4f1005b8ddba21a3
+  metadata.gz: c5f99b7ad6dad2fcd262a6269bbe2c7a2acae695b077712ce745c9f0746e2580
+  data.tar.gz: de2217f416b703f1cc0ae06f6c42bddbebedef906013b128b5efcdc552df40af
 SHA512:
-  metadata.gz: 362fa919cbbdd98a7d69e99fa793f42a31fd790513d4d0e62db1e5838bf4937526fceb03139f394c069fd376d7a10c2cfcedf7207cda9377838b441022fa1a2f
-  data.tar.gz: 95064a493e111f68cf5da145f6322e9a30d1c7a2ce48c022b776109fc581ba7c1fd63dbb0a26dae7dcbd0c67086ec5ee0c7c507deae55cf45aa8ed73704ecb4c
+  metadata.gz: 6149a32bf28606ac1051a127deabefd66fbab577700035f36ba01b9268438b1223423a30e399c1efaed92858586722a0dfa6d7d1a180a4ff0870c894ac730fde
+  data.tar.gz: 1799bbf948a1725f99b567b0934c29eb53f3361db5c22c660e616e876cc857c15c85330db3d2e60df4a6d5f1c0c9697722e1ded6b114897cbe8b5a257fd06511

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.7] - 2024-08-xx
+## [3.0.9] - 2024-08-xx
 
 ### Added
 
@@ -10,6 +10,33 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.0.8] - 2024-08-30
+
+### Added
+
+- options to choose `-batch-mode` [`:batch`|`:job`]
+
+### Changed
+
+- When `-skip-api-policies`
+  - Default policy: to skip non generic logic when api policies are skept
+  - Still run default policies
+
+### Fixed
+
+- unknown option `suggestions`
+
+## [3.0.7] - 2024-08-27
+
+### Added
+
+- `Eco::API::UseCases::GraphQL::Helpers::Base::ErrorHandling`
+
+### Fixed
+
+- `Service:TreeUpdate`
+  - Should NOT call `re_archive` when there was a error that is NOT due to an interrupt (i.e. so when raised **error** or `exit`ed)
+
 ## [3.0.6] - 2024-08-26
 
 ### Added

data/Rakefile

@@ -19,6 +19,11 @@ RSpec::Core::RakeTask.new(:spec_fast) do |task|
 end
 task(rspec_fast: :spec_fast)
 
+desc "run rubocop diaplying cop names"
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
 # default task name is yard
 desc "Yard: generate all the documentation"
 YARD::Rake::YardocTask.new(:doc) do |t|

data/eco-helpers.gemspec

@@ -1,3 +1,4 @@
+# rubocop:disable Gemspec/DevelopmentDependencies
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -54,3 +55,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'roo-xls',       '>= 1.2.0',  '< 1.3'
   spec.add_dependency 'rubyzip',       '>= 2.3.2',  '< 2.4'
 end
+
+# rubocop:enable Gemspec/DevelopmentDependencies

data/lib/eco/api/policies/default_policies/99_user_access_policy.rb

@@ -14,8 +14,10 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     self.account_removed_count = 0
 
     people.each do |person|
-      remove_account_when_no_email!(person) if person.email.to_s.empty?
-      next unless account = person.account
+      remove_account_when_no_email!(person)
+
+      next if options.dig(:skip, :api_policies)
+      next unless (account = person.account)
       next if options.dig(:exclude, :account)
 
       add_def_policy_group_if_applicable!(account)
@@ -35,6 +37,7 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
   end
 
   def remove_account_when_no_email!(person)
+    return unless person.email.to_s.empty?
     return unless person.account
 
     self.account_removed_count += 1 if had_account?(person)

data/lib/eco/api/policies.rb

@@ -15,8 +15,10 @@ module Eco
       end
 
       def add(policy)
-        raise "Expected Eco::API::Policies::Policy object. Given: #{policy}" unless policy.is_a?(Eco::API::Policies::Policy)
-        super(policy)
+        msg = "Expected Eco::API::Policies::Policy object. Given: #{policy}"
+        raise ArgumentError, msg unless policy.is_a?(Eco::API::Policies::Policy)
+
+        super
       end
 
       def launch(people:, session:, job:, options: {})

data/lib/eco/api/session/batch/job.rb

@@ -350,9 +350,12 @@ module Eco
           # Applies the changes introduced by api policies
           def apply_policies(pre_queue)
             people(pre_queue).tap do |entries|
-              next if options.dig(:skip, :api_policies)
+              if options.dig(:skip, :api_policies)
+                policies = session.default_policies
+              else
+                policies = session.policies
+              end
 
-              policies = session.policies
               next if policies.empty?
 
               policies.launch(

data/lib/eco/api/session/batch.rb

@@ -12,6 +12,16 @@ module Eco
           end
         end
 
+        # @return [Symbol] the batch mode to run
+        def batch_mode(opts = self.options)
+          opts.dig(:workflow, :batch, :mode) || :batch
+        end
+
+        # @return [Boolean] are we running in `:job` mode?
+        def job_mode?(opts = self.options)
+          batch_mode(opts) == :job
+        end
+
         # Gets the _people_ of the organization according `params`.
         #   If `people` is not `nil`, scopes to only the people specified.
         # @note
@@ -113,6 +123,11 @@ module Eco
           )
         end
 
+        # Default way to retrieve options (unless provided)
+        def options
+          ASSETS.cli.options
+        end
+
         def launch_batch( # rubocop:disable Metrics/AbcSize
           data,
           method:,
@@ -120,7 +135,8 @@ module Eco
           job_mode:   true, # rubocop:disable Lint/UnusedMethodArgument
           per_page:   DEFAULT_BATCH_BLOCK,
           people_api: api&.people,
-          silent:     false
+          silent:     false,
+          options:    self.options
         )
           iteration  = 1
           done       = 0
@@ -145,7 +161,7 @@ module Eco
 
               start_slice = Time.now
               offer_retry_on(Ecoportal::API::Errors::TimeOut) do
-                people_api.batch(job_mode: false) do |batch|
+                people_api.batch(job_mode: job_mode?(options)) do |batch|
                   slice.each do |person|
                     batch.public_send(method, person) do |response|
                       faltal("Request with no response") unless response

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

@@ -365,6 +365,7 @@ module Eco
         # @return [Eco::API::Policies]
         def policies
           @policies = self["policies"] ||= Eco::API::Policies.new
+
           if block_given?
             yield(@policies)
             self

data/lib/eco/api/session.rb

@@ -252,11 +252,15 @@ module Eco
       # @return [Eco::API::Policies]
       def policies
         @policies ||= config.policies.dup.tap do |policies|
-          default_policies = Eco::API::Policies::DefaultPolicies.new
           policies.merge(default_policies)
         end
       end
 
+      # The native policies
+      def default_policies
+        @default_policies ||= Eco::API::Policies::DefaultPolicies.new
+      end
+
       # Set of helpers to simplify your code
       # @see Eco::API::MicroCases
       # @return [Eco::API::MicroCases]

data/lib/eco/api/usecases/graphql/helpers/base/case_env.rb

@@ -2,6 +2,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
   # Basic stuff you would need in any use case
   module CaseEnv
     include Eco::Language::AuxiliarLogger
+    include ErrorHandling
 
     private
 

data/lib/eco/api/usecases/graphql/helpers/base/error_handling.rb

@@ -0,0 +1,52 @@
+module Eco::API::UseCases::GraphQL::Helpers::Base
+  # Basic stuff you would need in any use case
+  module ErrorHandling
+    include Eco::Language::AuxiliarLogger
+
+    attr_reader :exception
+
+    private
+
+    def interrupted?(err = exception)
+      interrupt_errors.any? {|klass| err.is_a?(klass)}
+    end
+
+    def error_raised?
+      exception && !interrupted?
+    end
+
+    def rescued
+      yield
+    rescue StandardError => err
+      self.exception ||= err
+      log(:error) { err.patch_full_message }
+    end
+
+    def with_error_handling
+      @exception = nil
+      yield
+    rescue SystemExit => sext
+      @exception = sext
+      exit sext.status
+    rescue *interrupt_errors => int
+      @exception = int
+      raise
+    rescue SystemStackError
+      puts $! # rubocop:disable Style/SpecialGlobalVars
+      puts caller[0..100]
+      raise
+    rescue StandardError, SignalException => err
+      @exception = err
+      raise
+    end
+
+    def interrupt_errors
+      return @interrupt_errors if @interrupt_errors
+
+      errs = [Interrupt]
+      errs << IRB::Abort if Object.const_defined?(:IRB) && IRB.const_defined?(:Abort)
+
+      @interrupt_errors = errs
+    end
+  end
+end

data/lib/eco/api/usecases/graphql/helpers/base.rb

@@ -1,5 +1,6 @@
 module Eco::API::UseCases::GraphQL::Helpers
   module Base
+    require_relative 'base/error_handling'
     require_relative 'base/case_env'
     require_relative 'base/graphql_env'
 

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

@@ -24,38 +24,39 @@ class Eco::API::UseCases::GraphQL::Samples::Location
 
     # Main processor
     def process # rubocop:disable Metrics/AbcSize
-      self.error     = false
-      self.exception = nil
+      self.error = false
 
-      super if defined?(super)
+      with_error_handling do
+        super if defined?(super)
 
-      # this may trigger a backup of the tagtree
-      self.current_tree ||= live_tree
+        # this may trigger a backup of the tagtree
+        self.current_tree ||= live_tree
 
-      inputs(force_continue: force_continue?) do |input, stage|
-        results[stage] ||= []
+        inputs(force_continue: force_continue?) do |input, stage|
+          results[stage] ||= []
 
-        track_mode = batch_tree_track_mode(stage)
+          track_mode = batch_tree_track_mode(stage)
 
-        # yields the result of each batch
-        sliced_batches(input, desc: stage, track_tree_mode: track_mode) do |sliced_input, response, page, pages, done, total| # rubocop:disable Metrics/ParameterLists, Layout/LineLength
-          track_current_tree(response&.structure)
+          # yields the result of each batch
+          sliced_batches(input, desc: stage, track_tree_mode: track_mode) do |sliced_input, response, page, pages, done, total| # rubocop:disable Metrics/ParameterLists, Layout/LineLength
+            track_current_tree(response&.structure)
 
-          results[stage] << (page_results = request_results_class.new(sliced_input, response))
-          update_tags_remap_table(page_results, stage, current_tree)
+            results[stage] << (page_results = request_results_class.new(sliced_input, response))
+            update_tags_remap_table(page_results, stage, current_tree)
+
+            self.error = page_errors?(page_results, page, pages, done, total, stage: stage)
+            break if error
+          end
 
-          self.error = page_errors?(page_results, page, pages, done, total, stage: stage)
           break if error
         end
-
-        break if error
       end
     rescue SystemStackError
       puts $! # rubocop:disable Style/SpecialGlobalVars
       puts caller[0..100]
       raise
-    rescue StandardError => e
-      log(:error) { self.exception ||= e.patch_full_message }
+    rescue StandardError => err
+      log(:error) { err.patch_full_message }
       raise
     ensure
       rescued { self.tags_remap_csv_file = generate_tags_remap_csv }

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

@@ -3,13 +3,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
   module Command::Results
     include Eco::API::UseCases::GraphQL::Helpers::Base::CaseEnv
 
-    attr_accessor :error, :exception
-
-    def rescued
-      yield
-    rescue StandardError => e
-      log(:error) { self.exception ||= e.patch_full_message }
-    end
+    attr_accessor :error
 
     def request_results_class
       Eco::API::UseCases::GraphQL::Helpers::Location::Command::Results

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

@@ -7,7 +7,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
 
       class << self
         def included(base)
-          super(base)
+          super
           base.send :include, Eco::API::UseCases::GraphQL::Samples::Location::Service::TreeDiff
           base.send :include, Eco::API::UseCases::GraphQL::Samples::Location::Command::DSL
           base.send :include, Eco::API::UseCases::GraphQL::Utils::Sftp
@@ -17,9 +17,11 @@ class Eco::API::UseCases::GraphQL::Samples::Location
 
       module InstanceMethods
         def process
-          super
+          with_error_handling do
+            super
+          end
         ensure
-          rescued { re_archive }
+          rescued { re_archive } unless error_raised?
           rescued { email_digest('TagTree Update') }
         end
 
@@ -28,6 +30,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
         # @note this is an additional necessary step
         def re_archive
           return if simulate?
+          return if error_raised?
 
           stage = :rearchive
 
@@ -85,9 +88,9 @@ class Eco::API::UseCases::GraphQL::Samples::Location
           return if simulate?
           return if options.dig(:workflow, :no_email)
 
-          digest_msgs = logger.cache.logs(level: %i[info error warn])
-          exception   = exception ? " - Exception!" : ''
-          subject     = "#{config.active_enviro} - #{title}#{exception}"
+          digest_msgs   = logger.cache.logs(level: %i[info error warn])
+          str_exception = exception ? " - Exception!" : ''
+          subject       = "#{config.active_enviro} - #{title}#{str_exception}"
           session.mail(subject: subject, body: digest_msgs.join)
         end
 

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

@@ -58,23 +58,17 @@ class Eco::API::UseCases::GraphQL::Samples::Location
         next if prev_id == new_id
 
         tags_remap_table << [[prev_id], [new_id]]
-
-        # next unless ref_tree.is_a?(Eco::API::Organization::TagTree)
-        # next unless ref_tree.tag?(new_id)
-
-        # msg  = "Node '#{prev_id}' was updated to '#{new_id}', "
-        # msg << "but in current structure '#{new_id}' is not present"
-        # log(:warn) { msg }
       end
     end
 
     # Generates the final tags remap file
     def generate_tags_remap_csv(filename = tags_remap_csv_full_filename)
-      return nil if tags_remap_table.empty?
+      return if tags_remap_table.empty?
 
       timestamp_file(filename).tap do |file|
         CSV.open(file, 'w') do |csv|
           csv << %w[prev_node_ids new_node_ids]
+
           tags_remap_table.each do |tags_remap|
             csv << tags_remap.to_csv_row
           end

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff/convertible.rb

@@ -8,7 +8,7 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
     module Convertible
       class << self
         def included(base)
-          super(base)
+          super
           base.send :include, Inputable
         end
       end
@@ -24,12 +24,15 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
 
           csv.transform_headers do |name|
             next name unless header_maps.key?(name)
+
             header_maps[name]
           end
         end.then do |csv|
           transform_input_csv(csv).tap do |res|
             next if res.is_a?(Eco::CSV::Table)
-            raise ArgumentError, "Expecting and Eco::CSV::Table. Given: #{res.class}"
+
+            msg = "Expecting and Eco::CSV::Table. Given: #{res.class}"
+            raise ArgumentError, msg
           end
         end
       end

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff.rb

@@ -46,13 +46,15 @@ module Eco::API::UseCases::GraphQL::Samples
 
       class << self
         def included(base)
-          super(base)
+          super
           base.send :include, Convertible
         end
       end
 
       def process
-        compare
+        with_error_handling do
+          compare
+        end
       end
 
       def compare

data/lib/eco/api/usecases/graphql/samples/location/service/tree_to_list.rb

@@ -31,10 +31,12 @@ module Eco::API::UseCases::GraphQL::Samples
       include Converter
 
       def process
-        as_nodes_json(input_tagtree).tap do |list|
-          next generate_live_nodes_file(list) unless list.empty?
+        with_error_handling do
+          as_nodes_json(input_tagtree).tap do |list|
+            next generate_live_nodes_file(list) unless list.empty?
 
-          log(:error) { "There are no location nodes!" }
+            log(:error) { "There are no location nodes!" }
+          end
         end
       end
     end

data/lib/eco/assets.rb

@@ -1,6 +1,5 @@
 module Eco
   class Assets
-
     attr_reader :active_config
 
     def initialize
@@ -17,10 +16,12 @@ module Eco
 
     def config(key: active_config, update_active: true)
       configs[:default] ||= Eco::API::Session::Config.new(key)
+
       unless configs.key?(key)
-        @active_config = key unless !update_active
+        @active_config = key if update_active
         configs[key]   = configs[:default].clone(key)
       end
+
       configs[key].tap do |config|
         config.active_api(key) if config.apis.defined?(key)
         yield(config) if block_given?
@@ -36,6 +37,7 @@ module Eco
         @cli_init = true
         require_relative('cli_default')
       end
+
       @cli.tap { yield(@cli) if block_given? }
     end
   end

data/lib/eco/cli/scripting/args_helpers.rb

@@ -2,6 +2,8 @@ module Eco
   class CLI
     class Scripting
       module ArgsHelpers
+        class UnknownArgument < ArgumentError; end
+
         # @return [Array<String] the command line arguments.
         def argv
           @argv || ARGV
@@ -31,7 +33,8 @@ module Eco
           }
           unknown = arguments.unknown(**args) do |key, correct|
             next suggestions[key] = correct unless correct.empty?
-            suggstions[key] = '-- not known similar options! --'
+
+            suggestions[key] = ['-- not known similar options! --']
           end
           unknown = unknown.select {|arg| is_modifier?(arg)} if only_options
 
@@ -49,7 +52,7 @@ module Eco
           msg << "\nUse 'ruby main.rb -org [-usecase] --help -options' for more information"
           msg << "\n  - Please, remember that use case specific options "
           msg << "should come after the use case in the command line.\n"
-          raise msg
+          raise UnknownArgument, msg
         end
 
         # @return [Boolean] if `key` is in the command line.

data/lib/eco/cli_default/options.rb

@@ -27,7 +27,7 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
         puts conf.usecases.help(refine: huc)
       end
 
-      puts [
+      help_str = [
         "Please specify one of the below:",
         "  -filters       to display available filters on people",
         "  -input-filters to display available filters on input data",
@@ -36,7 +36,9 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
         "TIPS:",
         "  * You may specify the usecase to know its specific options by:    -usecase_name --help -options",
         "  * You may specify a refinement to show specific information only: --help -usecases tags"
-      ].join("\n") unless hpf || hif || ho || huc
+      ].join("\n")
+
+      puts help_str unless hpf || hif || ho || huc
       exit
     end
 
@@ -151,6 +153,26 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       session.config.dry_run!
     end
 
+    desc = "It specifies the type of batch to be used (default: ':batch')"
+    options_set.add("-batch-mode", desc) do |options, session|
+      mode_in  = SCR.get_arg("-batch-mode", with_param: true)
+      mode_str = mode_in.to_s.downcase
+      mode_sym = %i[batch job].find do |md|
+        next true if md.to_s == mode_str
+
+        md.to_s == mode_str.gsub(':', '')
+      end
+
+      unless mode_sym
+        session.log(:warn) {
+          "Unknown job_mode: #{mode_in}. Switching to default: ':batch'"
+        }
+        mode_sym = :batch
+      end
+
+      options.deep_merge!(workflow: {batch: {mode: mode_sym}})
+    end
+
     desc = "Runs runs post_launch cases even if in dry-run"
     options_set.add("-run-postlaunch", desc) do |options, session|
       options.deep_merge!(post_launch: {run: true})

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.6'.freeze
+  VERSION = '3.0.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.8
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -726,6 +726,7 @@ files:
 - lib/eco/api/usecases/graphql/helpers.rb
 - lib/eco/api/usecases/graphql/helpers/base.rb
 - lib/eco/api/usecases/graphql/helpers/base/case_env.rb
+- lib/eco/api/usecases/graphql/helpers/base/error_handling.rb
 - lib/eco/api/usecases/graphql/helpers/base/graphql_env.rb
 - lib/eco/api/usecases/graphql/helpers/location.rb
 - lib/eco/api/usecases/graphql/helpers/location/base.rb
@@ -921,7 +922,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: eco-helpers to manage people api cases