✨ [#4993] Implement fetching select(boxes) options from Referentielijsten #4996

stevenbal · 2025-01-07T14:33:14Z

Closes #4993

TODO:

generic ExternalServiceUnavailable error which should result in a 503 from our API

Changes

Implement fetching select(boxes) options from Referentielijsten
Add docker-compose file and fixtures for Referentielijsten

Checklist

Check off the items that are completed or not relevant.

Impact on features
- Checked copying a form
- Checked import/export of a form
- Config checks in the configuration overview admin page
- Problem detection in the admin email digest is handled
Release management
- I have labelled the PR as "needs-backport" accordingly
I have updated the translations assets (you do NOT need to provide translations)
- Ran ./bin/makemessages_js.sh
- Ran ./bin/compilemessages_js.sh
Dockerfile/scripts
- Updated the Dockerfile with the necessary scripts from the ./bin folder
Commit hygiene
- Commit messages refer to the relevant Github issue
- Commit messages explain the "why" of change, not the how

codecov · 2025-01-07T14:42:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.63%. Comparing base (f16d700) to head (714d33b).
Report is 16 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4996      +/-   ##
==========================================
+ Coverage   96.62%   96.63%   +0.01%     
==========================================
  Files         761      763       +2     
  Lines       25961    26068     +107     
  Branches     3394     3402       +8     
==========================================
+ Hits        25084    25191     +107     
  Misses        611      611              
  Partials      266      266

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/openforms/formio/dynamic_config/dynamic_options.py

stevenbal · 2025-01-13T15:24:50Z

src/openforms/submissions/api/serializers.py

+        except Exception as e:
+            if detail := getattr(e, "detail", None):
+                raise APIException(detail)
+            raise e


This is in preparation to display a proper error message to the user in case the referentielijsten options can't be fetched. I'm not sure if this is the right approach to get a specific message though, it currently looks like this:

Preferably I think the "detail" message should be displayed in the error block, which would require changes in the SDK

src/openforms/formio/dynamic_config/dynamic_options.py

src/openforms/formio/dynamic_config/referentielijsten.py

sergei-maertens · 2025-01-14T13:01:00Z

src/openforms/submissions/api/serializers.py

        # invoke the configured form logic to dynamically update the Formio.js configuration
-        new_configuration = evaluate_form_logic(
-            instance.submission,
-            instance,
-            instance.submission.data,
-            **self.context,
-        )
+        try:
+            new_configuration = evaluate_form_logic(
+                instance.submission,
+                instance,
+                instance.submission.data,
+                **self.context,
+            )
+        except Exception as e:
+            if detail := getattr(e, "detail", None):
+                raise APIException(detail)
+            raise e  # pragma: no cover


Currently the philosophy of OF is "continue at all costs" and this breaks. Let's discuss with Joeri what the expected behaviour is here.

I'm also out of the loop now what the service fetch behaviour is 🤔

In the issue this was mentioned:

If the API is unavailable or returns an error, Open Forms must display a user-friendly error message to the end user.

My assumption was to let the form crash, because the user won't be able to select a valid option (because they could not be fetched), which means that they cannot fill out the form. But it might be good to discuss this indeed 👍

I'm also out of the loop now what the service fetch behaviour is 🤔

Double checked this, with service fetch set up to fetch options from referentielijsten it does indeed continue and show no available options (Geen opties om te kiezen)

…sten this was previously possible with logic and service fetch, but this functionality provides a shortcut to more easily integrate with Re ferentielijsten API

to be used for unittests with VCR and local development

stevenbal marked this pull request as draft January 7, 2025 14:33

stevenbal force-pushed the feature/4993-referentielijsten-populate-component-choices branch from dbb75e3 to b82f2ab Compare January 7, 2025 15:28

sergei-maertens reviewed Jan 7, 2025

View reviewed changes

src/openforms/formio/dynamic_config/dynamic_options.py Outdated Show resolved Hide resolved

stevenbal force-pushed the feature/4993-referentielijsten-populate-component-choices branch 6 times, most recently from adc42bb to 9881217 Compare January 13, 2025 12:59

stevenbal changed the title ~~🚧 [#4993] Implement fetching select(boxes) options from Referentielijsten~~ ✨ [#4993] Implement fetching select(boxes) options from Referentielijsten Jan 13, 2025

stevenbal force-pushed the feature/4993-referentielijsten-populate-component-choices branch 4 times, most recently from 45ea58b to 99217fa Compare January 13, 2025 15:18

stevenbal commented Jan 13, 2025

View reviewed changes

stevenbal marked this pull request as ready for review January 13, 2025 15:35

stevenbal force-pushed the feature/4993-referentielijsten-populate-component-choices branch from 99217fa to 5b99dc0 Compare January 13, 2025 15:35

stevenbal requested a review from sergei-maertens January 13, 2025 15:54

sergei-maertens reviewed Jan 14, 2025

View reviewed changes

stevenbal marked this pull request as draft January 14, 2025 14:34

stevenbal added 3 commits January 14, 2025 16:23

✨ [#4993] Implement fetching select(boxes) options from Referentielij…

dd00dea

…sten this was previously possible with logic and service fetch, but this functionality provides a shortcut to more easily integrate with Re ferentielijsten API

🐳 [#4993] Add docker-compose file and fixtures for Referentielijsten

14a1f5e

to be used for unittests with VCR and local development

✅ [#4993] Tests for fetching options from Referentielijsten

714d33b

stevenbal force-pushed the feature/4993-referentielijsten-populate-component-choices branch from 5b99dc0 to 714d33b Compare January 14, 2025 15:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ [#4993] Implement fetching select(boxes) options from Referentielijsten #4996

✨ [#4993] Implement fetching select(boxes) options from Referentielijsten #4996

stevenbal commented Jan 7, 2025 •

edited

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

stevenbal Jan 13, 2025 •

edited

Loading

sergei-maertens Jan 14, 2025

stevenbal Jan 14, 2025 •

edited

Loading

stevenbal Jan 14, 2025

✨ [#4993] Implement fetching select(boxes) options from Referentielijsten #4996

Are you sure you want to change the base?

✨ [#4993] Implement fetching select(boxes) options from Referentielijsten #4996

Conversation

stevenbal commented Jan 7, 2025 • edited Loading

codecov bot commented Jan 7, 2025 • edited Loading

Codecov Report

stevenbal Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

sergei-maertens Jan 14, 2025

Choose a reason for hiding this comment

stevenbal Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

stevenbal Jan 14, 2025

Choose a reason for hiding this comment

stevenbal commented Jan 7, 2025 •

edited

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

stevenbal Jan 13, 2025 •

edited

Loading

stevenbal Jan 14, 2025 •

edited

Loading