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

fix(suite): redirect to index from /start, /onboarding if not initialRun #17286

Merged
merged 1 commit into from
Feb 28, 2025

Conversation

Lemonexe
Copy link
Contributor

@Lemonexe Lemonexe commented Feb 27, 2025

Description

  • create Redirect component, that replaces the same-named Redirect from react-router-dom
  • use it for /start, /onboarding to redirect to Dashboard / connecting screen if onboarding is finished

Related Issue

Resolve #17285

Screenshots:

redirects.webm

@Lemonexe Lemonexe marked this pull request as ready for review February 27, 2025 14:00
Copy link

coderabbitai bot commented Feb 27, 2025

Walkthrough

The changes modify application navigation by introducing a conditional redirection mechanism based on the application's initial run state. A new component, RedirectToDashboard, has been added to perform redirection to the "suite-index" route using a newly implemented Redirect component. The getFullscreenApp function in the Preloader component now accepts an extra boolean parameter, isInitialRun, and its logic has been updated to return either the existing components (SuiteStart or Onboarding) or the new redirection component, based on the parameter's value. Additionally, the new Redirect component is designed to synchronize Redux state with React Router state by dispatching a navigation action within a useLayoutEffect hook, and it returns no visible output after the dispatch.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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)
packages/suite/src/components/suite/Preloader/Preloader.tsx (1)

124-126: Consider addressing the TODO about fullscreen app logic in a future PR.

While not directly related to the current changes, the TODO comment indicates there might be room for improvement in the fullscreen app logic architecture. This could be worth exploring in a separate refactoring PR.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7e92e4b and e6c714e.

📒 Files selected for processing (2)
  • packages/suite/src/components/suite/Preloader/Preloader.tsx (3 hunks)
  • packages/suite/src/support/suite/Redirect.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: e2e-test-suite-web (@group=other)
  • GitHub Check: e2e-test-suite-web (@group=metadata2)
  • GitHub Check: e2e-test-suite-web (@group=metadata1)
  • GitHub Check: run-desktop-tests (@group=wallet, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=passphrase, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=settings, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=device-management, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=suite, trezor-user-env-unix)
🔇 Additional comments (5)
packages/suite/src/support/suite/Redirect.tsx (1)

1-26: Well-designed and documented Redirect component.

This new component effectively handles redirection while maintaining Redux state synchronization with React Router. The use of useLayoutEffect instead of useEffect is a thoughtful choice to prevent flickering during redirection.

packages/suite/src/components/suite/Preloader/Preloader.tsx (4)

29-29: Appropriate import of the new Redirect component.

The import statement correctly references the new custom Redirect component that maintains Redux state synchronization.


44-45: Good pattern for Dashboard redirection.

Creating a dedicated component for dashboard redirection improves maintainability and makes the codebase more expressive by clearly communicating the redirect destination.


46-58: Effective conditional redirection implementation.

The updated function signature with the added isInitialRun parameter allows for clean conditional rendering. The implementation successfully addresses the PR objective by redirecting users away from start/onboarding screens when not in initial run state.


127-127: Correctly passes initialRun state to getFullscreenApp.

This change properly integrates the existing Redux state with the modified function signature, ensuring the redirect logic works as intended.

Copy link
Contributor

@peter-sanderson peter-sanderson left a comment

Choose a reason for hiding this comment

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

👏 LGTM, not tested

@Lemonexe Lemonexe merged commit b5b153b into develop Feb 28, 2025
29 checks passed
@Lemonexe Lemonexe deleted the fix/loading-onboarding-routes-when-not-initialRun branch February 28, 2025 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Accessing /start, /onboarding leads to irrelevant UX flows
2 participants