PT-453 | Add backend support for is_part_of_cultural_route boolean field to enrolments, queue enrolments and their reports by karisal-anders · Pull Request #509 · City-of-Helsinki/palvelutarjotin

karisal-anders · 2026-05-28T14:50:09Z

Description

Add is_part_of_cultural_route boolean field support

Add a required is_part_of_cultural_route field to enrolments and
queue enrolments and their related reports. Updating enrolments through
admin view intentionally does not require is_part_of_cultural_route to
be always updated. Add is_part_of_cultural_route to Django admin's
EnrolmentReportAdmin, to its list display and add a boolean filter for
the value.

Also update snapshots as they changed to some other set of random
values, probably because of model change.

Manual testing

Tested locally by running the PR's backend + end-user frontend PR's frontend, enrolling to an event. I could enrol to an event.

Additional notes

Initializing old enrolment data to is_part_of_cultural_route with False was ok for the product owner. This means the value does not in itself distinguish between "Unanswered" (i.e. the old enrolments with False) and "No / I don't know" (i.e. the new enrolments with False). EnrolmentBase has enrolment_time with auto_now_add=True though, which could be used to check whether the enrolment is before this functionality was deployed to production (meaning its is_part_of_cultural_route=False means Unanswered) or after (meaning its is_part_of_cultural_route=False means No / I don't know).

NOTE:

EnrolmentReportCsvView doesn't really use the serializer it declares AFAIK i.e. serializer_class = EnrolmentReportSerializer for serializing values. It is there, possibly used by the OpenAPI endpoint schema documentation? Don't know for sure, but at least the data output doesn't seem to use it at all. This is out of scope for this PR to refactor / fix underlying issues, this PR adds a new field to relevant reports and serializes the newly added field properly. Old fields stay as they were for backward compatibility.

Screenshots

Event enrolling

Finnish

Swedish

English

Trying to enrol without choosing cultural route answer

Django admin

Event queue enrolment detail view

Enrolment detail view

Enrolment report list view

Enrolment report list view added filter

Enrolment report detail view

azure-pipelines · 2026-05-28T15:03:07Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

Copilot

Pull request overview

Adds end-to-end backend support for capturing and reporting whether an enrolment is part of a cultural route/path, spanning the enrolment domain model, GraphQL mutations, and reporting exports/serialization. Snapshot updates reflect test fixture output changes after introducing the new field.

Changes:

Add is_part_of_cultural_route boolean to enrolment models (including queued enrolments) and propagate it through enrolment creation and report hydration.
Extend GraphQL enrolment mutations/inputs to accept and persist the new boolean.
Add report serializer + CSV export support and update tests/snapshots accordingly.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
reports/views/csv_api.py	Adds a new CSV column for the cultural route flag.
reports/tests/test_serializers.py	Updates serializer input test to include the new field.
reports/serializers.py	Introduces a mapped boolean serializer field and wires it into `EnrolmentReportSerializer`.
reports/models.py	Adds the boolean field to `EnrolmentReport` and hydrates it from `Enrolment`.
reports/migrations/0002_enrolmentreport_is_part_of_cultural_route.py	Adds DB column for `EnrolmentReport.is_part_of_cultural_route`.
occurrences/schema.py	Adds GraphQL input field + passes it through enrolment mutations and update mutation logic.
occurrences/schema_services.py	Threads the new boolean through enrolment service functions.
occurrences/models.py	Adds the boolean field to enrolment base model and propagates it from queued enrolment to actual enrolment.
occurrences/migrations/0045_enrolment_is_part_of_cultural_route_and_more.py	Adds DB columns for `Enrolment` and `EventQueueEnrolment`.
occurrences/factories.py	Adds factory data for the new field.
occurrences/tests/test_api.py	Updates mutation test inputs to include the new GraphQL field.
organisations/tests/snapshots/test_api.ambr	Snapshot updates due to fixture value changes.
occurrences/tests/snapshots/test_notifications.ambr	Snapshot updates due to fixture value changes.
occurrences/tests/snapshots/test_api.ambr	Snapshot updates due to fixture value changes.
gdpr/tests/snapshots/test_gdpr_api.ambr	Snapshot updates due to fixture value changes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

azure-pipelines · 2026-05-29T10:51:32Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

azure-pipelines · 2026-05-29T14:04:27Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

azure-pipelines · 2026-06-01T06:56:41Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

azure-pipelines · 2026-06-01T07:36:14Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

also: - with the request of the product owner don't restore any previous answer to "Is part of cultural route" question from local storage persisted Formik form's data, but instead always reset the question to its initial value i.e. no data given at all - update generated GraphQL types using backend running City-of-Helsinki/palvelutarjotin#509 i.e. the backend support for the `is_part_of_cultural_route` field in enrolments and queue enrolments - update playwright tests Refs: PT-453

also: - with the request of the product owner don't restore any previous answer to "Is part of cultural route" question from local storage persisted Formik form's data, but instead always reset the question to its initial value i.e. no data given at all - update generated GraphQL types using backend running City-of-Helsinki/palvelutarjotin#509 i.e. the backend support for the `is_part_of_cultural_route` field in enrolments and queue enrolments - add tests - update playwright tests - load en/sv as well for tests instead of just fi as before - used for testing localization of "read more" url Refs: PT-453

also: - with the request of the product owner don't restore any previous answer to "Is part of cultural route" question from local storage persisted Formik form's data, but instead always reset the question to its initial value i.e. no data given at all - update generated GraphQL types using backend running City-of-Helsinki/palvelutarjotin#509 i.e. the backend support for the `is_part_of_cultural_route` field in enrolments and queue enrolments - add tests - update playwright tests Refs: PT-453

azure-pipelines · 2026-06-02T13:45:00Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

azure-pipelines · 2026-06-03T13:24:51Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

azure-pipelines · 2026-06-03T14:00:37Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

also: - with the request of the product owner don't restore any previous answer to "Is part of cultural route" question from local storage persisted Formik form's data, but instead always reset the question to its initial value i.e. no data given at all - update generated GraphQL types using backend running City-of-Helsinki/palvelutarjotin#509 i.e. the backend support for the `is_part_of_cultural_route` field in enrolments and queue enrolments - add tests - update playwright tests Refs: PT-453

nikomakela

Looks good to me.

nikomakela · 2026-06-04T06:31:01Z

+class BaseMappedBooleanField(serializers.Field):
+    """
+    Bidirectional serializer for a BooleanField with translatable labels for
+    False and True values.
+    """
+
+    @property
+    def false_label(self) -> str:
+        raise NotImplementedError("Subclasses must define a false_label property.")
+
+    @property
+    def true_label(self) -> str:
+        raise NotImplementedError("Subclasses must define a true_label property.")
+
+    def to_representation(self, value) -> str:
+        return self.true_label if value else self.false_label
+
+    def to_internal_value(self, data) -> bool:
+        # This is likely worst case 6 ifs (fi/sv/en languages and two labels):
+        for lang_code, _lang_name in settings.LANGUAGES:
+            with translation.override(lang_code):
+                if data == self.false_label:
+                    return False
+                if data == self.true_label:
+                    return True
+        raise serializers.ValidationError(f"Unable to parse {data} as a boolean.")
+
+
+class IsPartOfCulturalRouteField(BaseMappedBooleanField):
+    @property
+    def false_label(self) -> str:
+        # Django has fi/sv/en translations for "No" and "Unknown" out of the box:
+        return f"{_('No')} / {_('Unknown')}"
+
+    @property
+    def true_label(self) -> str:
+        # Django has fi/sv/en translations for "Yes" out of the box:
+        return _("Yes")
+
+


I would say this is a bit pointless, but I understand the benefit in terms of transparency and guiding the interpretation of reporting. This kind of belittles the situation where I really want to answer "NO". Since we are specifically tracking those who are cultural path users, this is just a display-level change and the expected response in the database data model is empty, this is fine.

The "No / I don't know" is a design choice already ~2.5 years ago:

https://helsinkisolutionoffice.atlassian.net/browse/PT-1644

And the product owner approved it. So it is a known shortcoming/feature that "No" and "I don't know" are using the same value.

Ah, and here the "No / Unknown" is a continuation of that, as product owner also approved that old enrolments and queue enrolments that have no data for the is_part_of_cultural_route field can be initialized to False (although they really mean "Unanswered", not "No" or "I don't know") and thus are indistinguishable from "No / I don't know" in themselves, but with EnrolmentBase.enrolment_time they are still distinguishable from "No / I don't know".

Add a required `is_part_of_cultural_route` field to enrolments and queue enrolments and their related reports. Updating enrolments through admin view intentionally does not require `is_part_of_cultural_route` to be always updated. Add `is_part_of_cultural_route` to Django admin's EnrolmentReportAdmin, to its list display and add a boolean filter for the value. Also update snapshots as they changed to some other set of random values, probably because of model change. Refs: PT-453

sonarqubecloud · 2026-06-04T10:24:46Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
71.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

azure-pipelines · 2026-06-04T10:31:24Z

KULTUS-API branch is deployed to platta: https://kultus-pr509.api.dev.hel.ninja 🚀🚀🚀

also: - with the request of the product owner don't restore any previous answer to "Is part of cultural route" question from local storage persisted Formik form's data, but instead always reset the question to its initial value i.e. no data given at all - update generated GraphQL types using backend running City-of-Helsinki/palvelutarjotin#509 i.e. the backend support for the `is_part_of_cultural_route` field in enrolments and queue enrolments - add tests - update playwright tests Refs: PT-453

karisal-anders requested a review from Copilot May 29, 2026 06:22

Copilot started reviewing on behalf of karisal-anders May 29, 2026 06:22 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

karisal-anders changed the title ~~PT-453 | Add backend support for Enrolment.is_part_of_cultural_path boolean field~~ PT-453 | Add backend support for is_part_of_cultural_path boolean field to enrolments, queue enrolments and their reports May 29, 2026

karisal-anders force-pushed the PT-453-add-culture-path-support branch 2 times, most recently from be0a837 to 69c8328 Compare May 29, 2026 10:41

karisal-anders force-pushed the PT-453-add-culture-path-support branch from 69c8328 to 6a30058 Compare May 29, 2026 13:53

karisal-anders force-pushed the PT-453-add-culture-path-support branch from 6a30058 to e1a3e62 Compare June 1, 2026 06:44

karisal-anders force-pushed the PT-453-add-culture-path-support branch from e1a3e62 to 5c84b6e Compare June 1, 2026 07:21

karisal-anders mentioned this pull request Jun 1, 2026

(→PR #495) PT-453 | Add cultural route support City-of-Helsinki/palvelutarjotin-ui#494

Closed

karisal-anders mentioned this pull request Jun 2, 2026

PT-453 | Add cultural route support to enrolment form City-of-Helsinki/palvelutarjotin-ui#495

Merged

karisal-anders changed the title ~~PT-453 | Add backend support for is_part_of_cultural_path boolean field to enrolments, queue enrolments and their reports~~ PT-453 | Add backend support for is_part_of_cultural_route boolean field to enrolments, queue enrolments and their reports Jun 2, 2026

karisal-anders force-pushed the PT-453-add-culture-path-support branch from 5c84b6e to f34e42d Compare June 2, 2026 13:33

karisal-anders force-pushed the PT-453-add-culture-path-support branch from f34e42d to 52e450c Compare June 3, 2026 13:15

karisal-anders marked this pull request as ready for review June 3, 2026 13:49

karisal-anders requested a review from a team as a code owner June 3, 2026 13:49

karisal-anders requested review from ToivoMattilaHelsinki and nikomakela June 3, 2026 13:51

nikomakela approved these changes Jun 4, 2026

View reviewed changes

danipran requested changes Jun 4, 2026

View reviewed changes

Comment thread occurrences/tests/test_api.py

karisal-anders force-pushed the PT-453-add-culture-path-support branch from 52e450c to 786295b Compare June 4, 2026 10:20

sentry Bot reviewed Jun 4, 2026

View reviewed changes

Comment thread occurrences/models.py

karisal-anders requested a review from danipran June 4, 2026 10:32

danipran approved these changes Jun 4, 2026

View reviewed changes

karisal-anders merged commit 589d3c1 into main Jun 4, 2026
32 checks passed

karisal-anders deleted the PT-453-add-culture-path-support branch June 4, 2026 10:45

Uh oh!

Conversation

karisal-anders commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Add is_part_of_cultural_route boolean field support

Related

Manual testing

Additional notes

Screenshots

Event enrolling

Finnish

Swedish

English

Trying to enrol without choosing cultural route answer

Django admin

Event queue enrolment detail view

Enrolment detail view

Enrolment report list view

Enrolment report list view added filter

Enrolment report detail view

Uh oh!

azure-pipelines Bot commented May 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

azure-pipelines Bot commented May 29, 2026

Uh oh!

azure-pipelines Bot commented May 29, 2026

Uh oh!

azure-pipelines Bot commented Jun 1, 2026

Uh oh!

azure-pipelines Bot commented Jun 1, 2026

Uh oh!

azure-pipelines Bot commented Jun 2, 2026

Uh oh!

azure-pipelines Bot commented Jun 3, 2026

Uh oh!

azure-pipelines Bot commented Jun 3, 2026

Uh oh!

nikomakela left a comment

Choose a reason for hiding this comment

Uh oh!

nikomakela Jun 4, 2026

Choose a reason for hiding this comment

Uh oh!

karisal-anders Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

karisal-anders Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jun 4, 2026

Quality Gate passed

Uh oh!

azure-pipelines Bot commented Jun 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

karisal-anders commented May 28, 2026 •

edited

Loading

karisal-anders Jun 4, 2026 •

edited

Loading

karisal-anders Jun 4, 2026 •

edited

Loading