Implement runtime file component registration config resolution by sergei-maertens · Pull Request #6271 · open-formulieren/open-forms

sergei-maertens · 2026-05-08T16:21:36Z

Changes

The file component now supports registration configuration where the catalogue identifier and document type descrition are specified. This is paired against the configured API group's catalogi API service and resolves into the correct version of a document type for a given submission.

Additionally, I've added some optimization to avoid looking up the same catalogue and/or document types over and over if multiple similar configurations are provided.

Finally, the file component configuration is quite cumbersome, so I added an option to copy registration plugin options into the components which we can do in JS quite easily, that should reduce the impact for form builders.

Problem detection with mis-matched configuration is deferred and will be implemented as part of #6262

I verified that uploads inside repeating groups are also properly picked up in the component table.

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
- Checked new model fields are usable in the admin
- Problem detection in the admin email digest is handled
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
Documentation
- Added documentation which describes the changes

sergei-maertens · 2026-05-08T16:23:00Z

+        document_type_configuration = file_component.get("registration", {}).get(
+            "documentType", {}
+        )
+        _document_type_description = document_type_configuration.get("description", "")
+        _catalogue = document_type_configuration.get("catalogue", {})
+        if (
+            _document_type_description
+            and (_catalogue_domain := _catalogue.get("domain"))
+            and (_catalogue_rsin := _catalogue.get("rsin"))
+        ):


this is set up very defensively on purpose - we don't have proper backend validation yet for component configuration and have to deal with legacy component configurations too

codecov · 2026-05-08T16:33:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.07%. Comparing base (cf6adf7) to head (68a81b9).
⚠️ Report is 563 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6271   +/-   ##
=======================================
  Coverage   97.07%   97.07%           
=======================================
  Files         865      866    +1     
  Lines       32700    32756   +56     
  Branches     2975     2981    +6     
=======================================
+ Hits        31743    31799   +56     
  Misses        646      646           
  Partials      311      311

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sergei-maertens · 2026-05-11T16:43:33Z

@annashamray @SonnyBA whomever gets first to review this, I think it's best to go commit-by-commit

SonnyBA · 2026-05-15T11:09:15Z

+                if (!componentDraft.registration) {
+                  componentDraft.registration = {};
+                }
+                if (!componentDraft.registration.documentType) {
+                  componentDraft.registration.documentType = {};
+                }
+                componentDraft.registration.documentType.catalogue = catalogue;
+                componentDraft.registration.documentType.description = description;
+              });


Should we empty the other values (informatieobjecttype) that won't be used whenever this action is performed? Only assigning these values might give the impression that the other fields might still be used (if those were filled in before) while they're not.

no I'm deliberately not doing that, in case something goes wrong that we can still reconstruct what the original situation was. The documentation/comments make it clear that the new situation is preferred if it's available, and this matches the behaviour of the registration plugin configuration options.

annashamray

Just a couple small remarks

This one exposes the file-component configuration options.

…mponents

…bjects API)

…I registration

…pe description For the components that don't use the default specified document type from the plugin settings, it's reasonable to assume that they will use at least the same catalogue for the file component uploads. A copy function to the components allows doing this in bulk, after which only the document type description itself may still need tweaking. This commit needs to be backported to 3.5 to allow migrating/preparation for the 4.0 upgrade. From 4.0 onwards, we should move this config out of the component registration options entirely and could possibly also offer a dropdown to select the document type.

Needs to be backported to 3.5 as well.

... with a companion hook so that we can load the available document types in an optimized/efficient way.

sergei-maertens · 2026-05-15T16:08:39Z

