Fix an issue when reloading a KML with adminId

with the new KML data approach, and as we do not have the metadata of the layer at app startup, the URL param parser couldn't figure out if the drawing module should be shown or not (because of a protection against legacy KML layer being loaded at startup)

So instead I've completely removed any adminId passthrough when parsing legacy KML layer, this way they are never given to the "modern" app, and will not be modified by web-mapviewer (that was the goal of this protection)

Author: pakb

src/router/legacyPermalinkManagement.routerPlugin.js

@@ -176,7 +176,11 @@ const handleLegacyParams = (legacyParams, store, to, next) => {
     const urlWithoutQueryParam = window.location.href.substr(0, window.location.href.indexOf('?'))
     window.history.replaceState(window.history.state, document.title, urlWithoutQueryParam)
 
-    if ('adminId' in legacyParams) {
+    // TODO BGDIINF_SB-2685: re-activate once on prod
+    //  we cannot let adminId get through right now because legacy KML will be broken by the new viewer if edited
+    //  (broken in a sense that they will not be usable by mf-geoadmin3 anymore)
+    const absolutelyNot = () => false
+    if (absolutelyNot() && 'adminId' in legacyParams) {
         // adminId legacy param cannot be handle above in the loop because it needs to add a layer
         // to the layers param, thats why we do handle after.
         handleLegacyKmlAdminIdParam(legacyParams, newQuery)

src/router/storeSync/LayerParamConfig.class.js

@@ -1,6 +1,6 @@
+import ExternalGroupOfLayers from '@/api/layers/ExternalGroupOfLayers.class'
 import ExternalWMSLayer from '@/api/layers/ExternalWMSLayer.class'
 import ExternalWMTSLayer from '@/api/layers/ExternalWMTSLayer.class'
-import ExternalGroupOfLayers from '@/api/layers/ExternalGroupOfLayers.class'
 import KMLLayer from '@/api/layers/KMLLayer.class'
 import LayerTypes from '@/api/layers/LayerTypes.enum'
 import AbstractParamConfig from '@/router/storeSync/abstractParamConfig.class'
@@ -153,11 +153,7 @@ function dispatchLayersFromUrlIntoStore(store, urlParamValue) {
             )
         ) {
             const layerObject = createLayerObject(parsedLayer)
-            if (
-                layerObject.type === LayerTypes.KML &&
-                layerObject.adminId &&
-                !layerObject.isLegacy() // TODO BGDIINF_SB-2685: remove once on prod
-            ) {
+            if (layerObject.type === LayerTypes.KML && layerObject.adminId) {
                 promisesForAllDispatch.push(store.dispatch('setShowDrawingOverlay', true))
             }
             log.debug(`  Add layer ${parsedLayer.id} to active layers`, layerObject)

tests/e2e-cypress/integration/importTool.cy.js

@@ -47,8 +47,8 @@ describe('The Import Tool', () => {
         cy.get('[data-cy="import-add-layer-button"]').should('be.visible')
         cy.get('[data-cy="import-result-list"]').children().should('have.length', 3).first().click()
         cy.wait('@wms-get-map')
+        cy.readStoreValue('state.layers.activeLayers').should('be.empty')
         cy.get('[data-cy="import-add-layer-button"]').click()
-        cy.wait('@wms-get-map')
         cy.readStoreValue('state.layers.activeLayers').then((activeLayers) => {
             expect(activeLayers).to.be.an('Array').length(1)
             const externalLayer = activeLayers[0]

tests/e2e-cypress/integration/legacyParamImport.cy.js

@@ -132,7 +132,8 @@ describe('Test on legacy param import', () => {
                 expect(kmlLayer.visible).to.be.true
             })
         })
-        it('is able to import an external KML from a legacy adminId query param', () => {
+        // TODO BGDIINF_SB-2685: re-activate
+        it.skip('is able to import an external KML from a legacy adminId query param', () => {
             cy.goToMapView({
                 adminId: adminId,
             })
@@ -147,7 +148,8 @@ describe('Test on legacy param import', () => {
                 expect(kmlLayer.adminId).to.equal(adminId)
             })
         })
-        it("don't keep KML adminId in URL after import", () => {
+        // TODO BGDIINF_SB-2685: re-activate
+        it.skip("don't keep KML adminId in URL after import", () => {
             cy.goToMapView({
                 adminId: adminId,
             })
@@ -163,7 +165,8 @@ describe('Test on legacy param import', () => {
             })
             cy.url().should('not.contain', adminId)
         })
-        it('is able to import an external KML from a legacy adminId query param with other layers', () => {
+        // TODO BGDIINF_SB-2685: re-activate
+        it.skip('is able to import an external KML from a legacy adminId query param with other layers', () => {
             cy.goToMapView({
                 adminId: adminId,
                 layers: 'test.wms.layer,test.wmts.layer',

tests/e2e-cypress/support/drawing.js

@@ -124,7 +124,11 @@ Cypress.Commands.add('goToDrawing', (queryParams = {}, withHash = false) => {
     cy.readWindowValue('map')
         .then((map) => map.getOverlays().getLength())
         .as('nbOverlaysAtBeginning')
-    cy.openDrawingMode()
+    // opening the drawing mode if no KML with adminId defined in the URL
+    // (otherwise, the drawing mode will be opened by default, no need to open it)
+    if (!queryParams.layers || queryParams.layers.indexOf('@adminId=') === -1) {
+        cy.openDrawingMode()
+    }
     cy.readStoreValue('state.ui.showDrawingOverlay').should('be.true')
     cy.waitUntilState((state) => state.drawing.iconSets.length > 0)
 })