From 721c34ccc9d59d5e9ce5c4f690bcfc035b77653f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A9lien=20Warnon?= <awa@odoo.com>
Date: Wed, 4 Mar 2020 08:03:02 +0000
Subject: [PATCH 1/6] [FIX] survey: correctly fade out wrong answer bars in
 session mode

This commit fixes the faded out answers bars on choice questions during a
survey session.
The logic is currently inverted (correct answers are faded out instead of wrong
ones).

LINKS

PR #48442
Task 2208574
---
 addons/survey/static/src/js/survey_session_chart.js | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/addons/survey/static/src/js/survey_session_chart.js b/addons/survey/static/src/js/survey_session_chart.js
index 3dd2fac13ec..2341b6e7328 100644
--- a/addons/survey/static/src/js/survey_session_chart.js
+++ b/addons/survey/static/src/js/survey_session_chart.js
@@ -199,8 +199,8 @@ publicWidget.registry.SurveySessionChart = publicWidget.Widget.extend({
     _getBackgroundColor: function (metaData) {
         var opacity = '0.8';
         if (this.showAnswers && this.hasCorrectAnswers) {
-            if (this._isValidAnswer(metaData.dataIndex)){
-                opacity = 0.3;
+            if (!this._isValidAnswer(metaData.dataIndex)){
+                opacity = '0.3';
             }
         }
         var rgb = SESSION_CHART_COLORS[metaData.dataIndex];

From 090f9ad3338381786725e092eac15843f74c6dea Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A9lien=20Warnon?= <awa@odoo.com>
Date: Wed, 4 Mar 2020 09:04:46 +0000
Subject: [PATCH 2/6] [FIX] survey: fix sessions leaderboard & "final
 leaderboard" display

This commit fixes a problem where the "final leaderboard" would duplicate the
attendees ranking display if the last question of the survey is scored.

We now also directly close the session when the host hits "next" on the last
question and there is no leaderboard to display.

LINKS

PR #48442
Task 2208574
---
 addons/survey/static/src/js/survey_session_manage.js      | 8 +++++---
 .../survey/views/survey_templates_user_input_session.xml  | 5 ++++-
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/addons/survey/static/src/js/survey_session_manage.js b/addons/survey/static/src/js/survey_session_manage.js
index aec3c1f76bf..4a1fdf13798 100644
--- a/addons/survey/static/src/js/survey_session_manage.js
+++ b/addons/survey/static/src/js/survey_session_manage.js
@@ -156,15 +156,17 @@ publicWidget.registry.SurveySessionManage = publicWidget.Widget.extend({
             delete this.resultsRefreshInterval;
             this.$('.o_survey_session_navigation_previous').removeClass('d-none');
         } else if (['leaderboard', 'leaderboardFinal'].includes(screenToDisplay)
-                   && this.currentScreen !== 'leaderboardFinal') {
-            if (screenToDisplay === 'leaderboardFinal') {
-                this.$('.o_survey_session_leaderboard_title').text(_('Final Leaderboard'));
+                   && !['leaderboard', 'leaderboardFinal'].includes(this.currentScreen)) {
+            if (this.isLastQuestion) {
                 this.$('.o_survey_session_navigation_next').addClass('d-none');
             }
             this.leaderBoard.showLeaderboard(true);
         } else {
             if (!this.isLastQuestion) {
                 this._nextQuestion();
+            } else if (!this.sessionShowLeaderboard) {
+                // If we have no leaderboard to show, directly end the session
+                this.$('.o_survey_session_close').click();
             }
         }
 
diff --git a/addons/survey/views/survey_templates_user_input_session.xml b/addons/survey/views/survey_templates_user_input_session.xml
index 6f3ff38d282..1d1a91b368f 100644
--- a/addons/survey/views/survey_templates_user_input_session.xml
+++ b/addons/survey/views/survey_templates_user_input_session.xml
@@ -129,7 +129,10 @@
                 </div>
                 <div class="o_survey_session_leaderboard w-100 flex-column flex-grow-1" style="display: none;">
                     <div class="d-flex">
-                        <h1 class="o_survey_session_leaderboard_title flex-grow-1">Leaderboard</h1>
+                        <h1 class="o_survey_session_leaderboard_title flex-grow-1">
+                            <span t-if="is_last_question">Final Leaderboard</span>
+                            <span t-else="">Leaderboard</span>
+                        </h1>
                         <div t-att-class="'o_survey_leaderboard_buttons font-weight-bold %s' % 'd-none' if not is_last_question else ''">
                             <a href="#" role="button" class="o_survey_session_close btn btn-primary mr-4"><i class="fa fa-close"/> Close</a>
                             <a href="#" role="button" class="o_survey_session_close btn btn-primary" t-att-data-show-results="True"><i class="fa fa-bar-chart"/> Results</a>

From 8d09178b4292369ddee36e8ca230ab005c277826 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A9lien=20Warnon?= <awa@odoo.com>
Date: Mon, 23 Mar 2020 09:01:40 +0000
Subject: [PATCH 3/6] [FIX] survey: correctly handle "free text sections" in
 surveys and sessions

We now have a way to display "free text sections" during the survey flow.
(Since 5b74f54396f6cf8986494e4632d0ea1b9940619b )

However, the behavior during survey sessions was not optimal:
- Attendees could click on "submit" and it would raise an error
- The section description was not displayed on the host screen
- The section description was never the "current question" of the session of it
  was the first item of the question_and_page_ids

This commit fixes all those points to have a nice session flow.

While the host is explaining the section description to the attendees, they get
a waiting message on their screen.

In addition, we fixed the display to avoid showing pages that lack a
description, and we reworked the '_get_pages_or_questions' method to have more
meaningful and readable cases for every layouts.

LINKS

PR #48442
Task 2208574
---
 addons/survey/controllers/main.py             |  3 +-
 .../controllers/survey_session_manage.py      |  2 ++
 addons/survey/models/survey_survey.py         | 33 +++++++++++--------
 addons/survey/static/src/js/survey_form.js    |  8 ++++-
 addons/survey/views/survey_templates.xml      |  5 +++
 .../survey_templates_user_input_session.xml   |  1 +
 6 files changed, 37 insertions(+), 15 deletions(-)

diff --git a/addons/survey/controllers/main.py b/addons/survey/controllers/main.py
index 3b9b29a9036..ee0017672fb 100644
--- a/addons/survey/controllers/main.py
+++ b/addons/survey/controllers/main.py
@@ -13,7 +13,7 @@ from odoo.addons.base.models.ir_ui_view import keep_query
 from odoo.exceptions import UserError
 from odoo.http import request, content_disposition
 from odoo.osv import expression
-from odoo.tools import format_datetime, format_date
+from odoo.tools import format_datetime, format_date, is_html_empty
 
 from odoo.addons.web.controllers.main import Binary
 
@@ -266,6 +266,7 @@ class Survey(http.Controller):
                 - previous_page_id : come from the breadcrumb or the back button and force the next questions to load
                                      to be the previous ones. """
         data = {
+            'is_html_empty': is_html_empty,
             'survey': survey_sudo,
             'answer': answer_sudo,
             'breadcrumb_pages': [{
diff --git a/addons/survey/controllers/survey_session_manage.py b/addons/survey/controllers/survey_session_manage.py
index ad7154b8753..b93a31d94ff 100644
--- a/addons/survey/controllers/survey_session_manage.py
+++ b/addons/survey/controllers/survey_session_manage.py
@@ -10,6 +10,7 @@ from werkzeug.urls import url_join
 
 from odoo import fields, http
 from odoo.http import request
+from odoo.tools import is_html_empty
 
 
 class UserInputSession(http.Controller):
@@ -165,6 +166,7 @@ class UserInputSession(http.Controller):
             } for line in full_statistics.get('table_data', request.env['survey.user_input.line'])[:100]]
 
         return {
+            'is_html_empty': is_html_empty,
             'question_statistics_graph': full_statistics.get('graph_data'),
             'input_line_values': input_line_values,
             'answers_validity': json.dumps(answers_validity),
diff --git a/addons/survey/models/survey_survey.py b/addons/survey/models/survey_survey.py
index 52ae373b22f..da8e1670fad 100644
--- a/addons/survey/models/survey_survey.py
+++ b/addons/survey/models/survey_survey.py
@@ -9,6 +9,7 @@ import werkzeug
 from odoo import api, exceptions, fields, models, _
 from odoo.exceptions import AccessError
 from odoo.osv import expression
+from odoo.tools import is_html_empty
 
 
 class Survey(models.Model):
@@ -437,12 +438,21 @@ class Survey(models.Model):
 
     @api.model
     def _get_pages_or_questions(self, user_input):
-        if self.questions_layout == 'one_page':
-            return self.env['survey.question']
-        elif self.questions_layout == 'page_per_question' and self.questions_selection == 'random':
-            return user_input.predefined_question_ids
-        else:
-            return self.question_and_page_ids if self.questions_layout == 'page_per_question' else self.page_ids
+        """ Returns the pages or questions (depending on the layout) that will be shown
+        to the user taking the survey.
+        In 'page_per_question' layout, we also want to show pages that have a description. """
+
+        result = self.env['survey.question']
+        if self.questions_layout == 'page_per_section':
+            result = self.page_ids
+        elif self.questions_layout == 'page_per_question':
+            if self.questions_selection == 'random':
+                result = user_input.predefined_question_ids
+            else:
+                result = self.question_and_page_ids.filtered(
+                    lambda question: not question.is_page or not is_html_empty(question.description))
+
+        return result
 
     def _get_next_page_or_question(self, user_input, page_or_question_id, go_back=False):
         """
@@ -580,13 +590,10 @@ class Survey(models.Model):
         if not self.question_ids or not self.env.user.has_group('survey.group_survey_user'):
             return
 
-        if not self.session_question_id:
-            next_question = self.question_ids[0]
-        else:
-            most_voted_answers = self._get_session_most_voted_answers()
-            next_question = self._get_next_page_or_question(most_voted_answers, self.session_question_id.id)
-
-        return next_question
+        most_voted_answers = self._get_session_most_voted_answers()
+        return self._get_next_page_or_question(
+            most_voted_answers,
+            self.session_question_id.id if self.session_question_id else 0)
 
     def _get_session_most_voted_answers(self):
         """ In sessions of survey that has conditional questions, as the survey is passed at the same time by
diff --git a/addons/survey/static/src/js/survey_form.js b/addons/survey/static/src/js/survey_form.js
index 9e0d82a88eb..c9e9d5942a3 100644
--- a/addons/survey/static/src/js/survey_form.js
+++ b/addons/survey/static/src/js/survey_form.js
@@ -51,7 +51,7 @@ publicWidget.registry.SurveyFormWidget = publicWidget.Widget.extend({
                 $(document).on('keypress', self._onKeyPress.bind(self));
             }
             if (self.options.sessionInProgress &&
-                (self.options.isStartScreen || self.options.hasAnswered)) {
+                (self.options.isStartScreen || self.options.hasAnswered || self.options.isPageDescription)) {
                 self.preventEnterSubmit = true;
             }
             self._initSessionManagement();
@@ -428,6 +428,12 @@ publicWidget.registry.SurveyFormWidget = publicWidget.Widget.extend({
             }
             self._initChoiceItems();
             self._initTextArea();
+
+            if (this.options.sessionInProgress && this.$('.o_survey_form_content_data').data('isPageDescription')) {
+                // prevent enter submit if we're on a page description (there is nothing to submit)
+                this.preventEnterSubmit = true;
+            }
+
             this.$('.o_survey_form_content').fadeIn(this.fadeInOutDelay);
             $("html, body").animate({ scrollTop: 0 }, this.fadeInOutDelay);
             self._focusOnFirstInput();
diff --git a/addons/survey/views/survey_templates.xml b/addons/survey/views/survey_templates.xml
index 7984694941b..4cc54cca006 100644
--- a/addons/survey/views/survey_templates.xml
+++ b/addons/survey/views/survey_templates.xml
@@ -74,6 +74,7 @@
                 t-att-data-is-start-screen="answer.state == 'new'"
                 t-att-data-readonly="survey_form_readonly"
                 t-att-data-has-answered="bool(has_answered)"
+                t-att-data-is-page-description="bool(question and question.is_page and not is_html_empty(question.description))"
                 t-att-data-questions-layout="survey.questions_layout"
                 t-att-data-triggered-questions-by-answer="json.dumps(triggered_questions_by_answer)"
                 t-att-data-selected-answers="json.dumps(selected_answers)">
@@ -139,6 +140,7 @@
         <div class="o_survey_form_content_data d-none"
             t-att-data-question-time-limit-reached="answer.question_time_limit_reached"
             t-att-data-has-answered="bool(has_answered)"
+            t-att-data-is-page-description="bool(question and question.is_page and not is_html_empty(question.description))"
             t-att-data-timer="timer_start"
             t-att-data-time-limit-minutes="time_limit_minutes"/>
         <t t-if="survey.questions_layout == 'one_page'">
@@ -192,6 +194,9 @@
                 <div t-if="answer.question_time_limit_reached and not has_answered" class="font-weight-bold mb128">Sorry, you have not been fast enough.</div>
                 <div t-else="" class="font-weight-bold mb128">We have registered your answer! Please wait for the host to go to the next question.</div>
             </t>
+            <t t-elif="answer.is_session_answer and question.is_page and not is_html_empty(question.description)">
+                <div class="font-weight-bold mt-5">Pay attention to the host screen until the next question.</div>
+            </t>
             <t t-else="">
                 <t t-call="survey.question_container"/>
 
diff --git a/addons/survey/views/survey_templates_user_input_session.xml b/addons/survey/views/survey_templates_user_input_session.xml
index 1d1a91b368f..19dbddc76f2 100644
--- a/addons/survey/views/survey_templates_user_input_session.xml
+++ b/addons/survey/views/survey_templates_user_input_session.xml
@@ -112,6 +112,7 @@
                         </div>
                         <div t-elif="show_text_answers" class="p-2 pt-4 o_survey_session_text_answers_container">
                         </div>
+                        <div t-elif="question.is_page and not is_html_empty(question.description)" class="mb-6 o_survey_manage_fontsize_14" t-field="question.description" />
                         <div t-else="" class="mb-6">
                             <h2 class="font-weight-normal mb-3">
                                 <span>Waiting for attendees...</span>

From af9b9d56c04a7a64b22afa2377244d2571f0aafb Mon Sep 17 00:00:00 2001
From: David Beguin <dbe@odoo.com>
Date: Thu, 26 Mar 2020 09:51:00 +0000
Subject: [PATCH 4/6] [FIX] survey: fix conditional questions navigation on
 survey

This commit remove unecessary array around triggered_questions_by_answer values
that is used at the client side to find inactive questions.

Before this fix, when looping through every elements of
triggered_questions_by_answer, we got an array, instead of each question id
separately.

PR #48442
Task ID 2208574
---
 addons/survey/controllers/main.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/addons/survey/controllers/main.py b/addons/survey/controllers/main.py
index ee0017672fb..d12348a33a7 100644
--- a/addons/survey/controllers/main.py
+++ b/addons/survey/controllers/main.py
@@ -284,9 +284,9 @@ class Survey(http.Controller):
                     if triggering_answer_by_question[question]
                 },
                 'triggered_questions_by_answer': {
-                    answer.id: [
-                        triggered_questions_by_answer[answer].ids
-                    ] for answer in triggered_questions_by_answer.keys()},
+                    answer.id: triggered_questions_by_answer[answer].ids
+                    for answer in triggered_questions_by_answer.keys()
+                },
                 'selected_answers': selected_answers.ids
             })
 

From 826a25c7d1896414721f4ff8d1ce57795ad5e030 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A9lien=20Warnon?= <awa@odoo.com>
Date: Fri, 20 Mar 2020 10:58:01 +0000
Subject: [PATCH 5/6] [FIX] survey: fix back button behavior

This commit fixes 2 small problems when the user goes back on the survey form:

- The back button should not be shown on "page_per_question" layout if we are
  on the first page of the survey.
  Pages can be displayed on "page_per_question" layout if they have a
  description since #44271
- Can't go back on "page_per_section" layout if you are on the second page of
  the survey, introduced by 0675d68afb7afe69e5e9d62a172c273a6d0b83e8

LINKS

PR #48442
Task 2208574
---
 addons/survey/models/survey_survey.py    |  2 +-
 addons/survey/views/survey_templates.xml | 11 +++++++++--
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/addons/survey/models/survey_survey.py b/addons/survey/models/survey_survey.py
index da8e1670fad..94d3a5bece6 100644
--- a/addons/survey/models/survey_survey.py
+++ b/addons/survey/models/survey_survey.py
@@ -481,7 +481,7 @@ class Survey(models.Model):
         current_page_index = pages_or_questions.ids.index(next(p.id for p in pages_or_questions if p.id == page_or_question_id))
 
         # Get previous and we are on first page  OR Get Next and we are on last page
-        if (go_back and current_page_index == 0) or current_page_index == len(pages_or_questions) - 1:
+        if (go_back and current_page_index == 0) or (not go_back and current_page_index == len(pages_or_questions) - 1):
             return Question
 
         # Conditional Questions Management
diff --git a/addons/survey/views/survey_templates.xml b/addons/survey/views/survey_templates.xml
index 4cc54cca006..b8addaaab7f 100644
--- a/addons/survey/views/survey_templates.xml
+++ b/addons/survey/views/survey_templates.xml
@@ -202,8 +202,15 @@
 
                 <div class="row">
                     <div class="offset-3 col-6 text-center mt16 mb128">
-                        <button t-if="not answer.is_session_answer and survey.users_can_go_back and question != answer.predefined_question_ids[0]" type="submit" class="btn btn-secondary"
-                                name="button_submit" value="previous" t-att-data-previous-page-id="previous_page_id">Back</button>
+                        <!-- Can go back if:
+                            - Back button is allowed in configuration
+                            - This is not a session answer (doesn't make sense to go back in session context)
+                            - This is not the first question
+                            - The survey doesn't have pages OR this is not the first page of the survey
+                              (pages are displayed in 'page_per_question' layout when they have a description, see PR#44271)
+                        -->
+                        <button t-if="survey.users_can_go_back and not answer.is_session_answer and question != answer.predefined_question_ids[0] and (not survey.page_ids or question != survey.page_ids[0])"
+                            type="submit" class="btn btn-secondary" name="button_submit" value="previous" t-att-data-previous-page-id="previous_page_id">Back</button>
                         <button type="submit" t-att-value="'next' if not survey_last else 'finish'" class="btn btn-primary">
                             <t t-if="answer.is_session_answer">
                                 Submit

From e8f0475a38c8da2801656cfa23c21a5d8816e3b8 Mon Sep 17 00:00:00 2001
From: David Beguin <dbe@odoo.com>
Date: Fri, 27 Mar 2020 08:33:07 +0000
Subject: [PATCH 6/6] [FIX] survey: skip section with no active questions (in
 conditional questions)

This commit applies conditional questions management on  the
"_get_next_page_or_question" method in "page_per_section" questions layout.

We choose the first section that has at least one active question when
searching the next section to display.
Indeed, a whole section could contain only disabled questions based on the
previously selected answers of the attendee.
(The logic is obviously reverted when "go_back" is True).

PR #48442
Task ID 2208574
---
 addons/survey/models/survey_survey.py | 48 ++++++++++++++++++---------
 1 file changed, 33 insertions(+), 15 deletions(-)

diff --git a/addons/survey/models/survey_survey.py b/addons/survey/models/survey_survey.py
index 94d3a5bece6..41022901c9e 100644
--- a/addons/survey/models/survey_survey.py
+++ b/addons/survey/models/survey_survey.py
@@ -455,15 +455,21 @@ class Survey(models.Model):
         return result
 
     def _get_next_page_or_question(self, user_input, page_or_question_id, go_back=False):
-        """
-        This methods gets the next question or page to display.
-        In case the survey contains conditional question, when navigating to next or previous questions,
-        in page_per_question layout only, the next or previous question to display depends on the selected answers
-        and the questions hierarchy. This methods returns the next question index to display among the survey_questions.
+        """ Generalized logic to retrieve the next question or page to show on the survey.
+        It's based on the page_or_question_id parameter, that is usually the currently displayed question/page.
+
+        There is a special case when the survey is configured with conditional questions:
+        - for "page_per_question" layout, the next question to display depends on the selected answers and
+          the questions 'hierarchy'.
+        - for "page_per_section" layout, before returning the result, we check that it contains at least a question
+          (all section questions could be disabled based on previously selected answers)
+
+        The whole logic is inverted if "go_back" is passed as True.
+
         :param user_input: user's answers
         :param page_or_question_id: current page or question id
-        :param go_back: must be True to get the previous question
-        :return: next or previous question.id
+        :param go_back: reverse the logic and get the PREVIOUS question/page
+        :return: next or previous question/page
         """
 
         survey = user_input.survey_id
@@ -486,14 +492,26 @@ class Survey(models.Model):
 
         # Conditional Questions Management
         triggering_answer_by_question, triggered_questions_by_answer, selected_answers = user_input._get_conditional_values()
-        if survey.has_conditional_questions and survey.questions_layout == 'page_per_question' and triggered_questions_by_answer:
-            potential_next_questions = pages_or_questions[0:current_page_index] if go_back \
-                else pages_or_questions[current_page_index+1:]
-            for question in sorted(potential_next_questions, key=lambda q: q.id, reverse=go_back):
-                triggering_answer = triggering_answer_by_question.get(question)
-                if not triggering_answer or triggering_answer in selected_answers:
-                    # If next question found
-                    return question
+        if survey.has_conditional_questions and triggered_questions_by_answer:
+            if survey.questions_layout == 'page_per_question':
+                question_candidates = pages_or_questions[0:current_page_index] if go_back \
+                    else pages_or_questions[current_page_index + 1:]
+                for question in question_candidates.sorted(reverse=go_back):
+                    triggering_answer = triggering_answer_by_question.get(question)
+                    if not triggering_answer or triggering_answer in selected_answers:
+                        # question is visible because not conditioned or conditioned by a selected answer
+                        # -> return it
+                        return question
+            elif survey.questions_layout == 'page_per_section':
+                inactive_questions = user_input._get_inactive_conditional_questions()
+                section_candidates = pages_or_questions[0:current_page_index] if go_back \
+                    else pages_or_questions[current_page_index + 1:]
+                for section in section_candidates.sorted(reverse=go_back):
+                    if any(question not in inactive_questions for question in section.question_ids):
+                        # section contains at least one active question
+                        # -> return it
+                        return section
+                return Question
         else:
             return pages_or_questions[current_page_index + (1 if not go_back else -1)]