canvas-lms/lib/sis/section_importer.rb

# frozen_string_literal: true

#
# Copyright (C) 2011 - 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/>.
#

module SIS
  class SectionImporter < BaseImporter
    def process
      importer = Work.new(@batch, @root_account, @logger)
      CourseSection.suspend_callbacks(:delete_enrollments_later_if_deleted) do
        Course.skip_updating_account_associations do
          CourseSection.process_as_sis(@sis_options) do
            yield importer
          end
        end
      end
      Course.update_account_associations(importer.course_ids_to_update_associations.to_a) unless importer.course_ids_to_update_associations.empty?
      importer.sections_to_update_sis_batch_ids.in_groups_of(1000, false) do |batch|
        CourseSection.where(:id => batch).update_all(:sis_batch_id => @batch.id)
      end
      # there could be a ton of deleted sections, and it would be really slow to do a normal find_each
      # that would order by id. So do it on the secondary, to force a cursor that avoids the sort so that
      # it can run really fast
      GuardRail.activate(:secondary) do
        # ideally we change this to find_in_batches, and call (the currently non-existent) Enrollment.destroy_batch
        Enrollment.where(course_section_id: importer.deleted_section_ids.to_a).active.find_in_batches do |enrollments|
          GuardRail.activate(:primary) do
            new_data = Enrollment::BatchStateUpdater.destroy_batch(enrollments, sis_batch: @batch)
            importer.roll_back_data.push(*new_data)
            SisBatchRollBackData.bulk_insert_roll_back_data(importer.roll_back_data)
            importer.roll_back_data = []
          end
        end
      end

      importer.success_count
    end

    class Work
      attr_accessor(
        :success_count,
        :sections_to_update_sis_batch_ids,
        :course_ids_to_update_associations,
        :deleted_section_ids,
        :roll_back_data
      )

      def initialize(batch, root_account, logger)
        @batch = batch
        @root_account = root_account
        @logger = logger
        @success_count = 0
        @sections_to_update_sis_batch_ids = []
        @roll_back_data = []
        @course_ids_to_update_associations = Set.new
        @deleted_section_ids = Set.new
      end

      def add_section(section_id, course_id, name, status, start_date = nil, end_date = nil, integration_id = nil)
        raise ImportError, "No section_id given for a section in course #{course_id}" if section_id.blank?
        raise ImportError, "No course_id given for a section #{section_id}" if course_id.blank?
        raise ImportError, "No name given for section #{section_id} in course #{course_id}" if name.blank? && status =~ /\Aactive/i
        raise ImportError, "Improper status \"#{status}\" for section #{section_id} in course #{course_id}" unless /\Aactive|\Adeleted/i.match?(status)
        return if @batch.skip_deletes? && status =~ /deleted/i

        course = @root_account.all_courses.where(sis_source_id: course_id).take
        raise ImportError, "Section #{section_id} references course #{course_id} which doesn't exist" unless course

        section = @root_account.course_sections.where(sis_source_id: section_id).take
        section ||= course.course_sections.where(sis_source_id: section_id).first_or_initialize
        section.root_account = @root_account
        # this is an easy way to load up the cache with data we already have
        section.course = course if course.id == section.course_id

        # only update the name on new records, and ones that haven't been changed since the last sis import
        raise ImportError, "No name given for section #{section_id} in course #{course_id}" if name.blank? && section.new_record?

        section.name = name if section.new_record? || (!section.stuck_sis_fields.include?(:name) && name.present?)

        # update the course id if necessary
        if section.course_id != course.id
          if section.nonxlist_course_id
            # this section is crosslisted
            if (section.nonxlist_course_id != course.id && !section.stuck_sis_fields.include?(:course_id)) || (section.course.workflow_state == 'deleted' && status.start_with?('active'))
              # but the course id we were given didn't match the crosslist info
              # we have, so, uncrosslist and move
              @course_ids_to_update_associations.merge [course.id, section.course_id, section.nonxlist_course_id]
              section.uncrosslist
              section.move_to_course(course)
            end
          elsif !section.stuck_sis_fields.include?(:course_id)
            # this section isn't crosslisted and lives on the wrong course. move
            @course_ids_to_update_associations.merge [section.course_id, course.id]
            section.move_to_course(course)
          end
        end
        if section.course_id_changed?
          @course_ids_to_update_associations.merge [section.course_id, section.course_id_was].compact
        end

        section.integration_id = integration_id
        if /active/i.match?(status)
          section.workflow_state = 'active'
        elsif /deleted/i.match?(status)
          section.workflow_state = 'deleted'
          deleted_section_ids << section.id
        end

        if (section.stuck_sis_fields & [:start_at, :end_at]).empty?
          section.start_at = start_date
          section.end_at = end_date
        end
        unless section.stuck_sis_fields.include?(:restrict_enrollments_to_section_dates)
          section.restrict_enrollments_to_section_dates = (section.start_at.present? || section.end_at.present?)
        end

        if section.changed?
          if section.workflow_state_changed? && section.workflow_state_was == "deleted"
            if section.default_section? && CourseSection.active.where(:course_id => section.course_id, :default_section => true).exists?
              # trying to restore a previously default section but there's one already so undefault the restored one
              section.default_section = false
            end
          end
          section.sis_batch_id = @batch.id
          if section.valid?
            section.save
            data = SisBatchRollBackData.build_data(sis_batch: @batch, context: section)
            @roll_back_data << data if data
          else
            msg = "A section did not pass validation "
            msg += "(" + "section: #{section_id} / #{name}, course: #{course_id}, error: "
            msg += section.errors.full_messages.join(", ") + ")"
            raise ImportError, msg
          end
        else
          @sections_to_update_sis_batch_ids << section.id
        end

        @success_count += 1
      end
    end
  end
end