Configured route redirect does not propagate query string

[rmja]

I'm submitting a bug report

• Library Version:
  1.5.0

Please tell us about your environment:

• Operating System:
  Windows 10

• Node Version:
  14.6.0

• NPM Version:
  6.14.8

• JSPM OR Webpack AND Version
  webpack 4

• Browser:
  all

• Language:
  all

Current behavior:
The following route configuration does not propagate the query string to the redirected route:

const routes: RouteConfig[] = [
    { route: "does-not-work", redirect: "/dashboard?autoselect=true"; },
    { route: "does-work", navigationStrategy: instruction => { instruction.config.redirect = "/dashboard"; instruction.queryString = "autoselect=true"; } },
    { route: "dashboard", name: "dashboard", moduleId: PLATFORM.moduleName("./dashboard")  }
];

Expected/desired behavior:

• What is the expected behavior?
  The route "does-not-work" should have the behavior of "does-work".
  The issue is related to this code:

router/src/navigation-plan.ts

Lines 81 to 84 in 9ba6ef3

	let queryString = instruction.queryString;
	if (queryString) {
	redirectLocation += '?' + queryString;
	}

I believe the behavior should be more like instruction.queryString || redirectInstruction.queryString

• What is the motivation / use case for changing the behavior?
  Easier configuration of redirect route

[rmja]

Is there an update on this? The fix seems really easy.

The error is shown specifically when using aurelia-open-id-connect, where the redirect route is assigned here: https://github.com/aurelia-contrib/aurelia-open-id-connect/blob/master/src/open-id-connect-navigation-strategies.ts#L86. For example:

instruction.config.redirect = "/dashboard?some-parameter=123";

The redirect route may contain query parameters, which are then later stripped by the router during the redirect because of this issue.

To make this work, we either need an update to the router here so that it retains the query parameters (preferred), or an update to aurelia-open-id-connect so that it assigns the query parameters to the instruction in addition to the redirect - this seems wrong.

[rmja]

It seems that there is a PR for a fix here #643
cc @bigopon

[rmja]

Related to #639