[IMP] survey: enable custom speed rewards

This PR ams to improve speed reward logic in the survey. Users
will now have the possibility to specify a default time limit, as well
as custom time limits on each question.
To keep things simple, the time limit on the question is used for both
the "real" limit and the speed-related part of the score, both in the
live session setting only.

Modifying the time limit set on the survey should update all questions
that are not customized. Here is an example of the desired behavior:
(See `test_survey_time_limits_config`)

1. A time limit is set to 30s on a survey where no time configuration
 was done before => All questions are now rewarded with extra point
 after 30s.
2. After the previous step, question `A` 's time limit is overridden to
  60s. Only this question will have 60s. (a flag for this override is
  also set).
3. Question `B`'s time limit is set to 20 sec, the same as above
  occurs.
4. Question `C` is set to "no time limit" (also an override).
4. At this point, the time limit at the survey level is reduced from 30
  to 20s. This will make `B` not overridden anymore, while
  * A is still at 60s
  * C is still not limited (and no time-related rewards)

See technical details in the individual commits.

Task-2803327

closes odoo#115141

Related: odoo/enterprise#56810
Related: odoo/upgrade#5457
Signed-off-by: Thibault Delavallee (tde) <[email protected]>
Co-authored-by: Andro Gvivradze <[email protected]>

Author: 2 people

addons/survey/__manifest__.py

@@ -2,7 +2,7 @@
 # Part of Odoo. See LICENSE file for full copyright and licensing details.
 {
     'name': 'Surveys',
-    'version': '3.6',
+    'version': '3.7',
     'category': 'Marketing/Surveys',
     'description': """
 Create beautiful surveys and visualize answers

addons/survey/models/survey_question.py

@@ -47,6 +47,17 @@ class SurveyQuestion(models.Model):
     _rec_name = 'title'
     _order = 'sequence,id'
 
+    @api.model
+    def default_get(self, fields_list):
+        res = super().default_get(fields_list)
+        if default_survey_id := self.env.context.get('default_survey_id'):
+            survey = self.env['survey.survey'].browse(default_survey_id)
+            if 'is_time_limited' in fields_list and 'is_time_limited' not in res:
+                res['is_time_limited'] = survey.session_speed_rating
+            if 'time_limit' in fields_list and 'time_limit' not in res:
+                res['time_limit'] = survey.session_speed_rating_time_limit
+        return res
+
     # question generic data
     title = fields.Char('Title', required=True, translate=True)
     description = fields.Html(
@@ -58,6 +69,7 @@ class SurveyQuestion(models.Model):
     survey_id = fields.Many2one('survey.survey', string='Survey', ondelete='cascade')
     scoring_type = fields.Selection(related='survey_id.scoring_type', string='Scoring Type', readonly=True)
     sequence = fields.Integer('Sequence', default=10)
+    session_available = fields.Boolean(related='survey_id.session_available', string='Live Session available', readonly=True)
     # page specific
     is_page = fields.Boolean('Is a page?')
     question_ids = fields.One2many('survey.question', string='Questions', compute="_compute_question_ids")
@@ -118,6 +130,7 @@ class SurveyQuestion(models.Model):
     # -- display & timing options
     is_time_limited = fields.Boolean("The question is limited in time",
         help="Currently only supported for live sessions.")
+    is_time_customized = fields.Boolean("Customized speed rewards")
     time_limit = fields.Integer("Time limit (seconds)")
     # -- comments (simple choice, multiple choice, matrix (without count as an answer))
     comments_allowed = fields.Boolean('Show Comments Field')
@@ -179,6 +192,8 @@ class SurveyQuestion(models.Model):
             'All "Is a scored question = True" and "Question Type: Date" questions need an answer'),
         ('scale', "CHECK (question_type != 'scale' OR (scale_min >= 0 AND scale_max <= 10 AND scale_min < scale_max))",
             'The scale must be a growing non-empty range between 0 and 10 (inclusive)'),
+        ('is_time_limited_have_time_limit', "CHECK (is_time_limited != TRUE OR time_limit IS NOT NULL AND time_limit > 0)",
+            'All time-limited questions need a positive time limit'),
     ]
 
     # -------------------------------------------------------------------------
@@ -388,9 +403,14 @@ def copy(self, default=None):
                 new_question.triggering_answer_ids = old_question.triggering_answer_ids
         return new_questions
 
-    # ------------------------------------------------------------
-    # CRUD
-    # ------------------------------------------------------------
+    def create(self, vals_list):
+        questions = super().create(vals_list)
+        questions.filtered(
+            lambda q: q.survey_id
+            and (q.survey_id.session_speed_rating != q.is_time_limited
+                 or q.is_time_limited and q.survey_id.session_speed_rating_time_limit != q.time_limit)
+        ).is_time_customized = True
+        return questions
 
     @api.ondelete(at_uninstall=False)
     def _unlink_except_live_sessions_in_progress(self):
@@ -520,6 +540,36 @@ def _index(self):
         self.ensure_one()
         return list(self.survey_id.question_and_page_ids).index(self)
 
+    # ------------------------------------------------------------
+    # SPEED RATING
+    # ------------------------------------------------------------
+
+    def _update_time_limit_from_survey(self, is_time_limited=None, time_limit=None):
+        """Update the speed rating values after a change in survey's speed rating configuration.
+
+        * Questions that were not customized will take the new default values from the survey
+        * Questions that were customized will not change their values, but this method will check
+          and update the `is_time_customized` flag if necessary (to `False`) such that the user
+          won't need to "actively" do it to make the question sensitive to change in survey values.
+
+        This is not done with `_compute`s because `is_time_limited` (and `time_limit`) would depend
+        on `is_time_customized` and vice versa.
+        """
+        write_vals = {}
+        if is_time_limited is not None:
+            write_vals['is_time_limited'] = is_time_limited
+        if time_limit is not None:
+            write_vals['time_limit'] = time_limit
+        non_time_customized_questions = self.filtered(lambda s: not s.is_time_customized)
+        non_time_customized_questions.write(write_vals)
+
+        # Reset `is_time_customized` as necessary
+        customized_questions = self - non_time_customized_questions
+        back_to_default_questions = customized_questions.filtered(
+            lambda q: q.is_time_limited == q.survey_id.session_speed_rating
+            and (q.is_time_limited is False or q.time_limit == q.survey_id.session_speed_rating_time_limit))
+        back_to_default_questions.is_time_customized = False
+
     # ------------------------------------------------------------
     # STATISTICS / REPORTING
     # ------------------------------------------------------------