Implement Objects API sets #4332

Viicos · 2024-05-27T15:56:58Z

For #4267

Changes

This is best reviewed commit per commit.

Add a Objects API group model
The ObjectsAPIConfig model now holds a reference to a default group
Data migrations to update existing instances
Update the Objects API registration configuration to be able to specify a group to use (fallback to the default group)

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.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

Mostly taken from #3146

…group

Implementation mostly taken from the ZGW set PR

…ersions fetching They now take a new query parameter, specifiying the group to use. Tests are updated.

…roups

Tests still need to be added to check that an explicitly provided group is being used.

It is assumed that the ZGW registration will use the default Objects API. This is currently not configurable, but might be in the future.

It now takes a new `objects_api_group` parameter, similar to zgw. `registration_backend` is now made required, as it doesn't really make sense to have it optional. Tests were adapted/refactored.

codecov · 2024-05-29T13:57:51Z

Codecov Report

Attention: Patch coverage is 94.35484% with 7 lines in your changes missing coverage. Please review.

Project coverage is 96.24%. Comparing base (69b95dc) to head (4e05ba2).
Report is 773 commits behind head on master.

Files with missing lines	Patch %	Lines
...rms/registrations/contrib/objects_api/api/views.py	77.77%	2 Missing and 2 partials ⚠️
src/openforms/registrations/api/filters.py	95.23%	0 Missing and 1 partial ⚠️
...nforms/registrations/contrib/objects_api/models.py	92.85%	1 Missing ⚠️
...nforms/registrations/contrib/objects_api/plugin.py	92.30%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4332      +/-   ##
==========================================
- Coverage   96.25%   96.24%   -0.02%     
==========================================
  Files         731      731              
  Lines       23741    23789      +48     
  Branches     2800     2807       +7     
==========================================
+ Hits        22853    22895      +42     
- Misses        617      620       +3     
- Partials      271      274       +3

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

src/openforms/registrations/api/filters.py

Viicos · 2024-05-29T14:55:04Z

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

+ objects_api_config = ObjectsAPIConfig.get_solo()
+ assert isinstance(objects_api_config, ObjectsAPIConfig)


I assumed we use the default objects API group when registering to the Objects API from the ZGW registration.

Should we add support for group selection as well for ZGW?

Yeah, selection seems best and consistent, but this can be a separate PR

Opened #4344

src/openforms/js/components/admin/form_design/registrations/objectsapi/LegacyConfigFields.js

src/openforms/js/components/admin/form_design/registrations/objectsapi/V2ConfigFields.js

src/openforms/js/components/admin/form_design/registrations/objectsapi/hooks.js

src/openforms/js/components/admin/form_design/registrations/objectsapi/utils.js

src/openforms/registrations/api/filters.py

src/openforms/registrations/contrib/objects_api/migrations/0017_move_singleton_data.py

sergei-maertens · 2024-05-30T15:32:50Z

src/openforms/registrations/contrib/objects_api/migrations/0019_add_default.py

this can be dropped entirely - and the zgw config/api group should get the same treatment.

src/openforms/registrations/contrib/objects_api/models.py

src/openforms/registrations/contrib/objects_api/plugin.py

sergei-maertens · 2024-06-10T12:03:25Z

Closing to declutter :)

Viicos added 5 commits May 28, 2024 16:43

[#4267] Add ObjectsAPIGroupConfig

8bf0527

[#4267] Add migration to migrate existing Objects API config

4268cf7

Mostly taken from #3146

[#4267] Change ObjectsAPIConfig to hold a reference to the default …

8abc945

…group

[#4267] Update admin index fixture

dc5a598

[#4267] Register ObjectsAPIGroupConfig in admin

e653b61

Viicos force-pushed the feature/objects-api-sets branch from 75c8cf2 to 6d16c82 Compare May 28, 2024 17:11

Viicos added 7 commits May 28, 2024 19:12

[#4267] Update config checks

b8c307b

[#4267] Add migration to set the default Objects API group

600cb28

Implementation mostly taken from the ZGW set PR

[#4267] Update Objecttypes client tests

99682c7

[#4267] Remove unused cassettes

3557d5f

[#4267] Update API endpoints related to Objecttypes and objecttypes v…

4817674

…ersions fetching They now take a new query parameter, specifiying the group to use. Tests are updated.

[#4267] Add option to select Objects API group in the frontend

0f61d9d

[#4267] Update Objects API plugin implementation to use Objects API g…

dfbc998

…roups

Viicos force-pushed the feature/objects-api-sets branch from 6d16c82 to 2aa1be4 Compare May 28, 2024 17:12

Viicos added 3 commits May 29, 2024 11:55

[#4267] Update Objects API registration tests

20756bf

Tests still need to be added to check that an explicitly provided group is being used.

[#4267] Update misc. tests related to config refactor

a60c969

It is assumed that the ZGW registration will use the default Objects API. This is currently not configurable, but might be in the future.

[#4267] Update nformatieobjecttypes endpoint

ddb427e

It now takes a new `objects_api_group` parameter, similar to zgw. `registration_backend` is now made required, as it doesn't really make sense to have it optional. Tests were adapted/refactored.

Viicos force-pushed the feature/objects-api-sets branch from 2aa1be4 to ddb427e Compare May 29, 2024 13:15

[#4267] Make JS messages

4e05ba2

Viicos marked this pull request as ready for review May 29, 2024 14:13

Viicos commented May 29, 2024

View reviewed changes

src/openforms/registrations/api/filters.py Show resolved Hide resolved

Viicos commented May 29, 2024

View reviewed changes

sergei-maertens self-requested a review May 30, 2024 11:50

sergei-maertens requested changes May 30, 2024

View reviewed changes

This was referenced Jun 3, 2024

Add option to select Objects API Group to use in the ZGW registration #4344

Open

Implement Objects API sets #4343

Merged

sergei-maertens closed this Jun 10, 2024

Viicos deleted the feature/objects-api-sets branch June 17, 2024 10:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Objects API sets #4332

Implement Objects API sets #4332

Viicos commented May 27, 2024 •

edited by sergei-maertens

Loading

codecov bot commented May 29, 2024 •

edited

Loading

Viicos May 29, 2024

sergei-maertens May 30, 2024

Viicos Jun 3, 2024

sergei-maertens May 30, 2024

sergei-maertens commented Jun 10, 2024

		objects_api_config = ObjectsAPIConfig.get_solo()
		assert isinstance(objects_api_config, ObjectsAPIConfig)

Implement Objects API sets #4332

Implement Objects API sets #4332

Conversation

Viicos commented May 27, 2024 • edited by sergei-maertens Loading

codecov bot commented May 29, 2024 • edited Loading

Codecov Report

Viicos May 29, 2024

Choose a reason for hiding this comment

sergei-maertens May 30, 2024

Choose a reason for hiding this comment

Viicos Jun 3, 2024

Choose a reason for hiding this comment

sergei-maertens May 30, 2024

Choose a reason for hiding this comment

sergei-maertens commented Jun 10, 2024

Viicos commented May 27, 2024 •

edited by sergei-maertens

Loading

codecov bot commented May 29, 2024 •

edited

Loading