Module: CanvasSync

Defined in:
lib/canvas_sync.rb,
lib/canvas_sync/job.rb,
lib/canvas_sync/config.rb,
lib/canvas_sync/engine.rb,
lib/canvas_sync/record.rb,
lib/canvas_sync/version.rb,
lib/canvas_sync/live_events.rb,
lib/canvas_sync/misc_helper.rb,
lib/canvas_sync/sidekiq_job.rb,
app/models/canvas_sync/job_log.rb,
lib/canvas_sync/batch_processor.rb,
app/models/canvas_sync/sync_batch.rb,
lib/canvas_sync/jobs/report_checker.rb,
lib/canvas_sync/jobs/report_starter.rb,
lib/canvas_sync/jobs/sync_roles_job.rb,
lib/canvas_sync/jobs/sync_terms_job.rb,
lib/canvas_sync/jobs/sync_admins_job.rb,
lib/canvas_sync/jobs/sync_scores_job.rb,
lib/canvas_sync/jobs/sync_rubrics_job.rb,
lib/canvas_sync/jobs/term_batches_job.rb,
lib/canvas_sync/jobs/sync_accounts_job.rb,
lib/canvas_sync/class_callback_executor.rb,
lib/canvas_sync/importers/bulk_importer.rb,
lib/canvas_sync/importers/legacy_importer.rb,
lib/canvas_sync/jobs/begin_sync_chain_job.rb,
lib/canvas_sync/jobs/report_processor_job.rb,
lib/canvas_sync/jobs/sync_assignments_job.rb,
lib/canvas_sync/jobs/sync_submissions_job.rb,
lib/canvas_sync/jobs/sync_simple_table_job.rb,
lib/canvas_sync/processors/normal_processor.rb,
lib/canvas_sync/processors/report_processor.rb,
lib/canvas_sync/generators/install_generator.rb,
lib/canvas_sync/processors/rubrics_processor.rb,
lib/canvas_sync/jobs/sync_context_modules_job.rb,
lib/canvas_sync/jobs/sync_assignment_groups_job.rb,
lib/canvas_sync/jobs/sync_course_progresses_job.rb,
lib/canvas_sync/jobs/sync_content_migrations_job.rb,
lib/canvas_sync/jobs/sync_rubric_assessments_job.rb,
lib/canvas_sync/processors/assignments_processor.rb,
lib/canvas_sync/processors/submissions_processor.rb,
lib/canvas_sync/jobs/sync_provisioning_report_job.rb,
lib/canvas_sync/jobs/sync_rubric_associations_job.rb,
lib/canvas_sync/jobs/sync_assignment_overrides_job.rb,
lib/canvas_sync/jobs/sync_context_module_items_job.rb,
lib/canvas_sync/processors/context_modules_processor.rb,
lib/canvas_sync/processors/assignment_groups_processor.rb,
lib/canvas_sync/processors/content_migrations_processor.rb,
lib/canvas_sync/processors/rubric_assessments_processor.rb,
lib/canvas_sync/generators/install_live_events_generator.rb,
lib/canvas_sync/processors/provisioning_report_processor.rb,
lib/canvas_sync/processors/rubric_associations_processor.rb,
lib/canvas_sync/processors/assignment_overrides_processor.rb,
lib/canvas_sync/processors/context_module_items_processor.rb,
lib/canvas_sync/processors/course_completion_report_processor.rb

Defined Under Namespace

Modules: Api, ApiSyncable, Concerns, Importers, JobBatches, JobUniqueness, Jobs, LiveEvents, MiscHelper, Processors, Record, Sidekiq Classes: BatchProcessor, ClassCallbackExecutor, Config, Engine, InstallGenerator, InstallLiveEventsGenerator, Job, JobLog, SyncBatch

Constant Summary collapse

