eco-helpers 3.0.19 → 3.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f6637f51c2d892eb93c881cca7613fba034cbb00ff2676966172c2277f583ce
-  data.tar.gz: 68703625905aa5ed2c00223a628de16612714a2c2cdd69a1c0a284c8c6096332
+  metadata.gz: a7764e6e3e78228f59b9a5f5baf2aa8602c627882905a23270007b4fe1a09c9f
+  data.tar.gz: aca94b571b1c70c000e0d88f09182f2339a306187c5f9651968e9692981d79d9
 SHA512:
-  metadata.gz: 89bbd57468fd7de3412240e3e44f61122aee9982896401494c4ee88c5e2dec97563e421cac2da0794c4f68ff90206422bc52b2868ee1e7ef3422fce50f3ec73d
-  data.tar.gz: 82703dafe2ccecf25994567926c80e7bd40fe0af70853cce664dbcbfc12b56b0b9ad72308ccf2789a386e053baadce2a8c29095130aa57dc560228d99c27267e
+  metadata.gz: bcef313643bc67ba9d90755e3ce8a3a3a39c1973404b2dcd35292b76c67d158ad3e9c666414e2f6254776eeb800f4d07fc2ab10953a15e9e2b293d2b8f15303e
+  data.tar.gz: 3d12155562df35e9ecadea021a758f922f35ab68d689592e4a319e41232b4865a87e22c0e333b1083e42340418f57388f24139748246d08652142ef52f1a041d

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 *.gem
 /.bundle
 /.vscode
+.solargraph.yml
 /vendor/bundle
 /spec/reports/
 /tmp/

data/CHANGELOG.md

@@ -2,7 +2,41 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.19] - 2024-10-xx
+## [3.0.21] - 2024-12-16
+
+### Added
+
+- `Eco::API::Common::Session::Logger`
+  - Implement **channels** logging.
+
+### Changed
+
+- Moved `input` and `people` **cli_default configurations** to a class definition
+- `Eco::Language::AuxiliarLogger#log`
+  - Allow for multiple levels
+  - Return `NilClass`
+
+### Fixed
+
+- `Eco::API::Session::Batch::Job#summary`
+  - Ensure a summary of pending jobs can be handled, even if `#launch` was NOT explicitly called.
+  - As we don't consolidate, it may give more actual updates than pending, yet this is better than providing the `count` of entries in the job's queue.
+
+## [3.0.20] - 2024-12-07
+
+### Added
+
+- Mailer: to specify non-default `space` in the subject, when used.
+- `Eco::API::Common::Loaders::Config`
+  - Can call config with params
+- `Eco::API::Common::Loaders::Session`
+  - Which switches the configuration to that of the specific environment
+
+### Changed
+
+- On failure, `Eco::API::Session::Job#summary` to give precise estimates on what is pending to be run.
+
+## [3.0.19] - 2024-11-21
 
 ### Added
 
@@ -21,8 +55,6 @@ All notable changes to this project will be documented in this file.
   - `ecoportal-api-v2`
   - `ecoportal-api-graphql`
 
-### Fixed
-
 ## [3.0.18] - 2024-10-28
 
 ### Changed

data/lib/eco/api/common/loaders/config/cli.rb

@@ -0,0 +1,9 @@
+class Eco::API::Common::Loaders::CliConfig < Eco::API::Common::Loaders::Config
+  class << self
+    def config
+      ASSETS.cli.config
+    end
+  end
+
+  delegate_missing_to :config
+end

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

@@ -0,0 +1,12 @@
+class Eco::API::Common::Loaders::Session < Eco::API::Common::Loaders::Config
+  class << self
+    # This is a config tied to the current environment session.
+    def config
+      return @config if instance_variable_defined?(:@config)
+
+      @config = super(key: super.apis.active_root_name)
+    end
+  end
+
+  delegate_missing_to :workflow
+end

data/lib/eco/api/common/loaders/config/workflow/mailer.rb

@@ -18,9 +18,8 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       next if     session.config.dry_run?
       next unless session.config.run_mode_remote?
 
