Skip to content

Commit

Permalink
Fix for bugs in the Conditional Questions functionality:
Browse files Browse the repository at this point in the history
 In the case of a conditional question with answers that removed questions, any answers of removed questions was not removed. Nor were the removed answers deleted in the database.

    Changes:
    - Fixed the broken functionality in the method remove_answers_list in
      app/helpers/conditions_helper.rb.
    - Removed and destroyed the answers of the removed questions.
    - Updated RSpec tests for Conditional Questions functionality.
  • Loading branch information
John Pinto committed Nov 7, 2024
1 parent 56759df commit fac99a6
Show file tree
Hide file tree
Showing 12 changed files with 1,265 additions and 17 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Changelog

- Fix for bug in Conditional questions functionality. In the case of a conditional question with answers that removed questions, any answers of removed questions was not removed. Nor were the removed answers deleted in the database. The Rspec tests were also updated to reflect this change.


## v4.2.0

**Note this upgrade is mainly a migration from Bootstrap 3 to Bootstrap 5.**
Expand Down
30 changes: 24 additions & 6 deletions app/controllers/answers_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,32 @@ def create_or_update
@section = @plan.sections.find_by(id: @question.section_id)
template = @section.phase.template

remove_list_after = remove_list(@plan)

# Get list of questions to be removed from the plan based on any conditional questions.
questions_remove_list_before_destroying_answers = remove_list(@plan)
all_question_ids = @plan.questions.pluck(:id)
# rubocop pointed out that these variable is not used
# all_answers = @plan.answers

# Destroy all answers for removed questions
questions_remove_list_before_destroying_answers.each do |id|
Answer.where(question_id: id, plan: @plan).each do |a|
Answer.destroy(a.id)
end
end
# Now update @plan after removing answers of questions removed from the plan.
@plan = Plan.includes(
sections: {
questions: %i[
answers
question_format
]
}
).find(p_params[:plan_id])

# Now get list of question ids to remove based on remaining answers.
remove_list_question_ids = remove_list(@plan)

qn_data = {
to_show: all_question_ids - remove_list_after,
to_hide: remove_list_after
to_show: all_question_ids - remove_list_question_ids,
to_hide: remove_list_question_ids
}

section_data = []
Expand Down
4 changes: 3 additions & 1 deletion app/helpers/conditions_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ def answer_remove_list(answer, user = nil)
opts = cond.option_list.map(&:to_i).sort
action = cond.action_type
chosen = answer.question_option_ids.sort
if chosen == opts

# if the chosen (options) include the opts (options list) in the condition
if !opts.empty? && !chosen.empty? && (chosen & opts) == opts
if action == 'remove'
rems = cond.remove_data.map(&:to_i)
id_list += rems
Expand Down
9 changes: 3 additions & 6 deletions app/javascript/src/answers/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
} from '../utils/isType';
import { Tinymce } from '../utils/tinymce.js';
import debounce from '../utils/debounce';
import { updateSectionProgress, getQuestionDiv } from '../utils/sectionUpdate';
import { updateSectionProgress, getQuestionDiv , deleteAllAnswersForQuestion } from '../utils/sectionUpdate';
import datePicker from '../utils/datePicker';
import TimeagoFactory from '../utils/timeagoFactory.js.erb';

Expand All @@ -23,7 +23,9 @@ $(() => {
updateSectionProgress(section.sec_id, section.no_ans, section.no_qns);
});
data.qn_data.to_hide.forEach((questionid) => {
deleteAllAnswersForQuestion(questionid);
getQuestionDiv(questionid).slideUp();

});
data.qn_data.to_show.forEach((questionid) => {
getQuestionDiv(questionid).slideDown();
Expand Down Expand Up @@ -100,11 +102,6 @@ $(() => {
const form = target.closest('form');
const id = questionId(target);

console.log('SUBMITTING');
console.log(target);
console.log(form);
console.log(id);

if (debounceMap[id]) {
// Cancels the delated execution of autoSaving
// (e.g. user clicks the button before the delay is met)
Expand Down
29 changes: 29 additions & 0 deletions app/javascript/src/utils/sectionUpdate.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Tinymce } from '../utils/tinymce.js';

// update details in section progress panel
export const updateSectionProgress = (id, numSecAnswers, numSecQuestions) => {
const progressDiv = $(`#section-panel-${id}`).find('.section-status');
Expand Down Expand Up @@ -25,3 +27,30 @@ export const updateSectionProgress = (id, numSecAnswers, numSecQuestions) => {
// given a question id find the containing div
// used inconditional questions
export const getQuestionDiv = (id) => $(`#answer-form-${id}`).closest('.question-body');

// Clear an answers for a given question id.
export const deleteAllAnswersForQuestion = (questionid) => {
const answerFormDiv = $(`#answer-form-${questionid}`);
const editAnswerForm = $(`#answer-form-${questionid}`).find('.form-answer');

editAnswerForm.find('input:checkbox').prop('checked', false);
editAnswerForm.find('input:radio').prop('checked', false);
editAnswerForm.find('option').prop('selected', false);
editAnswerForm.find('input:text').text('');

// Get the TinyMce editor textarea and rest content to ''
const editorAnswerTextAreaId = `answer-text-${questionid}`;
const tinyMceAnswerEditor = Tinymce.findEditorById(editorAnswerTextAreaId);
if (tinyMceAnswerEditor) {
tinyMceAnswerEditor.setContent('');
}
// Date fields in form are input of type="date"
// The editAnswerForm.find('input:date') throws error, so
// we need an alternate way to reset date.
editAnswerForm.find('#answer_text').each ( (el) => {
if($(el).attr('type') === 'date') {
$(el).val('');
}

});
};
8 changes: 7 additions & 1 deletion app/models/condition.rb
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,18 @@ class Condition < ApplicationRecord

# Sort order: Number ASC
default_scope { order(number: :asc) }

# rubocop:disable Metrics/AbcSize
def deep_copy(**options)
copy = dup
copy.question_id = options.fetch(:question_id, nil)
# Added to allow options to be passed in for all fields
copy.option_list = options.fetch(:option_list, option_list) if options.key?(:option_list)
copy.remove_data = options.fetch(:remove_data, remove_data) if options.key?(:remove_data)
copy.action_type = options.fetch(:action_type, action_type) if options.key?(:action_type)
copy.webhook_data = options.fetch(:webhook_data, webhook_data) if options.key?(:webhook_data)
# TODO: why call validate false here
copy.save!(validate: false) if options.fetch(:save, false)
copy
end
# rubocop:enable Metrics/AbcSize
end
Loading

0 comments on commit fac99a6

Please sign in to comment.