SUPPORTED_MODELS = 
%w[
  users
  pseudonyms
  courses
  groups
  group_memberships
  accounts
  terms
  enrollments
  sections
  assignments
  submissions
  roles
  admins
  assignment_groups
  context_modules
  context_module_items
  xlist
  user_observers
  grading_periods
  grading_period_groups
  content_migrations
  learning_outcomes
  learning_outcome_results
  course_nicknames
  rubrics
  rubric_associations
  rubric_assessments
  course_progresses
  assignment_overrides
  scores
].freeze
SUPPORTED_TERM_SCOPE_MODELS = 
%w[
  assignments
  submissions
  assignment_groups
  context_modules
  context_module_items
  rubrics
  rubric_associations
  rubric_assessments
  course_progresses
  assignment_overrides
  scores
].freeze
DEFAULT_TERM_SCOPE_MODELS = 
%w[
  assignments
  submissions
  assignment_groups
  context_modules
  context_module_items
  rubrics
  rubric_associations
  rubric_assessments
  course_progresses
  assignment_overrides
  scores
].freeze
SUPPORTED_LIVE_EVENTS = 
%w[
  course
  enrollment
  submission
  assignment
  user
  syllabus
  grade
  module
  module_item
  course_section
].freeze
SUPPORTED_NON_PROV_REPORTS = 
%w[
  graded_submissions
].freeze
VERSION = 
"0.22.18".freeze

Class Method Summary collapse

Class Method Details

.base_canvas_sync_chain(legacy_support: false, account_id: nil, updated_after: nil, full_sync_every: nil, batch_genre: nil, globals: {}, &blk) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/canvas_sync.rb', line 247

def base_canvas_sync_chain(
  legacy_support: false, # Import records 1 by 1 instead of with bulk upserts
  account_id: nil, # legacy/non PandaPal apps
  updated_after: nil,
  full_sync_every: nil,
  batch_genre: nil,
  globals: {},
  &blk
)
  global_options = {
    legacy_support: legacy_support,
    updated_after: updated_after,
    full_sync_every: full_sync_every,
    batch_genre: batch_genre,
  }
  global_options[:account_id] =  if .present?
  global_options.merge!(globals) if globals

  JobBatches::ChainBuilder.build(CanvasSync::Jobs::BeginSyncChainJob, *[], **global_options, &blk)
end

.config ⇒ Object

Returns the CanvasSync config



335
336
337
 
# File 'lib/canvas_sync.rb', line 335

def config
  @config ||= CanvasSync::Config.new
end

.configure {|config| ... } ⇒ Object

Configure options for CanvasSync. See config.rb for valid configuration options.

Example:

CanvasSync.configure do |config|

config.classes_to_only_log_errors_on << "Blah"

end

Yields:



329
330
331
332
 
# File 'lib/canvas_sync.rb', line 329

def configure
  yield config
  config
end

.default_provisioning_report_chain(models, term_scope: nil, term_scoped_models: DEFAULT_TERM_SCOPE_MODELS, options: {}, **kwargs) ⇒ Hash

Syncs terms, users/roles/admins if necessary, then the rest of the specified models.