-      # temporary contingency
-      maybe_error_pages_or_tree_updates = other_case?(io) && error?
-      next unless some_update?(io) || maybe_error_pages_or_tree_updates
+      # temporary contingency: maybe_error_or_tree_updates?
+      next unless some_update?(io) || maybe_error_pages_or_tree_updates?(io)
 
       subject = base_subject
 
@@ -47,7 +46,15 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
     end
 
     def base_subject
-      "#{org_name} (#{active_enviro}) at #{Time.now.iso8601}"
+      "#{org_name} (#{active_enviro_desc}) at #{Time.now.iso8601}"
+    end
+
+    def active_enviro_desc
+      space_desc = config.active_enviro_space.to_s.strip
+      space_desc = ''                          if space_desc == 'default'
+      space_desc = " - space: '#{space_desc}'" unless space_desc.empty?
+
+      "#{active_enviro}#{space_desc}"
     end
 
     def some_update?(io)
@@ -66,6 +73,11 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       !!error
     end
 
+    # @note at some stage, tree cases should have their own case type
+    def maybe_error_pages_or_tree_updates?(io)
+      other_case?(io) && error?
+    end
+
     def errors_n_warnings(io)
       [error_message, log_err_n_warn(io)].join("\n")
     end
@@ -73,6 +85,7 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
     def log_err_n_warn(io)
       warn_errors = io.logger.cache.logs(level: %i[error warn])
       return if warn_errors.empty?
+
       "ALL WARNINGS & ERRORS:\n#{warn_errors.join}\n"
     end
 

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

@@ -1,17 +1,24 @@
 class Eco::API::Common::Loaders::Config
   extend Eco::API::Common::ClassHelpers
   extend Eco::Language::Methods::DelegateMissing
+
   inheritable_class_vars :delegate_missing_to
 
   class << self
     # To create samples of configurations
     def config_block(&block)
       return @config_block unless block_given?
+
+      unless @config_block.nil?
+        msg = "Reconfiguring config_block on #{self}"
+        session.log(:warn) { msg }
+      end
+
       @config_block = block
     end
 
-    def config
-      ASSETS.config
+    def config(...)
+      ASSETS.config(...)
     end
 
     def cli
@@ -26,4 +33,6 @@ class Eco::API::Common::Loaders::Config
   delegate_missing_to :config
 end
 
+require_relative 'config/cli'
 require_relative 'config/workflow'
+require_relative 'config/session'

data/lib/eco/api/common/people/default_parsers/xls_parser.rb

@@ -27,7 +27,7 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
   end
 
   def expected_headers
