Merge pull request #4992 from Gustry/data-attributes

Popup - Add layer ID and feature ID as data attributes
3liz · Nov 26, 2024 · f2d3c82 · f2d3c82
2 parents 070b0eb + 4e794a5
commit f2d3c82
Show file tree

Hide file tree

Showing 6 changed files with 1,001 additions and 807 deletions.
diff --git a/assets/src/modules/Action.js b/assets/src/modules/Action.js
@@ -107,14 +107,14 @@ export default class Action {
                     // Add action buttons if needed
                     let popupContainerId = popup.containerId;
                     let popupContainer = document.getElementById(popupContainerId);
+
                     if (!popupContainer) return false;
-                    let featureIdInputSelector = 'div.lizmapPopupContent input.lizmap-popup-layer-feature-id';
-                    Array.from(popupContainer.querySelectorAll(featureIdInputSelector)).map(element => {
 
-                        // Get layer id and feature id
-                        let val = element.value;
-                        let featureId = val.split('.').pop();
-                        let layerId = val.replace('.' + featureId, '');
+                    Array.from(popupContainer.querySelectorAll('div.lizmapPopupContent .lizmapPopupSingleFeature')).map(element => {
+
+                        // Get layer ID and feature ID
+                        const featureId = element.dataset.featureId;
+                        const layerId = element.dataset.layerId;
 
                         // Get layer lizmap config
                         let getLayerConfig = mainLizmap.lizmap3.getLayerConfigById(layerId);

diff --git a/lizmap/modules/lizmap/lib/Request/WMSRequest.php b/lizmap/modules/lizmap/lib/Request/WMSRequest.php
@@ -701,6 +701,8 @@ protected function gfiVectorXmlToHtml($layerId, $layerName, $layerTitle, $layer,
             ++$layerFeaturesCounter;
 
             // Hidden input containing layer id and feature id
+            // TODO Deprecated, it will be removed later
+            // Use data-attributes in the parent div instead
             $hiddenFeatureId = '<input type="hidden" value="'.$layerId.'.'.$id.'" class="lizmap-popup-layer-feature-id"/>'.PHP_EOL;
 
             $popupFeatureContent = $this->getViewTpl('view~popupDefaultContent', $layerName, $layerId, $layerTitle, array(

diff --git a/lizmap/modules/view/templates/popup.tpl b/lizmap/modules/view/templates/popup.tpl
@@ -1,4 +1,4 @@
-<div class="lizmapPopupSingleFeature">
+<div class="lizmapPopupSingleFeature" {if $featureId}data-feature-id="{$featureId}"{/if} data-layer-id="{$layerId}">
     <h4 class="lizmapPopupTitle">{$layerTitle}</h4>
 
     <div class="lizmapPopupDiv">

diff --git a/tests/end2end/playwright/popup.spec.js b/tests/end2end/playwright/popup.spec.js
@@ -95,8 +95,8 @@ test.describe('Style parameter in GetFeatureInfo request', () => {
         await page.waitForTimeout(300);
 
 
-        // get the popup of the feature with id = 3. The STYLE property (STYLE=default) should be passed in the getfeatureinfo request.
-        // Otherwise the popup would not be shown because QGIS Server query the layer natural_areas with the "ids" style
+        // get the popup of the feature with id = 3. The STYLE property (STYLE=default) should be passed in the GetFeatureInfo request.
+        // Otherwise, the popup would not be shown because QGIS Server query the layer natural_areas with the "ids" style
 
         let getPopup = page.waitForRequest(request => request.method() === 'POST' && request.postData()?.includes('STYLE=default') === true);
 
@@ -109,6 +109,10 @@ test.describe('Style parameter in GetFeatureInfo request', () => {
 
         await getPopup;
 
+        const mainPopup = page.locator("#popupcontent div.lizmapPopupContent div.lizmapPopupSingleFeature")
+        await expect(mainPopup).toHaveAttribute("data-layer-id", "natural_areas_d4a1a538_3bff_4998_a186_38237507ac1e")
+        await expect(mainPopup).toHaveAttribute("data-feature-id")
+
         // inspect feature toolbar, expect to find only one
         const popup = page.locator("#popupcontent > div.menu-content > div.lizmapPopupContent > div.lizmapPopupSingleFeature > div.lizmapPopupDiv div.container.popup_lizmap_dd")
         await expect(popup).toHaveCount(1)
@@ -183,7 +187,7 @@ test.describe('Style parameter in GetFeatureInfo request', () => {
         expect(getFeatureInfoRequest.postData()).not.toMatch(/LEGEND_OFF/);
         let getFeatureInfoResponse = await getFeatureInfoRequest.response()
         expect(getFeatureInfoResponse?.headers()['content-type']).toContain('text/html');
-        expect(getFeatureInfoResponse?.headers()['content-length']).toBe('1789');
+        expect(getFeatureInfoResponse?.headers()['content-length']).toBe('1875');
 
         // inspect feature toolbar, expect to find only one
         const popup = page.locator("#popupcontent > div.menu-content > div.lizmapPopupContent > div.lizmapPopupSingleFeature > div.lizmapPopupDiv div.container.popup_lizmap_dd")
@@ -221,6 +225,26 @@ test.describe('Style parameter in GetFeatureInfo request', () => {
     })
 })
 
+test.describe('Raster identify', () => {
+
+    test('Raster identify check with data-attributes', async ({ page }) => {
+        const url = '/index.php/view/map/?repository=testsrepository&project=rasters';
+        await gotoMap(url, page);
+
+        let getFeatureInfoPromise = page.waitForRequest(request => request.method() === 'POST' && request.postData()?.includes('GetFeatureInfo') === true);
+        await page.locator('#newOlMap').click({
+            position: {
+                x: 510,
+                y: 415
+            }
+        });
+        let getFeatureInfoRequest = await getFeatureInfoPromise
+        const popup = page.locator("#popupcontent div.lizmapPopupContent div.lizmapPopupSingleFeature")
+        await expect(popup).toHaveAttribute("data-layer-id", "local_raster_layer_c4c2ec5e_7567_476b_bf78_2b7c64f32615")
+        await expect(popup).not.toHaveAttribute("data-feature-id", )
+    });
+});
+
 test.describe('Popup', () => {
 
     test.beforeEach(async ({ page }) => {
@@ -381,7 +405,7 @@ test.describe('Popup', () => {
                 y: 415
             }
         });
-        await page.waitForTimeout(500); // wait to be sure, no request sended
+        await page.waitForTimeout(500); // wait to be sure, no request sent
         await expect(page.locator('#newOlMap #liz_layer_popup')).not.toBeVisible();
 
         // Erasing
@@ -395,7 +419,7 @@ test.describe('Popup', () => {
                 y: 415
             }
         });
-        await page.waitForTimeout(500); // wait to be sure, no request sended
+        await page.waitForTimeout(500); // wait to be sure, no request sent
         await expect(page.locator('#newOlMap #liz_layer_popup')).not.toBeVisible();
     });
 });