SWAMPy

✎ CARVE FLESH

EDITING: event_aggregator.rb

# frozen_string_literal: true

#
# Copyright (C) 2014 - 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 Quizzes::LogAuditing
  # @class EventAggregator
  #
  # Generate submission_data ready for use by a submission from a bunch of
  # answer-related events.
  class EventAggregator
    attr_reader :quiz

def initialize(quiz)
      @quiz = quiz
    end

# Main API for aggregating QuizSubmissionEvents
    #
    # @param [Integer] quiz_submission_id
    # @param [Integer] attempt_id
    # @param [Time] timestamp
    #   This is a timestamp which is used to filter out events. Any events
    #   which occurred after (inclusive) the given timestamp are excluded.
    #
    #  This queries the DB for the pertinent quiz submission events for the
    #  specified attempt and quiz submission.  It selects the events which are
    #  related to questions (question answers and question flags).  It also
    #  reduces the returned events to a conclusive set of events which describe
    #  the state of the quiz submission events up to and including the point in
    #  time corresponding to the provided timestamp.  These are returned in the
    #  form of submission data as would be stored in a QuizSubmission.
    #
    # @return [Hash] Submission data is returned
    #
    def run(quiz_submission_id, attempt, timestamp)
      sql_string = <<~SQL.squish
        quiz_submission_id = :qs_id
        AND attempt = :attempt
        AND event_type IN(:filter)
        AND created_at <= :time
      SQL
      events = Quizzes::QuizSubmissionEvent.where(sql_string, {
                                                    qs_id: quiz_submission_id,
                                                    attempt:,
                                                    filter: [
                                                      Quizzes::QuizSubmissionEvent::EVT_QUESTION_ANSWERED,
                                                      Quizzes::QuizSubmissionEvent::EVT_QUESTION_FLAGGED
                                                    ],
                                                    time: timestamp
                                                  }).order("created_at ASC")
      filtered_events, final_answers = pick_latest_distinct_events_and_answers(events)
      submission_data_hash = build_submission_data_from_events(filtered_events)
      submission_data_hash.merge build_submission_data_from_answers(final_answers)
    end

private

# constructs submission data from events, including the parsing of flagged
    # to indicate that they are 'marked' or 'flagged'
    def build_submission_data_from_events(events)
      events.each_with_object({}) do |event, submission_data|
        case event.event_type
        when Quizzes::QuizSubmissionEvent::EVT_QUESTION_FLAGGED
          submission_data["question_#{event.event_data["quiz_question_id"]}_marked"] = event.event_data["flagged"]
        end
      end
    end

# constructs submission data from events, including the parsing of flagged
    # to indicate that they are 'marked' or 'flagged'
    def build_submission_data_from_answers(answers)
      submission_data = {}
      answers.each do |question_id, answer|
        question = quiz.quiz_questions.find { |qq| qq.id == question_id.to_i }
        question ||= Quizzes::QuizQuestion.where(id: question_id).first
        next unless question.question_data["question_type"] != "text_only_question"

serializer = Quizzes::QuizQuestion::AnswerSerializers.serializer_for(question)
        thing = serializer.serialize(answer).answer
        submission_data.merge! thing
      end
      submission_data
    end

# Filter out the redundant or overwritten events, creating a minimal set
    # of events which only contain the results of the series of events
    def pick_latest_distinct_events_and_answers(events)
      kept_events = {}
      kept_answers = {}
      events.each do |event|
        case event.event_type
        when Quizzes::QuizSubmissionEvent::EVT_QUESTION_ANSWERED
          kept_events["#{event.event_type}_#{event.event_data.first["quiz_question_id"]}"] = event
          event.event_data.each do |answer|
            kept_answers[answer["quiz_question_id"]] = answer["answer"]
          end
        else
          kept_events["#{event.event_type}_#{event.event_data["quiz_question_id"]}"] = event
        end
      end
      [kept_events.values, kept_answers]
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 event_aggregator.rb	RB	4.9 KB	2023-09-24 03:36	EDIT
📄 question_answered_event_extractor.rb	RB	4 KB	2023-09-24 03:36	EDIT
📄 question_answered_event_optimizer.rb	RB	2.3 KB	2023-09-24 03:36	EDIT
📄 snapshot_scraper.rb	RB	3 KB	2023-09-24 03:36	EDIT