[16.0][FIX] survey_record_generation: backport fixes on linked records and unanswered questions #32

Merged
mondot merged 2 commits from 16.0-backport-survey_record_generation-fixes into 16.0 2026-11-17 14:15:13 +00:00
6 changed files with 261 additions and 27 deletions

View File

@@ -11,7 +11,7 @@ Allow to create record of any model when sending the form :
* Associate question with fields
* For x2m fields : Associate values to questions
""",
"version": "16.0.1.0.3",
"version": "16.0.1.0.4",
"license": "AGPL-3",
"author": "Elabore",
"website": "https://www.elabore.coop",

View File

@@ -61,6 +61,11 @@ class SurveyUserInput(models.Model):
)
field_name: str = field_value.field_id.name
if value is None:
# No value (e.g. question not displayed or skipped):
# keep the default/computed value of the field, and
# let another question fill up the same field.
continue
vals[field_name] = value
existing_record = self.find_existing_record(record_creation, vals)
@@ -160,8 +165,9 @@ class SurveyUserInput(models.Model):
elif field_value.value_origin == "question":
value = self.get_value_from_user_answer(field_value, user_input)
elif field_value.value_origin == "other_record":
# if the other_record value is a required field, get it or raise
value = self.get_required_value_from_other_record(
# if the other record is already created, get it
# (or raise if it is not created yet and the field is required)
value = self.get_value_from_other_record(
model, created_records, field_value
)
# otherwise, we update the record later (out of this for loop)
@@ -194,39 +200,34 @@ class SurveyUserInput(models.Model):
if unique_fields:
uniq_domain = []
for uniq_field in unique_fields:
uniq_domain.append((uniq_field, "=", vals[uniq_field]))
uniq_domain.append((uniq_field, "=", vals.get(uniq_field, False)))
duplicate = self.env[model].search(uniq_domain, limit=1)
return duplicate
def get_required_value_from_other_record(
def get_value_from_other_record(
self,
model: str,
created_records: dict[Any, Any],
field_value: "SurveyRecordCreationFieldValues",
) -> Any:
model_class = self.env[model]
if model_class._fields[field_value.field_id.name].required:
# check if the other record is already created,
# if yes add it to vals, else raise
if (
len(created_records) > 0
and created_records[field_value.other_created_record_id.id]
):
linked_record = created_records[field_value.other_created_record_id.id]
return self.get_value_for_relational_field(field_value, linked_record)
else:
raise UserError(
_(
"The field %(field)s is mandatory for model %(model)s. "
"In Record Creation tab, drag %(record)s "
"on top of the model %(model)s."
)
% {
"field": field_value.field_id.display_name,
"model": model,
"record": field_value.other_created_record_id.name,
}
linked_record = created_records.get(field_value.other_created_record_id.id)
if linked_record:
# The other record is already created: link it right away.
return self.get_value_for_relational_field(field_value, linked_record)
if self.env[model]._fields[field_value.field_id.name].required:
raise UserError(
_(
"The field %(field)s is mandatory for model %(model)s. "
"In Record Creation tab, drag %(record)s "
"on top of the model %(model)s."
)
% {
"field": field_value.field_id.display_name,
"model": model,
"record": field_value.other_created_record_id.name,
}
)
return None
def get_value_from_user_answer(
self,

View File

@@ -1,2 +1,3 @@
from . import test_survey_record_creation
from . import test_end_migration_16_0_1_0_3
from . import test_computed_fields

View File

@@ -0,0 +1,33 @@
from odoo import api, fields, models
class SurveyRecordGenerationFakeParent(models.Model):
_name = "survey.record.generation.fake.parent"
_description = "Fake parent record (tests only)"
name = fields.Char()
price = fields.Float()
class SurveyRecordGenerationFakeLine(models.Model):
"""Line whose price is computed from its parent, like the price of a
subscription line (subscription_oca).
Pattern reproduced: the survey creates a parent, then a line linked to
it, with a price answered by the user. The user's price must be kept,
the parent's price only applies when the user gave none.
"""
_name = "survey.record.generation.fake.line"
_description = "Fake line record (tests only)"
parent_id = fields.Many2one("survey.record.generation.fake.parent")
price_unit = fields.Float(
compute="_compute_price_unit", store=True, readonly=False
)
@api.depends("parent_id.price")
def _compute_price_unit(self):
for line in self:
if line.parent_id:
line.price_unit = line.parent_id.price

View File

@@ -0,0 +1,120 @@
from odoo_test_helper import FakeModelLoader
from odoo.addons.survey.tests.common import SurveyCase
class TestComputedFields(SurveyCase):
"""User's answers must not be overridden by computed fields depending on
a link to another generated record.
Use case: a membership form creating a subscription and a subscription
line whose price is typed by the participant (free amount), while the
line price is computed from the subscription.
"""
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.loader = FakeModelLoader(cls.env, cls.__module__)
cls.loader.backup_registry()
from .fake_models import (
SurveyRecordGenerationFakeLine,
SurveyRecordGenerationFakeParent,
)
cls.loader.update_registry(
(SurveyRecordGenerationFakeParent, SurveyRecordGenerationFakeLine)
)
@classmethod
def tearDownClass(cls):
cls.loader.restore_registry()
super().tearDownClass()
def setUp(self):
super().setUp()
self.survey = self.env["survey.survey"].create({"title": "Join us"})
self.question_amount = self._add_question(
page=None,
name="Free amount",
qtype="numerical_box",
survey_id=self.survey.id,
sequence=1,
)
# Parent, with a default price of 20
self.parent_creation = self._add_record_creation(
"Parent", "survey.record.generation.fake.parent", 0
)
self._add_field_value(
self.parent_creation, "name", value_origin="fixed",
fixed_value_char="Membership",
)
self._add_field_value(
self.parent_creation, "price", value_origin="fixed",
fixed_value_float=20.0,
)
# Line, linked to the parent, with the price answered by the user
self.line_creation = self._add_record_creation(
"Line", "survey.record.generation.fake.line", 1
)
self._add_field_value(
self.line_creation, "parent_id", value_origin="other_record",
other_created_record_id=self.parent_creation.id,
)
self._add_field_value(
self.line_creation, "price_unit", value_origin="question",
question_id=self.question_amount.id,
)
def _add_record_creation(self, name, model, sequence):
return self.env["survey.record.creation"].create(
{
"name": name,
"survey_id": self.survey.id,
"model_id": self.env["ir.model"]._get(model).id,
"sequence": sequence,
}
)
def _add_field_value(self, record_creation, field_name, **vals):
field = self.env["ir.model.fields"]._get(
record_creation.model_id.model, field_name
)
return self.env["survey.record.creation.field.values"].create(
{
"survey_record_creation_id": record_creation.id,
"survey_id": self.survey.id,
"model_id": record_creation.model_id.id,
"field_id": field.id,
**vals,
}
)
def _submit(self, amount=None):
answer = self._add_answer(
survey=self.survey, partner=False, email="jean@test.fr"
)
if amount is not None:
self._add_answer_line(
question=self.question_amount, answer=answer, answer_value=amount
)
answer._mark_done()
return self.env["survey.record.generation.fake.line"].search(
[("parent_id.name", "=", "Membership")]
)
def test_answer_is_not_overridden_by_computed_field(self):
line = self._submit(amount=33)
self.assertEqual(len(line), 1)
self.assertEqual(line.price_unit, 33.0)
def test_computed_field_applies_when_question_is_not_displayed(self):
# E.g. the "free amount" question is only displayed when the user
# chose "Other amount": otherwise the line keeps the computed price.
line = self._submit()
self.assertEqual(len(line), 1)
self.assertEqual(line.price_unit, 20.0)

View File

@@ -1096,3 +1096,82 @@ class TestSurveyRecordCreation(SurveyCase):
self.assertEqual(self.answer.partner_id, jean)
self.assertNotEqual(self.answer.partner_id, jeanne)
self.assertEqual(self.answer.email, jean.email)
def test_question_not_displayed_does_not_override_default_value(self):
# When a question is not displayed to the user (e.g. a conditional
# question), the field must keep its default (or computed) value
# instead of being emptied.
question_type = self._add_question(
page=None,
name="Type",
qtype="simple_choice",
labels=[{"value": "contact"}, {"value": "other"}],
survey_id=self.survey.id,
sequence=2,
answer_values_type="value",
)
for suggested_answer in question_type.suggested_answer_ids:
suggested_answer.value_char = suggested_answer.value
type_field = self.env["ir.model.fields"]._get("res.partner", "type")
self.env["survey.record.creation.field.values"].create(
{
"survey_record_creation_id": self.survey_record_creation.id,
"survey_id": self.survey.id,
"model_id": self.res_partner_model.id,
"field_id": type_field.id,
"value_origin": "question",
"question_id": question_type.id,
}
)
self.answer = self._add_answer(
survey=self.survey, partner=False, email="jean@test.fr"
)
self._add_answer_line(
question=self.question_name, answer=self.answer, answer_value="Jean"
)
self.answer._mark_done()
partner = self.env["res.partner"].search([("name", "=", "Jean")])
self.assertEqual(partner.type, "contact")
def test_several_conditional_questions_on_the_same_field(self):
# Several questions can fill up the same field (e.g. one list of
# amounts per periodicity, displayed conditionally): the answered
# question wins, the questions not displayed are ignored.
street_field = self.env["ir.model.fields"]._get("res.partner", "street")
questions = self.env["survey.question"]
for sequence, name in enumerate(["Street (France)", "Street (abroad)"], 2):
question = self._add_question(
page=None,
name=name,
qtype="char_box",
survey_id=self.survey.id,
sequence=sequence,
)
self.env["survey.record.creation.field.values"].create(
{
"survey_record_creation_id": self.survey_record_creation.id,
"survey_id": self.survey.id,
"model_id": self.res_partner_model.id,
"field_id": street_field.id,
"value_origin": "question",
"question_id": question.id,
}
)
questions |= question
self.answer = self._add_answer(
survey=self.survey, partner=False, email="jean@test.fr"
)
self._add_answer_line(
question=self.question_name, answer=self.answer, answer_value="Jean"
)
# Only the first question is displayed and answered
self._add_answer_line(
question=questions[0], answer=self.answer, answer_value="1 rue de Paris"
)
self.answer._mark_done()
partner = self.env["res.partner"].search([("name", "=", "Jean")])
self.assertEqual(partner.street, "1 rue de Paris")