Parameters:

  • models (Array<String>)
  • term_scope (String) (defaults to: nil)
  • legacy_support (Boolean, false) —

    This enables legacy_support, where rows are not bulk inserted. For this to work your models must have a ‘create_or_udpate_from_csv` class method that takes a row and inserts it into the database.

  • account_id (Integer, nil) —

    This optional parameter can be used if your Term creation and canvas_sync_client methods require an account ID.

Returns:

  • (Hash) 


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/canvas_sync.rb', line 154

def default_provisioning_report_chain(
  models,
  term_scope: nil,
  term_scoped_models: DEFAULT_TERM_SCOPE_MODELS,
  options: {},
  **kwargs
) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
  return unless models.present?
  models.map! &:to_s
  term_scope = term_scope.to_s if term_scope
  options = options.deep_symbolize_keys!

  model_job_map = {
    terms: CanvasSync::Jobs::SyncTermsJob,
    accounts: CanvasSync::Jobs::SyncAccountsJob,
    roles: CanvasSync::Jobs::SyncRolesJob,
    admins: CanvasSync::Jobs::SyncAdminsJob,

    assignments: CanvasSync::Jobs::SyncAssignmentsJob,
    submissions: CanvasSync::Jobs::SyncSubmissionsJob,
    assignment_groups: CanvasSync::Jobs::SyncAssignmentGroupsJob,
    assignment_overrides: CanvasSync::Jobs::SyncAssignmentOverridesJob,
    context_modules: CanvasSync::Jobs::SyncContextModulesJob,
    context_module_items: CanvasSync::Jobs::SyncContextModuleItemsJob,
    content_migrations: CanvasSync::Jobs::SyncContentMigrationsJob,
    course_progresses: CanvasSync::Jobs::SyncCourseProgressesJob,
    rubrics: CanvasSync::Jobs::SyncRubricsJob,
    rubric_associations: CanvasSync::Jobs::SyncRubricAssociationsJob,
    rubric_assessments: CanvasSync::Jobs::SyncRubricAssessmentsJob,
    scores: CanvasSync::Jobs::SyncScoresJob,
  }.with_indifferent_access

  root_chain = base_canvas_sync_chain(**kwargs, globals: options[:global] || kwargs[:globals])
  concurrent_root_chain = JobBatches::ChainBuilder.new(JobBatches::ConcurrentBatchJob)
  root_chain << concurrent_root_chain
  current_chain = concurrent_root_chain

  try_add_model_job = ->(model) {
    return unless models.include?(model)
    current_chain << { job: model_job_map[model].to_s, options: options[model.to_sym] || {} }
    models -= [model]
  }

  ##############################
  # General provisioning jobs (not term-scoped)
  ##############################

  # Accounts, users, roles, and admins cannot be scoped to term
  try_add_model_job.call('accounts')

  # These Models use the provisioning report, but are not term-scoped,
  # so we sync them outside of the term scoping to ensure work is not duplicated
  if term_scope.present?
    models -= (first_provisioning_models = models & ['users', 'pseudonyms', 'user_observers', 'grading_periods', 'grading_period_groups'])
    current_chain.insert(generate_provisioning_jobs(first_provisioning_models, options))
  end

  try_add_model_job.call('roles')
  try_add_model_job.call('admins')

  (SUPPORTED_TERM_SCOPE_MODELS - term_scoped_models).each do |mdl|
    try_add_model_job.call(mdl)
  end

  ###############################
  # Per-term provisioning jobs
  ###############################

  term_parent_chain = current_chain

  per_term_chain = JobBatches::ChainBuilder.build(model_job_map[:terms], term_scope: term_scope)
  current_chain = per_term_chain

  term_scoped_models.each do |mdl|
    try_add_model_job.call(mdl)
  end

  current_chain.insert(
    generate_provisioning_jobs(models - ['terms'], options)
  )

  # Skip syncing terms if not required
  if !current_chain.empty? || (models & ['terms']).present?
    term_parent_chain << per_term_chain
  end

  ###############################
  # Wrap it all up
  ###############################

  root_chain
end

.generate_provisioning_jobs(model_list, options_hash, job_options: {}, only_split: nil, default_key: :provisioning) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/canvas_sync.rb', line 289

def generate_provisioning_jobs(model_list, options_hash, job_options: {}, only_split: nil, default_key: :provisioning)
  # Group the model options as best we can.
  # This is mainly for backwards compatibility, since 'users' was previously it's own job
  unique_option_models = group_by_job_options(
    model_list,
    options_hash,
    only_split: only_split,
    default_key: default_key,
  )

  unique_option_models.map do |mopts, models|
    opts = { models: models }
    opts.merge!(job_options)
    opts.merge!(mopts) if mopts.present?
    {
      job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s,
      options: opts,
    }
  end
end

.get_canvas_sync_client(options) ⇒ Object

Calls the canvas_sync_client in your app. If you have specified an account ID when starting the job it will pass the account ID to your canvas_sync_client method.

Parameters:

  • options (Hash) 


314
315
316
317
318
319
320
 
# File 'lib/canvas_sync.rb', line 314

def get_canvas_sync_client(options)
  if options[:account_id]
    canvas_sync_client(options[:account_id])
  else
    canvas_sync_client
  end
end

.group_by_job_options(model_list, options_hash, only_split: nil, default_key: :provisioning) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/canvas_sync.rb', line 268

def group_by_job_options(model_list, options_hash, only_split: nil, default_key: :provisioning)
  dup_models = [ *model_list ]
  unique_option_models = {}

  filtered_models = only_split ? (only_split & model_list) : model_list
  filtered_models.each do |m|
    mopts = options_hash[m.to_sym] || options_hash[default_key]
    unique_option_models[mopts] ||= []
    unique_option_models[mopts] << m
    dup_models.delete(m)
  end

  if dup_models.present?
    mopts = options_hash[default_key]
    unique_option_models[mopts] ||= []
    unique_option_models[mopts].concat(dup_models)
  end

  unique_option_models
end

.logger ⇒ Object 



351
352
353
354
355
356
 
# File 'lib/canvas_sync.rb', line 351

def logger
  return @logger if defined? @logger
  @logger = Logger.new(STDOUT)
  @logger.level = Logger::WARN
  @logger
end

.provisioning_sync(models, **kwargs) ⇒ Object

Runs a standard provisioning sync job with no extra report types. Terms will be synced first using the API. If you are syncing users/roles/admins and have also specified a Term scope, Users/Roles/Admins will by synced first, before every other model (as Users/Roles/Admins are never scoped to Term).

Parameters:

  • models (Array<String>) —

    A list of models to sync. e.g., [‘users’, ‘courses’]. must be one of SUPPORTED_MODELS

  • term_scope (Symbol, nil) —

    An optional symbol representing a scope that exists on the Term model. The provisioning report will be run for each of the terms contained in that scope.

  • legacy_support (Boolean | Array<String>, false) —

    This enables legacy_support, where rows are not bulk inserted. For this to work your models must have a ‘create_or_udpate_from_csv` class method that takes a row and inserts it into the database. If an array of model names is provided then only those models will use legacy support.

  • account_id (Integer, nil) —

    This optional parameter can be used if your Term creation and canvas_sync_client methods require an account ID.



