Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Conditional Question Display State Issues in Surveys #6103

Merged
merged 1 commit into from
Jan 9, 2025
+63 −52
Merged

Fix Conditional Question Display State Issues in Surveys #6103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 61 additions & 44 deletions app/assets/javascripts/surveys/modules/Survey.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,50 +698,45 @@ const Survey = {
}
},

// FIXME: This is supposed to remove a conditional question from
// the flow if the condition that it depends on has changed.
// However, when this happens it leaves the survey in a state
// with no visible questions and no way to proceed.
// Disabling this feature means that, once inserted, a conditional
// question will not be removed, but that's better than a broken survey.
resetConditionalGroupChildren(/* conditionalGroup */) {
// const { children, currentAnswers } = conditionalGroup;

// if ((typeof currentAnswers !== 'undefined' && currentAnswers !== null) && currentAnswers.length) {
// const excludeFromReset = [];
// currentAnswers.forEach((a) => { excludeFromReset.push(a); });
// children.forEach((question) => {
// const $question = $(question);
// let string;
// if ($question.data('conditional-question')) {
// string = $question.data('conditional-question');
// } else {
// string = $question.find('[data-conditional-question]').data('conditional-question');
// }
// const { value } = Utils.parseConditionalString(string);
// if (excludeFromReset.indexOf(value) === -1) {
// this.resetConditionalQuestion($question);
// } else {
// $question.removeClass('hidden');
// }
// });
// } else {
// children.forEach((question) => {
// this.resetConditionalQuestion($(question));
// if ($(question).hasClass('survey__question-row')) {
// const $parentBlock = $(question).parents(BLOCK_CONTAINER_SELECTOR);
// const blockIndex = $(question).data('block-index');
// if (!($parentBlock.find('.survey__question-row:not([data-conditional-question])').length > 1)) {
// this.resetConditionalQuestion($parentBlock);
// if (this.detachedParentBlocks[blockIndex] === undefined) {
// this.detachedParentBlocks[blockIndex] = $parentBlock;
// this.removeSlide($parentBlock);
// $parentBlock.detach();
// }
// }
// }
// });
// }
// To remove a conditional question from the flow if the condition that it depends on has changed.
resetConditionalGroupChildren(conditionalGroup) {
const { children, currentAnswers } = conditionalGroup;

if ((typeof currentAnswers !== 'undefined' && currentAnswers !== null) && currentAnswers.length) {
const excludeFromReset = [];
currentAnswers.forEach((a) => { excludeFromReset.push(a); });
children.forEach((question) => {
const $question = $(question);
let string;
if ($question.data('conditional-question')) {
string = $question.data('conditional-question');
} else {
string = $question.find('[data-conditional-question]').data('conditional-question');
}
const { value } = Utils.parseConditionalString(string);
if (excludeFromReset.indexOf(value) === -1) {
this.resetConditionalQuestion($question);
} else {
$question.removeClass('hidden');
}
});
} else {
children.forEach((question) => {
this.resetConditionalQuestion($(question));
if ($(question).hasClass('survey__question-row')) {
const $parentBlock = $(question).parents(BLOCK_CONTAINER_SELECTOR);
const blockIndex = $(question).data('block-index');
if (!($parentBlock.find('.survey__question-row:not([data-conditional-question])').length > 1)) {
this.resetConditionalQuestion($parentBlock);
if (this.detachedParentBlocks[blockIndex] === undefined) {
this.detachedParentBlocks[blockIndex] = $parentBlock;
this.removeSlide($parentBlock);
$parentBlock.detach();
}
}
}
});
}
},

removeSlide($block) {
Expand All @@ -753,7 +748,29 @@ const Survey = {
if ($question.hasClass('survey__question-row')) {
$question.removeAttr('style').addClass('hidden not-seen disabled');
} else {
// Find which question group/slider this question belongs to by climbing up the DOM tree
const $grandParents = $question.parents('[data-question-group-blocks]');

// Extract the group's index number so we know which specific slider we need to modify
const questionGroupIndex = $grandParents.data('question-group-blocks');

// Get the actual slider jQuery object that we need to remove the question from
const $slider = this.groupSliders[questionGroupIndex];

// Get the slide index before detaching
const slideIndex = $question.data('slick-index');

// Remove the slide from Slick first
$slider?.slick('slickRemove', slideIndex);

// Then detach the element
$question.detach();

// Updates Progress Bar on Top Right of the UI.
this.indexBlocks();

// Update Slide Button to Determine whether to show Next or Submit button.
this.updateButtonText();
}
$question.find('input[type=text], textarea').val('');
$question.find('input:checked').removeAttr('checked');
Expand Down
10 changes: 2 additions & 8 deletions spec/features/survey_bugs_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,8 @@
click_button('Next', visible: true) # Q2
end

# Now this question ideally should be skipped
# but the code that did that breaks the survey
# by removing the question without sliding
# the next one into view.
find('.label', text: 'Maybe').click
within('div[data-progress-index="4"]') do
click_button('Next', visible: true) # Q3
end
sleep 2
expect(page).to have_content('Submit Survey')

# Now we can actually submit the survey
# and finish.
Expand Down
Loading