Class: CanvasSync::JobBatches::ChainBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/canvas_sync/job_batches/chain_builder.rb

Constant Summary collapse

VALID_PLACEMENT_PARAMETERS = 
%i[before after with].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_type = SerialBatchJob) ⇒ ChainBuilder

Returns a new instance of ChainBuilder.



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 8

def initialize(base_type = SerialBatchJob)
  if base_type.is_a?(Hash)
    @base_job = base_type
  else
    @base_job = {
      job: base_type,
      parameters: [],
    }
  end
end

Instance Attribute Details

#base_job ⇒ Object (readonly)

Returns the value of attribute base_job.



6
7
8
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 6

def base_job
  @base_job
end

Class Method Details

._job_type_definitions ⇒ Object 



190
191
192
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 190

def _job_type_definitions
  @job_type_definitions ||= {}
end

.build(job, *args, &blk) ⇒ Object 



183
184
185
186
187
188
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 183

def build(job, *args, &blk)
  new(job).tap do |ch|
    ch[:parameters] = args
    ch.apply_block(&blk)
  end
end

.enqueue_job(job_def) ⇒ Object

TODO: Add a Chain progress web View Augment Batch tree-view with Chain data

> [DONE] Tree view w/o Chain will only show Parent/Current batches and Job Counts
> If augmented with Chain data, the above will be annotated with Chain-related info and will be able to show Jobs defined in the Chain
  > Chain-jobs will be supplied chain_id and chain_step_id metadata
  > Using server-middleware, if a Chain-job (has chain_id and chain_step_id) creates a Batch, tag the Batch w/ the chain_id and chain_step_id
  > UI will map Batches to Chain-steps using the chain_step_id. UI will add entries for any Chain-steps that were not tied to a Batch
> [DONE] Use a Lua script to find child batch IDs. Support max_depth, items_per_depth, top_depth_slice parameters



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 220

def enqueue_job(job_def)
  job_class = job_def[:job].constantize
  job_options = job_def[:parameters] || []

  # Legacy Support
  if job_def[:options]
    job_options << {} unless job_options[-1].is_a?(Hash)
    job_options[-1].merge!(job_def[:options])
  end

  if job_class.respond_to? :perform_async
    job_class.perform_async(*job_options)
  else
    job_class.perform_later(*job_options)
  end
end

.get_chain_parameter(job_def, raise_error: true) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 201

def get_chain_parameter(job_def, raise_error: true)
  unless _job_type_definitions[job_def[:job].to_s].present?
    raise "Job Type #{job_def[:job].to_s} does not accept a sub-chain" if raise_error
    return nil
  end

  key = _job_type_definitions[job_def[:job].to_s][:chain_parameter]
  mapper = ParamsMapper.new(job_def[:parameters])
  mapper[key] ||= []
end

.register_chain_job(job_class, chain_parameter, **options) ⇒ Object 



194
195
196
197
198
199
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 194

def register_chain_job(job_class, chain_parameter, **options)
  _job_type_definitions[job_class.to_s] = {
    **options,
    chain_parameter: chain_parameter,
  }
end

Instance Method Details

#<<(new_job) ⇒ Object 



36
37
38
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 36

def <<(new_job)
  insert_at(-1, new_job)
end

#[](key) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 24

def [](key)
  if key.is_a?(Class)
    get_sub_chain(key)
  else
    @base_job[key]
  end
end

#apply_block(&blk) ⇒ Object 



135
136
137
138
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 135

def apply_block(&blk)
  return unless blk.present?
  instance_exec(&blk)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 101

def empty?
  self.class.get_chain_parameter(self).empty?
end

#get_sub_chain(sub_type) ⇒ Object 



105
106
107
108
109
110
111
112
113
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 105

def get_sub_chain(sub_type)
  matching_jobs = find_matching_jobs(sub_type).to_a
  raise "Found multiple \"#{sub_type}\" jobs in the chain" if matching_jobs.count > 1
  return nil if matching_jobs.count == 0

  job = matching_jobs[0][0]
  job = self.class.new(job) unless job.is_a?(ChainBuilder)
  job
end

#insert(new_jobs, *args, **kwargs, &blk) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 51

def insert(new_jobs, *args, **kwargs, &blk)
  if new_jobs.is_a?(Class) || new_jobs.is_a?(String)
    job_kwargs = kwargs.except(*VALID_PLACEMENT_PARAMETERS)
    args << job_kwargs if job_kwargs.present?
    new_jobs = build_job_hash(new_jobs, *args, &blk)
    kwargs = kwargs.slice(*VALID_PLACEMENT_PARAMETERS)
  else
    invalid_params = kwargs.keys - VALID_PLACEMENT_PARAMETERS
    raise "Invalid placement parameters: #{invalid_params.map(&:to_s).join(', ')}" if invalid_params.present?
    raise "At most one placement parameter may be provided" if kwargs.values.compact.length > 1
    raise "Unexpected number of arguments" if args.length > 0
  end

  new_jobs = [new_jobs] unless new_jobs.is_a?(Array)

  if !kwargs.present?
    insert_at(-1, new_jobs)
  else
    placement = kwargs.keys[0]
    relative_to = kwargs.values[0]

    matching_jobs = find_matching_jobs(relative_to).to_a
    raise "Could not find a \"#{relative_to}\" job in the chain" if matching_jobs.count == 0
    raise "Found multiple \"#{relative_to}\" jobs in the chain" if matching_jobs.count > 1

    relative_job, parent_job, sub_index = matching_jobs[0]
    needed_parent_type = placement == :with ? ConcurrentBatchJob : SerialBatchJob

    chain = self.class.get_chain_parameter(parent_job)

    if parent_job[:job] != needed_parent_type
      old_job = chain[sub_index]
      parent_job = chain[sub_index] = {
        job: needed_parent_type,
        parameters: [],
      }
      sub_index = 0
      chain = self.class.get_chain_parameter(parent_job)
      chain << old_job
    end

    if placement == :with
      chain.insert(-1, *new_jobs)
    else
      sub_index += 1 if placement == :after
      chain.insert(sub_index, *new_jobs)
    end
  end
end

#insert_at(position, new_jobs, *args, &blk) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 40

def insert_at(position, new_jobs, *args, &blk)
  chain = self.class.get_chain_parameter(base_job)
  if new_jobs.is_a?(Class) || new_jobs.is_a?(String)
    new_jobs = build_job_hash(new_jobs, *args, &blk)
  elsif args.length > 0
    raise "Unexpected number of arguments"
  end
  new_jobs = [new_jobs] unless new_jobs.is_a?(Array)
  chain.insert(position, *new_jobs)
end

#merge_options(job, options) ⇒ Object

Legacy Support



128
129
130
131
132
133
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 128

def merge_options(job, options)
  find_matching_jobs(job).each do |j, parent, index|
    j[:options] ||= {}
    j[:options].deep_merge!(options)
  end
end

#normalize!(job_def = self.base_job) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 115

def normalize!(job_def = self.base_job)
  if job_def.is_a?(ChainBuilder)
    job_def.normalize!
  else
    job_def[:job] = job_def[:job].to_s
    if (chain = self.class.get_chain_parameter(job_def, raise_error: false)).present?
      chain.map! { |sub_job| normalize!(sub_job) }
    end
    job_def
  end
end

#params ⇒ Object 



32
33
34
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 32

def params
  ParamsMapper.new(self[:parameters])
end

#process! ⇒ Object 



19
20
21
22
 
# File 'lib/canvas_sync/job_batches/chain_builder.rb', line 19

def process!
  normalize!
  self.class.enqueue_job(base_job)
end