[go_router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new] #8352

ahyangnb · 2024-12-28T07:57:20Z

the old pr #6953

Change the 3 files of lib and add a example, because issue flutter/flutter#150312

The reason for the issue is when call counterStream.increment(); will notify notifyListeners() of StreamListener, and finally affect _handleRouteInformationProviderNotification of _RouterState in packages/flutter/lib/src/widgets/router.dart.

When pop should not call _handleRouteInformationProviderNotification otherwise will be path wrong.
because the value of GoRouteInformationProvider is not the latest.

Solution:

always make the value of GoRouteInformationProvider knew the latest RouteInformation[but not to do notifyListeners()].

i don't know if adding pop to NavigatingType is reasonable, if any place needs to be changed please tell me.

Result:

After changed, the issue been solved and all the others pop not be affect such as drawer/dialog/bottomsheet, See the video below.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene page, which explains my responsibilities.
I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
I signed the CLA.
The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
I linked to at least one issue that this PR fixes in the description above.

flutter/flutter#150312

I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.

exempt from version changes

I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style, or this PR is exempt from CHANGELOG changes.

this PR is exempt from CHANGELOG changes.

I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.

this PR is test-exempt.

All existing and new tests are passing.

the go_route_test.dart will error if testWidgets('throw if redirect to itself')[I have this problem when I pull the online branch. it's not relate this PR, All of the others test success, So I view this as all test cases successfully passing.]

Exception has occurred.
_AssertionError ('package:go_router/src/parser.dart': Failed assertion: line 110 pos 18: '!matchList.last.route.redirectOnly': A redirect-only route must redirect to location different from itself.
 The offending route: GoRoute#0ae4e(name: null, path: "route", Redirect Only))

flutter-dashboard · 2024-12-28T07:57:24Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

ahyangnb · 2024-12-28T08:05:42Z

example code:
packages/packages/go_router/example/lib/stream_listener_router.dart

which contain test pop the drawer/dialog/bottomsheet.

ahyangnb · 2024-12-28T08:17:19Z

after_changed

after_changed.MP4

ahyangnb · 2024-12-28T08:18:27Z

before_change

before_change.MP4

packages/go_router/lib/src/information_provider.dart

packages/go_router/lib/src/parser.dart

ahyangnb · 2025-01-09T11:00:26Z

@chunhtai , it's already been updated.

ahyangnb · 2025-01-22T02:14:51Z

The unit test related to this issue has already been committed.

…wline at the end of the file. Try adding a newline at the end of the file. • eol_at_end_of_file"

packages/go_router/example/lib/stream_listener_router.dart

chunhtai

besides the unaddressed comment, this change LGTM

packages/go_router/CHANGELOG.md

hannah-hyj · 2025-05-28T22:40:54Z

LGTM with some nit comments

…he same time doesn't update the URL on web.

ahyangnb · 2025-06-09T08:35:44Z

okay, it's all updated

@chunhtai @hannah-hyj

hannah-hyj

LGTM

ahyangnb · 2025-06-11T01:59:10Z

how do we makes the pr as merged?

Piinks · 2025-06-18T18:51:57Z

Hey @ahyangnb, updating the merge conflict here should put this in a mergable state so we can finally land it. 🎊

Piinks · 2025-06-18T18:55:08Z

Let me see if I can update it so we can get this merged

…e same time doesn't update the URL on web [new] (flutter/packages#8352)

flutter/packages@715a0a5...0ec4053 2025-06-19 [email protected] Roll Flutter from 8303a96 to 85a9b4f (93 revisions) (flutter/packages#9457) 2025-06-19 [email protected] [go_router] Update sype safe routing topic to use mixin from go_router_builder 3.0.0 (flutter/packages#9422) 2025-06-19 [email protected] [go_router] fix: PopScope.onPopInvokedWithResult not called in branch routes (flutter/packages#9245) 2025-06-18 [email protected] [pigeon] Create a message call free InstanceManager when running unit tests (flutter/packages#9395) 2025-06-18 [email protected] [go_router] Use library prefix for meta (flutter/packages#9434) 2025-06-18 [email protected] [go_router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new] (flutter/packages#8352) 2025-06-18 [email protected] [camera_avfoundation] Fix incorrect types in image stream events (flutter/packages#9418) 2025-06-18 [email protected] [go_router_builder] Temporarily restrict `build` (flutter/packages#9453) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…ime doesn't update the URL on web [new] (flutter#8352) > the old pr flutter#6953 Change the 3 files of lib and add a example, because issue flutter/flutter#150312 The reason for the issue is when call `counterStream.increment();` will notify `notifyListeners()` of `StreamListener`, and finally affect `_handleRouteInformationProviderNotification` of` _RouterState` in `packages/flutter/lib/src/widgets/router.dart`. When pop should not call `_handleRouteInformationProviderNotification` otherwise will be path wrong. because the value of `GoRouteInformationProvider` is not the latest. ## Solution: always make the value of `GoRouteInformationProvider` knew the latest `RouteInformation`[but not to do `notifyListeners()`]. i don't know if adding `pop` to `NavigatingType` is reasonable, if any place needs to be changed please tell me. ## Result: After changed, the issue been solved and all the others pop not be affect such as drawer/dialog/bottomsheet, See the video below. > flutter/flutter#150312 > exempt from version changes > this PR is exempt from CHANGELOG changes. > this PR is test-exempt. > the `go_route_test.dart` will error if `testWidgets('throw if redirect to itself')`[I have this problem when I pull the online branch. it's not relate this PR, All of the others test success, So I view this as all test cases successfully passing.] ``` Exception has occurred. _AssertionError ('package:go_router/src/parser.dart': Failed assertion: line 110 pos 18: '!matchList.last.route.redirectOnly': A redirect-only route must redirect to location different from itself. The offending route: GoRoute#0ae4e(name: null, path: "route", Redirect Only)) ```

flutter/packages@715a0a5...0ec4053 2025-06-19 [email protected] Roll Flutter from 8303a96 to 85a9b4f (93 revisions) (flutter/packages#9457) 2025-06-19 [email protected] [go_router] Update sype safe routing topic to use mixin from go_router_builder 3.0.0 (flutter/packages#9422) 2025-06-19 [email protected] [go_router] fix: PopScope.onPopInvokedWithResult not called in branch routes (flutter/packages#9245) 2025-06-18 [email protected] [pigeon] Create a message call free InstanceManager when running unit tests (flutter/packages#9395) 2025-06-18 [email protected] [go_router] Use library prefix for meta (flutter/packages#9434) 2025-06-18 [email protected] [go_router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new] (flutter/packages#8352) 2025-06-18 [email protected] [camera_avfoundation] Fix incorrect types in image stream events (flutter/packages#9418) 2025-06-18 [email protected] [go_router_builder] Temporarily restrict `build` (flutter/packages#9453) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…ime doesn't update the URL on web [new] (flutter#8352) > the old pr flutter#6953 Change the 3 files of lib and add a example, because issue flutter/flutter#150312 The reason for the issue is when call `counterStream.increment();` will notify `notifyListeners()` of `StreamListener`, and finally affect `_handleRouteInformationProviderNotification` of` _RouterState` in `packages/flutter/lib/src/widgets/router.dart`. When pop should not call `_handleRouteInformationProviderNotification` otherwise will be path wrong. because the value of `GoRouteInformationProvider` is not the latest. ## Solution: always make the value of `GoRouteInformationProvider` knew the latest `RouteInformation`[but not to do `notifyListeners()`]. i don't know if adding `pop` to `NavigatingType` is reasonable, if any place needs to be changed please tell me. ## Result: After changed, the issue been solved and all the others pop not be affect such as drawer/dialog/bottomsheet, See the video below. > flutter/flutter#150312 > exempt from version changes > this PR is exempt from CHANGELOG changes. > this PR is test-exempt. > the `go_route_test.dart` will error if `testWidgets('throw if redirect to itself')`[I have this problem when I pull the online branch. it's not relate this PR, All of the others test success, So I view this as all test cases successfully passing.] ``` Exception has occurred. _AssertionError ('package:go_router/src/parser.dart': Failed assertion: line 110 pos 18: '!matchList.last.route.redirectOnly': A redirect-only route must redirect to location different from itself. The offending route: GoRoute#0ae4e(name: null, path: "route", Redirect Only)) ```

ahyangnb added 2 commits December 28, 2024 15:09

reproduce issue flutter/flutter#150312

63ef007

fix #150312

b92dc00

ahyangnb requested a review from chunhtai as a code owner December 28, 2024 07:57

github-actions bot added the p: go_router label Dec 28, 2024

ahyangnb changed the title ~~[Go Router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new]~~ [go_router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new] Dec 28, 2024

chunhtai reviewed Jan 8, 2025

View reviewed changes

packages/go_router/lib/src/information_provider.dart Outdated Show resolved Hide resolved

packages/go_router/lib/src/parser.dart Outdated Show resolved Hide resolved

A new way to fix the flutter#6953 issue.

614663c

Unit test for issues/150312

ae86e7a

ahyangnb and others added 5 commits January 22, 2025 10:16

Merge branch 'main' into main

15dd5b7

fix"info • example/test/test_stream_listener.dart:41:2 • Missing a ne…

cad1f24

…wline at the end of the file. Try adding a newline at the end of the file. • eol_at_end_of_file"

license text used by all first-party files in this repository

6030676

Version 14.6.5: - Fix issue 150312.

545f133

Merge branch 'main' into main

9a53bdf

chunhtai self-requested a review January 23, 2025 22:54

ahyangnb and others added 10 commits January 24, 2025 15:58

Merge branch 'main' into main

e208cca

version 14.7.2: - Fix issue 150312.

99f7293

Merge branch 'main' into main

653d58e

Merge branch 'main' into main

ec2be8d

14.7.3

0dae57a

Merge branch 'main' into main

8cc913b

Merge branch 'main' into main

00d392c

Merge branch 'main' into main

6ce16f8

Merge branch 'main' into main

31d8ddb

Merge branch 'main' into main

2345943

hannah-hyj reviewed May 2, 2025

View reviewed changes

packages/go_router/example/lib/stream_listener_router.dart Outdated Show resolved Hide resolved

chunhtai approved these changes May 8, 2025

View reviewed changes

packages/go_router/CHANGELOG.md Outdated Show resolved Hide resolved

Merge branch 'main' into main

8c1e543

ahyangnb requested a review from hannah-hyj May 13, 2025 07:04

ahyangnb and others added 3 commits June 9, 2025 13:43

Merge branch 'flutter:main' into main

6fbb0e0

* add change logs: Fixes Popping state and re-rendering scaffold at t…

93ee871

…he same time doesn't update the URL on web.

* remove: stream_listener_router.dart and test_stream_listener.dart

96320b2

ahyangnb added 2 commits June 10, 2025 11:52

## 15.1.4

dd6dae6

Update version to 15.1.4 in pubspec.yaml

137c5e3

hannah-hyj approved these changes Jun 10, 2025

View reviewed changes

Merge branch 'main' into main

fe1bfae

Merge branch 'main' into main

c6cd8d4

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 18, 2025

This was referenced Jun 18, 2025

[go_router] fix: PopScope.onPopInvokedWithResult not called in branch routes #9245

Merged

[go_router] Update sype safe routing topic to use mixin from go_router_builder 3.0.0 #9422

Merged

auto-submit bot merged commit 2a7df7a into flutter:main Jun 18, 2025
78 checks passed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 19, 2025

2a7df7a [go_router] fix Popping state and re-rendering scaffold at th…

72e7b98

…e same time doesn't update the URL on web [new] (flutter/packages#8352)

engine-flutter-autoroll mentioned this pull request Jun 19, 2025

Roll Packages from 715a0a5c4fdd to ca07b70466b0 (7 revisions) flutter/flutter#170876

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 19, 2025

2a7df7a [go_router] fix Popping state and re-rendering scaffold at th…

6c559c4

…e same time doesn't update the URL on web [new] (flutter/packages#8352)

engine-flutter-autoroll mentioned this pull request Jun 19, 2025

Roll Packages from 715a0a5c4fdd to 0ec405358e43 (8 revisions) flutter/flutter#170879

Merged

kylianSalomon mentioned this pull request Aug 28, 2025

[go_router]: Timing Inconsistency: Generated Routes vs Manual Routes in _handlePopPageWithRouteMatch Due to onExit Callback Behavior flutter/flutter#174525

Open

[go_router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new] #8352

[go_router] fix Popping state and re-rendering scaffold at the same time doesn't update the URL on web [new] #8352

Uh oh!

Conversation

ahyangnb commented Dec 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Solution:

Result:

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Dec 28, 2024

Uh oh!

ahyangnb commented Dec 28, 2024

Uh oh!

ahyangnb commented Dec 28, 2024

Uh oh!

ahyangnb commented Dec 28, 2024

Uh oh!

Uh oh!

Uh oh!

ahyangnb commented Jan 9, 2025

Uh oh!

ahyangnb commented Jan 22, 2025

Uh oh!

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hannah-hyj commented May 28, 2025

Uh oh!

ahyangnb commented Jun 9, 2025

Uh oh!

hannah-hyj left a comment

Choose a reason for hiding this comment

Uh oh!

ahyangnb commented Jun 11, 2025

Uh oh!

Piinks commented Jun 18, 2025

Uh oh!

Piinks commented Jun 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ahyangnb commented Dec 28, 2024 •

edited

Loading