yew_router::attach_route_listener Event listener provides previuos route instead of current

[voidpumpkin]

Problem
yew_router::attach_route_listener Event listener provides previuos route isntead of current

Originally noticed in #2109

Steps To Reproduce
Steps to reproduce the behavior:
Use this repo: https://github.com/voidpumpkin/yew-playground/tree/stale-agents
Everytime you click a link, console shows got X and X is previous route instead of current

Expected behavior
expected to get current route

Screenshots

Environment:

• Yew version: [master]
• Rust version: [1.55]
• Target, if relevant: -
• Build tool, if relevant: -
• OS, if relevant: -
• Browser and version, if relevant: -

Questionnaire

• I'm interested in fixing this myself but don't know where to start
• I would like to fix and I have a solution
• I don't have time to fix this right now, but maybe later

[futursolo]

I have encountered this problem a couple days ago as well.

The root cause of this problem is that attach_route_listener is a simple event listener that listens to popstate event which the same event is used for updating the route by the router so the callback can be called before the route is updated.

This can be mitigated by using Route::recognize() before a fix is available.

This can be fixed by making current route to be provided as a context value instead of held in a thread_local!.

This is the approach that react-router is using and it also enables rendering in a non-browser environment which could also be beneficial to the upcoming SSR.

I have updated the proposal in #2113 to make <Router /> a context provider.

[voidpumpkin]

@futursolo let me know how I can help with providing the needed changes. I saw you have most of it done in your PR?

[futursolo]

@voidpumpkin Thank you.

For now I am trying to get #2107 landed so I can continue working on it as my fork has changes in this PR on master.

[voidpumpkin]

Fixed by #2118