[go_router_builder] Proposal: add json support, custom string encoder/decoder #8665

NearTox · 2025-02-20T02:39:19Z

Add initial json support for use in go_router_builder
Adds annotation that enable custom string encoder/decoder, its enable conversion for base64

This allow custom type conversion for parameters, like mentionated in #117261 and #110781

Pre-launch Checklist

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

hannah-hyj · 2025-02-24T19:48:51Z

packages/go_router/lib/go_router.dart

@@ -6,6 +6,9 @@
 /// deep linking, data-driven routes and more.
 library go_router;

+// used for json decoder/encoder


just import 'dart:convert'; in the file where you use it

hannah-hyj · 2025-02-24T19:50:11Z

packages/go_router_builder/test_inputs/bad_json.dart

+class JsonExample {
+  const JsonExample({required this.id});
+
+  // mismach toJson


typo: mismatch

hannah-hyj · 2025-02-24T19:52:05Z

packages/go_router_builder/test_inputs/bad_json.dart

+  const JsonExample({required this.id});
+
+  // mismach toJson
+  factory JsonExample.toJson(dynamic json) {


do you mean fromJson here ?

hannah-hyj · 2025-02-24T19:56:08Z

packages/go_router_builder/test_inputs/json_template.dart

+
+import 'package:go_router/go_router.dart';
+
+@TypedGoRoute<BadJson>(path: '/')


BadJson-> rename it?

hannah-hyj · 2025-02-24T23:36:45Z

you also need to bump versions in packages/go_router_builder/CHANGELOG.md and packages/go_router_builder/pubspec.yaml

hannah-hyj · 2025-02-24T23:51:49Z

packages/go_router_builder/lib/src/type_helpers.dart

+}''';
+  }
+
+  bool _isTemplate(InterfaceType type) {


_isTemplate : maybe rename to _isNestedTemplate?

hannah-hyj · 2025-02-24T23:55:27Z

thank you for contributing the PR! This looks good to me over all with some comments

hannah-hyj · 2025-02-25T19:32:19Z

packages/go_router_builder/test_inputs/bad_json.dart

+
+import 'package:go_router/go_router.dart';
+// used for json decoder/encoder
+export 'dart:convert' show jsonDecode, jsonEncode;


i think you can just import it instead of export it?

hannah-hyj · 2025-03-17T22:22:18Z

packages/go_router_builder/lib/src/type_helpers.dart

+        '`${type.getDisplayString(withNullability: false)}` not have a supported fromJson definition.',
+        element: type.element,
+      );
+      // return false;


// return false;

is this a typo?

hannah-hyj · 2025-03-17T22:29:56Z

packages/go_router_builder/lib/src/type_helpers.dart

+      String? decoder;
+
+      final ElementAnnotation? annotation =
+          metadata?.firstWhereOrNull((ElementAnnotation annotation) {
+        return annotation.computeConstantValue()?.type?.getDisplayString() ==
+            'CustomParameterCodec';
+      });
+      if (annotation != null) {
+        final String? decode = annotation
+            .computeConstantValue()
+            ?.getField('decode')
+            ?.toFunctionValue()
+            ?.displayName;
+        final String? encode = annotation
+            .computeConstantValue()
+            ?.getField('encode')
+            ?.toFunctionValue()
+            ?.displayName;
+        if (decode != null && encode != null) {
+          decoder = decode;
+        }
+      }


nit: code here is same as L110-L129, you can extract them into a function to reuse.

hannah-hyj · 2025-03-17T22:31:31Z

packages/go_router_builder/lib/src/type_helpers.dart

-  String _encode(String fieldName, DartType type) =>
-      '$fieldName${type.ensureNotNull}.toString()';
+  String _encode(String fieldName, DartType type, String? customEncoder) {
+    String encode = '$fieldName${type.ensureNotNull}.toString()';


nit: this could be:

if (customEncoder != null) { return '$customEncoder($encode)'; } return '$fieldName${type.ensureNotNull}.toString()';

hannah-hyj · 2025-03-17T22:32:24Z

packages/go_router_builder/lib/src/type_helpers.dart

-  String _encode(String fieldName, DartType type) =>
-      '$fieldName${type.ensureNotNull}.toString()';
+  String _encode(String fieldName, DartType type, String? customEncoder) {
+    String encode = '$fieldName${type.ensureNotNull}.toString()';


nit: ditto, and all other _encode

hannah-hyj · 2025-03-17T22:36:12Z

PR looks good to me over all, just left some nit comments :)

NearTox · 2025-03-19T16:29:08Z

I made a rebase in order to take in account latest changes from main branch

chunhtai · 2025-03-21T20:36:32Z

looks like the ci is not happy

NearTox · 2025-03-21T22:30:01Z

I think it’s because the annotations requires the changes that I made in go_router_builder.
When I tested locally was overriding the dependency.
I should add it?

chunhtai · 2025-03-21T22:47:23Z

they will have to be separate into two prs. I think we try to avoid having one pr that bump the two package at once

hannah-hyj · 2025-05-02T22:23:43Z

Hi @NearTox , is this PR still on your radar? this pr has to be separated into 2 PRs for go_router and go_router_builder

NearTox · 2025-06-07T00:35:40Z

Hi @hannah-hyj , sorry for the delayed reply.
I splitted into two PR (chained commits)
I made a rebase in order to reach the last version of the go_router_builder

Piinks · 2025-06-18T19:03:01Z

Thanks for the updates, and for contributing @NearTox! It looks like this is currently failing a lot of tests, can you take a look?

chunhtai

Sorry for the late review, I think the overall approach looks fine, but can you add a example usage for custom codec?

chunhtai · 2025-03-10T22:24:53Z

packages/go_router_builder/example/lib/shared/data.dart

@@ -191,3 +191,46 @@ class Repository {
    return FamilyPerson(family: family, person: family.person(pid));
  }
 }
+
+class JsonExample {


let's move this to json_example.dart

chunhtai · 2025-06-23T18:49:57Z

packages/go_router_builder/lib/src/type_helpers.dart

+      final ElementAnnotation? annotation =
+          metadata?.firstWhereOrNull((ElementAnnotation annotation) {
+        final DartObject? constant = annotation.computeConstantValue();
+        return constant?.type?.getDisplayString() == 'CustomParameterCodec';


can you add an example for using custom codec?

NearTox requested a review from chunhtai as a code owner February 20, 2025 02:39

github-actions bot added p: go_router_builder p: go_router labels Feb 20, 2025

NearTox force-pushed the main branch from 8e7f994 to 093aa3a Compare February 20, 2025 05:47

chunhtai requested review from hannah-hyj and removed request for chunhtai February 20, 2025 23:12

hannah-hyj reviewed Feb 24, 2025

View reviewed changes

github-actions bot removed the p: go_router label Feb 25, 2025

hannah-hyj requested a review from chunhtai February 25, 2025 19:28

hannah-hyj reviewed Feb 25, 2025

View reviewed changes

NearTox changed the title ~~[go_router_builder] Proposal: add json support~~ [go_router_builder] Proposal: add json support, custom string encoder/decoder Feb 26, 2025

github-actions bot added the p: go_router label Feb 26, 2025

chunhtai requested a review from hannah-hyj March 13, 2025 22:08

hannah-hyj reviewed Mar 17, 2025

View reviewed changes

NearTox force-pushed the main branch from dcb6a19 to 8479cc4 Compare March 19, 2025 16:27

NearTox force-pushed the main branch from 2d48aeb to d38e1e4 Compare March 19, 2025 17:21

hannah-hyj self-requested a review March 24, 2025 22:48

NearTox force-pushed the main branch from 1078864 to 1379a70 Compare June 7, 2025 00:24

NearTox mentioned this pull request Jun 7, 2025

[go_router] add initial json support #110781 #9404

Open

11 tasks

NearTox added 2 commits June 12, 2025 17:10

[go_router] add initial json support #110781

02bd704

[go_router_builder] add initial json support #110781

30a208b

NearTox force-pushed the main branch from 1379a70 to 30a208b Compare June 12, 2025 23:14

Piinks mentioned this pull request Jun 18, 2025

[go_router_builder] Add support for relative routes #8476

Open

11 tasks

chunhtai reviewed Jun 23, 2025

View reviewed changes


		import 'package:go_router/go_router.dart';

		@TypedGoRoute<BadJson>(path: '/')

[go_router_builder] Proposal: add json support, custom string encoder/decoder #8665

Are you sure you want to change the base?

[go_router_builder] Proposal: add json support, custom string encoder/decoder #8665

Uh oh!

Conversation

NearTox commented Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hannah-hyj commented Feb 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hannah-hyj commented Feb 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hannah-hyj Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hannah-hyj Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hannah-hyj commented Mar 17, 2025

Uh oh!

NearTox commented Mar 19, 2025

Uh oh!

chunhtai commented Mar 21, 2025

Uh oh!

NearTox commented Mar 21, 2025

Uh oh!

chunhtai commented Mar 21, 2025

Uh oh!

hannah-hyj commented May 2, 2025

Uh oh!

NearTox commented Jun 7, 2025

Uh oh!

Piinks commented Jun 18, 2025

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NearTox commented Feb 20, 2025 •

edited

Loading

hannah-hyj Mar 17, 2025 •

edited

Loading

hannah-hyj Mar 17, 2025 •

edited

Loading