fix(router-plugin): serialize entered URL and compare with the recognized one

[arturovt]

PR Checklist

• The commit message follows our guidelines: https://github.com/ngxs/store/blob/master/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

[x] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #1153

What is the new behavior?

location.pathname is concatenated with location.search as it has to be.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

[arturovt]

@splincode @markwhitfeld

Just a small bugfix.

[splincode]

Test?)

[arturovt]

Test?)

if (isAngularInTestMode()) {
  return;
}

?

[splincode]

I mean, can you write tests?

[markwhitfeld]

Thanks @arturovt!
Just a thought, could this be done using this method instead?
https://angular.io/api/common/Location#iscurrentpathequalto
This could make it more resilient around urls that are the same but differ in small aspects like some url encoded characters. Really unfamiliar with this API though, so this is a guess.

[markwhitfeld]

Oh, and can you remember what this code was a workaround for?

if (isAngularInTestMode()) {
  return;
}

If it was around protecting against no window.location in nodejs (jest) then we have fixed that shortfall by using PlatformLocation.

[arturovt]

Thanks @arturovt!
Just a thought, could this be done using this method instead?
https://angular.io/api/common/Location#iscurrentpathequalto
This could make it more resilient around urls that are the same but differ in small aspects like some url encoded characters. Really unfamiliar with this API though, so this is a guess.

Let me check tomorrow.

[arturovt]

@markwhitfeld

The problem of isCurrentPathEqualTo is that we basically compare the entered URL with itself, like:

// entered in the search bar
const url = '/path';
if (url === url) {
  ... do stuff
}

So this code:

 const currentUrl = `${this._platformLocation.pathname}${this._platformLocation.search}`;
if (this._location.isCurrentPathEqualTo(currentUrl)) {
  // ...
}

Is not valid, because Angular compares pathname + search with pathname + search, because isCurrentPathEqualTo uses PlatformLocation under the hood.

By using the url from the RoutesRecognized event - we're comparing the recognized one URL.

If we'd use isCurrentPathEqualTo - that means that if the user enters /path in the address bar - but router plugin recognized another URL - the user will be redirected to the previously saved URL.

We could use isCurrentPathEqualTo with the recognized URL, but the behavior will be the same...
I can re-write this code, this is not a problem.

[markwhitfeld]

@arturovt Are you saying that we could write it as:

if (this._location.isCurrentPathEqualTo(url)) {
  // ...
}

[markwhitfeld]

LGTM. Nicely done!