PB-1895: Refactor messages to use objects as Parameters

ltkum · ltkum · commit d3517c8e9926 · 2025-08-26T15:56:26.000+02:00
- Issue: With the extra parameters `isAcknowledged` and `sourceId` in the messages,
we could end up with disgracious instantiation with empty parameters just to add the last one.

- Fix: We Refactor the messages to accept objects as parameters
diff --git a/packages/geoadmin-log/src/Message.ts b/packages/geoadmin-log/src/Message.ts
@@ -12,9 +12,15 @@ export class Message {
      * @param {string} msg Translation key message
      * @param {any} params Translation params to pass to i18n (used for message formatting)
      */
-    constructor(msg: string, params: Record<string, any> | null = null, sourceId? : string, isAcknowledged: boolean = false ) {
+    constructor(msgParams: Record<string, any> ) {
+        const {
+            msg = 'unknown_message',
+            params = {},
+            isAcknowledged = false,
+            sourceId = undefined
+        } = msgParams
         this.msg = msg
-        this.params = params ?? {}
+        this.params = params
         this.isAcknowledged = isAcknowledged
         this.sourceId = sourceId
     }
diff --git a/packages/geoadmin-log/src/__test__/message.spec.js b/packages/geoadmin-log/src/__test__/message.spec.js
@@ -5,54 +5,76 @@ import { describe, it } from 'vitest'
 describe('Unit Tests for messages', () => {
     describe('checking equality between messages', () => {
         it('Ensure that errors with no sources are considered equal too when the rest is equal', () => {
-            const msg1 = new ErrorMessage('test text', {}, null)
-            const msg2 = new ErrorMessage('test text', {}, null)
-            const msg3 = new ErrorMessage('test text', { key1: 'value1', key2: 'value2' }, null)
-            const msg4 = new ErrorMessage('test text', { key1: 'value1', key2: 'value2' }, null)
+            const msg1 = new ErrorMessage({ msg: 'test text', params: {} })
+            const msg2 = new ErrorMessage({ msg: 'test text', params: {} })
+            const msg3 = new ErrorMessage({
+                msg: 'test text',
+                params: { key1: 'value1', key2: 'value2' },
+            })
+            const msg4 = new ErrorMessage({
+                msg: 'test text',
+                params: { key1: 'value1', key2: 'value2' },
+            })
             expect(msg1.isEquals(msg1)).to.equal(true)
             expect(msg1.isEquals(msg2)).to.equal(true)
             expect(msg3.isEquals(msg3)).to.equal(true)
             expect(msg3.isEquals(msg4)).to.equal(true)
         })
         it('detects equality and inequality between two messages', () => {
             // messages without parameter
-            const simpleTextMsg1 = new ErrorMessage('test text', {}, 'test_source_12345')
-            const copyOfimpleTextMsg1 = new ErrorMessage('test text', {}, 'test_source_12345')
-            const simpleTextMsg1OtherSource = new ErrorMessage('test text', {}, 'test_source_02345')
-            const simpleTextMsg2 = new ErrorMessage('Another test text', {}, 'test_source_12345')
+            const simpleTextMsg1 = new ErrorMessage({
+                msg: 'test text',
+                params: {},
+                sourceId: 'test_source_12345',
+            })
+            const copyOfimpleTextMsg1 = new ErrorMessage({
+                msg: 'test text',
+                params: {},
+                sourceId: 'test_source_12345',
+            })
+            const simpleTextMsg1OtherSource = new ErrorMessage({
+                msg: 'test text',
+                params: {},
+                sourceId: 'test_source_02345',
+            })
+            const simpleTextMsg2 = new ErrorMessage({
+                msg: 'Another test text',
+                params: {},
+                sourceId: 'test_source_12345',
+            })
 
             expect(simpleTextMsg1.isEquals(simpleTextMsg1)).to.be.true
             expect(simpleTextMsg1.isEquals(copyOfimpleTextMsg1)).to.be.true
             expect(simpleTextMsg1.isEquals(simpleTextMsg1OtherSource)).to.be.false // different source
             expect(simpleTextMsg1.isEquals(simpleTextMsg2)).to.be.false // different msg
 
             // messages with parameters
-            const paramMsg1 = new ErrorMessage(
-                'test text',
-                { key1: 'value1', key2: 'value2' },
-                'test_source_12345'
-            )
-            const copyOfParamMsg1 = new ErrorMessage(
-                'test text',
-                { key1: 'value1', key2: 'value2' },
-                'test_source_12345'
-            )
-            const paramMsg2 = new ErrorMessage(
-                'test text',
-                { key1: 'value2', key2: 'value2' },
-                'test_source_12345'
-            )
+            const paramMsg1 = new ErrorMessage({
+                msg: 'test text',
+                params: { key1: 'value1', key2: 'value2' },
+                sourceId: 'test_source_12345',
+            })
+            const copyOfParamMsg1 = new ErrorMessage({
+                msg: 'test text',
+                params: { key1: 'value1', key2: 'value2' },
+                sourceId: 'test_source_12345',
+            })
+            const paramMsg2 = new ErrorMessage({
+                msg: 'test text',
+                params: { key1: 'value2', key2: 'value2' },
+                sourceId: 'test_source_12345',
+            })
 
-            const paramMsg3 = new ErrorMessage(
-                'test text',
-                { key2: 'value1', key3: 'value2' },
-                'test_source_12345'
-            )
-            const paramMsg4 = new ErrorMessage(
-                'Another test text',
-                { key1: 'value1', key2: 'value2' },
-                'test_source_12345'
-            )
+            const paramMsg3 = new ErrorMessage({
+                msg: 'test text',
+                params: { key2: 'value1', key3: 'value2' },
+                sourceId: 'test_source_12345',
+            })
+            const paramMsg4 = new ErrorMessage({
+                msg: 'Another test text',
+                params: { key1: 'value1', key2: 'value2' },
+                sourceId: 'test_source_12345',
+            })
             expect(simpleTextMsg1.isEquals(paramMsg1)).to.be.false // empty params vs params
             expect(paramMsg1.isEquals(paramMsg1)).to.be.true
             expect(paramMsg1.isEquals(copyOfParamMsg1)).to.be.true
@@ -61,8 +83,8 @@ describe('Unit Tests for messages', () => {
             expect(paramMsg1.isEquals(paramMsg3)).to.be.false // different keys in params
         })
         it('ensure that acknowledement of a message does not change equality', () => {
-            const msg1 = new ErrorMessage('test', {}, null, false)
-            const msg2 = new ErrorMessage('test', {}, null, true)
+            const msg1 = new ErrorMessage({ msg: 'test', params: {}, isAcknowledged: false })
+            const msg2 = new ErrorMessage({ msg: 'test', params: {}, isAcknowledged: true })
             expect(msg1.isEquals(msg2)).to.be.true
         })
     })
diff --git a/packages/mapviewer/src/api/errorQueues.api.js b/packages/mapviewer/src/api/errorQueues.api.js
@@ -1,9 +1,12 @@
 import { ErrorMessage } from '@geoadmin/log/Message'
 
 export function getStandardErrorMessage(query, urlParamName) {
-    return new ErrorMessage('url_parameter_error', {
-        param: urlParamName,
-        value: query,
+    return new ErrorMessage({
+        msg: 'url_parameter_error',
+        params: {
+            param: urlParamName,
+            value: query,
+        },
     })
 }
 
diff --git a/packages/mapviewer/src/modules/drawing/DrawingModule.vue b/packages/mapviewer/src/modules/drawing/DrawingModule.vue
@@ -138,8 +138,11 @@ watch(availableIconSets, () => {
             const icon = getIcon(iconArgs, null /*iconStyle*/, availableIconSets.value, () => {
                 store.dispatch('addWarnings', {
                     warnings: [
-                        new WarningMessage('kml_icon_set_not_found', {
-                            iconSetName: iconArgs.set,
+                        new WarningMessage({
+                            msg: 'kml_icon_set_not_found',
+                            params: {
+                                iconSetName: iconArgs.set,
+                            },
                         }),
                     ],
                     ...dispatcher,
diff --git a/packages/mapviewer/src/modules/map/components/cesium/CesiumWMTSLayer.vue b/packages/mapviewer/src/modules/map/components/cesium/CesiumWMTSLayer.vue
@@ -15,11 +15,10 @@ import { getWmtsXyzUrl } from '@/utils/layerUtils'
 const dispatcher = { dispatcher: 'CesiumWMTSLayer.vue' }
 
 const MAXIMUM_LEVEL_OF_DETAILS = 18
-const unsupportedProjectionError = new ErrorMessage(
-    '3d_unsupported_projection',
-    {},
-    wmtsLayerConfig.id
-)
+const unsupportedProjectionError = new ErrorMessage({
+    msg: '3d_unsupported_projection',
+    sourceId: wmtsLayerConfig.id,
+})
 
 const { wmtsLayerConfig, zIndex, parentLayerOpacity } = defineProps({
     wmtsLayerConfig: {
diff --git a/packages/mapviewer/src/modules/map/components/openlayers/OpenLayersKMLLayer.vue b/packages/mapviewer/src/modules/map/components/openlayers/OpenLayersKMLLayer.vue
@@ -91,9 +91,12 @@ function iconUrlProxy(url) {
         (url) => {
             store.dispatch('addWarnings', {
                 warnings: [
-                    new WarningMessage('kml_icon_url_cors_issue', {
-                        layerName: layerName.value,
-                        url: url,
+                    new WarningMessage({
+                        msg: 'kml_icon_url_cors_issue',
+                        params: {
+                            layerName: layerName.value,
+                            url: url,
+                        },
                     }),
                 ],
                 ...dispatcher,
@@ -102,9 +105,12 @@ function iconUrlProxy(url) {
         (url) => {
             store.dispatch('addWarnings', {
                 warnings: [
-                    new WarningMessage('kml_icon_url_scheme_http', {
-                        layerName: layerName.value,
-                        url: url,
+                    new WarningMessage({
+                        msg: 'kml_icon_url_scheme_http',
+                        params: {
+                            layerName: layerName.value,
+                            url: url,
+                        },
                     }),
                 ],
                 ...dispatcher,
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/ImportFileOnlineTab.vue b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/ImportFileOnlineTab.vue
@@ -83,7 +83,9 @@ async function loadFile() {
         await handleFileSource(fileUrl.value, false)
         if (!fileUrl.value.match(/^https:\/\//)) {
             store.dispatch('addWarnings', {
-                warnings: [new WarningMessage('import_http_external_file_warning', {})],
+                warnings: [
+                    new WarningMessage({ msg: 'import_http_external_file_warning', params: {} }),
+                ],
                 dispatcher: 'Import File Online Tab',
             })
         }
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/KMLParser.class.js b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/KMLParser.class.js
@@ -74,8 +74,12 @@ export class KMLParser extends FileParser {
 
         if (!isKmlFeaturesValid(kmlAsText)) {
             kmlLayer.addWarningMessage(
-                new WarningMessage('kml_malformed', {
-                    filename: kmlLayer.name ?? kmlLayer.id,
+                new WarningMessage({
+                    msg: 'kml_malformed',
+                    params: {
+                        filename: kmlLayer.name ?? kmlLayer.id,
+                    },
+                    sourceId: kmlLayer.id,
                 })
             )
         }
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/errors/generateErrorMessageFromErrorType.utils.js b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/errors/generateErrorMessageFromErrorType.utils.js
@@ -15,13 +15,23 @@ import UnknownProjectionError from '@/modules/menu/components/advancedTools/Impo
  */
 export default function generateErrorMessageFromErrorType(error, layer) {
     if (error instanceof AxiosError || /fetch/.test(error.message)) {
-        return new ErrorMessage('loading_error_network_failure', {}, layer?.id)
+        return new ErrorMessage({
+            msg: 'loading_error_network_failure',
+            sourceId: layer?.id,
+        })
     } else if (error instanceof OutOfBoundsError) {
-        return new ErrorMessage('imported_file_out_of_bounds', {}, layer?.id)
+        return new ErrorMessage({
+            msg: 'imported_file_out_of_bounds',
+            sourceId: layer?.id,
+        })
     } else if (error instanceof EmptyFileContentError) {
-        return new ErrorMessage('kml_gpx_file_empty', {}, layer?.id)
+        return new ErrorMessage({ msg: 'kml_gpx_file_empty', sourceId: layer?.id })
     } else if (error instanceof UnknownProjectionError) {
-        return new ErrorMessage('unknown_projection_error', { epsg: error.epsg }, layer?.id)
+        return new ErrorMessage({
+            msg: 'unknown_projection_error',
+            params: { epsg: error.epsg },
+            sourceId: layer?.id,
+        })
     }
-    return new ErrorMessage('invalid_import_file_error', {}, layer?.id)
+    return new ErrorMessage({ msg: 'invalid_import_file_error', sourceId: layer?.id })
 }
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/useImportFile.composable.js b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/useImportFile.composable.js
@@ -43,8 +43,12 @@ export default function useImportFile() {
                     projection.value.bounds.isInBounds(extent[2], extent[3])
                 if (!isLayerFullyInBound) {
                     layer.addWarningMessage(
-                        new WarningMessage('file_imported_partially_out_of_bounds', {
-                            filename: layer.name ?? layer.id,
+                        new WarningMessage({
+                            msg: 'file_imported_partially_out_of_bounds',
+                            params: {
+                                filename: layer.name ?? layer.id,
+                            },
+                            sourceId: layer.id,
                         })
                     )
                 }
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/MenuAdvancedToolsList.vue b/packages/mapviewer/src/modules/menu/components/advancedTools/MenuAdvancedToolsList.vue
@@ -45,7 +45,7 @@ function onToggleCompareSlider() {
 
     if (hasNoVisibleLayer.value) {
         store.dispatch('addWarnings', {
-            warnings: [new WarningMessage('no_layers_info_compare')],
+            warnings: [new WarningMessage({ msg: 'no_layers_info_compare' })],
             ...dispatcher,
         })
     }
diff --git a/packages/mapviewer/src/router/storeSync/LayerParamConfig.class.js b/packages/mapviewer/src/router/storeSync/LayerParamConfig.class.js
@@ -277,11 +277,17 @@ function validateUrlInput(store, query) {
         .filter((layer) => !store.getters.getLayerConfigById(layer.id))
         .forEach((layer) => {
             if (!layer.baseUrl) {
-                faultyLayers.push(new ErrorMessage('url_layer_error', { layer: layer.id }))
+                faultyLayers.push(
+                    new ErrorMessage({ msg: 'url_layer_error', params: { layer: layer.id } })
+                )
             } else if (!layer.baseUrl?.match(url_matcher)?.length > 0) {
                 localLayers.push(
-                    new WarningMessage('url_external_layer_no_scheme_warning', {
-                        layer: `${layer.type}|${layer.baseUrl}`,
+                    new WarningMessage({
+                        msg: 'url_external_layer_no_scheme_warning',
+                        params: {
+                            layer: `${layer.type}|${layer.baseUrl}`,
+                        },
+                        sourceId: layer.baseUrl,
                     })
                 )
             }
diff --git a/packages/mapviewer/src/router/storeSync/TimeSliderParamConfig.class.js b/packages/mapviewer/src/router/storeSync/TimeSliderParamConfig.class.js
@@ -21,7 +21,7 @@ function dispatchTimeSliderFromUrlParam(to, store, urlParamValue) {
                 dispatcher: STORE_DISPATCHER_ROUTER_PLUGIN,
             })
         )
-        if (store.getters.visibleLayers.some(layer => layer.hasMultipleTimestamps)) {
+        if (store.getters.visibleLayers.some((layer) => layer.hasMultipleTimestamps)) {
             promisesForAllDispatch.push(
                 store.dispatch('setTimeSliderActive', {
                     timeSliderActive: true,
@@ -52,7 +52,7 @@ function validateUrlInput(store, query) {
             validationObject.warnings = []
         }
         validationObject.warnings.push(
-            new WarningMessage('time_slider_no_time_layer_active_url_warning', {})
+            new WarningMessage({ msg: 'time_slider_no_time_layer_active_url_warning' })
         )
     }
     return validationObject
diff --git a/packages/mapviewer/src/store/modules/layers.store.js b/packages/mapviewer/src/store/modules/layers.store.js
@@ -805,8 +805,10 @@ const actions = {
                 clone.isLoading = false
 
                 // Always clean up the error messages before doing the check
-                const emptyFileErrorMessage = new ErrorMessage('kml_gpx_file_empty')
-                const outOfBoundsErrorMessage = new ErrorMessage('imported_file_out_of_bounds')
+                const emptyFileErrorMessage = new ErrorMessage({ msg: 'kml_gpx_file_empty' })
+                const outOfBoundsErrorMessage = new ErrorMessage({
+                    msg: 'imported_file_out_of_bounds',
+                })
                 clone.removeErrorMessage(emptyFileErrorMessage)
                 clone.removeErrorMessage(outOfBoundsErrorMessage)
 
diff --git a/packages/mapviewer/src/store/modules/ui.store.js b/packages/mapviewer/src/store/modules/ui.store.js
@@ -466,12 +466,12 @@ export default {
                 )
             }
             if (state.errors.has(error)) {
-                const acknowledgedError = new ErrorMessage(
-                    error.msg,
-                    error.params,
-                    error.sourceId,
-                    true
-                )
+                const acknowledgedError = new ErrorMessage({
+                    msg: error.msg,
+                    params: error.params,
+                    sourceId: error.sourceId,
+                    isAcknowledged: true,
+                })
                 commit('removeError', { error, dispatcher })
                 commit('addErrors', { errors: [acknowledgedError], dispatcher })
             }
@@ -502,12 +502,12 @@ export default {
                 )
             }
             if (state.warnings.has(warning)) {
-                const acknowledgedWarning = new WarningMessage(
-                    warning.msg,
-                    warning.params,
-                    warning.sourceId,
-                    true
-                )
+                const acknowledgedWarning = new WarningMessage({
+                    msg: warning.msg,
+                    params: warning.params,
+                    sourceId: warning.sourceId,
+                    isAcknowledged: true,
+                })
                 commit('removeWarning', { warning, dispatcher })
                 commit('addWarnings', { warnings: [acknowledgedWarning], dispatcher })
             }
diff --git a/packages/mapviewer/src/store/plugins/external-layers.plugin.js b/packages/mapviewer/src/store/plugins/external-layers.plugin.js
@@ -112,7 +112,7 @@ async function updateExternalLayer(store, capabilities, layer, projection) {
         return updated
     } catch (error) {
         log.error(`Failed to update external layer ${layer.id}: `, error)
-        const errorMessage = new ErrorMessage(error.key ?? 'error', {}, layer.id)
+        const errorMessage = new ErrorMessage({ msg: error.key ?? 'error', sourceId: layer.id })
         store.dispatch('addLayerError', {
             layerId: layer.id,
             isExternal: layer.isExternal,
diff --git a/packages/mapviewer/src/store/plugins/geolocation-management.plugin.js b/packages/mapviewer/src/store/plugins/geolocation-management.plugin.js
diff --git a/packages/mapviewer/src/store/plugins/load-geojson-style-and-data.plugin.js b/packages/mapviewer/src/store/plugins/load-geojson-style-and-data.plugin.js
diff --git a/packages/mapviewer/src/store/plugins/load-gpx-data.plugin.js b/packages/mapviewer/src/store/plugins/load-gpx-data.plugin.js
diff --git a/packages/mapviewer/src/store/plugins/load-kml-kmz-data.plugin.js b/packages/mapviewer/src/store/plugins/load-kml-kmz-data.plugin.js

Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,12 @@ export class KMLParser extends FileParser {`
`74`	`74`
`75`	`75`	`if (!isKmlFeaturesValid(kmlAsText)) {`
`76`	`76`	`kmlLayer.addWarningMessage(`
`77`		`- new WarningMessage('kml_malformed', {`
`78`		`- filename: kmlLayer.name ?? kmlLayer.id,`
	`77`	`+ new WarningMessage({`
	`78`	`+ msg: 'kml_malformed',`
	`79`	`+ params: {`
	`80`	`+ filename: kmlLayer.name ?? kmlLayer.id,`
	`81`	`+ },`
	`82`	`+ sourceId: kmlLayer.id,`
`79`	`83`	`})`
`80`	`84`	`)`
`81`	`85`	`}`