geosolutions-it#10281: Use Cache Options functionality extended to be…

… applied on all the layers from a service Description: - add the functionality for use cache options for mapviewer, dashboard, geostory, context - add unit tests - add translations
mahmoudadel54 · May 22, 2024 · e05aa62 · e05aa62
1 parent 0e694cd
commit e05aa62
Show file tree

Hide file tree

Showing 10 changed files with 158 additions and 6 deletions.
diff --git a/web/client/components/catalog/editor/AdvancedSettings/RasterAdvancedSettings.js b/web/client/components/catalog/editor/AdvancedSettings/RasterAdvancedSettings.js
@@ -174,6 +174,14 @@ export default ({
                 &nbsp;<InfoPopover text={<Message msgId="layerProperties.enableInteractiveLegendInfo.info" />} />
             </Checkbox>
         </FormGroup>}
+        {![ServerTypes.NO_VENDOR].includes(service.layerOptions?.serverType) && service.type === "wms" &&  <FormGroup controlId="useCacheOption" key="useCacheOption">
+            <Checkbox data-qa="display-interactive-legend-option"
+                onChange={(e) => onChangeServiceProperty("layerOptions", { ...service.layerOptions, remoteTileGrids: e.target.checked})}
+                checked={!isNil(service.layerOptions?.remoteTileGrids) ? service.layerOptions?.remoteTileGrids : false}>
+                <Message msgId="layerProperties.useCacheOptionInfo.label" />
+                &nbsp;<InfoPopover text={<Message msgId="layerProperties.useCacheOptionInfo.info" />} />
+            </Checkbox>
+        </FormGroup>}
         <hr style={{margin: "8px 0"}}/>
         <FormGroup style={advancedRasterSettingsStyles} className="form-group-flex">
             <ControlLabel className="strong"><Message msgId="layerProperties.format.title" /></ControlLabel>

diff --git a/...lient/components/catalog/editor/AdvancedSettings/__tests__/RasterAdvancedSettings-test.js b/...lient/components/catalog/editor/AdvancedSettings/__tests__/RasterAdvancedSettings-test.js
@@ -33,7 +33,7 @@ describe('Test Raster advanced settings', () => {
         const advancedSettingPanel = document.getElementsByClassName("mapstore-switch-panel");
         expect(advancedSettingPanel).toBeTruthy();
         const fields = document.querySelectorAll(".form-group");
-        expect(fields.length).toBe(14);
+        expect(fields.length).toBe(15);
     });
     it('test wms advanced options with no vendor serverType', () => {
         ReactDOM.render(<RasterAdvancedSettings service={{type: "wms", autoload: false, layerOptions: {serverType: 'no-vendor'}}} isLocalizedLayerStylesEnabled/>, document.getElementById("container"));
@@ -227,6 +227,25 @@ describe('Test Raster advanced settings', () => {
         expect(spyOn).toHaveBeenCalled();
         expect(spyOn.calls[1].arguments).toEqual([ 'allowUnsecureLayers', false ]);
     });
+    it('test component onChangeServiceProperty useCacheOption for remote tile grids', () => {
+        const action = {
+            onChangeServiceProperty: () => {}
+        };
+        const spyOn = expect.spyOn(action, 'onChangeServiceProperty');
+        ReactDOM.render(<RasterAdvancedSettings
+            onChangeServiceProperty={action.onChangeServiceProperty}
+            service={{ type: "wms" }}
+        />, document.getElementById("container"));
+        const advancedSettingsPanel = document.getElementsByClassName("mapstore-switch-panel");
+        expect(advancedSettingsPanel).toBeTruthy();
+        const formGroup = document.querySelectorAll('.form-group')[7];
+        expect(formGroup.textContent.trim()).toBe('layerProperties.useCacheOptionInfo.label');
+        const useCacheOption = formGroup.querySelector('input[type="checkbox"]');
+        expect(useCacheOption).toBeTruthy();
+        TestUtils.Simulate.change(useCacheOption, { "target": { "checked": true }});
+        expect(spyOn).toHaveBeenCalled();
+        expect(spyOn.calls[0].arguments).toEqual([ 'layerOptions', { remoteTileGrids: true } ]);
+    });
     it('test component onChangeServiceProperty singleTile', () => {
         const action = {
             onChangeServiceProperty: () => {}

diff --git a/web/client/epics/__tests__/catalog-test.js b/web/client/epics/__tests__/catalog-test.js
@@ -680,6 +680,67 @@ describe('catalog Epics', () => {
                 }
             });
     });
+    it('addLayerAndDescribeEpic for wms layer with remoteTileGrids = true', (done) => {
+        const layer = {
+            type: 'wms',
+            url: 'base/web/client/test-resources/wms/DescribeLayers.xml',
+            visibility: true,
+            dimensions: [],
+            name: 'workspace:vector_layer',
+            title: 'workspace:vector_layer',
+            bbox: {"crs": "EPSG:4326", "bounds": {"minx": "-103.87791475407893", "miny": "44.37246687108142", "maxx": "-103.62278893469492", "maxy": "44.50235105543566"}},
+            links: [],
+            params: {
+                CQL_FILTER: 'NAME=\'Test\''
+            },
+            allowedSRS: {
+                'EPSG:3857': true,
+                'EPSG:4326': true
+            },
+            remoteTileGrids: true
+        };
+        const NUM_ACTIONS = 3;
+        testEpic(addTimeoutEpic(addLayerAndDescribeEpic, 0), NUM_ACTIONS,
+            addLayerAndDescribe(layer),
+            (actions) => {
+                expect(actions.length).toBe(NUM_ACTIONS);
+                actions.map((action) => {
+                    switch (action.type) {
+                    case ADD_LAYER:
+                        expect(action.layer.name).toBe("workspace:vector_layer");
+                        expect(action.layer.title).toBe("workspace:vector_layer");
+                        expect(action.layer.type).toBe("wms");
+                        expect(action.layer.params).toEqual(layer.params);
+                        break;
+                    case CHANGE_LAYER_PROPERTIES:
+                        expect(action.newProperties).toExist();
+                        expect(action.newProperties.search).toExist();
+                        expect(action.newProperties.search.url).toBe("http://some.geoserver.org:80/geoserver/wfs");
+                        expect(action.newProperties.search.type).toBe("wfs");
+                        expect(action.newProperties.tileGridStrategy).toEqual('custom');
+                        expect(action.newProperties.tileGrids).toExist();
+                        break;
+                    case TEST_TIMEOUT:
+                        break;
+                    default:
+                        expect(true).toBe(false);
+                    }
+                });
+                done();
+            }, {
+                catalog: {
+                    delayAutoSearch: 50,
+                    selectedService: "wmsCatalog",
+                    services: {
+                        "wmsCatalog": {
+                            type: "wms",
+                            url: "base/web/client/test-resources/wms/GetCapabilities-1.1.1.xml"
+                        }
+                    },
+                    pageSize: 2
+                }
+            });
+    });
     it('addLayerAndDescribeEpic multiple urls', (done) => {
         const layer = {
             type: 'wms',

diff --git a/web/client/epics/catalog.js b/web/client/epics/catalog.js
@@ -62,6 +62,7 @@ import {
     updateServiceData
 } from '../utils/CatalogUtils';
 import { getCapabilities, describeLayers, flatLayers } from '../api/WMS';
+import {generateGeoServerWMTSUrl} from '../utils/WMTSUtils';
 import CoordinatesUtils from '../utils/CoordinatesUtils';
 import ConfigUtils from '../utils/ConfigUtils';
 import {getCapabilitiesUrl, getLayerId, getLayerUrl, removeWorkspace, DEFAULT_GROUP_ID} from '../utils/LayersUtils';
@@ -75,6 +76,8 @@ import { extractGeometryType } from '../utils/WFSLayerUtils';
 import { createDefaultStyle } from '../utils/StyleUtils';
 import { removeDuplicateLines } from '../utils/StringUtils';
 import { logError } from '../utils/DebugUtils';
+import { isProjectionAvailable } from '../utils/ProjectionUtils';
+import {getLayerTileMatrixSetsInfo} from '../api/WMTS';
 
 const onErrorRecordSearch = (isNewService, errObj) => {
     logError({message: errObj});
@@ -270,8 +273,27 @@ export default (API) => ({
                     actions.push(zoomToExtent(layer.bbox.bounds, layer.bbox.crs));
                 }
                 if (layer.type === 'wms') {
-                    return Rx.Observable.defer(() => describeLayers(getLayerUrl(layer), layer.name))
-                        .switchMap(results => {
+                    // * fetch the api of cashe option if layer has 'remoteTileGrids' property with true value
+                    return Rx.Observable.forkJoin(
+                        Rx.Observable.defer(() => describeLayers(getLayerUrl(layer), layer.name)),
+                        (!layer?.remoteTileGrids) ?
+                            Rx.Observable.of(null) :
+                            Rx.Observable.defer(() => getLayerTileMatrixSetsInfo(generateGeoServerWMTSUrl(layer), layer.name, layer))
+                                .catch(() => Rx.Observable.of(null))
+                    )
+                        .switchMap(([results, tileGridData]) => {
+                            let tileGridProperties = {};
+                            if (tileGridData) {
+                                const filteredTileGrids = tileGridData.tileGrids.filter(({ crs }) => isProjectionAvailable(CoordinatesUtils.normalizeSRS(crs)));
+                                tileGridProperties = tileGridData !== undefined ? {
+                                    tileGrids: tileGridData.tileGrids,
+                                    tileGridStrategy: 'custom',
+                                    tileGridCacheSupport: filteredTileGrids?.length > 0 ?
+                                        tileGridData.formats ? {formats: tileGridData.formats} : {}
+                                        : undefined
+                                } : {};
+
+                            }
                             if (results) {
                                 let description = find(results, (desc) => desc.name === layer.name );
                                 if (description && description.owsType === 'WFS') {
@@ -280,9 +302,12 @@ export default (API) => ({
                                         search: {
                                             url: filteredUrl,
                                             type: 'wfs'
-                                        }
+                                        }, ...tileGridProperties
                                     }));
                                 }
+                                return Rx.Observable.of(changeLayerProperties(id, {
+                                    ...tileGridProperties
+                                }));
                             }
                             return Rx.Observable.empty();
                         })

diff --git a/web/client/plugins/widgetbuilder/MapBuilder.jsx b/web/client/plugins/widgetbuilder/MapBuilder.jsx
@@ -25,6 +25,10 @@ import mapToolbar from './enhancers/mapToolbar';
 import MapLayerSelectorComp from './MapLayerSelector';
 import MapSelector from './MapSelector';
 import { catalogEditorEnhancer } from './enhancers/catalogEditorEnhancer';
+import { getLayerTileMatrixSetsInfo } from '../../api/WMTS';
+import { generateGeoServerWMTSUrl } from '../../utils/WMTSUtils';
+import { isProjectionAvailable } from '../../utils/ProjectionUtils';
+import { normalizeSRS } from '../../utils/CoordinatesUtils';
 
 
 const Toolbar = mapToolbar(ToolbarComp);
@@ -51,8 +55,23 @@ const chooseMapEnhancer = compose(
                 manageLayers,
                 withHandlers({
                     onLayerChoice: ({ toggleLayerSelector = () => { }, addLayer = () => { } }) => (layer) => {
-                        addLayer(layer);
-                        toggleLayerSelector(false);
+                        // fetching 'tileGridData' if layer has truthy flag 'remoteTileGrids' and adding the required props to layer object
+                        let tileGridPromise = layer.type === 'wms' && layer.remoteTileGrids ? getLayerTileMatrixSetsInfo(generateGeoServerWMTSUrl(layer), layer.name, layer) : new Promise((resolve) => resolve(null));
+                        tileGridPromise.then((tileGridData) => {
+                            let tileGridProperties = {};
+                            if (tileGridData) {
+                                const filteredTileGrids = tileGridData.tileGrids.filter(({ crs }) => isProjectionAvailable(normalizeSRS(crs)));
+                                tileGridProperties = tileGridData !== undefined ? {
+                                    tileGrids: tileGridData.tileGrids,
+                                    tileGridStrategy: 'custom',
+                                    tileGridCacheSupport: filteredTileGrids?.length > 0 ?
+                                        tileGridData.formats ? {formats: tileGridData.formats} : {}
+                                        : undefined
+                                } : {};
+                            }
+                            addLayer({...layer, ...tileGridProperties});
+                            toggleLayerSelector(false);
+                        });
                     }
                 }),
                 layerSelector

diff --git a/web/client/translations/data.de-DE.json b/web/client/translations/data.de-DE.json
@@ -212,6 +212,10 @@
                 "label": "Lokalisierten Stil aktivieren",
                 "tooltip": "Hinweis: Diese Einstellung benötigt spezifische Konfigurationen im GeoServer"
             },
+            "useCacheOptionInfo": {
+                "label": "Verwenden Sie entfernte benutzerdefinierte Kachelraster",
+                "info": "Stellen Sie sicher, dass WMTS aktiviert ist, um benutzerdefinierte Kachelraster verwenden zu können"
+            },
             "format": {
                 "title": "Format",
                 "tile": "Fliese",

diff --git a/web/client/translations/data.en-US.json b/web/client/translations/data.en-US.json
@@ -212,6 +212,10 @@
                 "label": "Enable localized style",
                 "tooltip": "Note: This parameter requires specific configurations on GeoServer"
             },
+            "useCacheOptionInfo": {
+                "label": "Use remote custom tile grids",
+                "info": "Make sure to have WMTS enabled in order to use custom tile grids"
+            },
             "format": {
                 "title": "Format",
                 "tile": "Tile",

diff --git a/web/client/translations/data.es-ES.json b/web/client/translations/data.es-ES.json
@@ -212,6 +212,10 @@
                 "label": "Habilitar estilo localizado",
                 "tooltip": "Nota: este parámetro requiere configuraciones específicas en GeoServer"
             },
+            "useCacheOptionInfo": {
+                "label": "Utilice cuadrículas de mosaicos personalizadas remotas",
+                "info": "Asegúrese de que WMTS esté habilitado para poder usar cuadrículas de mosaicos personalizadas"
+            },
             "format": {
                 "title": "Formato",
                 "tile": "Teja",

diff --git a/web/client/translations/data.fr-FR.json b/web/client/translations/data.fr-FR.json
@@ -212,6 +212,10 @@
                 "label": "Activer le style localisé",
                 "tooltip": "Remarque: ce paramètre nécessite des configurations spécifiques sur GeoServer"
             },
+            "useCacheOptionInfo": {
+                "label": "Utiliser des grilles de carreaux personnalisées à distance",
+                "info": "Assurez-vous que WMTS est activé afin d'utiliser des grilles de tuiles personnalisées"
+            },
             "format": {
                 "title": "Format",
                 "tile": "Tile",

diff --git a/web/client/translations/data.it-IT.json b/web/client/translations/data.it-IT.json
@@ -212,6 +212,10 @@
                 "label": "Abilita stile localizzato",
                 "tooltip": "Nota: questo parametro richiede configurazioni specifiche su GeoServer"
             },
+            "useCacheOptionInfo": {
+                "label": "Utilizza griglie di riquadri personalizzate remote",
+                "info": "Assicurati che WMTS sia abilitato per utilizzare griglie di riquadri personalizzate"
+            },
             "format": {
                 "title": "Formato",
                 "tile": "Tile",