Allow more map interactions and refactor map value datastructures #4953

robinmolen · 2024-12-18T14:45:38Z

Closes #2177
Closes #2178

Changes

Changing the datatype of the map component from array to geoJson

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-06T15:29:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.66%. Comparing base (46f3859) to head (308f1c4).
Report is 45 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4953      +/-   ##
==========================================
+ Coverage   96.63%   96.66%   +0.03%     
==========================================
  Files         761      762       +1     
  Lines       26004    26041      +37     
  Branches     3395     3394       -1     
==========================================
+ Hits        25129    25173      +44     
+ Misses        610      606       -4     
+ Partials      265      262       -3

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

src/openforms/formio/components/custom.py

src/openforms/formio/constants.py

src/openforms/formio/formatters/custom.py

sergei-maertens

Might be a good idea to disable prettier on JSON files, I had to do the same for markdown and HTML too 😉

src/openforms/formio/components/custom.py

src/openforms/formio/tests/validation/test_map.py

sergei-maertens · 2025-01-15T14:21:10Z

src/openforms/formio/formatters/custom.py

+type Coordinates = tuple[float, float]
+
+
+class PointGeometry(TypedDict):


wouldn't it make more sense to define these types in src/openforms/api/geojson.py too? Ultimately these are the types that match the serializers.

Otherwise I'd say to put them in openforms.typing.

I thought that these should remain near the MapFormatter, seeing how these types are only used for this class.
And also to keep the code uniform to the AddressNLFormatter / AddressValue implementation.

But sure, i can move them

I've moved most of these types to src/openforms/api/geojson.py. I've kept a MapValue type in the src/openforms/formio/formatters/custom.py, to specify the value for the format function

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

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

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

robinmolen · 2025-01-16T15:55:01Z

Might be a good idea to disable prettier on JSON files, I had to do the same for markdown and HTML too 😉

Ah yeah, probably best to add those to the .prettierignore 🙂 (just to solve it project wide)
I'll make a PR for it

sergei-maertens · 2025-01-17T11:07:00Z

Might be a good idea to disable prettier on JSON files, I had to do the same for markdown and HTML too 😉

Ah yeah, probably best to add those to the .prettierignore 🙂 (just to solve it project wide) I'll make a PR for it

Let's enable prettier on json files inside src/openforms/js and disable in other locations.

For the map interaction changes, we need to save the map data in a different format. This is to allow us to differentiate between point, line or polygon map information. At the moment we only need the geometry information of the geoJson, so thats what we will store. The other geoJson information, `type` and `properties`, are at the moment not used. In addition, the backend registrations (objects API, ZGW APIs and StUF-ZDS) also only need the geometry information.

The backend registration plugins (Objects API, ZGW APIs and StUF-ZDS) now support point, line and polygon geojson geometries.

Changed the map data from coordinates to geoJson geometry values.

Map component that don't have interactions configuration, will receive the default config when importing using the migration_converters

The form designer configuration for the map component has changed a bit. So are the map specific settings moved to the 'Map settings' tab. Also, the label for initial lat/lng settings has been changed to 'Initial focus'

…tions The formatter and camunda tests now cover all map data formats: Point, Polygon and LineString

sergei-maertens · 2025-01-21T14:39:23Z

src/openforms/formio/formatters/custom.py

@@ -21,10 +23,16 @@ def format(self, component: Component, value: str) -> str:
        return f"{fmt_date(parsed_value)} {fmt_time(parsed_value, 'H:i')}"


+type MapValue = PointGeometry | LineStringGeometry | PolygonGeometry


this is the ideal compromise - it keeps the stuff that's not specific to map components in a generic place while still refining it sufficiently within the map component context

robinmolen linked an issue Dec 18, 2024 that may be closed by this pull request

Kaartmateriaal - Verschillende types kaart-interactie (Point, Polygon en Line) #2177

Closed

robinmolen force-pushed the feature/2177-map-interactions-and-different-map-data branch from 4aaecd1 to 45f8fdc Compare December 18, 2024 16:27

robinmolen force-pushed the feature/2177-map-interactions-and-different-map-data branch from 45f8fdc to 9653b84 Compare January 6, 2025 15:13

robinmolen force-pushed the feature/2177-map-interactions-and-different-map-data branch from 9653b84 to 3438a77 Compare January 6, 2025 15:59

