[#885] Scaffolding for external registers plugins #921

SilviaAmAm · 2025-11-27T16:54:14Z

Fixes #885

Depends on maykinmedia/django-health-checks#1

codecov-commenter · 2025-11-28T13:39:34Z

Codecov Report

❌ Patch coverage is 83.87097% with 40 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.92%. Comparing base (380ffdd) to head (03a04ba).
⚠️ Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
...r/external_registers/setup_configuration/models.py	0.00%	13 Missing ⚠️
...er/external_registers/setup_configuration/steps.py	0.00%	13 Missing ⚠️
...src/openarchiefbeheer/external_registers/plugin.py	86.36%	6 Missing ⚠️
...c/openarchiefbeheer/external_registers/registry.py	82.60%	4 Missing ⚠️
...eer/external_registers/contrib/openklant/plugin.py	85.00%	3 Missing ⚠️
...ngs/pages/health-check/HealthCheckSettingsPage.tsx	90.90%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #921      +/-   ##
==========================================
- Coverage   90.28%   89.92%   -0.36%     
==========================================
  Files         214      223       +9     
  Lines        6885     7068     +183     
  Branches      696      703       +7     
==========================================
+ Hits         6216     6356     +140     
- Misses        669      712      +43

Flag	Coverage Δ
backend	`90.89% <83.11%> (-0.57%)`	⬇️
jest	`34.10% <11.76%> (-0.20%)`	⬇️
storybook	`83.46% <94.11%> (-0.06%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

CharString · 2025-12-02T11:57:42Z

backend/src/openarchiefbeheer/config/templates/configuration_health_check.html

-        <li>{{ error.message }}</li>
-        {% endfor %}
-    </ul>
+        <p>{% translate 'The configuration is complete.' %}</p>


A checklist with succeeded checks ✔️ shows that checks were performed.
If misconfigured, or configuration drift occurred (e.g. updates), and somehow no checks are collected or only a subset, then all checks pass, but health may not be okay.
Perhaps that's all impossible here, but the user doesn't know that.

Maybe we can have a default in the library
that uses `<details>` and `<summary>` tags to

not overwhelming with data

still provide access to that data to help end-user, application manager, dev ops and 1st line support spot issues.

Moved the template tag to the library. I think it still needs some work, but it is functional for now.

backend/src/openarchiefbeheer/config/tests/factories.py

...end/src/openarchiefbeheer/external_registers/contrib/openklant/setup_configuration/models.py

backend/src/openarchiefbeheer/external_registers/contrib/openklant/plugin.py

backend/src/openarchiefbeheer/external_registers/registry.py

CharString · 2025-12-02T15:59:16Z

backend/src/openarchiefbeheer/external_registers/registry.py

+        )
+
+
+register = Registry()


We do need to bind the PluginT type var, or it will be a Registry[Unknown]

Suggested change

register = Registry()

register: Registry[AbstractBasePlugin] = Registry()

PS, to prevent the Unknown/Any judgement, you can set a default type if none is annotated:

class Registry[PluginT: AbstractBasePlugin = AbstractBasePlugin]:

The syntax is GenericType[TypeVarName: UpperBoundType = DefaultType]. where GenericType can be a function, class or method.

Ah yes! I did this in the end: Registry[AbstractBasePlugin[object]] because AbstractBasePlugin also has a generic type 😵‍💫

Hmmm. If we remove the bound from Registry, you can reuse it for the health checks, and have a Registry[HealthCheckPlugin] of which the __iter__ method is a valid checks_collector.... Oh wait. The __call__ does more than just adding to the collection.

backend/src/openarchiefbeheer/external_registers/registry.py

CharString · 2025-12-02T16:05:34Z

backend/src/openarchiefbeheer/external_registers/registry.py

+    def __call__(self, identifier: str) -> Callable[[type[PluginT]], type[PluginT]]:
+        def decorator(plugin_cls: type[PluginT]) -> type[PluginT]:
+            if identifier in self._registry:
+                raise ValueError(
+                    f"The unique identifier '{identifier}' is already present "
+                    "in the registry."
+                )
+
+            self._registry[identifier] = plugin_cls(identifier=identifier)
+            return plugin_cls
+
+        return decorator


We want to express that the decorator doesn't just return some type[PluginT] but the same that was passed in.

Suggested change

def __call__(self, identifier: str) -> Callable[[type[PluginT]], type[PluginT]]:

def decorator(plugin_cls: type[PluginT]) -> type[PluginT]:

if identifier in self._registry:

raise ValueError(

f"The unique identifier '{identifier}' is already present "

"in the registry."

)

self._registry[identifier] = plugin_cls(identifier=identifier)

return plugin_cls

return decorator

def __call__[T: type[PluginT]](self, identifier: str) -> Callable[[T], T]:

def decorator(plugin_cls: T) -> T:

if identifier in self._registry:

raise ValueError(

f"The unique identifier '{identifier}' is already present "

"in the registry."

)

self._registry[identifier] = plugin_cls(identifier=identifier)

return plugin_cls

return decorator

I get that TypeVar constraint type cannot be generic (since pluginT is generic). I can't get it to be happy with [T: type[AbstractBasePlugin]] instead 😩

As discussed. We can drop the generic from Registry, and replace all occurrences of PluginT with AbstractBasePlugin. (or define it as a an alias type PluginT = AbastractBasePlugin for shorthand... or rename it to BasePlugin, as it is clear that it's an abstract from its inheritance from ABC. But that's a matter of taste.)

backend/src/openarchiefbeheer/external_registers/plugin.py

SilviaAmAm · 2025-12-05T15:19:23Z

backend/src/openarchiefbeheer/external_registers/registry.py

+from openarchiefbeheer.external_registers.plugin import AbstractBasePlugin
+
+
+class Registry[PluginT: AbstractBasePlugin]:


Discussed with Chris:
The [PluginT: AbstractBasePlugin] can be moved to the call function.

And instead of being generic it can be only AbstractBasePlugin in the other places

CharString

Almost there. 🙂 👍

CharString · 2025-12-05T15:31:50Z

backend/src/openarchiefbeheer/external_registers/registry.py

+    def __call__(self, identifier: str) -> Callable[[type[PluginT]], type[PluginT]]:
+        def decorator(plugin_cls: type[PluginT]) -> type[PluginT]:
+            if identifier in self._registry:
+                raise ValueError(
+                    f"The unique identifier '{identifier}' is already present "
+                    "in the registry."
+                )
+
+            self._registry[identifier] = plugin_cls(identifier=identifier)
+            return plugin_cls
+
+        return decorator


As discussed. We can drop the generic from Registry, and replace all occurrences of PluginT with AbstractBasePlugin. (or define it as a an alias type PluginT = AbastractBasePlugin for shorthand... or rename it to BasePlugin, as it is clear that it's an abstract from its inheritance from ABC. But that's a matter of taste.)

SilviaAmAm added 12 commits November 27, 2025 17:53

✨ [#885] Add base for plugins

e67e583

♻️ [#885] Refactor health checks to use new library

0045eb5

♻️ [#885] Update frontend for new health check format

6737771

➕ [#885] Add msgspec for health check results

76a4aa8

🚧 [#885] Finished restructuring health checks backend

9c533a3

🚧 [#885] Finished restructuring health checks frontend

4d36f63

🚧 [#885] Continue improving health checks structure

bf2c0bc

✅ [#885] Update tests

1503ce1

✨ [#885] Add logic to delete related resources

5ec30ce

✨ [#885] Add django setup configuration for plugins

5b328ef

✨ [#885] Improve base plugin for setup configuration

3d01e7f

♻️ [#885] Move health checks structs to utils

f335c5c

SilviaAmAm marked this pull request as draft November 27, 2025 16:54

SilviaAmAm added 2 commits November 28, 2025 11:45

➕ [#885] Add django-health-checks dependency

b68da4c

✅ [#885] Update test fixture in storybook

d44bd64

SilviaAmAm added 3 commits November 28, 2025 14:57

🚧 [#885] Fix NotImplemented breaking tests

cb8d546

🐳 [#885] Add git to docker image to be able to deal with git dependency

c8fb061

🚿 [#885] Cleaning up unneeded settings

3d2a57d

SilviaAmAm marked this pull request as ready for review December 1, 2025 10:53

SilviaAmAm requested a review from CharString December 1, 2025 10:53

♻️ [#885] Make type hints more specific

b7cb5f1

SilviaAmAm mentioned this pull request Dec 2, 2025

[#900] Configuration openklant #917

Open

CharString requested changes Dec 2, 2025

View reviewed changes

SilviaAmAm added 4 commits December 4, 2025 14:16

⬆️ [#885] Bump health-checks version

e6ed88f

✅ [#885] Update tests

6ba7749

👌 [#885] Process Chris' feedback

254d0fc

📝 Fix comment

03a04ba

SilviaAmAm requested a review from CharString December 4, 2025 14:04

SilviaAmAm commented Dec 5, 2025

View reviewed changes

CharString requested changes Dec 5, 2025

View reviewed changes

	register = Registry()
	register: Registry[AbstractBasePlugin] = Registry()

		from openarchiefbeheer.external_registers.plugin import AbstractBasePlugin


		class Registry[PluginT: AbstractBasePlugin]:

[#885] Scaffolding for external registers plugins #921

Are you sure you want to change the base?

[#885] Scaffolding for external registers plugins #921

Uh oh!

Conversation

SilviaAmAm commented Nov 27, 2025

Uh oh!

codecov-commenter commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CharString Dec 4, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SilviaAmAm Dec 5, 2025 • 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!

CharString left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Nov 28, 2025 •

edited

Loading

CharString Dec 4, 2025 •

edited

Loading

SilviaAmAm Dec 5, 2025 •

edited

Loading