125
126
127
128
 
# File 'lib/canvas_sync.rb', line 125

def provisioning_sync(models, **kwargs)
  validate_models!(models)
  default_provisioning_report_chain(models, **kwargs).process!
end

.redis(*args, &blk) ⇒ Object 



358
359
360
 
# File 'lib/canvas_sync.rb', line 358

def redis(*args, &blk)
  JobBatches::Batch.redis(*args, &blk)
end

.redis_prefix ⇒ Object 



362
363
364
365
366
 
# File 'lib/canvas_sync.rb', line 362

def redis_prefix
  pfx = config.redis_key_prefix
  pfx = "#{Apartment::Tenant.current}:#{pfx}" if defined?(Apartment)
  pfx
end

.sync_scope(scope) ⇒ Object

Given a Model or Relation, scope it down to items that should be synced



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/canvas_sync.rb', line 131

def sync_scope(scope)
  terms = %i[should_canvas_sync active_for_canvas_sync should_sync active_for_sync active]
  terms.each do |t|
    return scope.send(t) if scope.respond_to?(t)
  end
  model = scope.try(:model) || scope
  if model.try(:column_names)&.include?(:workflow_state)
    return scope.where.not(workflow_state: %w[deleted])
  end
  Rails.logger.warn("Could not filter Syncable Scope for model '#{scope.try(:model)&.name || scope.name}'")
  scope
end

.validate_live_events!(events) ⇒ Object 



345
346
347
348
349
 
# File 'lib/canvas_sync.rb', line 345

def validate_live_events!(events)
  invalid = events - SUPPORTED_LIVE_EVENTS
  return if invalid.empty?
  raise "Invalid live event(s) specified: #{invalid.join(', ')}. Only #{SUPPORTED_LIVE_EVENTS.join(', ')} are supported."
end

.validate_models!(models) ⇒ Object 



339
340
341
342
343
 
# File 'lib/canvas_sync.rb', line 339

def validate_models!(models)
  invalid = models - SUPPORTED_MODELS
  return if invalid.empty?
  raise "Invalid model(s) specified: #{invalid.join(', ')}. Only #{SUPPORTED_MODELS.join(', ')} are supported."
end