Class: Kaal::SchedulerFileLoader::JobApplier

Inherits:
Object
  • Object
show all
Includes:
Kaal::Support::HashTools
Defined in:
lib/kaal/scheduler_file/job_applier.rb

Overview

Applies normalized scheduler jobs and rolls them back on failure.

Instance Method Summary collapse

Methods included from Kaal::Support::HashTools

constantize, deep_dup, deep_merge, duplicable?, stringify_keys, symbolize_keys

Constructor Details

#initialize(configuration:, definition_registry:, registry:, logger:, helper_bundle:) ⇒ JobApplier

Returns a new instance of JobApplier.



15
16
17
18
19
20
21
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 15

def initialize(configuration:, definition_registry:, registry:, logger:, helper_bundle:)
  @configuration = configuration
  @definition_registry = definition_registry
  @registry = registry
  @logger = logger
  @helper_bundle = helper_bundle
end

Instance Method Details

#apply(job) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 23

def apply(job)
  key = job.fetch(:key)
  cron = job.fetch(:cron)
  job_class_name = job.fetch(:job_class_name)
  queue = job.fetch(:queue)
  existing_definition = @definition_registry.find_definition(key)
  existing_registry_entry = @registry.find(key)
  return nil if conflict?(key:, existing_definition:)

  job_class = resolved_job_class(job_class_name:, key:, queue:)
  callback = callback_for(
    key: key,
    job_class_name: job_class_name,
    queue: queue,
    args_template: job.fetch(:args),
    kwargs_template: job.fetch(:kwargs)
  )
  persisted_metadata = persisted_metadata(job, job_class)

  @definition_registry.upsert_definition(
    key: key,
    cron: cron,
    enabled: job.fetch(:enabled),
    source: 'file',
    metadata: persisted_metadata
  )

  begin
    @registry.upsert(key: key, cron: cron, enqueue: callback)
  rescue StandardError
    rollback_job(key:, existing_definition:, existing_registry_entry:)
    raise
  end

  { key: key, existing_definition: existing_definition, existing_registry_entry: existing_registry_entry }
end

#callback_for(key:, job_class_name:, queue:, args_template:, kwargs_template:) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 66

def callback_for(key:, job_class_name:, queue:, args_template:, kwargs_template:)
  job_class = resolved_job_class(job_class_name:, key:, queue:)
  build_callback(
    {
      key: key,
      queue: queue,
      args: args_template,
      kwargs: kwargs_template
    },
    job_class
  )
end

#conflict?(key:, existing_definition:) ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 88

def conflict?(key:, existing_definition:)
  existing_source = existing_definition&.[](:source)
  return false unless existing_source && existing_source.to_s != 'file'

  policy = @configuration.scheduler_conflict_policy
  case policy
  when :error
    raise SchedulerConfigError, "Scheduler key conflict for '#{key}' with existing source '#{existing_source}'"
  when :code_wins
    @logger&.warn("Skipping scheduler file job '#{key}' because scheduler_conflict_policy is :code_wins")
    true
  when :file_wins
    false
  else
    raise SchedulerConfigError, "Unsupported scheduler_conflict_policy '#{policy}'"
  end
end

#resolved_job_class(job_class_name:, key:, queue: nil) ⇒ Object 



79
80
81
82
83
84
85
86
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 79

def resolved_job_class(job_class_name:, key:, queue: nil)
  Kaal::JobDispatcher.resolve_job_class(
    job_class_name:,
    key:,
    queue:,
    apply_delayed_job_allow_list: false
  )
end

#rollback_job(key:, existing_definition:, existing_registry_entry:) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 106

def rollback_job(key:, existing_definition:, existing_registry_entry:)
  if existing_definition
    @definition_registry.upsert_definition(
      **Definition::AttributeHelpers.definition_attributes(existing_definition), enabled: existing_definition[:enabled]
    )
  else
    @definition_registry.remove_definition(key)
  end

  @registry.remove(key) if @registry.registered?(key)

  return unless existing_registry_entry

  @registry.upsert(
    key: existing_registry_entry.key,
    cron: existing_registry_entry.cron,
    enqueue: existing_registry_entry.enqueue
  )
rescue StandardError => e
  @logger&.error("Failed to rollback scheduler file application for #{key}: #{e.message}")
end

#rollback_jobs(applied_job_contexts) ⇒ Object 



60
61
62
63
64
 
# File 'lib/kaal/scheduler_file/job_applier.rb', line 60

def rollback_jobs(applied_job_contexts)
  applied_job_contexts.reverse_each do |applied_job_context|
    rollback_job(**applied_job_context)
  end
end