Class: Aspera::Agent::Direct

Inherits:
Base
  • Object
show all
Defined in:
lib/aspera/agent/direct.rb

Overview

executes a local “ascp”, connects mgt port, equivalent of “Fasp Manager”

Constant Summary

Constants inherited from Base

Base::RUBY_EXT

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

agent_list, options, #wait_for_completion

Instance Attribute Details

#sessions ⇒ Object (readonly)

Returns the value of attribute sessions.



323
324
325
 
# File 'lib/aspera/agent/direct.rb', line 323

def sessions
  @sessions
end

Instance Method Details

#process_progress(event) ⇒ Object

Parameters:

  • event —

    management port event



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aspera/agent/direct.rb', line 146

def process_progress(event)
  session_id = event['SessionId']
  case event['Type']
  when 'INIT'
    @pre_calc_sent = false
    @pre_calc_last_size = nil
    notify_progress(session_id: session_id, type: :session_start)
  when 'NOTIFICATION' # sent from remote
    if event.key?('PreTransferBytes')
      @pre_calc_sent = true
      notify_progress(session_id: session_id, type: :session_size, info: event['PreTransferBytes'])
    end
  when 'STATS' # during transfer
    @pre_calc_last_size = event['TransferBytes'].to_i + event['StartByte'].to_i
    notify_progress(session_id: session_id, type: :transfer, info: @pre_calc_last_size)
  when 'DONE', 'ERROR' # end of session
    total_size = event['TransferBytes'].to_i + event['StartByte'].to_i
    if !@pre_calc_sent && !total_size.zero?
      notify_progress(session_id: session_id, type: :session_size, info: total_size)
    end
    if @pre_calc_last_size != total_size
      notify_progress(session_id: session_id, type: :transfer, info: total_size)
    end
    notify_progress(session_id: session_id, type: :end)
    # cspell:disable
  when 'SESSION'
  when 'ARGSTOP'
  when 'FILEERROR'
  when 'STOP'
    # cspell:enable
    # stop event when one file is completed
  else
    Log.log.debug{"unknown event type #{event['Type']}"}
  end
end

#send_command(job_id, data) ⇒ Object

send command of management port to ascp session (used in ‘asession) ’type’=>‘START’,‘source’=><em>path</em>,‘destination’=><em>path</em> ‘type’=>‘DONE’

Parameters:

  • job_id —

    identified transfer process

  • session_index —

    index of session (for multi session)

  • data —

    command on mgt port, examples:



311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/aspera/agent/direct.rb', line 311

def send_command(job_id, data)
  session = session_by_id(job_id)
  Log.log.debug{"command: #{data}"}
  # build command
  command = data
    .keys
    .map{|k|"#{k.capitalize}: #{data[k]}"}
    .unshift(MGT_HEADER)
    .push('', '')
    .join("\n")
  session[:io].puts(command)
end

#session_by_id(id) ⇒ Hash

Returns session information.

Returns:

  • (Hash) —

    session information



298
299
300
301
302
303
 
# File 'lib/aspera/agent/direct.rb', line 298

def session_by_id(id)
  matches = @sessions.select{|s| s[:id].eql?(id)}
  raise 'no such session' if matches.empty?
  raise 'more than one session' if matches.length > 1
  return matches.first
end

#sessions_by_job(job_id) ⇒ Array

Returns list of sessions for a job.

Returns:

  • (Array) —

    list of sessions for a job



293
294
295
 
# File 'lib/aspera/agent/direct.rb', line 293

def sessions_by_job(job_id)
  @sessions.select{|s| s[:job_id].eql?(job_id)}
end

#shutdown ⇒ Object

used by asession (to be removed ?)



141
142
143
 
# File 'lib/aspera/agent/direct.rb', line 141

def shutdown
  Log.log.debug('fasp local shutdown')
end

#start_transfer(transfer_spec, token_regenerator: nil) ⇒ Object

method of Base start ascp transfer(s) (non blocking), single or multi-session session information added to @sessions

Parameters:

  • transfer_spec (Hash) —

    aspera transfer specification

  • token_regenerator (Object) (defaults to: nil) —

    object with method refreshed_transfer_token



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspera/agent/direct.rb', line 44

