[go_router] Migrates test for leak testing

[hgraceb]

migrating test for

flutter/flutter#176519

Pre-Review 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.
• 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.
• I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under¹.
• I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under¹.
• I updated/added any relevant documentation (doc comments with ///).
• I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under¹.
• All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

[gemini-code-assist]

Code Review

This pull request migrates a test to include leak testing, specifically ignoring TestRestorationManager and RestorationBucket classes. This change aims to improve the reliability and robustness of the go_router package by ensuring that state restoration works correctly without introducing memory leaks.

[gemini-code-assist]

The experimentalLeakTesting parameter is used to ignore specific classes during leak testing. While this can be useful for suppressing known leaks or focusing on specific areas, it's important to ensure that these ignored classes are genuinely not a concern and won't cause issues in the long run. Consider adding a comment explaining why these classes are being ignored and under what circumstances it's safe to ignore them.

Additionally, it's good to link to the specific issue or discussion where this decision was made, if applicable.

    'Restores state correctly',
    // TODO(Flop): Remove when minimum flutter version includes
    // https://github.com/flutter/flutter/pull/176519
    // Ignoring RestorationBucket and TestRestorationManager due to known issues with restoration.
    // See [link to issue or discussion] for more details.
    experimentalLeakTesting: LeakTesting.settings.withIgnored(
      classes: <String>['TestRestorationManager', 'RestorationBucket'],
    ),

[ValentinVignal]

LGTM except for the username of the TODO. In any case, I think it is better if @chunhtai is the one providing the approval

[ValentinVignal]

Who is Flop? I think we are supposed to put our own username here (in that case, yours).

@chunhtai, what is the best to do here?

[chunhtai]

yes please use your username here.

Otherwise, adding this exception sound fine to me

[chunhtai]

we should put this after the test body

[chunhtai]

yes please use your username here.

Otherwise, adding this exception sound fine to me

[hgraceb]

@ValentinVignal @chunhtai Thank you, I may have overlooked this part of the documentation. I have changed it to my username, and I will find time later to submit a PR to complete the migration.