[go_router] Add encoder,decoder and compare parameters to TypedQueryParameter

[ValentinVignal]

Part of

• [go_router_builder] Allow the user to specify a type converter of the parameters flutter#112152
• [go_router_builder] Custom type conversion for parameters flutter#110781

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 enhances TypedQueryParameter by adding encoder, decoder, and compare parameters, allowing for more flexible handling of query parameters in type-safe routes. The changes are well-implemented and include corresponding updates to the changelog, pubspec, and tests. I have one suggestion to improve the clarity of the documentation for the new compare parameter to prevent potential misuse.

[gemini-code-assist]

The documentation for the compare function is a bit confusing. The first sentence says it's for equality comparison, but the following sentence states it returns true if the values are different. This is counter-intuitive for a function that is described as comparing for equality.

To avoid confusion for developers using this API, I suggest rephrasing the documentation to be more direct about its purpose. For example, you could describe it as an inequality check.

Suggested change

	/// A function that compares two parameter values for equality.
	///
	/// Returns `true` if the values are different and `false` if they are the
	/// same. This is used to determine whether a parameter should be included in
	/// the URI when it has a default value.
	/// A function that compares two parameter values for inequality.
	///
	/// Returns `true` if the values are considered different, and `false` if they
	/// are the same. This is used to determine whether a parameter should be
	/// included in the URI when it has a default value.

[ValentinVignal]

go_router_builder PR: #11068

[ValentinVignal]

The analyzer is failing because of go_router_builder example

Got dependencies in `./example`.
Running command: "dart analyze --fatal-infos" in /b/s/w/ir/x/w/packages/packages/go_router_builder
Analyzing go_router_builder...

warning - example/lib/typed_query_parameter_example.dart:30:5 - The type argument(s) of the constructor 'TypedQueryParameter' can't be inferred. Use explicit type argument(s) for 'TypedQueryParameter'. - inference_failure_on_instance_creation
warning - example/lib/typed_query_parameter_example.dart:31:5 - The type argument(s) of the constructor 'TypedQueryParameter' can't be inferred. Use explicit type argument(s) for 'TypedQueryParameter'. - inference_failure_on_instance_creation
warning - example/lib/typed_query_parameter_example.dart:33:5 - The type argument(s) of the constructor 'TypedQueryParameter' can't be inferred. Use explicit type argument(s) for 'TypedQueryParameter'. - inference_failure_on_instance_creation
warning - test_inputs/typed_query_parameter.dart:13:5 - The type argument(s) of the constructor 'TypedQueryParameter' can't be inferred. Use explicit type argument(s) for 'TypedQueryParameter'. - inference_failure_on_instance_creation
warning - test_inputs/typed_query_parameter.dart:14:5 - The type argument(s) of the constructor 'TypedQueryParameter' can't be inferred. Use explicit type argument(s) for 'TypedQueryParameter'. - inference_failure_on_instance_creation

Now, TypedQueryParameter takes a generic type. I've updated those in the go_router_builder PR: #11068.
Should I update them in this PR?

[chunhtai]

go_router has migrated to batch release, now we should add a new entry in pending_changelogs folder. the ci also hinted this.

[ValentinVignal]

Oh okay, I changed it in Use batch release, let me know if that's correct

[chunhtai]

we should typedef this. also what does returning null does here? and in what case will null to be feed into this. we should document these behavior in the typedef

[ValentinVignal]

Good point, I made the parameter non-nullable in Better documentation

[chunhtai]

can you talk a bit more why this is needed?

[ValentinVignal]

Let me know if that's good enough or not Better documentation