def start_transfer(transfer_spec, token_regenerator: nil)
  # clone transfer spec because we modify it (first level keys)
  transfer_spec = transfer_spec.clone
  # if there are aspera tags
  if transfer_spec.dig('tags', Transfer::Spec::TAG_RESERVED).is_a?(Hash)
    # TODO: what is this for ? only on local ascp ?
    # NOTE: important: transfer id must be unique: generate random id
    # using a non unique id results in discard of tags in AoC, and a package is never finalized
    # all sessions in a multi-session transfer must have the same xfer_id (see admin manual)
    transfer_spec['tags'][Transfer::Spec::TAG_RESERVED]['xfer_id'] ||= SecureRandom.uuid
    Log.log.debug{"xfer id=#{transfer_spec['xfer_id']}"}
    # TODO: useful ? node only ? seems to be a timeout for retry in node
    transfer_spec['tags'][Transfer::Spec::TAG_RESERVED]['xfer_retry'] ||= 3600
  end
  Log.log.debug{Log.dump('ts', transfer_spec)}
  # Compute this before using transfer spec because it potentially modifies the transfer spec
  # (even if the var is not used in single session)
  multi_session_info = nil
  if transfer_spec.key?('multi_session')
    multi_session_info = {
      count: transfer_spec['multi_session'].to_i
    }
    # Managed by multi-session, so delete from transfer spec
    transfer_spec.delete('multi_session')
    if multi_session_info[:count].negative?
      Log.log.error{"multi_session(#{transfer_spec['multi_session']}) shall be integer >= 0"}
      multi_session_info = nil
    elsif multi_session_info[:count].eql?(0)
      Log.log.debug('multi_session count is zero: no multi session')
      multi_session_info = nil
    elsif @options[:multi_incr_udp] # multi_session_info[:count] > 0
      # if option not true: keep default udp port for all sessions
      multi_session_info[:udp_base] = transfer_spec.key?('fasp_port') ? transfer_spec['fasp_port'] : Transfer::Spec::UDP_PORT
      # delete from original transfer spec, as we will increment values
      transfer_spec.delete('fasp_port')
      # override if specified, else use default value
    end
  end

  # generic session information
  session = {
    id:                nil, # SessionId from INIT message in mgt port
    job_id:            SecureRandom.uuid, # job id (regroup sessions)
    ts:                transfer_spec,     # transfer spec
    thread:            nil,               # Thread object monitoring management port, not nil when pushed to :sessions
    error:             nil,               # exception if failed
    io:                nil,               # management port server socket
    token_regenerator: token_regenerator, # regenerate bearer token with oauth
    # env vars and args to ascp (from transfer spec)
    env_args:          Transfer::Parameters.new(transfer_spec, @options).ascp_args
  }

  if multi_session_info.nil?
    Log.log.debug('Starting single session thread')
    # single session for transfer : simple
    session[:thread] = Thread.new(session) {|s|transfer_thread_entry(s)}
    @sessions.push(session)
  else
    Log.log.debug('Starting multi session threads')
    1.upto(multi_session_info[:count]) do |i|
      # do not delay the first session
      sleep(@options[:spawn_delay_sec]) unless i.eql?(1)
      # do deep copy (each thread has its own copy because it is modified here below and in thread)
      this_session = session.clone
      this_session[:ts] = this_session[:ts].clone
      this_session[:env_args] = this_session[:env_args].clone
      this_session[:env_args][:args] = this_session[:env_args][:args].clone
      # set multi session part
      this_session[:env_args][:args].unshift("-C#{i}:#{multi_session_info[:count]}")
      # option: increment (default as per ascp manual) or not (cluster on other side ?)
      this_session[:env_args][:args].unshift('-O', (multi_session_info[:udp_base] + i - 1).to_s) if @options[:multi_incr_udp]
      # finally start the thread
      this_session[:thread] = Thread.new(this_session) {|s|transfer_thread_entry(s)}
      @sessions.push(this_session)
    end
  end
  return session[:job_id]
end

#start_transfer_with_args_env(env_args, session) ⇒ Object

This is the low level method to start the “ascp” process currently, relies on command line arguments start ascp with management port. raises FaspError on error if there is a thread info: set and broadcast session id runs in separate thread could be private method

Parameters:

  • env_args —

    a hash containing :args :env :ascp_version

  • session —

    this session information



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/aspera/agent/direct.rb', line 191

