Return value when pop #3368

NazarenoCavazzon · 2023-03-03T18:44:15Z

In this PR I'm modifying the push and pushNamed by making them return a Future<T?>, and using completers to make the users able to return an wait values from within pages.

Fixes flutter/flutter#99663.
Fixes flutter/flutter#107217
Fixes flutter/flutter#100969

This PR will not conflict with older versions of go_router when updated.

Pre-launch Checklist

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

NazarenoCavazzon · 2023-03-03T18:45:39Z

@chunhtai Here it is

chunhtai · 2023-03-03T18:50:48Z

packages/go_router/example/pubspec.yaml

@@ -17,6 +17,7 @@ dependencies:
  go_router:
    path: ..
  logging: ^1.0.0
+  package_info_plus_web: ^2.0.0


can this be removed?

chunhtai · 2023-03-03T18:51:38Z

packages/go_router/CHANGELOG.md

@@ -3,6 +3,10 @@
 - Updates compileSdkVersion to 33.
 - Updates example app to iOS 11.

+## 6.3.0
+
+- Support for returning values on pop.


Suggested change

- Support for returning values on pop.

- Supports for returning values on pop.

please move the item under ## NEXT to be under 6.3.0 as well

chunhtai · 2023-03-03T18:52:42Z

packages/go_router/doc/navigation.md

+```dart
+onTap: () {
+  final bool? result = await context.push<bool>('/page2');
+  WidgetsBinding.instance.addPostFrameCallback((_) {


Why a post frame callback?

This was before context.mounted was implemented, and using context after the value was returned lead to some dirty context problems, but we can take it out

chunhtai · 2023-03-03T18:56:02Z

packages/go_router/lib/src/delegate.dart

@@ -113,6 +116,7 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
    final _NavigatorStateIterator iterator = _createNavigatorStateIterator();
    while (iterator.moveNext()) {
      if (iterator.current.canPop()) {
+        iterator.matchList.last.completer?.complete(result);


Instead of exposing the completer directly, can you add a method in RouteMatch something like didComplete()? and let ImperativeRouteMatch to override the method to call complete on the completer

chunhtai · 2023-03-03T18:57:16Z

packages/go_router/lib/src/match.dart

@@ -27,6 +30,7 @@ class RouteMatch {
    required String parentSubloc, // e.g. /family/f2
    required Map<String, String> pathParameters,
    required Object? extra,
+    Completer<dynamic>? completer,


If you use method this property should be in ImerativeRouteMatch, and instead of dynamic, it should use generic type T

chunhtai · 2023-03-03T19:08:03Z

packages/go_router/lib/src/delegate.dart

@@ -91,10 +92,12 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
      error: matches.last.error,
      pageKey: pageKey,
      matches: matches,
+      completer: completer,


Why not let ImperativeRouteMatch to create the completer itself.

chunhtai · 2023-03-03T19:09:43Z

packages/go_router/lib/src/delegate.dart

@@ -278,6 +282,7 @@ class ImperativeRouteMatch extends RouteMatch {
    required super.error,
    required super.pageKey,
    required this.matches,
+    super.completer,


Somewhere in the doc should mention about the completer and future and what it meant.

also, please remove the todo for me. Thanks in advance

chunhtai · 2023-03-03T19:13:16Z

Since this is not really a breaking change, so you don't need to write a breaking change doc. Consider moving the snippet in the doc into the example folder

NazarenoCavazzon · 2023-03-03T19:47:30Z

let me know if there's another change to make

chunhtai · 2023-03-03T19:50:24Z

packages/go_router/CHANGELOG.md

+## 6.3.0
+
+- Supports for returning values on pop.
+
 ## NEXT


I meant the ##Next section should be merged in 6.3.0

## Next meant whoever publish the next version will need to publish the changes in##NEXTas well

AHHHHH, got it

This seems not address yet?

chunhtai · 2023-03-03T19:57:36Z

packages/go_router/lib/src/match.dart

@@ -61,6 +63,18 @@ class RouteMatch {
    throw MatcherError('Unexpected route type: $route', restLoc);
  }

+  /// Completes the promise returned by [GoRouter.push].
+  void complete([T? value]) {


the entire completer should be move to ImperativeRouteMatch. This can just be a empty implementation for subclass override

also maybe change this to didComplete. it is a special keyword in the framework, that has specific meaning

chunhtai · 2023-03-03T19:58:29Z

packages/go_router/lib/src/match.dart

@@ -61,6 +63,18 @@ class RouteMatch {
    throw MatcherError('Unexpected route type: $route', restLoc);
  }

+  /// Completes the promise returned by [GoRouter.push].


This should document what the purpose of this method

NazarenoCavazzon · 2023-03-03T20:30:28Z

packages/go_router/lib/src/match.dart

+  /// ```dart
+  /// context.pop(true);
+  /// ```
+  void complete([dynamic value]) {}


