PB-2064: fix map ready state parsed legacy state

Author: sommerfe

packages/viewer/src/router/legacyPermalink.routerPlugin.ts

@@ -30,6 +30,8 @@ import {
     isLegacyParams,
 } from '@/utils/legacyLayerParamUtils'
 
+const dispatcher = { name: 'legacyPermalinkRouterPlugin' }
+
 function toNumber(input: string | number): number {
     return typeof input === 'number' ? input : parseFloat(input)
 }
@@ -180,7 +182,7 @@ export function handleLegacyParam(
             newValue = legacyParamValue
             break
     }
-
+    console.log('handleLegacyParam', legacyParamName, legacyParamValue, key, newValue)
     if (newValue !== undefined) {
         // When receiving a query, the application will encode the URI components
         // We decode those so that the new query won't encode encoded character
@@ -449,7 +451,9 @@ export const legacyPermalinkManagementRouterPlugin: RouterPlugin = (router): voi
                                         titleColor: LogPreDefinedColor.Amber,
                                         messages: [`redirect to the converted params`, newRoute],
                                     })
-                                    router.replace(newRoute).catch((error) => {
+                                    router.replace(newRoute).then(() => {
+                                        useAppStore().setLegacyUrlParamsParsedHasHappened(dispatcher)
+                                    }).catch((error) => {
                                         log.error({
                                             title: 'Legacy URL',
                                             titleColor: LogPreDefinedColor.Amber,

packages/viewer/src/store/modules/app/actions/setLegacyUrlParamsParsingHasHappened.ts

@@ -0,0 +1,9 @@
+import type { AppStore } from '@/store/modules/app/types/app'
+import type { ActionDispatcher } from '@/store/types'
+
+export default function setLegacyUrlParamsParsedHasHappened(
+    this: AppStore,
+    dispatcher: ActionDispatcher
+) {
+    this.legacParamsParsingHasHappened = true
+}

packages/viewer/src/store/modules/app/index.ts

@@ -5,6 +5,7 @@ import type { AppStoreGetters, AppStoreState } from '@/store/modules/app/types/a
 import nextState from '@/store/modules/app/actions/nextState'
 import setHasPendingUrlParsing from '@/store/modules/app/actions/setHasPendingUrlParsing'
 import setInitialUrlParsingHasHappened from '@/store/modules/app/actions/setInitialUrlParsingHasHappened'
+import setLegacyUrlParamsParsedHasHappened from '@/store/modules/app/actions/setLegacyUrlParamsParsingHasHappened'
 import isConfigLoaded from '@/store/modules/app/getters/isConfigLoaded'
 import isCurrentStateFulfilled from '@/store/modules/app/getters/isCurrentStateFulfilled'
 import isLoadingConfig from '@/store/modules/app/getters/isLoadingConfig'
@@ -51,7 +52,10 @@ const initiateUrlParsing: AppState = {
 
 const parseLegacyUrlParams: AppState = {
     name: AppStateNames.LegacyParsing,
-    isFulfilled: () => !isLegacyParams(window?.location?.search),
+    // legacParamsParsingHasHappened is necessary to reevaluate after the legacy parsing has happened, without it, 
+    // isFulfilled would always return false/true after the first time
+    // it also has to be the first condition because the && operator is short-circuiting
+    isFulfilled: () => useAppStore().legacParamsParsingHasHappened && !isLegacyParams(window?.location?.search),
     next: () => {
         return initiateUrlParsing
     },
@@ -89,6 +93,7 @@ const state = (): AppStoreState => ({
     appState: initializing,
     initialUrlParsingHasHappened: false,
     hasPendingUrlParsing: false,
+    legacParamsParsingHasHappened: false,
 })
 
 const getters: AppStoreGetters = {
@@ -105,6 +110,7 @@ const actions = {
     nextState,
     setHasPendingUrlParsing,
     setInitialUrlParsingHasHappened,
+    setLegacyUrlParamsParsedHasHappened,
 }
 
 const useAppStore = defineStore('app', {

packages/viewer/src/store/modules/app/types/app.ts

@@ -4,6 +4,7 @@ import type { AppState } from '@/store/modules/app/types/appState'
 export interface AppStoreState {
     appState: AppState
     initialUrlParsingHasHappened: boolean
+    legacParamsParsingHasHappened: boolean
     hasPendingUrlParsing: boolean
 }
 export type AppStoreGetters = {