Merge pull request #99 from Dataport/fix/improve-robustness-on-miscon…

…figuration improve robustness on misconfiguration
Dataport · Feb 5, 2024 · d72fb34 · d72fb34
2 parents ec0e4a0 + 3648aef
commit d72fb34
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 30 deletions.
diff --git a/packages/plugins/LayerChooser/CHANGELOG.md b/packages/plugins/LayerChooser/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## unpublished
+
+- Fix: The LayerChooser plugin will keep working on the error that a layer without entry in the service register has been configured. The layer will not be displayed.
+- Fix: An outdated warning has been removed.
+
 ## 1.2.0
 
 - Feature: Improved implementation to make plugin SPA-ready.

diff --git a/packages/plugins/LayerChooser/src/store/index.ts b/packages/plugins/LayerChooser/src/store/index.ts
@@ -5,6 +5,7 @@ import {
 import {
   LayerConfiguration,
   LayerConfigurationOptionLayers,
+  MapConfig,
   PolarModule,
 } from '@polar/lib-custom-types'
 import * as masterportalapi from '@masterportal/masterportalapi/src'
@@ -28,6 +29,36 @@ export const getInitialState = (): LayerChooserState => ({
   activeLayerIds: {},
 })
 
+const getBackgroundsAndMasks = (
+  configuration: MapConfig
+): [LayerConfiguration[], LayerConfiguration[]] =>
+  configuration.layers.reduce(
+    ([backgrounds, masks], current) => {
+      const rawLayer = masterportalapi.rawLayerList.getLayerWhere({
+        id: current.id,
+      })
+
+      if (rawLayer === null) {
+        console.error(
+          `@polar/plugin-layer-chooser: Layer ${current.id} not found in service register. This is a configuration issue. The map might behave in unexpected ways.`,
+          current
+        )
+
+        return [backgrounds, masks]
+      }
+      if (current.type === 'background') {
+        return [[...backgrounds, current], masks]
+      } else if (current.type === 'mask') {
+        return [backgrounds, [...masks, current]]
+      }
+      console.error(
+        `@polar/plugin-layer-chooser: Unknown layer type ${current.type}. Layer is ignored by plugin.`
+      )
+      return [backgrounds, masks]
+    },
+    [[] as LayerConfiguration[], [] as LayerConfiguration[]]
+  )
+
 // OK for module creation
 // eslint-disable-next-line max-lines-per-function
 export const makeStoreModule = () => {
@@ -41,20 +72,7 @@ export const makeStoreModule = () => {
         commit,
         dispatch,
       }): void {
-        const [backgrounds, masks] = configuration.layers.reduce(
-          ([backgrounds, masks], current) => {
-            if (current.type === 'background') {
-              return [[...backgrounds, current], masks]
-            } else if (current.type === 'mask') {
-              return [backgrounds, [...masks, current]]
-            }
-            console.error(
-              `@polar/plugin-layer-chooser: Unknown layer type ${current.type}. Layer is ignored by plugin.`
-            )
-            return [backgrounds, masks]
-          },
-          [[] as LayerConfiguration[], [] as LayerConfiguration[]]
-        )
+        const [backgrounds, masks] = getBackgroundsAndMasks(configuration)
 
         // at most one background, arbitrarily many masks
         const activeBackground = backgrounds.find(
@@ -68,7 +86,6 @@ export const makeStoreModule = () => {
         dispatch('setActiveMaskIds', asIdList(activeMasks))
 
         dispatch('updateActiveAndAvailableLayersByZoom')
-
         map.on('moveend', () =>
           dispatch('updateActiveAndAvailableLayersByZoom')
         )
@@ -78,17 +95,6 @@ export const makeStoreModule = () => {
             id: layer.id,
           })
 
-          if (rawLayer.typ !== 'WMS' && !layer.hideInMenu) {
-            console.warn(
-              `@polar/plugin-layer-chooser: Used configuration 'layers' on layer with type '${
-                rawLayer.typ
-              }', but only 'WMS' is supported. Ignoring configuration for ${JSON.stringify(
-                rawLayer
-              )}.`
-            )
-            return
-          }
-
           // Store preparation needed when `layers` is an option
           if (layer.options?.layers) {
             commit('setActiveLayerIds', {

diff --git a/packages/plugins/Legend/CHANGELOG.md b/packages/plugins/Legend/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## unpublished
+
+- Fix: The Legend plugin will keep working on the error that a layer without entry in the service register has been configured.
+
 ## 1.1.0
 
 - Feature: Locale string layer names are now translated.

diff --git a/packages/plugins/Legend/src/components/Legend.vue b/packages/plugins/Legend/src/components/Legend.vue
@@ -94,10 +94,19 @@ export default Vue.extend({
             id: layer.id,
           }),
         }))
-        .map((layer) => ({
-          ...layer,
-          legendUrl: masterportalapi.layerLib.getLegendURLs(layer.rawLayer)[0],
-        }))
+        .map((layer) => {
+          if (layer.rawLayer === null) {
+            // skip undefined layers
+            console.warn(`@polar/plugin-legend: Unknown layer.`, layer)
+            return {}
+          }
+          return {
+            ...layer,
+            legendUrl: masterportalapi.layerLib.getLegendURLs(
+              layer.rawLayer
+            )[0],
+          }
+        })
         .filter((layer) => layer.name && layer.legendUrl)
     },
   },