-    log(:warn) {
+    log(:info) {
       "Headers detection is using your fields_map.json file (native behaviour)"
     }
     session.fields_mapper.list(:external).uniq

data/lib/eco/api/common/session/logger/cache.rb

@@ -4,7 +4,8 @@ module Eco
       module Session
         class Logger
           class Cache
-            LEVELS = %w[UNKNOWN FATAL ERROR WARN INFO DEBUG].freeze
+            LEVELS   = %w[UNKNOWN FATAL ERROR WARN INFO DEBUG].freeze
+            CHANNELS = Logger::CHANNELS.map(&:to_s).map(&:upcase).freeze
 
             def initialize
               reset
@@ -56,7 +57,8 @@ module Eco
             end
 
             def to_datetime(value)
-              return nil unless value
+              return unless value
+
               Time.parse(value)
             end
 
@@ -64,7 +66,7 @@ module Eco
               levels = [value].flatten.map {|v| to_level(v)}.compact
               return levels unless levels.empty?
 
-              LEVELS
+              valid_levels
             end
 
             def to_level(value)
@@ -75,7 +77,7 @@ module Eco
 
             def valid_level!(str)
               return true unless str
-              return true if LEVELS.any? {|lev| str == lev}
+              return true if valid_levels.any? {|lev| str == lev}
 
               msg = "Unknown level #{str}. Should be one of #{LEVELS}"
               raise ArgumentError, msg
@@ -87,6 +89,10 @@ module Eco
 
               value
             end
+
+            def valid_levels
+              @valid_levels ||= self.class::LEVELS | self.class::CHANNELS
+            end
           end
         end
       end

data/lib/eco/api/common/session/logger/channels.rb

@@ -0,0 +1,41 @@
+module Eco
+  module API
+    module Common
+      module Session
+        class Logger
+          module Channels
+            CHANNELS = %i[general].freeze
+
+            class << self
+              def included(base)
+                super
+                base.extend ClassMethods
+              end
+            end
+
+            module ClassMethods
+              def channels!(&def_block)
+                str = "Block with channel implementation expected. None given."
+                raise ArgumentError, str unless block_given?
+
+                channels.each do |channel|
+                  meth = channel.to_s.downcase.to_sym
+
+                  define_method(meth) do |msg = nil, &block|
+                    def_block.call(meth, msg, &block)
+                  end
+                end
+              end
+
+              private
+
+              def channels
+                self::CHANNELS
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/common/session/logger.rb

@@ -5,6 +5,15 @@ module Eco
         class Logger < Eco::Language::BasicLogger
           TIMESTAMP_PATTERN = '%Y-%m-%dT%H:%M:%S'.freeze
 
+          require_relative 'logger/channels'
+          include Channels
+
+          channels! do |channel, message = nil, &block|
+            format_proc(console: true) do |severity, datetime, msg, formatted_msg|
+              cache.add(severity, datetime, msg, formatted_msg)
+            end.call(channel, Time.now, 'prog_name', message || block.call)
+          end
+
           attr_reader :cache
 
           def initialize(file_level: ::Logger::DEBUG, log_file: nil, enviro: nil, **kargs)

data/lib/eco/api/common/session/sftp.rb

@@ -8,6 +8,7 @@ module Eco
           def initialize(enviro:)
             invalid_env = enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
             raise "Required Environment object (enviro:). Given: #{enviro}" if invalid_env
+
             @enviro = enviro
           end
 
@@ -103,6 +104,7 @@ module Eco
           def download(files, local_folder: nil, &block)
             puts "Creating local files:"
             created_files = []
+
             [files].flatten.compact.map do |fullname|
               basename = windows_basename(fullname)
               dest_fullname = File.join(local_folder || ".", basename)
@@ -110,6 +112,7 @@ module Eco
               created_files << dest_fullname
               sftp_session.download(fullname, dest_fullname)
             end.each(&:wait)
+
             # run SSH event loop while dw.active?
             created_files.tap { created_files.each(&block) }
           end
@@ -155,9 +158,11 @@ module Eco
           def windows_basename(remote_fullname)
             dir_sep = /[\\\/]/
             patr_re = /[<>:\\\/|?*]/
+
             parts   = remote_fullname.split(dir_sep).map do |node|
               node.gsub(patr_re, '_')
             end
+
             local_fullname = File.join(*parts)
             File.basename(local_fullname)
           end

data/lib/eco/api/custom/mailer.rb

@@ -5,5 +5,6 @@
 #  end
 class Eco::API::Custom::Mailer < Eco::API::Common::Loaders::Workflow::Mailer
   extend Eco::Language::Klass::WhenInherited
+
   when_inherited(&config_block)
 end

data/lib/eco/api/error.rb

@@ -96,9 +96,11 @@ module Eco
           end.sort do |k_1, k_2|
             next -1 if k_2 < k_1
             next  1 if k_1 < k_2
+
             0
           end.tap do |siblings|
             siblings.delete(Unclassified)
+
             if direct
               siblings.reject! do |si|
                 siblings.any? {|s| si < s}
@@ -120,8 +122,10 @@ module Eco
 
           descendants(direct: true).reverse.each do |klass|
             next unless klass.err_match?(err_msg)
+
             type = klass
             next unless klass.descendants?(direct: true)
+
             type = klass.get_type(err_msg, first: false) || type
           end
 

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

@@ -146,6 +146,16 @@ module Eco
             @pending
           end
 
+          # @note some times we need a summary of what actually
+          #   is going to be run without invoking `launch`
+          #   (i.e. when there's a uncompliance with the batch policy)
+          def ensure_requests!
+            return if instance_variable_defined?(:@requests)
+
+            pqueue    = processed_queue
+            @requests = as_update(pqueue)
+          end
+
           # @note it requires launch to be firstly invoked
           # @raise [Exception] if 'launch' has not firstly invoked
           # @return [Enumbrable<Hash>] the last requests that the queue will generate
@@ -217,6 +227,7 @@ module Eco
             elsif !pqueue.empty?
               req_backup = as_update(pqueue, add_feedback: false)
               backup_update(req_backup)
+
               log(:debug) {
                 "Job ('#{name}':#{type}): going to launch batch against #{pqueue.count} entries"
               }
@@ -246,28 +257,26 @@ module Eco
           #   3. error messages in case they were errors from the server
           # @note if `launch` was not invoked, it specifies so
           # @return [String] the summary
-          def summary # rubocop:disable Metrics/AbcSize
+          def summary
             [].tap do |msg|
-              if pending?
-                msg << "PENDING - Batch #{type.to_s.upcase} - job '#{name}' - length: #{@queue.length}"
-              else
-                msg << feedback.generate(requests, only_stats: true)
+              msg << "PENDING Job -------->\n" if pending?
+              ensure_requests!
+              msg << feedback.generate(requests, only_stats: true)
 
-                if batch_policy && !batch_policy.compliant?(request_stats)
-                  msg << "Batch Policy Uncompliance:"
-                  msg << batch_policy.uncompliance(request_stats)
-                end
-
-                msg << status.errors.message if status
-                msg << subjobs_summary
+              if batch_policy && !batch_policy.compliant?(request_stats)
+                msg << 'Batch Policy Uncompliance:'
+                msg << batch_policy.uncompliance(request_stats)
               end
+
+              msg << status.errors.message if status
+              msg << subjobs_summary
             end.join("\n")
           end
 
           private
 
           def subjobs_summary
-            return "" unless subjobs.count.positive?
+            return '' unless subjobs.count.positive?
 
             [].tap do |msg|
               subjobs.map {|subjob| msg << subjob.summary}
@@ -431,7 +440,7 @@ module Eco
               next unless status.success?(entry)
 
               if type == :create && entry.respond_to?(:id=)
-                entry.id = status[entry].body["id"].tap do |id|
+                entry.id = status[entry].body['id'].tap do |id|
                   next unless id.to_s.strip.empty?
 
                   ref = Eco::API::Session::Batch::Feedback.person_ref(entry)
@@ -503,9 +512,9 @@ module Eco
 
           # Keep a copy of the requests for future reference
           def backup_update(requests, simulate: false)
-            dry_run   = simulate ? "_dry_run" : ""
+            dry_run   = simulate ? '_dry_run' : ''
             dir       = config.people.requests_folder
-            filename  = name.split(" ").join("-").gsub(/[=\\\/><,"-]+/, "_") # rubocop:disable Style/RedundantArgument
+            filename  = name.split(' ').join('-').gsub(/[=\\\/><,"-]+/, "_") # rubocop:disable Style/RedundantArgument
             file      = File.join(dir, "#{type}_data_#{filename}#{dry_run}.json")
             file_manager.save_json(requests, file, :timestamp)
           end

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

@@ -81,7 +81,7 @@ module Eco
           end
 
           def pending?
-            any? {|job| job.pending?}
+            any?(&:pending?)
           end
 
           # Launches every `Batch::Job` in the group.
@@ -108,19 +108,17 @@ module Eco
             end
           end
 
-          def status
+          def status(&block)
             if block_given?
-              status.each do |job, job_status|
-                yield(job, job_status)
-              end
+              status.each(&block)
               self
-            else # rubocop:disable Naming/MemoizedInstanceVariableName
-              @jobs_status ||= {}
+            else
+              @jobs_status ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
             end
           end
 
           def errors?
-            any? {|job| job.errors?}
+            any?(&:errors?)
           end
 
           def summary

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

@@ -18,14 +18,17 @@ module Eco
             private
 
             # Swaps to batch endpoint on specific errors
-            def batch_mode_on(*error_types, options: self.options, allow_job_mode: true, &block)
+            def batch_mode_on(*error_types, options: self.options, allow_job_mode: true)
+              msg = "Expecting block. Non given"
+              raise ArgumentError, msg unless block_given?
+
               in_job_mode = allow_job_mode && job_mode?(options)
 
               yield(in_job_mode, batch_size(options))
             rescue *error_types
               raise unless in_job_mode
 
-              yield(false , batch_mode_size)
+              yield(false, batch_mode_size)
             end
 
             # MODE

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

@@ -25,7 +25,12 @@ module Eco
               explanation << "You have #{retries_left} retries left."
               question    = " Do you want to retry (y/N)?"
 
-              prompt_user(question, default: "Y", explanation: explanation, timeout: 10) do |response|
+              prompt_user(
+                question,
+                default:     "Y",
+                explanation: explanation,
+                timeout:     10
+              ) do |response|
                 raise unless response.upcase.start_with?("Y")
 
                 puts "\nOkay... let's retry!"

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

@@ -135,6 +135,7 @@ module Eco
             self.class.description(self)
           end
 
+          # @todo: deletage to `apis.one_off?`
           def one_off?
             name.is_a?(Symbol)
           end

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

@@ -4,14 +4,14 @@ module Eco
       class Config
         class Apis
           module OneOff
-            private
-
             def one_off?
-              @is_one_off ||=
+              @is_one_off ||= # rubocop:disable Naming/MemoizedInstanceVariableName
                 SCR.get_arg('-api-key') ||
                 SCR.get_arg('-one-off')
             end
 
+            private
+
             def one_off_key
               return @one_off_key if instance_variable_defined?(:@one_off_key)
 
@@ -48,10 +48,10 @@ module Eco
               return @one_off_org if instance_variable_defined?(:@one_off_org)
 
               msg = "You should specify -org NAME when using -api-key or -one-off"
-              raise msg unless org = SCR.get_arg('-org', with_param: true)
+              raise msg unless (org = SCR.get_arg('-org', with_param: true))
 
               str_org = "#{org.downcase.split(/[^a-z]+/).join('_')}_#{one_off_enviro.gsub('.', '_')}"
-              @one_off_org  ||= str_org.to_sym
+              @one_off_org ||= str_org.to_sym
             end
 
             def one_off_enviro
@@ -83,7 +83,7 @@ module Eco
 
               true
             rescue StandardError => err
-              puts "#{err}"
+              puts err.to_s
               false
             end
           end

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

@@ -141,7 +141,8 @@ module Eco
           # @yieldreturn [Eco::API::UseCases::BaseIO] the `io` input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def rescue(&block)
-            return @rescue unless block
+            return @rescue unless block_given?
+
             @rescue = block
             self
           end
@@ -150,7 +151,8 @@ module Eco
 
           # Called on `SystemExit` exception
           def exit_handle(&block)
-            return @exit_handle unless block
+            return @exit_handle unless block_given?
+
             @exit_handle = block
             self
           end
@@ -171,6 +173,7 @@ module Eco
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def before(key = nil, &block)
             raise ArgumentError, "A block should be given." unless block_given?
+
             if key
               stage(key).before(&block)
             else
@@ -195,6 +198,7 @@ module Eco
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def after(key = nil, &block)
             raise ArgumentError, "A block should be given." unless block_given?
+
             if key
               stage(key).after(&block)
             else
@@ -267,6 +271,7 @@ module Eco
                 io.evaluate(self, io, &c)
               end
             end
+
             io
           end
 
@@ -276,6 +281,7 @@ module Eco
                 io.evaluate(self, io, &c)
               end
             end
+
             io
           end
 
@@ -305,6 +311,7 @@ module Eco
                 io.evaluate(self, io, &@on)
               end
             end
+
             io
           ensure
             @pending = false
@@ -341,7 +348,11 @@ module Eco
 
           def stage(key)
             self.class.validate_stage(key)
-            @stages[key] ||= self.class.workflow_class(key).new(key, _parent: self, config: config)
+            @stages[key] ||= self.class.workflow_class(key).new(
+              key,
+              _parent: self,
+              config:  config
+            )
           end
 
           # helper to treat trigger the exit and rescue handlers
@@ -354,6 +365,7 @@ module Eco
             io = io_result(io: io) do
               io.evaluate(err, io, &exit_handle)
             end
+
             exit err.status
           rescue Interrupt => _int
             raise
@@ -362,6 +374,7 @@ module Eco
             io = io_result(io: io) do
               io.evaluate(err, io, &self.rescue)
             end
+
             raise
           end
         end