Module: Karafka::Pro::RecurringTasks

Defined in:
lib/karafka/pro/recurring_tasks.rb,
lib/karafka/pro/recurring_tasks/task.rb,
lib/karafka/pro/recurring_tasks/errors.rb,
lib/karafka/pro/recurring_tasks/matcher.rb,
lib/karafka/pro/recurring_tasks/consumer.rb,
lib/karafka/pro/recurring_tasks/executor.rb,
lib/karafka/pro/recurring_tasks/listener.rb,
lib/karafka/pro/recurring_tasks/schedule.rb,
lib/karafka/pro/recurring_tasks/dispatcher.rb,
lib/karafka/pro/recurring_tasks/serializer.rb,
lib/karafka/pro/recurring_tasks/deserializer.rb,
lib/karafka/pro/recurring_tasks/setup/config.rb,
lib/karafka/pro/recurring_tasks/contracts/task.rb,
lib/karafka/pro/recurring_tasks/contracts/config.rb

Overview

Recurring tasks functionality

Defined Under Namespace

Modules: Contracts, Errors, Setup Classes: Consumer, Deserializer, Dispatcher, Executor, Listener, Matcher, Schedule, Serializer, Task

Class Method Summary collapse

Class Method Details

.define(version = '1.0.0', &block) ⇒ Object

Simplified API for schedules definitions and validates the tasks data

Examples:

Karafka::Pro::RecurringTasks.define('1.0.1') do
  schedule(id: 'mailer', cron: '* * * * *') do
    MailingJob.perform_async
  end
end

Parameters:

  • version (String) (defaults to: '1.0.0')
  • block (Proc) 


27
28
29
30
31
32
33
34
35
36
 
# File 'lib/karafka/pro/recurring_tasks.rb', line 27

def define(version = '1.0.0', &block)
  @schedule = Schedule.new(version: version)
  @schedule.instance_exec(&block)

  @schedule.each do |task|
    Contracts::Task.new.validate!(task.to_h)
  end

  @schedule
end

.post_setup(config) ⇒ Object

Parameters:

  • config (Karafka::Core::Configurable::Node) —

    root node config



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/karafka/pro/recurring_tasks.rb', line 61

def post_setup(config)
  RecurringTasks::Contracts::Config.new.validate!(config.to_h)

  # Published after task is successfully executed
  Karafka.monitor.notifications_bus.register_event('recurring_tasks.task.executed')

  # Initialize empty dummy schedule, so we always have one and so we do not have to
  # deal with a case where there is no schedule
  RecurringTasks.schedule

  # User can disable logging of executions, in which case we don't track them
  return unless Karafka::App.config.recurring_tasks.logging

  Karafka.monitor.subscribe(Listener.new)
end

.pre_setup(config) ⇒ Object

Sets up additional config scope, validations and other things

Parameters:

  • config (Karafka::Core::Configurable::Node) —

    root node config



53
54
55
56
57
58
 
# File 'lib/karafka/pro/recurring_tasks.rb', line 53

def pre_setup(config)
  # Expand the config with this feature specific stuff
  config.instance_eval do
    setting(:recurring_tasks, default: Setup::Config.config)
  end
end

.schedule ⇒ Schedule?

Returns current defined schedule or nil if not defined.

Returns:

  • (Schedule, nil) —

    current defined schedule or nil if not defined



12
13
14
 
# File 'lib/karafka/pro/recurring_tasks.rb', line 12

def schedule
  @schedule || define('0.0.0') {}
end