eco-helpers 3.0.17 → 3.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884bc5e19544453088719de4fb1445b7fdb38de4b14b0a70d2dbe795d7082fb6
-  data.tar.gz: 0ba7fa5b2367d5fe51e7a51571c5e031961ddb94ec863fa71a6ab2869aa7a353
+  metadata.gz: 47c28bbf13f50c0f3f895c40c0ad8532d13233e0e2b81faea474bbeb0a1c2308
+  data.tar.gz: e13091192acd044b667cd20ebe7bcaf5c17da30c1ef83266fefa9ffa90fb8348
 SHA512:
-  metadata.gz: 75eddb8557bf95b1174a2de8d18922aeac5bb3fb74fa8371c58d8c74be0413d7eef12a682549efe4a996c5413bc245e75dc2a6b06d9615aee520ab3be3247abd
-  data.tar.gz: 898c76f69fd73fd89c261ff4989798c2dec9d845ce8b4aadb168ac1c44c0b7c67cd0d6a1aabead337ede761ef37dcf7d850e895057d04af211c8f19a6708cf94
+  metadata.gz: 02fe482f0c75e0926fe147e1ab3f4b0a0d1b826990bae3ad8ea97fb0aa53a800e1d208fb62e209877c0594b4f32792096967ec1f0528be8c81c3cd8c404c5131
+  data.tar.gz: 4f9c12554b25c81243eac348f106392a092853c87204922d25cd1f25d287abcc23461df2b0a6a19b3dd3e4624f625e49ce5920ed04000ab6641f26312a38cb0f

data/CHANGELOG.md

@@ -8,6 +8,13 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
+- upgrade `ecoportal-api` gem
+- upgrade `ecoportal-api-v2` gem
+- `Eco::API::Session::Batch#launch_batch`
+  - **removed** `per_page` parameter
+  - **added** auto-swap endpoint from `job` to `batch` on TimeOut errors.
+  - **retries** also on `Ecoportal::API::Errors::StartTimeOut`
+
 ### Fixed
 
 ## [3.0.17] - 2024-10-18

data/eco-helpers.gemspec

@@ -40,9 +40,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bcrypt_pbkdf',  '~> 1.0'
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
-  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.5'
+  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.6'
   spec.add_dependency 'ecoportal-api-graphql', '~> 0.4',  '>= 0.4.2'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.10'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.11'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'

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

@@ -0,0 +1,65 @@
+module Eco
+  module API
+    class Session
+      class Batch
+        module Launcher
+          module ModeSize
+            include Eco::API::Session::Batch::Launcher::Options
+
+            DEFAULT_BATCH_SIZE = 50
+            DEFAULT_JOB_SIZE   = 100
+
+            def batch_size(opts = options)
+              return job_mode_size if job_mode?(opts)
+
+              batch_mode_size
+            end
+
+            private
+
+            # Swaps to batch endpoint on specific errors
+            def batch_mode_on(*error_types, options: self.options, allow_job_mode: true, &block)
+              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)
+            end
+
+            # MODE
+
+            # @return [Symbol] the batch mode to run
+            def batch_mode(opts = options)
+              opts.dig(:workflow, :batch, :mode) || :batch
+            end
+
+            # @return [Boolean] are we running in `:job` mode?
+            def job_mode?(opts = options)
+              batch_mode(opts) == :job
+            end
+
+            # SIZE
+
+            def job_mode_size
+              options.dig(:workflow, :batch, :job, :size).then do |size|
+                next self.class::DEFAULT_JOB_SIZE unless size
+
+                size
+              end
+            end
+
+            def batch_mode_size
+              options.dig(:workflow, :batch, :size).then do |size|
+                next self.class::DEFAULT_BATCH_SIZE unless size
+
+                [size, 100].min
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,9 +16,9 @@ module Eco
 
             private
 
-            def offer_retry_on(error_type, retries_left = 3, &block)
+            def offer_retry_on(*error_types, retries_left: 3, &block)
               yield
-            rescue error_type => err
+            rescue *error_types => err
               raise err.class, err.message, cause: nil unless retries_left.positive?
 
               explanation = "#{err}\n"
@@ -29,7 +29,7 @@ module Eco
                 raise unless response.upcase.start_with?("Y")
 
                 puts "\nOkay... let's retry!"
-                offer_retry_on(error_type, retries_left - 1, &block)
+                offer_retry_on(*error_types, retries_left: retries_left - 1, &block)
               end
             end
           end

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

@@ -1,7 +1,6 @@
 require_relative 'launcher/valid_methods'
 require_relative 'launcher/options'
-require_relative 'launcher/mode'
-require_relative 'launcher/size'
+require_relative 'launcher/mode_size'
 require_relative 'launcher/benchmarking'
 require_relative 'launcher/status_handling'
 require_relative 'launcher/retry'
@@ -24,12 +23,17 @@ module Eco
           end
 
           include Options
-          include Mode
-          include Size
+          include ModeSize
           include Benchmarking
           include StatusHandling
           include Retry
 
