OEL-3178: Add maps version 3.0 #254

drishu · 2024-10-11T10:31:52Z

OEL-3178

Description

Add support for maps version 3

Change log

Added: Config form
Changed: field widget

brummbar

We don't need a new major, we can provide an update path that creates the configuration and sets it to 2.0 for existing installations. New installations can be on 3.0. Sites like EWPP can stick on 2.0 by exporting the configuration.

brummbar · 2024-10-25T12:05:39Z

modules/oe_webtools_maps/oe_webtools_maps.permissions.yml

@@ -0,0 +1,2 @@
+administer webtools maps form:


This is not in line with the remaining permissions, it should be administer webtools maps
https://github.com/openeuropa/oe_webtools/blob/master/modules/oe_webtools_cookie_consent/oe_webtools_cookie_consent.permissions.yml#L1
https://github.com/openeuropa/oe_webtools/blob/master/modules/oe_webtools_globan/oe_webtools_globan.permissions.yml#L1
https://github.com/openeuropa/oe_webtools/blob/master/modules/oe_webtools_cookie_consent/oe_webtools_cookie_consent.permissions.yml#L1

brummbar · 2024-10-25T12:06:10Z

modules/oe_webtools_maps/oe_webtools_maps.routing.yml

+  path: '/admin/config/system/oe_webtools_maps'
+  defaults:
+    _form: 'Drupal\oe_webtools_maps\Form\WebtoolsMapsSettingsForm'
+    _title: 'Webtools Maps Form settings'


Suggested change

_title: 'Webtools Maps Form settings'

_title: 'Webtools Maps settings'

Drop the form a bit everywhere :)

brummbar · 2024-10-25T12:06:17Z

modules/oe_webtools_maps/config/schema/oe_webtools_maps.schema.yml

+  mapping:
+    map_version:
+      type: string
+      label: 'Map Version'


Suggested change

label: 'Map Version'

label: 'Map version'

piotrsmykaj · 2024-12-09T18:01:00Z

Hello @drishu,

Here is missing oe_webtools_maps.links.menu.yml and the settings form page is not visible on the Admin Configuration page.
Consider creating a hook_post_update() and set version 2.0 for the existing websites.

piotrsmykaj · 2024-12-09T18:02:34Z

modules/oe_webtools_maps/config/schema/oe_webtools_maps.schema.yml

@@ -1,3 +1,11 @@
+oe_webtools_maps.settings:
+  type: config_object
+  label: 'Webtools Maps Settings'


Suggested change

label: 'Webtools Maps Settings'

label: 'Webtools Maps settings'

drishu · 2025-01-15T11:32:36Z

modules/oe_webtools_maps/src/Form/WebtoolsMapsSettingsForm.php

+        '2.0' => $this->t('Version 2.0'),
+        '3.0' => $this->t('Version 3.0'),
+      ],
+      '#default_value' => $config->get('map_version') ?? '2.0',


@piotrsmykaj no need for "hook_post_update() and set version 2.0 for the existing websites." as we have this here

sergepavle · 2025-01-16T10:57:33Z

Unfortunately, somehow, I overlooked this PR regarding the webtools map upgrade and worked on almost the same independently. See PR: #258.
It doesn't have BC but in my PR implemented some changes regarding webtools Map 3 API changes (missed in this PR).
Here https://github.com/openeuropa/oe_webtools/pull/258/files#diff-d5788593f82f730c0aae0cc4840492e4a812488fa1fb087015bec48283327268L90 you may notice that in new version UEC had a new structure like layers.markers[0].data instead of layers[0].markers (as worked before). Without that markers
will not be shown.
Maybe you could also extend test coverage by reusing these changes: https://github.com/openeuropa/oe_webtools/pull/258/files#diff-93e9dfce3433d92e9cae1a182d4fb153f8b8169475098c75580da33298e5a187R1 to make sure that formatted settings also was reflected in UEC webtools code.
Feel free to cherry-pick commits if you wish.

sergepavle · 2025-01-16T11:32:01Z

