Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 44 additions & 26 deletions src/consents/forms.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
from collections.abc import Iterable
from collections.abc import Iterable, Iterator, Mapping
from typing import Any

from django import forms
from django.db.models import QuerySet
from django.db.models.fields import BLANK_CHOICE_DASH

from src.consents.models import Consent, Term, TermOption, TermOptionChoices
from src.consents.models import BaseConsent, Consent, Term, TermOption, TermOptionChoices
from src.workshops.forms import BootstrapHelper, WidgetOverrideMixin
from src.workshops.models import Person

Expand All @@ -19,6 +19,46 @@ def option_display_value(option: TermOption) -> str:
return option.content or OPTION_DISPLAY[TermOptionChoices(option.option_type)]


def create_consent_field(
term: Term,
consent: BaseConsent | None = None,
*,
label: str | None = None,
required: bool | None = None,
) -> forms.ChoiceField:
"""Build a select field with the term's options. The current consent (if any) is
used as the initial value. By default the label is the term's content and the field
is required for non-optional terms."""
options = [(opt.pk, option_display_value(opt)) for opt in term.options]
initial = consent.term_option_id if consent else None
attrs = {"class": "border border-warning"} if initial is None else {}

return forms.ChoiceField(
choices=BLANK_CHOICE_DASH + options, # type: ignore[operator]
label=term.content if label is None else label,
required=term.required_type != Term.OPTIONAL_REQUIRE_TYPE if required is None else required,
initial=initial,
help_text=term.help_text or "",
widget=forms.Select(attrs=attrs),
)


def changed_consents[C: BaseConsent](
terms: Iterable[Term],
cleaned_data: Mapping[str, Any],
current_consents: Mapping[int, C],
) -> Iterator[tuple[Term, str, C | None]]:
"""Yield `(term, selected option ID, current consent)` for every term whose answer
(a form field named after the term's slug) differs from the current consent.
Terms left blank are skipped. `current_consents` maps term IDs to active consents."""
for term in terms:
option_id = cleaned_data.get(term.slug)
consent = current_consents.get(term.pk)
if not option_id or (consent and option_id == str(consent.term_option_id)):
continue
yield term, option_id, consent


