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

chore(suite-native): refactor navigation route matching #16965

Merged
merged 1 commit into from
Feb 17, 2025

Conversation

Lemonexe
Copy link
Contributor

Description

Tweak navigation route matching in useHandleDeviceConnection. I searched for all occurrences of .routes, but did not find any other files which could do with such refactoring.

I tested that in following cases, the navigation behavior is unchanged:

  • already initialized device: connect leads to connecting screen & disconnect to Home (no device connected screen)
  • uninitialized T2B1 ➡️ click no in Security check, gets to Suspicious device screen, when I disconnect the screen stays and only after closing I am navigated back to Home (no device connected screen)

Related Issue

Related to #16452

@Lemonexe Lemonexe added mobile Suite Lite issues and PRs no-project This label is used to specify that PR doesn't need to be added to a project labels Feb 12, 2025
// If the device is connected again, he still should stay on that screen.
const isSuspiciousDeviceScreenFocused = useNavigationRouteMatch(
OnboardingStackRoutes.SuspiciousDevice,
);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

In this case we want to match the most specific route.
For that purpose we can use useNavigationRouteMatch, introduced in #16959.

ofc useRoute would be best, but that's not possible here

OnboardingStackRoutes.SuspiciousDevice,
);

const lastRoute = useNavigationState(state => state?.routes.at(-1)?.name);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, the current implementation may be buggy! TL;DR useNavigateState ensures that we'll rerender when the state changes (or more precisely - when the selector return value changes, similarly to redux useSelector)

💭 these cases are not matching the most specific route, but rather the first stack under RootStackNavigator. useNavigationRouteMatch only matches the lowest (most specific) route. I guess I could refactor it to gradually match at any hierarchy level, but for such simple case I think that useNavigationState directly is fine 🙂

@Lemonexe Lemonexe marked this pull request as ready for review February 12, 2025 18:23
@Lemonexe Lemonexe requested a review from a team as a code owner February 12, 2025 18:23
@Lemonexe Lemonexe force-pushed the feat/mobile-FW-rev-check-banners-atom-renderer branch from 66ae21b to d0b9416 Compare February 14, 2025 08:29
@Lemonexe Lemonexe marked this pull request as draft February 14, 2025 10:41
@Lemonexe Lemonexe force-pushed the chore/refactor-navigation-route-matching branch from 2751acd to 88c32b7 Compare February 14, 2025 16:06
@Lemonexe Lemonexe marked this pull request as ready for review February 14, 2025 16:07
Copy link

github-actions bot commented Feb 14, 2025

🚀 Expo preview is ready!

  • Project → trezor-suite-preview
  • Platforms → android, ios
  • Scheme → trezorsuitelite
  • Runtime Version → 26
  • More info

Learn more about 𝝠 Expo Github Action

Copy link
Contributor

@PeKne PeKne left a comment

Choose a reason for hiding this comment

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

Nice improvement, works as expected 👌

@trezor-ci trezor-ci force-pushed the feat/mobile-FW-rev-check-banners-atom-renderer branch from c5d37d0 to 10a2c27 Compare February 17, 2025 08:20
Base automatically changed from feat/mobile-FW-rev-check-banners-atom-renderer to develop February 17, 2025 09:07
@Lemonexe Lemonexe force-pushed the chore/refactor-navigation-route-matching branch from 88c32b7 to c1e5c37 Compare February 17, 2025 09:15
Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

The changes update the navigation state management in the device connection hook. The previous implementation used a separate function to determine if the current screen was the suspicious device screen. This approach has been replaced by directly using useNavigationRouteMatch from the @react-navigation/native package to assess if the current route matches the designated suspicious device route. Additionally, useNavigationState is now employed to derive the current route, and the conditional checks and dependency arrays in the associated useEffect hooks have been adjusted to work with these new values. The overall control flow of the hook remains unchanged, with modifications focused on utilizing navigation hooks directly instead of maintaining separate logic functions.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

@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

🧹 Nitpick comments (1)
suite-native/device/src/hooks/useHandleDeviceConnection.ts (1)

178-180: Consider implementing the suggested TODO improvement.

The TODO comment suggests a potential improvement to simplify the complex navigation logic by introducing a single source of truth. This would make the code more maintainable and easier to understand.

Consider refactoring to use a single function that determines the target route based on the current state, replacing the multiple useEffect hooks with imperative navigation instructions. This would make the navigation logic more declarative and easier to maintain.

Example approach:

const getTargetRoute = (state: AppState): Route => {
  if (state.isFirmwareInstallationRunning) return currentRoute;
  if (state.isDeviceCompromisedModalFocused) return currentRoute;
  if (state.isSuspiciousDeviceScreenFocused) return currentRoute;
  // ... other conditions
  return { name: RootStackRoutes.AppTabs, params: { ... } };
};
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d9a4f0e and c1e5c37.

📒 Files selected for processing (1)
  • suite-native/device/src/hooks/useHandleDeviceConnection.ts (9 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: EAS Update
  • GitHub Check: Analyze with CodeQL (javascript)
  • GitHub Check: prepare_android_test_app
  • GitHub Check: Setup and Cache Dependencies
🔇 Additional comments (3)
suite-native/device/src/hooks/useHandleDeviceConnection.ts (3)

4-4: LGTM! Import changes align with refactoring goals.

The addition of navigation hooks from '@react-navigation/native' and '@suite-native/navigation' supports the route matching refactoring.

Also applies to: 30-30


72-80: LGTM! Navigation state management improvements.

The changes improve the route matching logic in two ways:

  1. useNavigationRouteMatch ensures matching the most specific route for the suspicious device screen.
  2. useNavigationState guarantees proper re-rendering when navigation state changes.

The added comments clearly explain the suspicious device screen behavior.


88-88: LGTM! Consistent effect hook changes.

The suspicious device screen check is consistently added to all relevant useEffect hooks and their dependency arrays, ensuring proper handling of the suspicious device screen state.

Also applies to: 114-114, 124-124, 165-165, 181-181, 198-198

@Lemonexe Lemonexe merged commit 9debf4e into develop Feb 17, 2025
16 checks passed
@Lemonexe Lemonexe deleted the chore/refactor-navigation-route-matching branch February 17, 2025 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mobile Suite Lite issues and PRs no-project This label is used to specify that PR doesn't need to be added to a project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants