Add Product to the ZGW API registration #4803

robinmolen · 2024-10-30T15:07:00Z

Changes

Added product as a configuration option to the ZGW API registration. The product select gets populated from the selected case type. If there are multiple versions of the case type, then the case type version that is active at the moment of configuring is chosen.

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
Commit hygiene
- Commit messages refer to the relevant Github issue
- Commit messages explain the "why" of change, not the how

codecov · 2024-10-30T16:28:34Z

Codecov Report

Attention: Patch coverage is 96.22642% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.55%. Comparing base (c47e11b) to head (4e229c2).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/openforms/contrib/zgw/clients/catalogi.py	87.50%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4803      +/-   ##
==========================================
- Coverage   96.55%   96.55%   -0.01%     
==========================================
  Files         748      748              
  Lines       25423    25474      +51     
  Branches     3362     3370       +8     
==========================================
+ Hits        24548    24597      +49     
  Misses        610      610              
- Partials      265      267       +2

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

src/openforms/js/components/admin/form_design/registrations/zgw/ZGWOptionsFormFields.stories.js

…zaak post

sergei-maertens

I'd suggest renaming product -> product_url everywhere so that it's clear we're dealing with a URL. Especially because we're moving literal URL-configuration options to their semantic 'description' and resolve URLs dynamically, I suspect we will go through this at some point too (where maybe a product slug/description will be stored instead of the exact URL).

sergei-maertens · 2024-11-14T09:26:50Z

docker/docker-compose.open-zaak.yml

+  flask_app:
+    build: ./open-zaak
+    ports:
+      - "80:80"
+    volumes:
+      - ./open-zaak/:/app/


Let's put this in it's own docker-compose and directory and not lump it in with open-zaak. The products/services API specification doesn't exist yet so it definitely can't be part of Open Zaak.

A folder named rx_mission is okay - that makes it clear which service/API we're supporting with this. Instructions for tests will then require you to bring up both open zaak and rx_mission docker compose

sergei-maertens · 2024-11-14T09:28:50Z

docker/open-zaak/app.py

+
+    data = {
+        "url": request.base_url,
+        "id": "XXXXXXXX",


Maybe you can take the JSON file that was given to us, obfuscate that a little bit, but ultimately use that as a "database"? We then at least have some representative, different test data rather than every product (with different URLs) showing the same description.

sergei-maertens · 2024-11-14T09:29:01Z

docker/open-zaak/app.py

+    # Log the request body
+    app.logger.info("Request body: %s", request.data.decode("utf-8"))


Not needed, they're simple GET calls without body

sergei-maertens · 2024-11-14T09:51:42Z

src/openforms/contrib/zgw/clients/catalogi.py

@@ -48,9 +49,15 @@ class CaseType(TypedDict):
    beginGeldigheid: str  # ISO 8601 date string
    eindeGeldigheid: NotRequired[str | None]  # ISO 8601 date string or empty
    concept: NotRequired[bool]
+    productenOfDiensten: NotRequired[list[str]]  # URL pointers to products


in the Catalogi API specification it's required:

Suggested change

productenOfDiensten: NotRequired[list[str]] # URL pointers to products

productenOfDiensten: list[str] # URL pointers to products

sergei-maertens · 2024-11-14T09:52:56Z

src/openforms/contrib/zgw/clients/catalogi.py

+class Product(TypedDict):
+    uri: str
+    description: NotRequired[str]


Would be good to add a comment that this is non-standard and not backed by any API specification yet

sergei-maertens · 2024-11-14T10:48:03Z

src/openforms/js/components/admin/form_design/registrations/zgw/fields/ProductSelect.js

+
+const ProductSelect = ({catalogueUrl = ''}) => {
+  const {
+    values: {zgwApiGroup = null, caseTypeIdentification = null},


Suggested change

values: {zgwApiGroup = null, caseTypeIdentification = null},

values: {zgwApiGroup = null, caseTypeIdentification = ''},

we're not using typescript yet, but still it's good practice to think about the data types :) this field is not nullable, ever.

sergei-maertens · 2024-11-14T10:50:31Z

src/openforms/js/components/admin/form_design/registrations/zgw/fields/ProductSelect.js

+ProductSelect.propTypes = {
+  caseTypeIdentification: PropTypes.string,
+};


proptypes don't match the actual props

sergei-maertens · 2024-11-14T10:53:45Z

src/openforms/registrations/contrib/zgw_apis/api/views.py

+        case_type_identification = filter_serializer.validated_data[
+            "case_type_identification"
+        ]
+        version_valid_on = datetime_in_amsterdam(timezone.now()).date()


Suggested change

version_valid_on = datetime_in_amsterdam(timezone.now()).date()

today = datetime_in_amsterdam(timezone.now()).date()

sergei-maertens · 2024-11-14T10:54:22Z

src/openforms/registrations/contrib/zgw_apis/options.py

@@ -72,6 +72,14 @@ class ZaakOptionsSerializer(JsonSchemaSerializerMixin, serializers.Serializer):
        ),
        default="",
    )
+    product = serializers.CharField(


Should be URLField, no?

Suggested change

product = serializers.CharField(

product = serializers.URLField(

sergei-maertens · 2024-11-14T10:55:24Z

src/openforms/registrations/contrib/zgw_apis/typing.py

@@ -32,6 +32,7 @@ class RegistrationOptions(TypedDict):
    zgw_api_group: ZGWApiGroupConfig
    catalogue: NotRequired[CatalogueOption]
    case_type_identification: str
+    product: NotRequired[str]


if you do default="" on the serializer, you can drop the NotRequired and that makes code less verbose

Suggested change

product: NotRequired[str]

product: str # URL reference to a product in the case type

robinmolen linked an issue Oct 30, 2024 that may be closed by this pull request

Als gemeente wil ik na het selecteren van een zaaktype, ook het product selecteren en meesturen met de inzending #4796

Open

2 tasks

robinmolen force-pushed the feature/4796-zgw-configuration-select-product branch 3 times, most recently from 9e24349 to 135ff90 Compare October 30, 2024 16:16

robinmolen force-pushed the feature/4796-zgw-configuration-select-product branch 2 times, most recently from 63d8e50 to f3c7954 Compare October 31, 2024 08:57

robinmolen marked this pull request as ready for review October 31, 2024 09:19

robinmolen commented Nov 7, 2024

View reviewed changes

src/openforms/js/components/admin/form_design/registrations/zgw/ZGWOptionsFormFields.stories.js Show resolved Hide resolved

robinmolen added the blocked label Nov 8, 2024

robinmolen marked this pull request as draft November 8, 2024 13:27

robinmolen force-pushed the feature/4796-zgw-configuration-select-product branch 2 times, most recently from 1b0eee6 to 3574ee1 Compare November 12, 2024 15:30

robinmolen marked this pull request as ready for review November 12, 2024 15:32

robinmolen force-pushed the feature/4796-zgw-configuration-select-product branch from 3574ee1 to 03d0f12 Compare November 13, 2024 07:04

robinmolen added 7 commits November 14, 2024 10:41

✨ [#4796] Added productSelect to ZGW API configuration

c1e3d1d

✨ [#4796] Added 'productenOfDiensten' to register_submission ZGW API …

a8aee2f

…zaak post

✅ [#4796] Added test for 'productenOfDiensten' in ZGW API zaak post

c95e2af

✅ [#4796] Added ZGW API products mock function for storybook tests

b78e305

✅ [#4796] Added backend tests for ZGW API registration with product

6fd76be

📦 [#4796] Updated OAS

1843ab3

🌐 [#4796] Updated translations

4e229c2

robinmolen force-pushed the feature/4796-zgw-configuration-select-product branch from 03d0f12 to 4e229c2 Compare November 14, 2024 09:41

sergei-maertens requested changes Nov 14, 2024

View reviewed changes

sergei-maertens removed the blocked label Nov 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Product to the ZGW API registration #4803

Add Product to the ZGW API registration #4803

robinmolen commented Oct 30, 2024 •

edited

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading

sergei-maertens left a comment

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

sergei-maertens Nov 14, 2024

		# Log the request body
		app.logger.info("Request body: %s", request.data.decode("utf-8"))

	productenOfDiensten: NotRequired[list[str]] # URL pointers to products
	productenOfDiensten: list[str] # URL pointers to products

	values: {zgwApiGroup = null, caseTypeIdentification = null},
	values: {zgwApiGroup = null, caseTypeIdentification = ''},

	version_valid_on = datetime_in_amsterdam(timezone.now()).date()
	today = datetime_in_amsterdam(timezone.now()).date()

	product = serializers.CharField(
	product = serializers.URLField(

	product: NotRequired[str]
	product: str # URL reference to a product in the case type

Add Product to the ZGW API registration #4803

Are you sure you want to change the base?

Add Product to the ZGW API registration #4803

Conversation

robinmolen commented Oct 30, 2024 • edited Loading

codecov bot commented Oct 30, 2024 • edited Loading

Codecov Report

sergei-maertens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robinmolen commented Oct 30, 2024 •

edited

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading