SWAMPy

✎ CARVE FLESH

EDITING: batch_state_updater.rb

# frozen_string_literal: true

#
# Copyright (C) 2016 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

class Enrollment::BatchStateUpdater
  # destroy_batch needs to account for all the callbacks in Enrollment
  #
  # destroy - handled in mark_enrollments_as_deleted
  # before_save :assign_uuid - not needed for state updates
  # before_validation :assert_section - not needed for state updates
  # after_save :recalculate_enrollment_state - handled in destroy_all
  # after_save :update_user_account_associations_if_necessary - not needed for destroy
  # before_save :audit_groups_for_deleted_enrollments - handled in remove_group_memberships
  # before_validation :ensure_role_id - not needed for state updates
  # after_save :copy_scores_from_existing_enrollment, if: :need_to_copy_scores? - not needed for destroy
  # after_save :restore_submissions_and_scores - not needed for destroy
  # after_save :clear_email_caches - handled in clear_email_caches
  # after_save :cancel_future_appointments - handled in cancel_future_appointments
  # after_save :update_linked_enrollments - handled in update_linked_enrollments
  # after_save :set_update_cached_due_dates - handled in update_cached_due_dates
  # after_save :touch_graders_if_needed - handled in touch_all_graders_if_needed
  # after_save :reset_notifications_cache - handled in reset_notifications_cache
  # after_save :dispatch_invitations_later - not needed for destroy
  # after_save :add_to_favorites_later - not needed for destroy
  # after_commit :update_cached_due_dates - handled in update_cached_due_dates
  # after_save :update_assignment_overrides_if_needed - handled in update_assignment_overrides
  # after_save :needs_grading_count_updated -handled in needs_grading_count_updated
  # after_commit :sync_microsoft_group - handled in sync_microsoft_group
  #
  # ignore_due_date_caching_for: optional hash of (course_id => user_ids_array) of users to _not_
  # re-cache their scores for (presumably the caller already queued one of their own)
  def self.destroy_batch(batch, sis_batch: nil, batch_mode: false, ignore_due_date_caching_for: {})
    raise ArgumentError, "Cannot call with more than 1000 enrollments" if batch.count > 1000

Enrollment.transaction do
      # cache some data before the destroy that is needed after the destroy
      @invited_user_ids = Enrollment.where(id: batch, workflow_state: "invited").distinct.pluck(:user_id)
      @students = Enrollment.of_student_type.where(id: batch).preload({ user: :linked_observers }, :root_account).to_a
      @students.each do |e|
        e.workflow_state = "deleted"
        e.readonly!
      end
      @user_course_tuples = Enrollment.where(id: batch).active.select(%i[user_id course_id]).distinct.to_a
      @user_ids = Enrollment.where(id: batch).order(:user_id).distinct.pluck(:user_id)
      @courses = Course.where(id: Enrollment.where(id: batch).select(:course_id).distinct).to_a
      @root_account = @courses.first.root_account
      @data = mark_enrollments_as_deleted(batch, sis_batch:, batch_mode:)
      gms = remove_group_memberships(batch, @courses, @user_ids, sis_batch:, batch_mode:)
      @data&.push(*gms) if gms
      # touch users after removing group_memberships to invalidate the cache.
      cancel_future_appointments(@courses, @user_ids)
      disassociate_cross_shard_users(@user_ids)
    end
    update_linked_enrollments(@students)
    update_assignment_overrides(batch, @courses, @user_ids)
    touch_and_update_associations(@user_ids)
    clear_email_caches(@invited_user_ids) unless @invited_user_ids.empty?
    needs_grading_count_updated(@courses)
    recache_all_course_grade_distribution(@courses)
    update_cached_due_dates(@students, ignore_due_date_caching_for)
    reset_notifications_cache(@user_course_tuples)
    touch_all_graders_if_needed(@students)
    sync_microsoft_group(@courses, @root_account)
    sis_batch ? @data : batch.count
  end

# bulk version of Enrollment.destroy
  def self.mark_enrollments_as_deleted(batch, **kwargs)
    data = mark_enrollments_as_state(batch, workflow_state: "deleted", **kwargs)
    EnrollmentState.where(enrollment_id: batch).update_all_locked_in_order(state: "deleted", state_valid_until: nil, updated_at: Time.now.utc)
    # we need the order to match the queries in GradeCalculator's save_course_and_grading_period_scores and save_assignment_group_scores,
    # _and_ the fact that the former runs first
    Score.transaction do
      Score.where(enrollment_id: batch).order(Arel.sql("assignment_group_id NULLS FIRST, enrollment_id")).in_batches(of: 10_000).update_all_locked_in_order(workflow_state: "deleted", updated_at: Time.zone.now)
    end
    data
  end

# updates enrollment objects to a workflow_state and generates sis_batch_data
  # and assigns sis_batch_id if there is a sis_batch.
  def self.mark_enrollments_as_state(batch, workflow_state:, sis_batch: nil, batch_mode: false)
    data = SisBatchRollBackData.build_dependent_data(sis_batch:, contexts: batch, updated_state: workflow_state, batch_mode_delete: batch_mode)
    updates = { workflow_state:, updated_at: Time.now.utc }
    updates[:sis_batch_id] = sis_batch.id if sis_batch
    Enrollment.where(id: batch).update_all_locked_in_order(**updates)
    data
  end

def self.touch_and_update_associations(user_ids)
    User.where(id: user_ids).touch_all
    User.clear_cache_keys(user_ids, :enrollments)
    User.update_account_associations(user_ids)
  end

def self.remove_group_memberships(batch, courses, user_ids, sis_batch: nil, batch_mode: false)
    data = []
    courses.each do |c|
      gms = GroupMembership.active.joins(:group)
                           .where(groups: { context_type: "Course", context_id: c },
                                  user_id: user_ids).where.not(user_id: c.enrollments.where.not(id: batch).pluck(:user_id))
      next unless gms.exists?

rollback = SisBatchRollBackData.build_dependent_data(sis_batch:, contexts: gms, updated_state: "deleted", batch_mode_delete: batch_mode)
      data.push(*rollback)
      leader_change_groups = Group.joins(:group_memberships).where(group_memberships: { id: gms }, leader_id: user_ids)
      leader_change_groups.update_all(leader_id: nil, updated_at: Time.zone.now)
      leader_change_groups.each(&:auto_reassign_leader)
      GroupMembership.where(id: gms).update_all(workflow_state: "deleted", updated_at: Time.zone.now)
      Group.joins(:group_memberships).where(group_memberships: { id: gms }).touch_all
    end
    data
  end

def self.clear_email_caches(invited_user_ids)
    Shard.partition_by_shard(invited_user_ids) do |shard_invited_users|
      emails = CommunicationChannel.email.unretired.where(user_id: shard_invited_users).distinct.pluck(:path)
      if Enrollment.cross_shard_invitations?
        Shard.birth.activate do
          emails.each { |path| Rails.cache.delete([path, "all_invited_enrollments2"].cache_key) }
        end
      else
        emails.each { |path| Rails.cache.delete([path, "invited_enrollments2"].cache_key) }
      end
    end
  end

def self.cancel_future_appointments(courses, user_ids)
    courses.each do |c|
      user_ids -= c.all_enrollments.active.where(user_id: user_ids).pluck(:user_id)
      next if user_ids.empty?

c.appointment_participants.active.current
       .where(context_id: user_ids, context_type: "User")
       .update_all(workflow_state: "deleted", updated_at: Time.zone.now)
    end
  end

def self.disassociate_cross_shard_users(user_ids); end

def self.update_linked_enrollments(students, restore: false)
    students.each { |e| e.update_linked_enrollments(restore:) }
  end

def self.touch_all_graders_if_needed(students)
    courses_to_touch_admins = students.map(&:course_id).uniq
    admin_ids = Enrollment.where(course_id: courses_to_touch_admins,
                                 type: %w[TeacherEnrollment TaEnrollment DesignerEnrollment])
                          .active.distinct.order(:user_id).pluck(:user_id)
    User.clear_cache_keys(admin_ids, :todo_list)
  end

