read singleWMS option from map state instead from the config object directly, update js-unit option config test

mind84 · mind84 · commit b5b4e891d8ff · 2024-03-19T16:45:33.000+01:00
diff --git a/assets/src/modules/Config.js b/assets/src/modules/Config.js
@@ -68,7 +68,6 @@ export class Config {
         this._hasFormFilterLayers = true;
         this._hasLoginFilteredLayers = true;
         this._hasDatavizConfig = true;
-        this._singleWMSLayer = null;
 
         const theConfig = deepFreeze(cfg);
 
@@ -97,7 +96,6 @@ export class Config {
         }
         this._theConfig = theConfig;
         this._theWmsCapabilities = theWmsCapabilities;
-        this._singleWMSLayer = theConfig.options?.wms_single_request_for_all_layers == "True" ? true : false;
 
         const optionalConfigProperties = [
             'metadata',
@@ -421,12 +419,4 @@ export class Config {
         }
         return this._datavizOptions;
     }
-    /**
-     * Config singleWMSLayer
-     *
-     * @type {Boolean}
-     */
-    get singleWMSLayer(){
-        return this._singleWMSLayer;
-    }
 }
diff --git a/assets/src/modules/SingleWMSLayer.js b/assets/src/modules/SingleWMSLayer.js
@@ -19,7 +19,7 @@ export default class SingleWMSLayer {
      */
     //constructor(singleWMSLayerList) {
     constructor(mainMapInstance) {
-        if (!mainLizmap.initialConfig.singleWMSLayer || !mainMapInstance || !(mainMapInstance instanceof map) || mainMapInstance.statesSingleWMSLayers.size == 0) {
+        if (!mainLizmap.state.map.singleWMSLayer || !mainMapInstance || !(mainMapInstance instanceof map) || mainMapInstance.statesSingleWMSLayers.size == 0) {
             throw new ValidationError('The Configuration is not valid, could not load the map as single WMS Layer');
         }
 
@@ -104,7 +104,7 @@ export default class SingleWMSLayer {
          * the WMS Ratio.
          * @type {number} 
          */
-        this._WMSRatio = 1.1;
+        this._WMSRatio = mainMapInstance._WMSRatio;
 
         /**
          * the image format
@@ -364,5 +364,4 @@ export default class SingleWMSLayer {
             }
         })
     }
-     
 }
diff --git a/assets/src/modules/State.js b/assets/src/modules/State.js
@@ -25,7 +25,7 @@ export class State extends EventDispatcher {
     constructor(initialCfg, startupFeatures) {
         super()
         this._initialConfig = initialCfg;
-        this._map = new MapState(startupFeatures);
+        this._map = new MapState(initialCfg.options, startupFeatures);
         this._map.addListener(this.dispatch.bind(this), 'map.state.changed');
         this._baseLayers = null;
         this._collection = null;
diff --git a/assets/src/modules/config/Options.js b/assets/src/modules/config/Options.js
@@ -32,7 +32,7 @@ const optionalProperties = {
     'use_native_zoom_levels': {type: 'boolean', nullable: true, default: null},
     'hide_numeric_scale_value': {type: 'boolean', default: false},
     'hideGroupCheckbox': { type: 'boolean', default: false },
-    'wms_single_request_for_all_layers' : { type:'string', default: false }
+    'wms_single_request_for_all_layers' : { type:'boolean', default: false }
 };
 
 /**
@@ -44,26 +44,26 @@ export class OptionsConfig  extends BaseObjectConfig {
 
     /**
      * Create an options config instance based on a config object
-     * @param {object}   cfg                                     - the lizmap config object for options
-     * @param {number[]} cfg.bbox                                - the project and web services max extent
-     * @param {number[]} cfg.initialExtent                       - the map extent at the loading page
-     * @param {number[]} cfg.mapScales                           - the map scales
-     * @param {number}   cfg.minScale                            - the map's min scale
-     * @param {number}   cfg.maxScale                            - the map's max scale
-     * @param {object}   cfg.projection                          - the web map projection
-     * @param {number}   cfg.pointTolerance                      - the point tolerance for QGIS Server WMS GetFeatureInfo request
-     * @param {number}   cfg.lineTolerance                       - the line tolerance for QGIS Server WMS GetFeatureInfo request
-     * @param {number}   cfg.polygonTolerance                    - the polygon tolerance for QGIS Server WMS GetFeatureInfo request
-     * @param {string}   cfg.popupLocation                       - the popup location in the User interface: dock, bottom-dock, right-dock, mini-dock, map
-     * @param {string}   cfg.datavizLocation                     - the popup location in the User interface: dock, bottom-dock, right-dock
-     * @param {boolean}  [cfg.hideProject]                       - is the project hidden in user interface ? Only services are available.
-     * @param {number}   [cfg.wmsMaxHeight]                      - the image max height for WMS GetMap request
-     * @param {number}   [cfg.wmsMaxWidth]                       - the image max width for WMS GetMap request
-     * @param {boolean}  [cfg.fixed_scale_overview_map]          - does the Overview map have fixed scale ?
-     * @param {boolean}  [cfg.use_native_zoom_levels]            - does the map use native zoom levels ?
-     * @param {boolean}  [cfg.hide_numeric_scale_value]          - does the scale line hide numeric scale value ?
-     * @param {boolean}  [cfg.hideGroupCheckbox]                 - are groups checkbox hidden ?
-     * @param {string}   [cfg.wms_single_request_for_all_layers] - are layers loaded as single WMS image ?  
+     * @param {object}   cfg                                      - the lizmap config object for options
+     * @param {number[]} cfg.bbox                                 - the project and web services max extent
+     * @param {number[]} cfg.initialExtent                        - the map extent at the loading page
+     * @param {number[]} cfg.mapScales                            - the map scales
+     * @param {number}   cfg.minScale                             - the map's min scale
+     * @param {number}   cfg.maxScale                             - the map's max scale
+     * @param {object}   cfg.projection                           - the web map projection
+     * @param {number}   cfg.pointTolerance                       - the point tolerance for QGIS Server WMS GetFeatureInfo request
+     * @param {number}   cfg.lineTolerance                        - the line tolerance for QGIS Server WMS GetFeatureInfo request
+     * @param {number}   cfg.polygonTolerance                     - the polygon tolerance for QGIS Server WMS GetFeatureInfo request
+     * @param {string}   cfg.popupLocation                        - the popup location in the User interface: dock, bottom-dock, right-dock, mini-dock, map
+     * @param {string}   cfg.datavizLocation                      - the popup location in the User interface: dock, bottom-dock, right-dock
+     * @param {boolean}  [cfg.hideProject]                        - is the project hidden in user interface ? Only services are available.
+     * @param {number}   [cfg.wmsMaxHeight]                       - the image max height for WMS GetMap request
+     * @param {number}   [cfg.wmsMaxWidth]                        - the image max width for WMS GetMap request
+     * @param {boolean}  [cfg.fixed_scale_overview_map]           - does the Overview map have fixed scale ?
+     * @param {boolean}  [cfg.use_native_zoom_levels]             - does the map use native zoom levels ?
+     * @param {boolean}  [cfg.hide_numeric_scale_value]           - does the scale line hide numeric scale value ?
+     * @param {boolean}  [cfg.hideGroupCheckbox]                  - are groups checkbox hidden ?
+     * @param {boolean}  [cfg.wms_single_request_for_all_layers]  - are layers loaded as single WMS image ?  
      */
     constructor(cfg) {
         if (!cfg || typeof cfg !== "object") {
@@ -239,7 +239,7 @@ export class OptionsConfig  extends BaseObjectConfig {
 
     /**
      * The layers are loaded as a single WMS image
-     * @type {string}
+     * @type {boolean}
      */
     get wms_single_request_for_all_layers() {
         return this._wms_single_request_for_all_layers;
diff --git a/assets/src/modules/map.js b/assets/src/modules/map.js
@@ -35,6 +35,7 @@ import DragZoom from 'ol/interaction/DragZoom.js';
 import { defaults as defaultInteractions } from 'ol/interaction.js';
 import { always } from 'ol/events/condition.js';
 import SingleWMSLayer from './SingleWMSLayer.js';
+import { Tile } from 'ol';
 
 /**
  * Class initializing Openlayers Map.
@@ -136,7 +137,6 @@ export default class map extends olMap {
         // Get pixel ratio, if High DPI is disabled do not use device pixel ratio
         const pixelRatio = this._hidpi ? this.pixelRatio_ : 1;
 
-        this._useTileWms = this.getSize().reduce(
         this._useTileWms = this.getSize().reduce(
             (r /*accumulator*/, x /*currentValue*/, i /*currentIndex*/) => r || Math.ceil(x*this._WMSRatio*pixelRatio) > wmsMaxSize[i],
             false,
@@ -243,7 +243,7 @@ export default class map extends olMap {
                         });
                     }
                 } else {
-                    if(mainLizmap.initialConfig.singleWMSLayer){
+                    if(mainLizmap.state.map.singleWMSLayer){
                         this._statesSingleWMSLayers.set(node.name,node);
                         node.singleWMSLayer = true;
                         return
@@ -461,7 +461,7 @@ export default class map extends olMap {
                         source: new WMTS(options)
                     });
                 } else {
-                    if(mainLizmap.initialConfig.singleWMSLayer){
+                    if(mainLizmap.state.map.singleWMSLayer){
                         baseLayerState.singleWMSLayer = true;
                         this._statesSingleWMSLayers.set(baseLayerState.name, baseLayerState); 
                     } else {
@@ -749,19 +749,31 @@ export default class map extends olMap {
     get overlayLayersGroup(){
         return this._overlayLayersGroup;
     }
-
+    /**
+     * Key (name) / value (state) Map of layers loaded in a single WMS image
+     * @type {Map}
+     */
     get statesSingleWMSLayers(){
         return this._statesSingleWMSLayers;
     }
-
+    /**
+     * Map and base Layers are loaded as TileWMS
+     * @type {Boolean}
+     */
     get useTileWms(){
         return this._useTileWms;
     }
-
+    /**
+     * TileGrid configuration when layers is loaded as TileWMS
+     * @type {null|TileGrid}
+     */
     get customTileGrid(){
         return this._customTileGrid;
     }
-
+    /**
+     * WMS/TileWMS high dpi support
+     * @type {Boolean}
+     */
     get hidpi(){
         return this._hidpi;
     }
diff --git a/assets/src/modules/state/BaseLayer.js b/assets/src/modules/state/BaseLayer.js
@@ -35,13 +35,14 @@ export class BaseLayerState extends EventDispatcher {
     }
 
     /**
-     * set if the base layer is loaded in a single layer ImageLayer or not
+     * Set if the base layer is loaded in a single WMS Layer or not
      * @param {boolean} val
      */
     set singleWMSLayer(val){
         this._singleWMSLayer = val;
     }
     /**
+     * The base layer is loaded in a single WMS Layer or not
      * @type {boolean}
      */
     get singleWMSLayer(){
diff --git a/assets/src/modules/state/Map.js b/assets/src/modules/state/Map.js
@@ -54,9 +54,10 @@ export class MapState extends EventDispatcher {
 
     /**
      * Creating the map state
+     * @param {OptionConfig}     [options]         - main configuration options
      * @param {string|undefined} [startupFeatures] - The features to highlight at startup in GeoJSON
      */
-    constructor(startupFeatures) {
+    constructor(options, startupFeatures) {
         super();
         this._ready = false;
         // default values
@@ -68,6 +69,13 @@ export class MapState extends EventDispatcher {
         this._scaleDenominator = -1;
         this._pointResolution = -1;
         this._pointScaleDenominator = -1;
+
+        // Values from options
+        this._singleWMSLayer = false;
+        if (options) {
+            this._singleWMSLayer = options.wms_single_request_for_all_layers; // default value is defined as false
+        }
+
         this._startupFeatures = startupFeatures;
     }
 
@@ -234,4 +242,13 @@ export class MapState extends EventDispatcher {
     get startupFeatures() {
         return this._startupFeatures;
     }
+
+    /**
+     * Config singleWMSLayer
+     *
+     * @type {Boolean}
+     */
+    get singleWMSLayer(){
+        return this._singleWMSLayer;
+    }
 }
diff --git a/tests/js-units/node/config.test.js b/tests/js-units/node/config.test.js
@@ -140,7 +140,7 @@ describe('Config', function () {
         const initialConfig = new Config(config, capabilities);
 
         expect(initialConfig.options).to.be.instanceOf(OptionsConfig)
-        expect(initialConfig.options.wms_single_request_for_all_layers).to.be.eq("True")
+        expect(initialConfig.options.wms_single_request_for_all_layers).to.be.eq(true)
     })
 
 })
diff --git a/tests/js-units/node/config/options.test.js b/tests/js-units/node/config/options.test.js
@@ -74,6 +74,8 @@ describe('OptionsConfig', function () {
         expect(opt.hideGroupCheckbox).to.be.eq(false)
         // Default value for multiple mapScales without use_native_zoom_levels defined
         expect(opt.use_native_zoom_levels).to.be.eq(false)
+        // Default value for singleWMS option is false (option wms_single_request_for_all_layers not defined)
+        expect(opt.wms_single_request_for_all_layers).to.be.eq(false)
     })
 
     it('use_native_zoom_levels', function () {
@@ -171,6 +173,53 @@ describe('OptionsConfig', function () {
         expect(opt.use_native_zoom_levels).to.be.eq(true)
     })
 
+    it('wms_single_request_for_all_layers', function () {
+        let opt = new OptionsConfig({
+            "projection": {
+                "proj4": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0 +lon_0=0 +x_0=0 +y_0=0 +k=1 +units=m +nadgrids=@null +wktext +no_defs",
+                "ref": "EPSG:3857"
+            },
+            "bbox": [
+                "414463.27939999999944121",
+                "5394742.82330000028014183",
+                "452853.33649999997578561",
+                "5416679.9988000001758337"
+            ],
+            "mapScales": [
+                1,
+                1000000000
+            ],
+            "minScale": 1,
+            "maxScale": 1000000000,
+            "use_native_zoom_levels": true,
+            "hide_numeric_scale_value": true,
+            "initialExtent": [
+                414463.2794,
+                5394742.8233,
+                452853.3365,
+                5416679.9988
+            ],
+            "popupLocation": "dock",
+            "draw": "True",
+            "measure": "True",
+            "zoomHistory": "True",
+            "pointTolerance": 25,
+            "lineTolerance": 10,
+            "polygonTolerance": 5,
+            "wms_single_request_for_all_layers": "True",
+            "tmTimeFrameSize": 10,
+            "tmTimeFrameType": "seconds",
+            "tmAnimationFrameLength": 1000,
+            "datavizLocation": "dock",
+            "theme": "dark",
+            "fixed_scale_overview_map": true,
+            "dataviz_drag_drop": []
+        })
+
+        // Load layers as a single WMS image
+        expect(opt.wms_single_request_for_all_layers).to.be.eq(true)
+    })
+
     it('ValidationError', function () {
         try {
             new OptionsConfig()

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,6 @@ export class Config {`
`68`	`68`	`this._hasFormFilterLayers = true;`
`69`	`69`	`this._hasLoginFilteredLayers = true;`
`70`	`70`	`this._hasDatavizConfig = true;`
`71`		`- this._singleWMSLayer = null;`
`72`	`71`
`73`	`72`	`const theConfig = deepFreeze(cfg);`
`74`	`73`
`@@ -97,7 +96,6 @@ export class Config {`
`97`	`96`	`}`
`98`	`97`	`this._theConfig = theConfig;`
`99`	`98`	`this._theWmsCapabilities = theWmsCapabilities;`
`100`		`- this._singleWMSLayer = theConfig.options?.wms_single_request_for_all_layers == "True" ? true : false;`
`101`	`99`
`102`	`100`	`const optionalConfigProperties = [`
`103`	`101`	`'metadata',`
`@@ -421,12 +419,4 @@ export class Config {`
`421`	`419`	`}`
`422`	`420`	`return this._datavizOptions;`
`423`	`421`	`}`
`424`		`- /**`
`425`		`- * Config singleWMSLayer`
`426`		`- *`
`427`		`- * @type {Boolean}`
`428`		`- */`
`429`		`- get singleWMSLayer(){`
`430`		`- return this._singleWMSLayer;`
`431`		`- }`
`432`	`422`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export default class SingleWMSLayer {`
`19`	`19`	`*/`
`20`	`20`	`//constructor(singleWMSLayerList) {`
`21`	`21`	`constructor(mainMapInstance) {`
`22`		`- if (!mainLizmap.initialConfig.singleWMSLayer \|\| !mainMapInstance \|\| !(mainMapInstance instanceof map) \|\| mainMapInstance.statesSingleWMSLayers.size == 0) {`
	`22`	`+ if (!mainLizmap.state.map.singleWMSLayer \|\| !mainMapInstance \|\| !(mainMapInstance instanceof map) \|\| mainMapInstance.statesSingleWMSLayers.size == 0) {`
`23`	`23`	`throw new ValidationError('The Configuration is not valid, could not load the map as single WMS Layer');`
`24`	`24`	`}`
`25`	`25`
`@@ -104,7 +104,7 @@ export default class SingleWMSLayer {`
`104`	`104`	`* the WMS Ratio.`
`105`	`105`	`* @type {number}`
`106`	`106`	`*/`
`107`		`- this._WMSRatio = 1.1;`
	`107`	`+ this._WMSRatio = mainMapInstance._WMSRatio;`
`108`	`108`
`109`	`109`	`/**`
`110`	`110`	`* the image format`
`@@ -364,5 +364,4 @@ export default class SingleWMSLayer {`
`364`	`364`	`}`
`365`	`365`	`})`
`366`	`366`	`}`
`367`		`-`
`368`	`367`	`}`