robinmolen marked this pull request as ready for review January 6, 2025 15:59

robinmolen force-pushed the feature/2177-map-interactions-and-different-map-data branch 3 times, most recently from dcee0e7 to 42885c6 Compare January 7, 2025 10:10

sergei-maertens reviewed Jan 8, 2025

View reviewed changes

robinmolen force-pushed the feature/2177-map-interactions-and-different-map-data branch 4 times, most recently from d8451a5 to ba5f7a2 Compare January 15, 2025 11:10

sergei-maertens requested changes Jan 15, 2025

View reviewed changes

robinmolen added 10 commits January 20, 2025 15:11

💥 [#2177] Handling geojson in plugins and map formatter

9d993ab

The backend registration plugins (Objects API, ZGW APIs and StUF-ZDS) now support point, line and polygon geojson geometries.

✅ [#2177] Fixing and updating formatter and registration plugin tests

c8e2efc

Changed the map data from coordinates to geoJson geometry values.

🏷️ [#2177] Added interactions to MapComponent type

3f7ac79

🗃️ [#2177] Added migration to ensure interactions on map components

8520de6

✅ [#2177] Added test for importing map components

67f8d4d

Map component that don't have interactions configuration, will receive the default config when importing using the migration_converters

⬆️ [#2177] Using formio-builder version 0.35.0

96147f7

🌐 [#2177] Translations

b1392b7

::white_check_mark:: [#2177] Fixed form designer tests

e7ce207

The form designer configuration for the map component has changed a bit. So are the map specific settings moved to the 'Map settings' tab. Also, the label for initial lat/lng settings has been changed to 'Initial focus'

✅ [#2177] Added formatter and camunda tests for different map data op…

308f1c4

…tions The formatter and camunda tests now cover all map data formats: Point, Polygon and LineString

robinmolen force-pushed the feature/2177-map-interactions-and-different-map-data branch from 165c370 to 308f1c4 Compare January 20, 2025 14:22

sergei-maertens reviewed Jan 21, 2025

View reviewed changes

sergei-maertens approved these changes Jan 21, 2025

View reviewed changes

sergei-maertens changed the title ~~Feature/2177 map interactions and different map data~~ Allow more map interactions and refactor map value datastructures Jan 21, 2025

sergei-maertens merged commit a4d0095 into master Jan 22, 2025
31 of 33 checks passed

sergei-maertens deleted the feature/2177-map-interactions-and-different-map-data branch January 22, 2025 11:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow more map interactions and refactor map value datastructures #4953

Allow more map interactions and refactor map value datastructures #4953

robinmolen commented Dec 18, 2024 •

edited by sergei-maertens

Loading

codecov bot commented Jan 6, 2025 •

edited

Loading

sergei-maertens left a comment

sergei-maertens Jan 15, 2025

robinmolen Jan 20, 2025

robinmolen Jan 20, 2025

robinmolen commented Jan 16, 2025

sergei-maertens commented Jan 17, 2025

sergei-maertens Jan 21, 2025

		type Coordinates = tuple[float, float]


		class PointGeometry(TypedDict):

		@@ -21,10 +23,16 @@ def format(self, component: Component, value: str) -> str:
		return f"{fmt_date(parsed_value)} {fmt_time(parsed_value, 'H:i')}"


		type MapValue = PointGeometry \| LineStringGeometry \| PolygonGeometry

Allow more map interactions and refactor map value datastructures #4953

Allow more map interactions and refactor map value datastructures #4953

Conversation

robinmolen commented Dec 18, 2024 • edited by sergei-maertens Loading

codecov bot commented Jan 6, 2025 • edited Loading

Codecov Report

sergei-maertens left a comment

Choose a reason for hiding this comment

sergei-maertens Jan 15, 2025

Choose a reason for hiding this comment

robinmolen Jan 20, 2025

Choose a reason for hiding this comment

robinmolen Jan 20, 2025

Choose a reason for hiding this comment

robinmolen commented Jan 16, 2025

sergei-maertens commented Jan 17, 2025

sergei-maertens Jan 21, 2025

Choose a reason for hiding this comment

robinmolen commented Dec 18, 2024 •

edited by sergei-maertens

Loading

codecov bot commented Jan 6, 2025 •

edited

Loading