Contents

#!/usr/bin/env ruby
# frozen_string_literal: true

example_description = <<DESC
  Sub-plan Concurrency Control Example
  ====================================

  This example shows, how an action with sub-plans can be used
  to control concurrency level and tasks distribution over time.

  This is useful, when doing resource-intensive bulk actions,
  where running all actions at once would drain the system's resources.

DESC

require_relative 'example_helper'

class CostyAction < Dynflow::Action

  SleepTime = 10

  def plan(number)
    action_logger.info("#{number} PLAN")
    plan_self(:number => number)
  end

  def run(event = nil)
    unless output.key? :slept
      output[:slept] = true
      suspend do |suspended_action|
        action_logger.info("#{input[:number]} SLEEP")
        world.clock.ping(suspended_action, SleepTime)
      end
    end
  end

  def finalize
    action_logger.info("#{input[:number]} DONE")
  end
end

class ConcurrencyControlExample < Dynflow::Action
  include Dynflow::Action::WithSubPlans

  ConcurrencyLevel = 2
  RunWithin = 2 * 60

  def plan(count)
    limit_concurrency_level(ConcurrencyLevel)
    distribute_over_time(RunWithin)
    super(:count => count)
  end

  def create_sub_plans
    sleep 1
    input[:count].times.map { |i| trigger(CostyAction, i) }
  end
end

if $0 == __FILE__
  ExampleHelper.world.action_logger.level = Logger::INFO
  triggered = ExampleHelper.world.trigger(ConcurrencyControlExample, 10)
  puts example_description
  puts <<-MSG.gsub(/^.*\|/, '')
    |  Execution plan #{triggered.id} with 10 sub plans triggered
    |  You can see the details at #{ExampleHelper::DYNFLOW_URL}/#{triggered.id}/actions/1/sub_plans
    |  Or simply watch in the console that there are never more than #{ConcurrencyControlExample::ConcurrencyLevel} running at the same time.
    |
    |  The tasks are distributed over #{ConcurrencyControlExample::RunWithin} seconds.
  MSG

  ExampleHelper.run_web_console
end

Version data entries

25 entries across 25 versions & 1 rubygems

Version	Path
dynflow-1.8.2	examples/sub_plan_concurrency_control.rb
dynflow-1.8.1	examples/sub_plan_concurrency_control.rb
dynflow-1.8.0	examples/sub_plan_concurrency_control.rb
dynflow-1.7.0	examples/sub_plan_concurrency_control.rb
dynflow-1.6.11	examples/sub_plan_concurrency_control.rb
dynflow-1.6.10	examples/sub_plan_concurrency_control.rb
dynflow-1.6.8	examples/sub_plan_concurrency_control.rb
dynflow-1.6.7	examples/sub_plan_concurrency_control.rb
dynflow-1.6.6	examples/sub_plan_concurrency_control.rb
dynflow-1.6.5	examples/sub_plan_concurrency_control.rb
dynflow-1.6.4	examples/sub_plan_concurrency_control.rb
dynflow-1.6.3	examples/sub_plan_concurrency_control.rb
dynflow-1.6.2	examples/sub_plan_concurrency_control.rb
dynflow-1.6.1	examples/sub_plan_concurrency_control.rb
dynflow-1.4.9	examples/sub_plan_concurrency_control.rb
dynflow-1.4.8	examples/sub_plan_concurrency_control.rb
dynflow-1.5.0	examples/sub_plan_concurrency_control.rb
dynflow-1.4.7	examples/sub_plan_concurrency_control.rb
dynflow-1.4.6	examples/sub_plan_concurrency_control.rb
dynflow-1.4.5	examples/sub_plan_concurrency_control.rb