+          TIMEOUT_RETRIES = 2
+          RETRY_ON        = [
+            Ecoportal::API::Errors::TimeOut,
+            Ecoportal::API::Errors::StartTimeOut
+          ].freeze
+
           private
 
           def batch_from(
@@ -48,7 +52,6 @@ module Eco
             launch_batch(
               data,
               method:     method,
-              per_page:   params[:per_page] || batch_size(options),
               people_api: people_api,
               silent:     silent,
               options:    options
@@ -59,54 +62,56 @@ module Eco
             data,
             method:,
             status:     nil,
-            job_mode:   true, # rubocop:disable Lint/UnusedMethodArgument
+            job_mode:   true,
             options:    self.options,
-            per_page:   batch_size(options),
             people_api: api&.people,
             silent:     false
           )
-            iteration  = 1
-            done       = 0
-            iterations = (data.length.to_f / per_page).ceil
 
             tap_status(status: status, enviro: enviro, queue: data, method: method) do |overall_status|
               pending_for_server_error = data.to_a[0..]
 
-              start_time = Time.now
+              batch_mode_on(*RETRY_ON, options: options, allow_job_mode: job_mode) do |job_mode, per_page|
+                iteration  = 0
+                done       = 0
+                iterations = (data.length.to_f / per_page).ceil
 
-              data.each_slice(per_page) do |slice|
-                msg  = "starting batch '#{method}' iteration #{iteration}/#{iterations}, "
-                msg << "with #{slice.length} entries of #{data.length} -- #{done} done"
-                msg << (" " * 20)
-                log(:info) { msg } unless silent
+                start_time = Time.now
 
-                start_slice = Time.now
+                data.each_slice(per_page) do |slice|
+                  iteration  += 1
 
-                offer_retry_on(Ecoportal::API::Errors::TimeOut) do
-                  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
+                  msg  = "starting batch '#{method}' iteration #{iteration}/#{iterations}, "
+                  msg << "with #{slice.length} entries of #{data.length} -- #{done} done"
+                  msg << (" " * 20)
+                  log(:info) { msg } unless silent
 
-                        next if server_error?(response)
+                  start_slice = Time.now
 
-                        pending_for_server_error.delete(person)
-                        overall_status[person] = response
-                      end
-                    end
-                  end # end batch
-                end
+                  offer_retry_on(*RETRY_ON, retries_left: TIMEOUT_RETRIES) do
+                    people_api.batch(job_mode: job_mode) do |batch|
+                      slice.each do |person|
+                        batch.public_send(method, person) do |response|
+                          faltal("Request with no response") unless response
 
-                done += slice.length
+                          next if server_error?(response)
 
-                msg  = "  ... iteration #{iteration}/#{iterations} done "
-                msg << "in #{str_per_sec(start_slice, slice.length)} "
-                msg << "(average: #{str_per_sec(start_time, done)})"
-                msg << (" " * 20)
-                log(:info) { msg } unless silent
+                          pending_for_server_error.delete(person)
+                          overall_status[person] = response
+                        end
+                      end
+                    end # end batch
+                  end
+
+                  done += slice.length
 
-                iteration  += 1
-              end # next slice
+                  msg  = "  ... iteration #{iteration}/#{iterations} done "
+                  msg << "in #{str_per_sec(start_slice, slice.length)} "
+                  msg << "(average: #{str_per_sec(start_time, done)})"
+                  msg << (" " * 20)
+                  log(:info) { msg } unless silent
+                end # next slice
+              end
 
               # temporary working around (due to back-end problems with batch/jobs)
               unless pending_for_server_error.empty?

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.17'.freeze
+  VERSION = '3.0.18'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.17
+  version: 3.0.18
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -229,7 +229,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 0.10.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -239,7 +239,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 0.10.6
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-graphql
   requirement: !ruby/object:Gem::Requirement
@@ -269,7 +269,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -279,7 +279,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.11
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -658,10 +658,9 @@ files:
 - lib/eco/api/session/batch/jobs_groups.rb
 - lib/eco/api/session/batch/launcher.rb
 - lib/eco/api/session/batch/launcher/benchmarking.rb
-- lib/eco/api/session/batch/launcher/mode.rb
+- lib/eco/api/session/batch/launcher/mode_size.rb
 - lib/eco/api/session/batch/launcher/options.rb
 - lib/eco/api/session/batch/launcher/retry.rb
-- lib/eco/api/session/batch/launcher/size.rb
 - lib/eco/api/session/batch/launcher/status_handling.rb
 - lib/eco/api/session/batch/launcher/valid_methods.rb
 - lib/eco/api/session/batch/policies.rb

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

@@ -1,23 +0,0 @@
-module Eco
-  module API
-    class Session
-      class Batch
-        module Launcher
-          module Mode
-            include Eco::API::Session::Batch::Launcher::Options
-
-            # @return [Symbol] the batch mode to run
-            def batch_mode(opts = options)
-              opts.dig(:workflow, :batch, :mode) || :batch
-            end
-
-            # @return [Boolean] are we running in `:job` mode?
-            def job_mode?(opts = options)
-              batch_mode(opts) == :job
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-module Eco
-  module API
-    class Session
-      class Batch
-        module Launcher
-          module Size
-            include Eco::API::Session::Batch::Launcher::Mode
-
-            DEFAULT_BATCH_SIZE = 50
-            DEFAULT_JOB_SIZE   = 100
-
-            def batch_size(opts = options)
-              return job_mode_size if job_mode?(opts)
-
-              batch_mode_size
-            end
-
-            private
-
-            def job_mode_size
-              options.dig(:workflow, :batch, :job, :size).then do |size|
-                next self.class::DEFAULT_JOB_SIZE unless size
-
-                size
-              end
-            end
-
-            def batch_mode_size
-              options.dig(:workflow, :batch, :size).then do |size|
-                next self.class::DEFAULT_BATCH_SIZE unless size
-
-                [size, 100].min
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end