class BaseTermConsentsForm(WidgetOverrideMixin, forms.ModelForm[Consent]):
"""
Builds form including all active terms with
Expand Down Expand Up @@ -54,34 +94,12 @@ def _build_form(self, person: Person) -> None:
for consent in Consent.objects.filter(archived_at=None, term__in=self.terms, person=person)
}
for term in self.terms:
self.fields[term.slug] = self.create_options_field(term)

def create_options_field(self, term: Term) -> forms.ChoiceField:
consent = self.term_id_by_consent.get(term.pk, None)
options = [(opt.pk, option_display_value(opt)) for opt in term.options]
required = term.required_type != Term.OPTIONAL_REQUIRE_TYPE
initial = consent.term_option_id if consent else None
attrs = {"class": "border border-warning"} if initial is None else {}

field = forms.ChoiceField(
choices=BLANK_CHOICE_DASH + options, # type: ignore
label=term.content,
required=required,
initial=initial,
help_text=term.help_text,
widget=forms.Select(attrs=attrs),
)
return field
self.fields[term.slug] = create_consent_field(term, self.term_id_by_consent.get(term.pk))

def save(self, *args: Any, **kwargs: Any) -> None: # type: ignore
person = self.cleaned_data["person"]
new_consents: list[Consent] = []
for term in self.terms:
option_id = self.cleaned_data.get(term.slug)
consent = self.term_id_by_consent.get(term.pk)
has_changed = option_id != str(consent.term_option_id) if consent else True
if not option_id or not has_changed:
continue
for term, option_id, consent in changed_consents(self.terms, self.cleaned_data, self.term_id_by_consent):
if consent:
consent.archive()
new_consents.append(Consent(person=person, term_option_id=option_id, term_id=term.pk))
Expand Down
27 changes: 3 additions & 24 deletions src/extforms/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@
from crispy_forms.layout import HTML, Div, Layout
from django import forms
from django.core.exceptions import ValidationError
from django.db.models.fields import BLANK_CHOICE_DASH
from django.http import HttpRequest
from django_recaptcha.fields import ReCaptchaField

from src.consents.forms import option_display_value
from src.consents.forms import changed_consents, create_consent_field
from src.consents.models import Term, TrainingRequestConsent
from src.extrequests.forms import (
SelfOrganisedSubmissionBaseForm,
Expand Down Expand Up @@ -238,24 +237,7 @@ def set_hr(self, layout: Layout) -> None:

def set_consent_fields(self, terms: Iterable[Term]) -> None:
for term in terms:
self.fields[term.slug] = self.create_consent_field(term)

def create_consent_field(self, term: Term) -> forms.ChoiceField:
options = [(opt.pk, option_display_value(opt)) for opt in term.options]
label = term.training_request_content or term.content
required = term.required_type == Term.PROFILE_REQUIRE_TYPE
initial = None
attrs = {"class": "border border-warning"} if initial is None else {}

field = forms.ChoiceField(
choices=BLANK_CHOICE_DASH + options, # type: ignore[operator]
label=label,
required=required,
initial=initial,
help_text=term.help_text or "",
widget=forms.Select(attrs=attrs),
)
return field
self.fields[term.slug] = create_consent_field(term, label=term.training_request_content or term.content)

@feature_flag_enabled("ENFORCE_MEMBER_CODES")
def validate_member_code(self, request: HttpRequest) -> None | dict[str, ValidationError]:
Expand Down Expand Up @@ -335,10 +317,7 @@ def clean(self) -> None:
def save(self, *args: Any, **kwargs: Any) -> TrainingRequest:
training_request = super().save(*args, **kwargs)
new_consents: list[TrainingRequestConsent] = []
for term in self.terms:
option_id = self.cleaned_data.get(term.slug)
if not option_id:
continue
for term, option_id, _ in changed_consents(self.terms, self.cleaned_data, {}):
new_consents.append(
TrainingRequestConsent(
training_request=training_request,
Expand Down
48 changes: 47 additions & 1 deletion src/extrequests/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@
from django.core.exceptions import ValidationError
from django.db.models import Case, When
from django.http import HttpRequest
from django.utils import timezone
from flags.state import flag_enabled # type: ignore[import-untyped]

from src.consents.forms import changed_consents, create_consent_field
from src.consents.models import Term, TrainingRequestConsent
from src.extrequests.models import (
DataVariant,
SelfOrganisedSubmission,
Expand Down Expand Up @@ -1321,7 +1324,10 @@ class Meta:
# `tasks` is maintained by matching/unmatching, not edited by hand - and with
# `exclude = ()` it would otherwise render every Task in the database as a
# plain <select multiple>, since there's no lookup view behind it.
exclude = ("tasks",)
# `data_privacy_agreement` is deprecated: the training request form no longer
# sets it. Data privacy consent is stored as `TrainingRequestConsent` and is
# edited via the consent fields added in `__init__` (#2608).
exclude = ("tasks", "data_privacy_agreement")
widgets = {
"occupation": forms.RadioSelect(),
"domains": forms.CheckboxSelectMultiple(),
Expand All @@ -1339,13 +1345,53 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
self.request_http = kwargs.pop("request", None)
super().__init__(*args, **kwargs)

# Same terms as in the training request form (`TrainingRequestForm`).
self.terms = list(
Term.objects.prefetch_active_options().filter(required_type=Term.PROFILE_REQUIRE_TYPE).order_by("slug")
)
self.current_consents: dict[int, TrainingRequestConsent] = (
{
consent.term_id: consent
for consent in TrainingRequestConsent.objects.active().filter(training_request=self.instance)
}
if self.instance.pk
else {}
)
for term in self.terms:
# Not required: older training requests may not have any consents
# recorded, and that shouldn't prevent admins from editing them.
self.fields[term.slug] = create_consent_field(
term,
self.current_consents.get(term.pk),
label=term.training_request_content or term.content,
required=False,
)

def clean(self) -> None:
super().clean()

errors = self.validate_member_code(request=self.request_http)
if errors:
raise ValidationError(errors)

def save(self, commit: bool = True) -> TrainingRequest:
training_request = super().save(commit=commit)
if commit:
self.save_consents(training_request)
return training_request

def save_consents(self, training_request: TrainingRequest) -> None:
to_archive: list[int] = []
to_create: list[TrainingRequestConsent] = []
for term, option_id, consent in changed_consents(self.terms, self.cleaned_data, self.current_consents):
if consent:
to_archive.append(consent.pk)
to_create.append(
TrainingRequestConsent(training_request=training_request, term_id=term.pk, term_option_id=option_id)
)
TrainingRequestConsent.objects.filter(pk__in=to_archive).update(archived_at=timezone.now())
TrainingRequestConsent.objects.bulk_create(to_create)

@feature_flag_enabled("ENFORCE_MEMBER_CODES")
def validate_member_code(self, request: HttpRequest) -> None | dict[str, ValidationError]:
errors = dict()
Expand Down
98 changes: 97 additions & 1 deletion src/extrequests/tests/test_training_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
TermOptionChoices,
TrainingRequestConsent,
)
from src.extrequests.forms import TrainingRequestsMergeForm
from src.extrequests.forms import TrainingRequestsMergeForm, TrainingRequestUpdateForm
from src.extrequests.views import _match_training_request_to_person
from src.fiscal.models import Partnership, PartnershipTier
from src.offering.models import Account, AccountBenefit, Benefit
Expand Down Expand Up @@ -2091,3 +2091,99 @@ def test_merging_consents_most_recent(self) -> None:
len(TrainingRequestConsent.objects.filter(training_request__in=[self.first_req, self.second_req])),
0,
)


class TestTrainingRequestUpdateConsents(TestBase):
"""Regression tests for #2608: data privacy consent given in the training request
form wasn't shown (and couldn't be edited) in the admin edit form."""

def setUp(self) -> None:
self._setUpUsersAndLogin()
self.request = create_training_request(state="p", person=None)
self.privacy_policy_term = Term.objects.get_by_key(TermEnum.PRIVACY_POLICY)
self.agree = TermOption.objects.filter(term=self.privacy_policy_term).get_agree_term_option()
# Privacy policy is a required term and only has an "agree" option by default.
self.decline, _ = TermOption.objects.get_or_create(
term=self.privacy_policy_term, option_type=TermOptionChoices.DECLINE, archived_at=None
)

def test_deprecated_data_privacy_agreement_not_in_form(self) -> None:
form = TrainingRequestUpdateForm(instance=self.request)
self.assertNotIn("data_privacy_agreement", form.fields)

def test_consent_fields_initial_values(self) -> None:
# Arrange
TrainingRequestConsent.objects.create(
training_request=self.request, term=self.privacy_policy_term, term_option=self.agree
)

# Act
form = TrainingRequestUpdateForm(instance=self.request)

# Assert
self.assertEqual(form[self.privacy_policy_term.slug].initial, self.agree.pk)

def test_consent_fields_initial_values_skip_archived(self) -> None:
TrainingRequestConsent.objects.create(
training_request=self.request,
term=self.privacy_policy_term,
term_option=self.agree,
archived_at=datetime.now(UTC),
)
form = TrainingRequestUpdateForm(instance=self.request)
self.assertIsNone(form[self.privacy_policy_term.slug].initial)

def test_edit_view_shows_consent(self) -> None:
TrainingRequestConsent.objects.create(
training_request=self.request, term=self.privacy_policy_term, term_option=self.agree
)
rv = self.client.get(reverse("trainingrequest_edit", args=[self.request.pk]))
self.assertEqual(rv.status_code, 200)
self.assertEqual(rv.context["form"][self.privacy_policy_term.slug].value(), self.agree.pk)

def test_save_consents_changed(self) -> None:
# Arrange
old_consent = TrainingRequestConsent.objects.create(
training_request=self.request, term=self.privacy_policy_term, term_option=self.agree
)
form = TrainingRequestUpdateForm(instance=self.request)
form.cleaned_data = {term.slug: "" for term in form.terms}
form.cleaned_data[self.privacy_policy_term.slug] = str(self.decline.pk)

# Act
form.save_consents(self.request)

# Assert
old_consent.refresh_from_db()
self.assertTrue(old_consent.is_archived())
TrainingRequestConsent.objects.active().get(
training_request=self.request, term=self.privacy_policy_term, term_option=self.decline
)

def test_save_consents_unchanged(self) -> None:
# Arrange
consent = TrainingRequestConsent.objects.create(
training_request=self.request, term=self.privacy_policy_term, term_option=self.agree
)
form = TrainingRequestUpdateForm(instance=self.request)
form.cleaned_data = {term.slug: "" for term in form.terms}
form.cleaned_data[self.privacy_policy_term.slug] = str(self.agree.pk)

# Act
form.save_consents(self.request)

# Assert
consent.refresh_from_db()
self.assertTrue(consent.is_active())
self.assertEqual(TrainingRequestConsent.objects.filter(training_request=self.request).count(), 1)

def test_save_consents_new(self) -> None:
form = TrainingRequestUpdateForm(instance=self.request)
form.cleaned_data = {term.slug: "" for term in form.terms}
form.cleaned_data[self.privacy_policy_term.slug] = str(self.agree.pk)

form.save_consents(self.request)

TrainingRequestConsent.objects.active().get(
training_request=self.request, term=self.privacy_policy_term, term_option=self.agree
)
24 changes: 13 additions & 11 deletions src/extrequests/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -823,8 +823,10 @@ def _match_training_request_to_person(

# Create new style consents based on the training request consents used in the
# training request form.
training_request_consents = TrainingRequestConsent.objects.filter(training_request=training_request).select_related(
"term_option", "term"
training_request_consents = (
TrainingRequestConsent.objects.active()
.filter(training_request=training_request)
.select_related("term_option", "term")
)
for consent in training_request_consents:
try:
Expand Down Expand Up @@ -887,9 +889,9 @@ def get_context_data(self, **kwargs: Any) -> dict[str, Any]:
context["title"] = f"Training request #{req.pk}"
context["consents"] = {
consent.term.key: consent
for consent in TrainingRequestConsent.objects.select_related("term", "term_option").filter(
training_request=req
)
for consent in TrainingRequestConsent.objects.active()
.select_related("term", "term_option")
.filter(training_request=req)
}
context["consents_content"] = {term.key: term.content for term in Term.objects.filter(slug__in=self.TERM_SLUGS)}
return context
Expand Down Expand Up @@ -1049,15 +1051,15 @@ def trainingrequests_merge(request: AuthenticatedHttpRequest) -> HttpResponse:
"form": form,
"obj_a_consents": {
consent.term.key: consent
for consent in TrainingRequestConsent.objects.select_related("term", "term_option").filter(
training_request=obj_a
)
for consent in TrainingRequestConsent.objects.active()
.select_related("term", "term_option")
.filter(training_request=obj_a)
},
"obj_b_consents": {
consent.term.key: consent
for consent in TrainingRequestConsent.objects.select_related("term", "term_option").filter(
training_request=obj_b
)
for consent in TrainingRequestConsent.objects.active()
.select_related("term", "term_option")
.filter(training_request=obj_b)
},
}
return render(request, "requests/trainingrequests_merge.html", context)
Expand Down
Loading