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-native): fix device onboarding feature flag evaluation #16941

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

PeKne
Copy link
Contributor

@PeKne PeKne commented Feb 12, 2025

Description

  • fixes usage of IsDeviceOnboardingEnabled so the device onboarding flow is hidden for the production builds

@PeKne PeKne added mobile Suite Lite issues and PRs release-native Has to be included in the upcoming release. labels Feb 12, 2025
@PeKne PeKne requested a review from a team as a code owner February 12, 2025 04:24
Copy link

coderabbitai bot commented Feb 12, 2025

Walkthrough

The changes involve modifications to the device connection hook and the selectors managing device state. In the hook, a new condition is added to one of the useEffect sections by incorporating !isDeviceSetupSupported into the logic. This update alters when prioritized device access is requested and the navigation to the authorization screen occurs, while other effects in the hook remain unchanged. In the selectors file, the NativeDeviceRootState type is augmented to include FeatureFlagsRootState, and the selector for device setup support now incorporates a check for a feature flag related to device onboarding. Additionally, a new module import has been incorporated to support the feature flag logic. No changes were made to the exported or public entities beyond these internal modifications.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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)

181-183: Consider refactoring the navigation logic.

The TODO comment suggests that the navigation logic is becoming complex and hard to understand. Consider implementing a single source of truth for navigation state.

Consider extracting the navigation logic into a separate function that returns the target route based on the current state. This would make the logic more maintainable and easier to test. Example:

+const getTargetRoute = (state: {
+  isDeviceSetupSupported: boolean;
+  isDeviceInitialized: boolean;
+  isDeviceConnected: boolean;
+  // ... other state
+}): Route => {
+  if (state.isDeviceSetupSupported && !state.isDeviceInitialized) {
+    return { stack: RootStackRoutes.OnboardingStack, screen: OnboardingStackRoutes.UninitializedDeviceLanding };
+  }
+  // ... other conditions
+  return { stack: RootStackRoutes.AppTabs, screen: AppTabsRoutes.HomeStack };
+};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1516375 and bdad929.

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

1-1: LGTM! Type definition updated correctly.

The addition of FeatureFlagsRootState to NativeDeviceRootState type is necessary to support the new feature flag functionality.

Also applies to: 50-51


202-212: Verify the impact of feature flag on device setup.

The updated selectIsDeviceSetupSupported selector now includes a feature flag check that could prevent device setup even for supported models. This is a significant change in behavior.

Let's verify the usage of this selector to ensure we understand the impact:

Additionally, let's verify that the feature flag is properly defined:

❌ Verification inconclusive

🏁 Script executed:

#!/bin/bash
# Search for usages of selectIsDeviceSetupSupported
rg "selectIsDeviceSetupSupported" -A 3

Length of output: 1865


🏁 Script executed:

#!/bin/bash
# Search for the IsDeviceOnboardingEnabled feature flag definition
rg "IsDeviceOnboardingEnabled.*=|enum.*IsDeviceOnboardingEnabled" -A 3

Length of output: 72


Impact of Feature Flag on Device Setup Behavior

  • The selectIsDeviceSetupSupported selector now returns false if the feature flag (FeatureFlag.IsDeviceOnboardingEnabled) is disabled—even when the device model is valid and supported by isDeviceSetupSupported(model).
  • Usages in files like useDetectDeviceError.tsx and useHandleDeviceConnection.ts imply that this change directly affects application behavior regarding device setup.
  • The initial search for the feature flag’s definition produced no output. Please verify that FeatureFlag.IsDeviceOnboardingEnabled is correctly defined (or imported) in the codebase or configuration to ensure the intended behavior.
suite-native/device/src/hooks/useHandleDeviceConnection.ts (2)

168-169: LGTM! Dependency array updated correctly.

The addition of isDeviceSetupSupported to the dependency array is necessary as it's used in the effect's condition.


136-138: Verify the navigation logic with the new condition.

The addition of !isDeviceSetupSupported to the condition means that devices that support setup will skip the authorization flow. This is a significant change in the navigation logic.

Let's verify the navigation paths to ensure we understand all scenarios:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Search for navigation to AuthorizeDeviceStack
rg "navigate.*AuthorizeDeviceStack" -A 3

# Search for navigation to OnboardingStack
rg "navigate.*OnboardingStack" -A 3

Length of output: 10384


Navigation Logic Verification: The new condition behaves as intended.

  • In suite-native/device/src/hooks/useHandleDeviceConnection.ts, the condition now includes !isDeviceSetupSupported, which ensures that if a device supports setup, it will bypass the authorization flow.
  • The code navigates to RootStackRoutes.AuthorizeDeviceStack (e.g., with the ConnectingDevice screen) only when both !shouldNavigateToDeviceCompromisedModal and !isDeviceSetupSupported are true.
  • Conversely, when isDeviceSetupSupported is true, the branch that navigates to RootStackRoutes.OnboardingStack (with the UninitializedDeviceLanding screen) is taken, confirming that devices with supported setup skip the authorization flow.
  • The rg search results across the repository corroborate these distinct navigation paths.

@PeKne PeKne self-assigned this Feb 12, 2025
@PeKne PeKne merged commit 26bea22 into develop Feb 12, 2025
20 checks passed
@PeKne PeKne deleted the fix/native/device-onobarding-ff-redirect branch February 12, 2025 09:38
@STew790
Copy link
Contributor

STew790 commented Feb 13, 2025

QA OK
iOS and Android are both ok, I can see the picture in onboarding.

Info
25.2.2 1c150ab

@STew790 STew790 added the QA OK Issue passed QA without any blocker label Feb 13, 2025
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 QA OK Issue passed QA without any blocker release-native Has to be included in the upcoming release.
Projects
Status: ✅ Approved
Development

Successfully merging this pull request may close these issues.

3 participants