@chunhtai what do you think?

why optional? I think it can be Object? value.

I meant this method should be call didComplete.

void didComplete(Object? value) {}

chunhtai · 2023-03-03T21:15:47Z

packages/go_router/lib/src/match.dart

@@ -61,6 +61,29 @@ class RouteMatch {
    throw MatcherError('Unexpected route type: $route', restLoc);
  }

+  /// Completes the promise returned by [GoRouter.push], allowing comunication


Maybe:

Called when the corresponding [Route] associated with this route match is completed.

chunhtai · 2023-03-03T21:16:54Z

packages/go_router/lib/src/match.dart

+  /// Completes the promise returned by [GoRouter.push], allowing comunication
+  /// between pages.
+  ///
+  /// If the promise has already been completed, this method does nothing.


promise is not a keyword in dart. I think you meant future. Eitherway, this is implementation detail, we should focus on when/why this method is called.

chunhtai · 2023-03-03T21:17:51Z

packages/go_router/lib/src/match.dart

+  /// ```dart
+  /// context.pop(true);
+  /// ```
+  void complete([dynamic value]) {}


why optional? I think it can be Object? value.

chunhtai · 2023-03-03T21:18:28Z

packages/go_router/lib/src/delegate.dart

+
+  /// The future of the [RouteMatch] completer. When the future completes, this
+  /// will return the value passed to [complete].
+  Future<T?> get future => _completer.future;


this can be private

The problem is we need to return this completer future in the push function, if we make it private we cannot return it.

You can access private method as long as the class is in the same file, so it should be fine

chunhtai · 2023-03-03T21:19:15Z

packages/go_router/lib/src/match.dart

+  /// ```dart
+  /// context.pop(true);
+  /// ```
+  void complete([dynamic value]) {}


I meant this method should be call didComplete.

void didComplete(Object? value) {}

chunhtai · 2023-03-03T21:20:29Z

packages/go_router/lib/src/parser.dart

@@ -104,7 +104,7 @@ class GoRouteInformationParser extends RouteInformationParser<RouteMatchList> {
    }
    if (configuration.matches.last is ImperativeRouteMatch) {
      configuration =
-          (configuration.matches.last as ImperativeRouteMatch).matches;
+          (configuration.matches.last as ImperativeRouteMatch<dynamic>).matches;


can this be Object? ?

we should avoid using dynamic as much as possible unless you are handling json.

chunhtai

LGTM, just some nits and change log

chunhtai · 2023-03-03T23:13:56Z

packages/go_router/lib/src/delegate.dart

+
+  /// The future of the [RouteMatch] completer. When the future completes, this
+  /// will return the value passed to [complete].
+  Future<T?> get future => _completer.future;


You can access private method as long as the class is in the same file, so it should be fine

chunhtai · 2023-03-03T23:14:45Z

packages/go_router/lib/src/delegate.dart

+    _completer.complete(value as T?);
+  }
+
+  /// The future of the [RouteMatch] completer. When the future completes, this


Suggested change

/// The future of the [RouteMatch] completer. When the future completes, this

/// The future of the [RouteMatch] completer.

///

/// When the future completes, this

Didn't know about private methods being accessed if in the same file, really cool!

chunhtai · 2023-03-03T23:15:35Z

packages/go_router/CHANGELOG.md

+## 6.3.0
+
+- Supports for returning values on pop.
+
 ## NEXT


This seems not address yet?

chunhtai · 2023-03-03T23:16:37Z

and the analyzer is not happy

NazarenoCavazzon · 2023-03-03T23:25:54Z

@chunhtai fixed the change log, almost forgot.

packages/go_router/CHANGELOG.md

Co-authored-by: HBS <[email protected]>

booooohdan · 2023-03-15T14:10:58Z

Waiting for resolving this PR

hannah-hyj

LGTM

chunhtai · 2023-03-23T16:02:46Z

It looks like there is some conflict, can you rebase off the latest main?

auto-submit · 2023-03-23T16:08:39Z

auto label is removed for flutter/packages, pr: 3368, Failed to merge pr#: 3368 with Pull request could not be merged: Pull Request is not mergeable.

NazarenoCavazzon · 2023-03-23T17:05:59Z

It looks like there is some conflict, can you rebase off the latest main?

Done

chunhtai · 2023-03-23T17:07:39Z

