aspera-cli 4.24.1 → 4.25.0.pre

data/lib/aspera/transfer/resumer.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'aspera/log'
+require 'aspera/assert'
+require 'aspera/transfer/error'
+
+module Aspera
+  module Transfer
+    # Implements a simple resume policy
+    class Resumer
+      # @param iter_max      [Integer] Maximum number of executions
+      # @param sleep_initial [Integer] Initial wait to re-execute
+      # @param sleep_factor  [Integer] Multiplier
+      # @param sleep_max.    [Integer] Max iterations
+      def initialize(
+        iter_max: 7,
+        sleep_initial: 2,
+        sleep_factor:  2,
+        sleep_max:     60
+      )
+        Aspera.assert_type(iter_max, Integer){k}
+        @iter_max = iter_max
+        Aspera.assert_type(sleep_initial, Integer){k}
+        @sleep_initial = sleep_initial
+        Aspera.assert_type(sleep_factor, Integer){k}
+        @sleep_factor = sleep_factor
+        Aspera.assert_type(sleep_max, Integer){k}
+        @sleep_max = sleep_max
+      end
+
+      # Calls block a number of times (resumes) until success or limit reached
+      # This is re-entrant, one resumer can handle multiple transfers in //
+      #
+      # @param block [Proc]
+      def execute_with_resume
+        Aspera.assert(block_given?)
+        # maximum of retry
+        remaining_resumes = @iter_max
+        sleep_seconds = @sleep_initial
+        Log.log.debug{"retries=#{remaining_resumes}"}
+        # try to send the file until ascp is successful
+        loop do
+          Log.log.debug('Transfer session starting')
+          begin
+            # Call provided block: execute transfer
+            yield
+            # Exit retry loop if success
+            break
+          rescue Error => e
+            Log.log.warn{"A transfer error occurred during transfer: #{e.message}"}
+            Log.log.debug{"Retryable ? #{e.retryable?}"}
+            # do not retry non-retryable
+            raise unless e.retryable?
+            # exit if we exceed the max number of retry
+            raise Error, "Maximum number of retry reached: #{@iter_max}" if remaining_resumes <= 0
+          end
+
+          # take this retry in account
+          remaining_resumes -= 1
+          Log.log.warn{"Resuming in #{sleep_seconds} seconds (retry left:#{remaining_resumes})"}
+
+          # wait a bit before retrying, maybe network condition will be better
+          sleep(sleep_seconds)
+
+          # increase retry period
+          sleep_seconds *= @sleep_factor
+          # cap value
+          sleep_seconds = @sleep_max if sleep_seconds > @sleep_max
+        end
+      end
+    end
+  end
+end

data/lib/aspera/transfer/spec.rb

@@ -5,7 +5,8 @@ require 'aspera/assert'
 
 module Aspera
   module Transfer
-    # parameters for Transfer Spec
+    # Parameters for Transfer Spec
+    # Parameters are generated from JSON Schema.
     class Spec
       # default transfer username for access key based transfers
       ACCESS_KEY_TRANSFER_USER = 'xfer'
@@ -21,7 +22,7 @@ module Aspera
       # fields for WSS
       WSS_FIELDS = %w[wss_enabled wss_port].freeze
       # all fields for transport
-      TRANSPORT_FIELDS = %w[remote_host remote_user ssh_port fasp_port].concat(WSS_FIELDS).freeze
+      TRANSPORT_FIELDS = (%w[remote_host] + AK_TSPEC_BASE.keys + WSS_FIELDS).freeze
       # reserved tag for Aspera
       TAG_RESERVED = 'aspera'
       class << self
@@ -44,12 +45,11 @@ module Aspera
         end
 
         def fix_transferd_resume_policy(transfer_spec)
-          # Fix discrepency in transfer spec
+          # Fix discrepancy in transfer spec
           transfer_spec['resume_policy'] = POLICY_FIX[transfer_spec['resume_policy']] if transfer_spec.key?('resume_policy')
         end
       end
-      SCHEMA = CommandLineBuilder.read_schema(__FILE__, 'spec')
-      CommandLineBuilder.adjust_properties_defaults(SCHEMA['properties'])
+      SCHEMA = CommandLineBuilder.read_schema(__dir__, 'spec', ascp: true)
       # define constants for enums of parameters: <parameter>_<enum>, e.g. CIPHER_AES_128, DIRECTION_SEND, ...
       SCHEMA['properties'].each do |name, description|
         next unless description['enum'].is_a?(Array)