fix(vue): replacing routes now updates location state correctly

[liamdebeasi]

Pull request checklist

Please check if your PR fulfills the following requirements:

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Build (npm run build) was run locally and any changes were pushed
• Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Build related changes
• Documentation content changes
• Other (please describe):

What is the current behavior?

Issue Number: resolves #24432

There are a few related issues:

1. When the incoming route had routeAction === 'replace' Ionic Vue would determine the leaving location by getting the second to last item in location history. This was fine when popping would remove items from location history automatically (I.e. what Ionic React does), but when you support router.go(n) you cannot do that. As a result, the locationHistory.previous() call was not always returning the correct previous route based on where the user was in location history.

2. The routeInfo.tab === undefined check was actually a bandaid for an issue I had run into when calling the old updateByHistoryPosition method (See:

   ionic-framework/packages/vue-router/src/router.ts

   Line 294 in a09d7d4

   locationHistory.updateByHistoryPosition(routeInfo, !hasDeltaStride);

   ). However, it was later determined in 0b18260 that this was not the correct solution for the problem that it tried to solve. Now that we have the correct solution in place, this bandaid is no longer needed.

3. When re-writing history, Ionic Vue never considered the case where you wanted to replace the current state of the route with another route and as a result, the location history was not being updated/wiped appropriately. This worked fine when you navigated backwards and then did a router.replace, but if you just did a router.replace on its own, location history did not update properly.

What is the new behavior?

• Removed the .previous method in favor of calling .current which takes into account your location within history. I also removed the previous method in general as it is no longer used in the codebase.
• Removed the routeInfo.tab bandaid.
• Added a check to account for when doing router.replace in order to determine if we should wipe the location history.
• Unrelated to the PR, but there was a stray cy.wait that was not needed. I removed that.

Does this introduce a breaking change?

• Yes
• No

Other information

[liamdebeasi]

One thing I am still trying to figure out is if we should be clearing out the tabs history at all when we call clearHistory? https://github.com/ionic-team/ionic-framework/blob/main/packages/vue-router/src/router.ts#L358

When clearing out location history, maybe we could get a list of the cleared routes and remove those same routes from the tabs history? Might be a bit of a performance overhead, but I worry that simply clearing out tabs history will cause unexpected issues down the road.

Going to investigate this more prior to merge, but let me know if you have any thoughts.

[amandaejohnston]

This LGTM 👍 Re: clearing out tabs, I'm hesitant to touch more than needed at once with router stuff; LMK if your investigation turns up anything but I'd want a strong repro/use case before forming opinions.

[liamdebeasi]

Agreed. I couldn't think of a use case where this is relevant. I am in favor of leaving it alone for now until we get feedback from the community.

[sean-perkins]

Looks good to me. Agreed the discussion regarding leaving tabs alone for now.