Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigate to homescreen only via go router #1289

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

Daniela510
Copy link
Contributor

@Daniela510 Daniela510 commented Nov 26, 2024

Summary by CodeRabbit

  • New Features

    • Updated navigation logic in the Summary Screen and Leave Game Dialog to use named routes for improved user experience.
  • Bug Fixes

    • Streamlined transitions to the profile selection page, enhancing navigation efficiency.

@Daniela510 Daniela510 requested a review from a team as a code owner November 26, 2024 15:03
Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The pull request introduces changes to the navigation logic within the SummaryScreen and LeaveGameDialog classes. It replaces traditional navigation methods with the Go Router package, specifically using context.goNamed(...) instead of Navigator.of(context).popUntil(...). This modification aims to streamline navigation by utilizing named routes, while the core structure and functionalities of the classes remain unchanged.

Changes

File Change Summary
lib/features/family/features/reflect/presentation/pages/summary_screen.dart Added imports for app_router.dart and go_router.dart; replaced navigation method with context.goNamed(...).
lib/features/family/features/reflect/presentation/widgets/leave_game_dialog.dart Added import for go_router; updated onTap callback to use context.goNamed(...) for navigation.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • TammiLion
  • MaikelStuivenberg

🐇 "In the land of code where rabbits play,
Navigation's changed in a bright new way.
With Go Router's charm, we hop and glide,
To screens of joy, we swiftly ride!
No more backtracking, just a named route,
In our coding burrow, we dance and shout!" 🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the bug Something isn't working label Nov 26, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
lib/features/family/features/reflect/presentation/widgets/leave_game_dialog.dart (1)

27-29: Consider adding error handling

The navigation logic could be more robust with proper error handling:

 onTap: () {
-  getIt<SummaryCubit>().saveSummary();
-  context.goNamed(
-    FamilyPages.profileSelection.name,
-  );
+  try {
+    getIt<SummaryCubit>().saveSummary();
+    context.goNamed(
+      FamilyPages.profileSelection.name,
+    );
+  } catch (e) {
+    ScaffoldMessenger.of(context).showSnackBar(
+      SnackBar(content: Text('Failed to leave game. Please try again.')),
+    );
+  }
 },
lib/features/family/features/reflect/presentation/pages/summary_screen.dart (1)

84-85: Remove or clarify the "hmm" comment

The comment appears to be a placeholder and doesn't provide any meaningful information. Consider removing it or replacing it with actual documentation if there's something that needs to be noted.

-              //hmm
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b550c46 and 67d5c6c.

📒 Files selected for processing (2)
  • lib/features/family/features/reflect/presentation/pages/summary_screen.dart (3 hunks)
  • lib/features/family/features/reflect/presentation/widgets/leave_game_dialog.dart (2 hunks)
🔇 Additional comments (4)
lib/features/family/features/reflect/presentation/widgets/leave_game_dialog.dart (2)

10-10: LGTM: Import added for Go Router integration

The go_router import is correctly added to support the new navigation approach.


27-29: Verify state cleanup before navigation

While the navigation change aligns with the PR objective, there are a few considerations:

  1. The goNamed call will clear the entire navigation stack. Verify this is the intended behavior.
  2. Consider adding error handling for both saveSummary() and navigation.

Let's verify the state cleanup requirements:

✅ Verification successful

Based on the search results, I can generate the final response now:

Navigation pattern is consistent with app-wide usage

The goNamed navigation to profile selection is used consistently across the app in similar scenarios (splash, registration, notifications, etc.) without explicit state cleanup. Since this is a StatelessWidget and the navigation pattern follows established conventions in the codebase, no additional cleanup is required.

  • The saveSummary() call before navigation ensures data persistence
  • goNamed clearing the navigation stack is the intended behavior, as evidenced by its consistent usage across similar flows
  • Error handling can be considered but isn't strictly required given the established patterns
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any state cleanup patterns in similar navigation scenarios
rg -A 5 "goNamed.*profileSelection" 

# Check for any dispose or cleanup methods that might be relevant
ast-grep --pattern 'class $_ extends StatelessWidget {
  $$$
  dispose() {
    $$$
  }
  $$$
}'

Length of output: 4674

lib/features/family/features/reflect/presentation/pages/summary_screen.dart (2)

5-5: LGTM: Required imports added for Go Router implementation

The new imports align with the PR objective to use Go Router for navigation.

Also applies to: 15-15


89-91: LGTM: Navigation properly implemented using Go Router

The implementation correctly uses named routes with Go Router, which is more maintainable than using string literals.

Let's verify that the route name is properly registered:

✅ Verification successful

LGTM: Route name is properly registered and consistently used

The verification confirms that:

  • The route is properly registered in lib/features/family/app/family_pages.dart as profileSelection with path '/profile-selection' and name 'PROFILE_SELECTION'
  • The route is correctly configured in the router setup in lib/features/family/app/family_routes.dart
  • The route name is consistently used across multiple features in the application
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the profileSelection route is properly registered in the router
# Expected: Find the route definition in app_router.dart

# Search for the route definition
ast-grep --pattern 'name: $route' | grep -i "profileSelection"

# Also check for any usages to ensure consistency
rg "profileSelection" --type dart

Length of output: 2779

Navigator.of(context).popUntil(
ModalRoute.withName(
FamilyPages.profileSelection.name,
),
Copy link
Contributor

@MaikelStuivenberg MaikelStuivenberg Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous solution was clearing the stack first, is that not needed anymore?

I think it can cause other problems if we don't do that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhere else in the app we also have a clear solution for this navigation (with a for loop I think)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are only 2 places we navigate without gorouter to this specific path and this these. From what i find online goNamed clears the stack, but im trying to test

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah okay! Maybe that was with a push what I have seen :)

Did a search on Google: With go() "Navigating to a destination in GoRouter will replace the current stack of screens with the screens configured to be displayed for the destination route."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that is the same as named :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Navigating to a destination in GoRouter will replace the current stack of screens with the screens configured to be displayed for the destination route.
GoRouter docs

@Daniela510 Daniela510 merged commit deefec5 into develop Nov 26, 2024
1 check passed
@Daniela510 Daniela510 deleted the bug/navigate-to-homescreen-only-via-go-router branch November 26, 2024 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants