SWAMPy

✎ CARVE FLESH

EDITING: question_answered_event_decorator.js

/*
 * Copyright (C) 2021 - 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/>.
 */

import _ from '@instructure/lodash-underscore'
import K from '../../constants'

const findWhere = _.findWhere
const keys = Object.keys
const QuestionAnsweredEventDecorator = {}

QuestionAnsweredEventDecorator.decorateAnswerRecord = function (question, record) {
  let answered = false
  const answer = record.answer
  let blank

switch (question.questionType) {
    case K.Q_NUMERICAL:
    case K.Q_CALCULATED:
    case K.Q_MULTIPLE_CHOICE:
    case K.Q_SHORT_ANSWER:
    case K.Q_ESSAY:
      answered = answer !== null
      break

case K.Q_FILL_IN_MULTIPLE_BLANKS:
    case K.Q_MULTIPLE_DROPDOWNS:
      for (blank in answer) {
        if (answer.hasOwnProperty(blank)) {
          answered = answer[blank] !== null
        }

if (answered) {
          break
        }
      }
      break

case K.Q_MATCHING:
      if (answer instanceof Array && answer.length > 0) {
        // watch out that at this point, the attributes are not normalized
        // and not camelCased:
        answered = answer.some(function (pair) {
          return pair.match_id !== null
        })
      }

break
    case K.Q_MULTIPLE_ANSWERS:
    case K.Q_FILE_UPLOAD:
      answered = answer instanceof Array && answer.length > 0
      break

default:
      answered = answer !== null
  }

record.answered = answered
}

/**
 * Extend the raw event attributes as received from the API with some stuff
 * that we'll need when rendering the views.
 *
 * This "decoration" could be done once after the payload is received and it
 * is not necessary to re-perform them, unless the event answer data has been
 * mutated.
 *
 * The decorations are:
 *
 * 1. `answered`
 *    This is applied on the answer records inside the model's "data" attr.
 *    ---
 *    A boolean indicating whether an answer is present. This
 *    differs in semantics based on the question type and that's why we can't
 *    simply test for "answer" to be null or "".
 *
 * 2. `last`
 *    This is applied on the answer records inside the model's "data" attr.
 *    ---
 *    A boolean indicating whether this answer record is the final answer
 *    provided to the referenced question.
 *
 * @param  {Models.Event[]} events
 *         An array of Event instances of type EVT_QUESTION_ANSWERED.
 *
 * @param  {Object[]} questions
 *         An array of question data; this must contain all the questions
 *         referenced by the event set above.
 *
 * @return {null}
 *         Nothing is returned as the decoration is done in-place on the model
 *         attributes.
 */
QuestionAnsweredEventDecorator.run = function (events, questions) {
  let finalAnswerEvents = {}

events.forEach(function (event) {
    event.attributes.data.forEach(function (record) {
      const question = questions.filter(function (question) {
        return question.id === record.quizQuestionId
      })[0]

finalAnswerEvents[question.id] = event

QuestionAnsweredEventDecorator.decorateAnswerRecord(question, record)
    })
  })

keys(finalAnswerEvents).forEach(function (quizQuestionId) {
    const event = finalAnswerEvents[quizQuestionId]

findWhere(event.attributes.data, {
      quizQuestionId,
    }).last = true
  })

finalAnswerEvents = null
}

export default QuestionAnsweredEventDecorator

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __tests__/	DIR	—	2023-09-24 03:36
📄 event.js	JS	1.6 KB	2023-09-24 03:36	EDIT
📄 question.js	JS	1.4 KB	2023-09-24 03:36	EDIT
📄 question_answered_event_decorator.js	JS	3.9 KB	2023-09-24 03:36	EDIT
📄 submission.js	JS	1.2 KB	2023-09-24 03:36	EDIT