modules/oe_webtools_maps/src/Plugin/Field/FieldFormatter/WebtoolsMapFormatter.php


    foreach ($items as $delta => $item) {
      $data_array = [
        'service' => 'map',
-        'version' => '2.0',
+        // Fallback to version 2.0 for BC.
+        'version' => $config->get('map_version') ?? '2.0',
        'map' => [
          'zoom' => $this->getSetting('zoom_level'),
          'center' => [


if ($this->getSetting('show_marker')) { $data_array['layers'] = [

should be updated according to changes in Webtools Maps UEC for maps 3.0. See this changes: https://github.com/openeuropa/oe_webtools/pull/258/files#diff-d5788593f82f730c0aae0cc4840492e4a812488fa1fb087015bec48283327268L90

I confirm that, without this change, the marker does not appear on the map.

sergepavle · 2025-01-16T11:40:47Z

modules/oe_webtools_maps/tests/src/Functional/ConfigurationTest.php

+  /**
+   * Tests if changing configuration changes the map JSON.
+   */
+  public function testConfigurationChanges(): void {


As we didn't have at all test coverage for oe_webtools_maps probably it makes sense to extend test coverage to assert field formatter settings. See https://github.com/openeuropa/oe_webtools/pull/258/files#diff-93e9dfce3433d92e9cae1a182d4fb153f8b8169475098c75580da33298e5a187R71

drishu force-pushed the OEL-3178 branch from d4978f0 to d108235 Compare October 22, 2024 08:35

drishu changed the base branch from master to 2.x October 23, 2024 12:44

drishu changed the base branch from 2.x to master October 23, 2024 12:46

brummbar suggested changes Oct 25, 2024

View reviewed changes

drishu force-pushed the OEL-3178 branch from d108235 to 030e743 Compare November 4, 2024 15:48

piotrsmykaj reviewed Dec 9, 2024

View reviewed changes

drishu added 10 commits January 15, 2025 08:55

OEL-3178: Add new permission.

0ef6a68

OEL-3178: Add configuration form for maps.

9c5e389

OEL-3178: Add new maps config.

e59a201

OEL-3178: Use new config in maps formatter.

92b8c87

OEL-3178: Cover maps configuration with tests.

ff198b7

OEL-3178: Comment BC fallback.

1857f92

OEL-3178: Rename permission.

aa99ff6

OEL-3178: Drop shorten form page title.

fd905e0

OEL-3178: Improve grammer in schema label.

db4dd17

OEL-3178: Add menu link for settings.

923f264

drishu force-pushed the OEL-3178 branch from 030e743 to 923f264 Compare January 15, 2025 10:53

OEL-3178: Change typing in schema.

525a2ee

drishu commented Jan 15, 2025

View reviewed changes

sergepavle mentioned this pull request Jan 16, 2025

EWPP-4527: Upgrade oe_webtools_maps to 3.0 version. #258

Closed

sergepavle reviewed Jan 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OEL-3178: Add maps version 3.0 #254

OEL-3178: Add maps version 3.0 #254

drishu commented Oct 11, 2024

brummbar left a comment

brummbar Oct 25, 2024

brummbar Oct 25, 2024

brummbar Oct 25, 2024

piotrsmykaj commented Dec 9, 2024 •

edited

Loading

piotrsmykaj Dec 9, 2024

drishu Jan 15, 2025

sergepavle commented Jan 16, 2025 •

edited

Loading

sergepavle Jan 16, 2025

saidatom Jan 21, 2025

sergepavle Jan 16, 2025

	_title: 'Webtools Maps Form settings'
	_title: 'Webtools Maps settings'

	label: 'Webtools Maps Settings'
	label: 'Webtools Maps settings'

OEL-3178: Add maps version 3.0 #254

Are you sure you want to change the base?

OEL-3178: Add maps version 3.0 #254

Conversation

drishu commented Oct 11, 2024

OEL-3178

Description

Change log

brummbar 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

piotrsmykaj commented Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergepavle commented Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

piotrsmykaj commented Dec 9, 2024 •

edited

Loading

sergepavle commented Jan 16, 2025 •

edited

Loading