def start_transfer_with_args_env(env_args, session)
  Aspera.assert_type(env_args, Hash)
  Aspera.assert_type(session, Hash)
  Log.log.debug{"env_args=#{env_args.inspect}"}
  notify_progress(session_id: nil, type: :pre_start, info: 'starting')
  begin
    ascp_pid = nil
    # we use Socket directly, instead of TCPServer, as it gives access to lower level options
    socket_class = RUBY_ENGINE.eql?('jruby') ? ServerSocket : Socket
    mgt_server_socket = socket_class.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
    # open any available (0) local TCP port for use as ascp management port
    mgt_server_socket.bind(Addrinfo.tcp(LISTEN_LOCAL_ADDRESS, ANY_AVAILABLE_PORT))
    # build arguments and add mgt port
    ascp_arguments = ['-M', mgt_server_socket.local_address.ip_port.to_s].concat(env_args[:args])
    # get location of ascp executable
    ascp_path = Ascp::Installation.instance.path(env_args[:ascp_version])
    # display ascp command line
    Log.log.debug do
      [
        'execute:'.red,
        env_args[:env].map{|k, v| "#{k}=#{Shellwords.shellescape(v)}"},
        Shellwords.shellescape(ascp_path),
        ascp_arguments.map{|a|Shellwords.shellescape(a)}
      ].flatten.join(' ')
    end
    # start ascp in separate process
    ascp_pid = Process.spawn(env_args[:env], [ascp_path, ascp_path], *ascp_arguments, close_others: true)
    Log.log.debug{"spawned ascp pid #{ascp_pid}"}
    notify_progress(session_id: nil, type: :pre_start, info: 'waiting for ascp')
    mgt_server_socket.listen(1)
    # TODO: timeout does not work when Process.spawn is used... until process exits, then it works
    Log.log.debug{"before select, timeout: #{@options[:spawn_timeout_sec]}"}
    readable, _, _ = IO.select([mgt_server_socket], nil, nil, @options[:spawn_timeout_sec])
    Log.log.debug('after select, before accept')
    Aspera.assert(readable, exception_class: Transfer::Error){'timeout waiting mgt port connect (select not readable)'}
    # There is a connection to accept
    client_socket, _client_addrinfo = mgt_server_socket.accept
    Log.log.debug('after accept')
    ascp_mgt_io = client_socket.to_io
    # management messages include file names which may be utf8
    # by default socket is US-ASCII
    # TODO: use same value as Encoding.default_external
    ascp_mgt_io.set_encoding(Encoding::UTF_8)
    session[:io] = ascp_mgt_io
    processor = Ascp::Management.new
    # read management port, until socket is closed (gets returns nil)
    while (line = ascp_mgt_io.gets)
      event = processor.process_line(line.chomp)
      next unless event
      # event is ready
      Log.log.trace1{Log.dump(:management_port, event)}
      @options[:management_cb]&.call(event)
      process_progress(event)
      Log.log.error((event['Description']).to_s) if event['Type'].eql?('FILEERROR') # cspell:disable-line
    end
    Log.log.debug('management io closed')
    last_event = processor.last_event
    # check that last status was received before process exit
    if last_event.is_a?(Hash)
      case last_event['Type']
      when 'ERROR'
        if /bearer token/i.match?(last_event['Description']) &&
            session[:token_regenerator].respond_to?(:refreshed_transfer_token)
          # regenerate token here, expired, or error on it
          # Note: in multi-session, each session will have a different one.
          Log.log.warn('Regenerating token for transfer')
          env_args[:env]['ASPERA_SCP_TOKEN'] = session[:token_regenerator].refreshed_transfer_token
        end
        raise Transfer::Error.new(last_event['Description'], last_event['Code'].to_i)
      when 'DONE'
        nil
      else
        raise "unexpected last event type: #{last_event['Type']}"
      end # case
    end
  rescue SystemCallError => e
    # Process.spawn failed, or socket error
    raise Transfer::Error, e.message
  rescue Interrupt
    raise Transfer::Error, 'transfer interrupted by user'
  ensure
    mgt_server_socket.close
    # if ascp was successfully started, check its status
    unless ascp_pid.nil?
      # "wait" for process to avoid zombie
      Process.wait(ascp_pid)
      status = $CHILD_STATUS
      ascp_pid = nil
      session.delete(:io)
      # status is nil if an exception occurred before starting ascp
      if !status&.success?
        message = status.nil? ? 'ascp not started' : "ascp failed (#{status})"
        # raise error only if there was not already an exception (ERROR_INFO)
        raise Transfer::Error, message unless $ERROR_INFO
        # else display this message also, as main exception is already here
        Log.log.error(message)
      end
    end
  end # begin-ensure
end

#wait_for_transfers_completion ⇒ Object

wait for completion of all jobs started

Returns:

  • list of :success or error message



125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/aspera/agent/direct.rb', line 125

def wait_for_transfers_completion
  Log.log.debug('wait_for_transfers_completion')
  # set to non-nil to exit loop
  result = []
  @sessions.each do |session|
    Log.log.debug{"join #{session[:thread]}"}
    session[:thread].join
    result.push(session[:error] || :success)
  end
  Log.log.debug('all transfers joined')
  # since all are finished and we return the result, clear statuses
  @sessions.clear
  return result
end