packages/go_router/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 6.3.0

+- Supports returning values on pop.


Please publish a new version

Updated to 6.5.0

It looks like the conflict is back :(

Yep, I'm resolving them rn

Everything is a mess hahahaha, I'll rebase it to main and made the implementation again 🙃

@chunhtai now there shouldn't be any more conflicts

chunhtai

LGTM

tomassasovsky · 2023-03-23T20:05:46Z

grande naza!

NazarenoCavazzon · 2023-03-23T20:06:53Z

Niceeeeeeeeee

Return value when pop

Return value when pop

f74ad0d

NazarenoCavazzon requested a review from chunhtai as a code owner March 3, 2023 18:44

github-actions bot added the p: go_router label Mar 3, 2023

Merge branch 'main' into feat/return-value-when-pop

72db2d6

chunhtai reviewed Mar 3, 2023

View reviewed changes

NazarenoCavazzon added 3 commits March 3, 2023 16:40

Fixes

ba08b81

Removed unnecessary completer

845dfbd

removed addPostFrameCallback from docs

0105de8

chunhtai reviewed Mar 3, 2023

View reviewed changes

NazarenoCavazzon added 2 commits March 3, 2023 17:23

Moved implementation to ImperativeRouteMatch

4a6352c

Documented complete() method

ecee639

NazarenoCavazzon commented Mar 3, 2023

View reviewed changes

chunhtai reviewed Mar 3, 2023

View reviewed changes

NazarenoCavazzon added 4 commits March 3, 2023 19:04

Changes

98e1216

Update delegate.dart

1b5e37b

Update go_router_test.dart

b734714

Merge branch 'main' into feat/return-value-when-pop

ba99cc5

chunhtai approved these changes Mar 3, 2023

View reviewed changes

chunhtai requested a review from hannah-hyj March 3, 2023 23:16

Last fixes

9b556a3

Update match.dart

8d34c15

TKDev7 reviewed Mar 4, 2023

View reviewed changes

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

NazarenoCavazzon and others added 2 commits March 3, 2023 22:08

Update packages/go_router/CHANGELOG.md

0f0eafc

Co-authored-by: HBS <[email protected]>

Merge branch 'main' into feat/return-value-when-pop

77f6ab9

NazarenoCavazzon mentioned this pull request Mar 6, 2023

[go_router] Support return data from a screen with pop() flutter/flutter#99663

Closed

Merge branch 'main' into feat/return-value-when-pop

251966a

hannah-hyj approved these changes Mar 20, 2023

View reviewed changes

Merge branch 'main' into feat/return-value-when-pop

ed87847

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 20, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 23, 2023

Merge branch 'main' into feat/return-value-when-pop

1661569

chunhtai requested changes Mar 23, 2023

View reviewed changes

NazarenoCavazzon added 5 commits March 23, 2023 14:10

Update version to 6.5.0

c3ed204

Updated from main

02a4f5c

Merge branch 'main' into feat/return-value-when-pop

a44a5cc

Type annotations

801c7c6

Update router.dart

5d88336

chunhtai approved these changes Mar 23, 2023

View reviewed changes

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 23, 2023

auto-submit bot merged commit 1f67d0c into flutter:main Mar 23, 2023

engine-flutter-autoroll mentioned this pull request Mar 24, 2023

Roll Packages from 0826798d73b8 to 32c120ff6af7 (4 revisions) flutter/flutter#123403

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 24, 2023

1f67d0c Return value when pop (flutter/packages#3368)

65f1bf7

engine-flutter-autoroll mentioned this pull request Mar 24, 2023

Roll Packages from 0826798d73b8 to 32c120ff6af7 (4 revisions) flutter/flutter#123411

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 24, 2023

1f67d0c Return value when pop (flutter/packages#3368)

d4b9d3b

HansMuller mentioned this pull request Mar 24, 2023

Flutter Framework Team: Notable Commits flutter/flutter#121415

Closed

blendthink mentioned this pull request Mar 28, 2023

Session/3 morikann/flutter_training#16

Merged

5 tasks

nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023

Return value when pop (flutter#3368)

a1f0c89

Return value when pop

	- Support for returning values on pop.
	- Supports for returning values on pop.

Return value when pop #3368

Return value when pop #3368

Uh oh!

Conversation

NazarenoCavazzon commented Mar 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

NazarenoCavazzon commented Mar 3, 2023

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chunhtai commented Mar 3, 2023

Uh oh!

NazarenoCavazzon commented Mar 3, 2023

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!

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!

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

NazarenoCavazzon commented Mar 3, 2023 •

edited

Loading