Backport commits to 3.5.x (PR: #6298):

…ile-component-doctype-resolution Runtime file component doctype resolution (#6271 backport)

github-actions Bot added the needs-backport Fix must be backported to stable release branch label May 8, 2026

sergei-maertens commented May 8, 2026

View reviewed changes

Comment thread src/openforms/registrations/contrib/zgw_apis/plugin.py

sergei-maertens force-pushed the cleanup/6269-runtime-file-component-registration-config-resolution branch from 5b905bc to 23b0b1f Compare May 8, 2026 16:24

sergei-maertens commented May 11, 2026

View reviewed changes

Comment thread src/openforms/js/components/admin/form_design/registrations/objectsapi/fields/DocumentTypes.js Outdated

sergei-maertens commented May 11, 2026

View reviewed changes

Comment thread src/openforms/js/components/admin/form_design/registrations/objectsapi/fields/DocumentTypes.js Outdated

sergei-maertens commented May 11, 2026

View reviewed changes

Comment thread src/openforms/js/components/admin/form_design/registrations/objectsapi/fields/DocumentTypes.js Outdated

sergei-maertens force-pushed the cleanup/6269-runtime-file-component-registration-config-resolution branch 5 times, most recently from aa921b0 to 4ced948 Compare May 11, 2026 15:36

sergei-maertens marked this pull request as ready for review May 11, 2026 16:40

sergei-maertens requested a review from annashamray May 11, 2026 16:40

sergei-maertens commented May 11, 2026

View reviewed changes

Comment thread src/openforms/js/components/admin/form_design/registrations/objectsapi/fields/index.js

sergei-maertens force-pushed the cleanup/6269-runtime-file-component-registration-config-resolution branch from cc51f68 to 9cb9e2a Compare May 11, 2026 16:41

sergei-maertens requested a review from SonnyBA May 11, 2026 16:43

sergei-maertens force-pushed the cleanup/6269-runtime-file-component-registration-config-resolution branch from 9cb9e2a to b6724e4 Compare May 13, 2026 08:48

SonnyBA reviewed May 15, 2026

View reviewed changes

annashamray reviewed May 15, 2026

View reviewed changes

sergei-maertens added 8 commits May 15, 2026 17:18

⬆️ [#6269] Upgrade to latest formio-builder version

c3d46d2

This one exposes the file-component configuration options.

✅ [#6269] Add test for desired document type resolution behaviour

33d7518

✨ [#6269] Implement document type resolution for ZGW APIs and file co…

9639716

…mponents

✅ [#6269] Add tests for desired document type resolution behaviour (o…

13e8363

…bjects API)

✨ [#6269] Resolve indirect document type references in the Objects AP…

d9562e9

…I registration

⚡ [#6269] Cache lookups of catalogi/document types

8db518b

📝 [#6269] Document the file component copy feature

1e8370e

sergei-maertens added 4 commits May 15, 2026 17:24

🌐 [#6269] Add Dutch translations for new UI elements

86118c1

Needs to be backported to 3.5 as well.

♻️ [#6269] Refactor document select into reusable component

32881b2

... with a companion hook so that we can load the available document types in an optimized/efficient way.

🏷️ [#6269] Add type definition for file component registration config

31197f1

🎨 [#6269] Merge imports together from same module

68a81b9

sergei-maertens force-pushed the cleanup/6269-runtime-file-component-registration-config-resolution branch from b6724e4 to 68a81b9 Compare May 15, 2026 15:30

sergei-maertens merged commit 21388a0 into main May 15, 2026
33 checks passed

sergei-maertens deleted the cleanup/6269-runtime-file-component-registration-config-resolution branch May 15, 2026 15:52

sergei-maertens added a commit that referenced this pull request May 15, 2026

Merge pull request #6298 from open-formulieren/backport/35x-runtime-f…

0a869e9

…ile-component-doctype-resolution Runtime file component doctype resolution (#6271 backport)

Uh oh!

Conversation

sergei-maertens commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sergei-maertens May 8, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov Bot commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sergei-maertens commented May 11, 2026

Uh oh!

Uh oh!

Uh oh!

SonnyBA May 15, 2026

Choose a reason for hiding this comment

Uh oh!

sergei-maertens May 15, 2026

Choose a reason for hiding this comment

Uh oh!

annashamray left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sergei-maertens commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sergei-maertens commented May 8, 2026 •

edited

Loading

codecov Bot commented May 8, 2026 •

edited

Loading