Module: Dynflow::Action::Rescue

Included in:
Dynflow::Action
Defined in:
lib/dynflow/action/rescue.rb

Constant Summary collapse

Strategy = 
Algebrick.type do
  variants Skip = atom, Pause = atom, Fail = atom
end
SuggestedStrategy = 
Algebrick.type do
  fields! action:   Action,
          strategy: Strategy
end

Instance Method Summary collapse

Instance Method Details

#combine_suggested_strategies(suggested_strategies) ⇒ Object

Override when different approach should be taken for combining the suggested strategies



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/dynflow/action/rescue.rb', line 52

def combine_suggested_strategies(suggested_strategies)
  if suggested_strategies.empty?
    nil
  else
    # TODO: Find the safest rescue strategy among the suggested ones
    if suggested_strategies.all? { |suggested_strategy| suggested_strategy.strategy == Skip }
      return Skip
    elsif suggested_strategies.all? { |suggested_strategy| suggested_strategy.strategy == Fail }
      return Fail
    else
      return Pause # We don't know how to handle this case, so we'll just pause
    end
  end
end

#rescue_strategy ⇒ Object

What strategy should be used for rescuing from error in the action or its sub actions

When determining the strategy, the algorithm starts from the entry action that by default takes the strategy from #rescue_strategy_for_self and #rescue_strategy_for_planned_actions and combines them together.

Returns:

  • Strategy



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/dynflow/action/rescue.rb', line 22

def rescue_strategy
  suggested_strategies = []

  if self.steps.compact.any? { |step| step.state == :error }
    suggested_strategies << SuggestedStrategy[self, rescue_strategy_for_self]
  end

  self.planned_actions.each do |planned_action|
    rescue_strategy = rescue_strategy_for_planned_action(planned_action)
    next unless rescue_strategy # ignore actions that have no say in the rescue strategy
    suggested_strategies << SuggestedStrategy[planned_action, rescue_strategy]
  end

  combine_suggested_strategies(suggested_strategies)
end

#rescue_strategy_for_planned_action(action) ⇒ Object

Override when the action should override the rescue strategy of an action it planned



46
47
48
 
# File 'lib/dynflow/action/rescue.rb', line 46

def rescue_strategy_for_planned_action(action)
  action.rescue_strategy
end

#rescue_strategy_for_self ⇒ Object

Override when another strategy should be used for rescuing from error on the action



40
41
42
 
# File 'lib/dynflow/action/rescue.rb', line 40

def rescue_strategy_for_self
  return Pause
end