Class: Actions::TriggerProxyBatch

Inherits:
Base
  • Object
show all
Defined in:
app/lib/actions/trigger_proxy_batch.rb

Overview

This action plans proxy tasks in batches. It needs to be manually notified about the next batch being available by sending a TriggerNextBatch event.

The ProxyAction needs to be planned with ‘:use_batch_triggering => true` to activate the feature

Constant Summary collapse

TriggerNextBatch = 
Algebrick.type do
  fields! batches: Integer
end
TriggerLastBatch = 
Algebrick.atom

Instance Method Summary collapse

Methods inherited from Base

#already_running?, #humanized_errors, #humanized_input, #humanized_name, #humanized_output, #notify_paused, #serializer_class, #task, #task_input, #task_output

Methods included from TaskSynchronization

included, #sync_execution_plan_to_task

Methods included from Helpers::LifecycleLogging

included, #log_task_state_change

Instance Method Details

#check_finish ⇒ Object 



59
60
61
62
63
64
65
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 59

def check_finish
  return on_finish if done?

  # If we're not done yet, try to trigger anything (if available)
  # and then either finish or suspend
  trigger_remote_tasks_batches
end

#done? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
70
71
72
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 67

def done?
  # We're done when we've either:
  # - dispatched everything
  # - received the last message
  output[:planned_count] + output[:failed_count] >= input[:total_count] || output[:planning_finished]
end

#init_counts ⇒ Object 



54
55
56
57
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 54

def init_counts
  output[:planned_count] = 0
  output[:failed_count] = 0
end

#on_finish ⇒ Object 



78
79
80
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 78

def on_finish
  # nothing for now
end

#remote_tasks ⇒ Object 



74
75
76
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 74

def remote_tasks
  task.remote_sub_tasks
end

#run(event = nil) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 12

def run(event = nil)
  case event
  when nil
    if output[:planned_count]
      check_finish
    else
      init_counts and suspend
    end
  when TriggerNextBatch
    trigger_remote_tasks_batches(event.batches)
  when TriggerLastBatch
    output[:planning_finished] = true
    trigger_remote_tasks_batches
  when ::Dynflow::Action::Skip
    # do nothing
  end
end

#trigger_remote_tasks_batch ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 35

def trigger_remote_tasks_batch
  # Find the tasks in batches, order them by proxy_url so we get all tasks
  # to a certain proxy "close to each other"
  batch = remote_tasks.pending.order(:proxy_url, :id).first(batch_size)
  # Group the tasks by operation, in theory there should be only one operation
  batch.group_by(&:operation).each do |operation, group|
    ForemanTasks::RemoteTask.batch_trigger(operation, group)
    output[:planned_count] += group.size
  end
rescue => e
  action_logger.warn "Could not trigger task on the smart proxy"
  action_logger.warn e
  # The response contains non-serializable objects
  # TypeError: no _dump_data is defined for class Monitor
  e.response = nil
  batch.each { |remote_task| remote_task.update_from_batch_trigger({ 'exception' => e }) }
  output[:failed_count] += batch.size
end

#trigger_remote_tasks_batches(amount = 1) ⇒ Object 



30
31
32
33
 
# File 'app/lib/actions/trigger_proxy_batch.rb', line 30

def trigger_remote_tasks_batches(amount = 1)
  amount.times { trigger_remote_tasks_batch }
  done? ? on_finish : suspend
end