def self.reset_notifications_cache(user_course_tuples)
    user_course_tuples.each do |enrollment|
      StreamItemCache.invalidate_recent_stream_items(enrollment.user_id, "Course", enrollment.course_id)
    end
  end

def self.update_assignment_overrides(batch, courses, user_ids)
    courses.each do |c|
      assignment_ids = Assignment.where(context_id: c, context_type: "Course").pluck(:id)
      next unless assignment_ids

# this is handled in :update_cached_due_dates
      AssignmentOverrideStudent.suspend_callbacks(:update_cached_due_dates) do
        AssignmentOverrideStudent
          .where(user_id: user_ids, assignment_id: assignment_ids)
          .where.not(user_id: c.enrollments.where(user_id: user_ids)
          .where.not(id: batch).select(:user_id)).each(&:destroy)
      end
    end
  end

def self.needs_grading_count_updated(courses)
    Assignment.where(context_id: courses).find_ids_in_batches(batch_size: 1000) do |assignment_ids|
      Assignment.clear_cache_keys(assignment_ids, :needs_grading)
    end
  end

def self.recache_all_course_grade_distribution(courses)
    courses.each do |c|
      c.recache_grade_distribution if c.respond_to?(:recache_grade_distribution)
    end
  end

def self.update_cached_due_dates(students, ignore_due_date_caching_for = {})
    students.group_by(&:course_id).each do |course, studs|
      user_ids = studs.map(&:user_id)
      user_ids -= ignore_due_date_caching_for[course] || []
      next if user_ids.empty?

DueDateCacher.recompute_users_for_course(
        studs.map(&:user_id),
        course
      )
    end
  end

def self.sync_microsoft_group(courses, root_account)
    return unless root_account.feature_enabled?(:microsoft_group_enrollments_syncing)
    return unless root_account.settings[:microsoft_sync_enabled]

MicrosoftSync::Group.not_deleted.where(course: courses).each(&:enqueue_future_sync)
  end

# this is to be used for enrollments that just changed workflow_states but are
  # not deleted. This also skips notifying users.
  def self.run_call_backs_for(batch, root_account:, n_strand_root: "restore_states_enrollment_states")
    raise ArgumentError, "Cannot call with more than 1000 enrollments" if batch.count > 1_000
    return if batch.empty?

EnrollmentState.delay_if_production(run_at: Setting.get("wait_time_to_calculate_enrollment_state", 1).to_f.minute.from_now,
                                        n_strand: [n_strand_root, root_account.global_id],
                                        max_attempts: 2)
                   .force_recalculation(batch)
    students = Enrollment.of_student_type.where(id: batch).preload({ user: :linked_observers }, :root_account).to_a
    user_ids = Enrollment.where(id: batch).distinct.pluck(:user_id)
    courses = Course.where(id: Enrollment.where(id: batch).select(:course_id).distinct).to_a
    touch_and_update_associations(user_ids)
    update_linked_enrollments(students, restore: true)
    needs_grading_count_updated(courses)
    recache_all_course_grade_distribution(courses)
    update_cached_due_dates(students)
    touch_all_graders_if_needed(students)
    sync_microsoft_group(courses, root_account)
  end

def self.update_batch_state(batch, root_account:, **kwargs)
    data = mark_enrollments_as_state(batch, **kwargs)
    run_call_backs_for(batch, root_account:, n_strand_root: "batch_mode_for")
    data
  end

def self.complete_batch(batch, **kwargs)
    update_batch_state(batch, workflow_state: "completed", **kwargs)
  end

def self.inactivate_batch(batch, **kwargs)
    update_batch_state(batch, workflow_state: "inactive", **kwargs)
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 batch_state_updater.rb	RB	12 KB	2023-09-24 03:39	EDIT
📄 query_builder.rb	RB	8.1 KB	2023-09-24 03:36	EDIT
📄 recent_activity.rb	RB	2.8 KB	2023-09-24 03:36	EDIT