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): pin matrix screen oveflow #17230

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

PeKne
Copy link
Contributor

@PeKne PeKne commented Feb 25, 2025

  • shrinks/hides the image on pin matrix screen if the screen is too small to render everything

Related Issue

Resolve #17035

@PeKne PeKne added the mobile Suite Lite issues and PRs label Feb 25, 2025
@PeKne PeKne requested a review from a team as a code owner February 25, 2025 14:54
Copy link

coderabbitai bot commented Feb 25, 2025

Walkthrough

This pull request makes adjustments in two separate components. In the first component, a new state variable isImageDisplayed and the function handlePinMatrixLayoutEvent are introduced to manage the visibility of an image based on the height of the pin matrix layout relative to half the screen height. The rendering logic for the Image component is modified to conditionally display the image based on this state, and the layout structure is updated for responsiveness. In the second component, the hasBottomInset prop has been removed from the Screen component, which may affect the bottom inset behavior during rendering. No public or exported entity declarations were modified in the second component.

✨ 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: 1

🧹 Nitpick comments (2)
suite-native/module-authorize-device/src/components/connect/PinOnKeypad.tsx (2)

89-89: Initialization default could cause layout shift.

Setting isImageDisplayed to true by default might cause a flash of the image on initial render before layout measurements are taken, potentially causing a layout shift.

Consider using a null state initially and only showing the image after layout is measured:

-const [isImageDisplayed, setIsImageDisplayed] = useState(true);
+const [isImageDisplayed, setIsImageDisplayed] = useState<boolean | null>(null);

Then in the render:

-{isImageDisplayed && (
+{isImageDisplayed !== false && (

93-101: Document the threshold selection rationale.

The current implementation uses 50% of screen height as the threshold, but there's no clear explanation for why this specific value was chosen.

Consider extracting this magic number to a named constant and documenting the rationale:

-const SCREEN_HEIGHT = getScreenHeight();
+// We hide the device image if the pin matrix takes up more than half the screen
+// to prevent overflow issues on smaller devices
+const SCREEN_HEIGHT = getScreenHeight();
+const PIN_MATRIX_HEIGHT_THRESHOLD = 0.5 * SCREEN_HEIGHT;

// And then in the handler:
-if (event.nativeEvent.layout.height > 0.5 * SCREEN_HEIGHT) {
+if (event.nativeEvent.layout.height > PIN_MATRIX_HEIGHT_THRESHOLD) {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3940c87 and 3a9d70f.

📒 Files selected for processing (2)
  • suite-native/module-authorize-device/src/components/connect/PinOnKeypad.tsx (3 hunks)
  • suite-native/module-device-settings/src/components/DeviceInteractionScreenWrapper.tsx (0 hunks)
💤 Files with no reviewable changes (1)
  • suite-native/module-device-settings/src/components/DeviceInteractionScreenWrapper.tsx
⏰ 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 (4)
suite-native/module-authorize-device/src/components/connect/PinOnKeypad.tsx (4)

1-8: Appropriate imports added for new functionality.

The added imports for useState, LayoutChangeEvent, and getScreenHeight provide the necessary tools to implement the responsive behavior needed to address the pin matrix overflow issue.


72-76: Good image styling approach for responsive display.

The image styling with flex: 1, width: 100%, and maxHeight: 194 creates a responsive image that maintains proportions while setting appropriate constraints.


104-117: Clean responsive layout implementation.

The responsive approach to conditionally rendering the image based on available space is well implemented. The flex justification and alignment properties ensure proper content placement when the image is hidden.


118-149: Effective event handling implementation.

Using the onLayout event handler on the Box wrapper is an effective way to measure the pin matrix and make layout decisions. The approach correctly implements the PR objective to prevent overflow by conditionally displaying the image.

maxHeight: 194,
}));

const SCREEN_HEIGHT = getScreenHeight();
Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Consider handling orientation changes for SCREEN_HEIGHT.

The SCREEN_HEIGHT constant is defined outside the component and won't update if orientation changes. If the app supports rotation, this could lead to incorrect display decisions.


🏁 Script executed:

#!/bin/bash
# Check if the app handles orientation changes elsewhere
rg -A 2 -B 2 "orientation|Orientation|portrait|landscape" --type ts

Length of output: 20662


🏁 Script executed:

#!/bin/bash
# Search for usage of getScreenHeight in the repository to see if there's any dynamic updating
rg "getScreenHeight" --type ts

Length of output: 2261


Action required: Dynamically update SCREEN_HEIGHT on orientation change

The current implementation of

const SCREEN_HEIGHT = getScreenHeight();

defines SCREEN_HEIGHT at module load time, meaning its value won’t update when the device’s orientation changes. Given that orientation events are handled elsewhere in the app (e.g., via the orientationchange listener in SuiteLayout), you should consider one of the following approaches in this component:

  • Move the call to getScreenHeight() inside the component’s render or a hook (such as using state with an event listener on orientation change).
  • Subscribe to orientation or resize updates (using React Native’s Dimensions.addEventListener or equivalent) to update the screen height dynamically.

Please review and adjust the implementation to ensure that the component correctly reflects display changes after rotation.

Copy link

github-actions bot commented Feb 25, 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

Comment on lines 95 to 100
if (event.nativeEvent.layout.height > 0.5 * SCREEN_HEIGHT) {
setIsImageDisplayed(false);

return;
}
setIsImageDisplayed(true);
Copy link
Contributor

Choose a reason for hiding this comment

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

What about this?

Suggested change
if (event.nativeEvent.layout.height > 0.5 * SCREEN_HEIGHT) {
setIsImageDisplayed(false);
return;
}
setIsImageDisplayed(true);
setIsImageDisplayed(event.nativeEvent.layout.height <= 0.5 * SCREEN_HEIGHT);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good idea, fixed 11453ba

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: 1

♻️ Duplicate comments (1)
suite-native/module-authorize-device/src/components/connect/PinOnKeypad.tsx (1)

78-78: ⚠️ Potential issue

SCREEN_HEIGHT should be calculated inside the component

Defining SCREEN_HEIGHT outside the component means it won't update if the device orientation changes. This could lead to incorrect display decisions after rotation.

Move this constant inside the component and use a state variable with an effect to listen for dimension changes:

-const SCREEN_HEIGHT = getScreenHeight();

export const PinOnKeypad = ({ variant, onSuccess }: PinOnKeypadProps) => {
+   const [screenHeight, setScreenHeight] = useState(getScreenHeight());
+   
+   useEffect(() => {
+       const dimensionsHandler = Dimensions.addEventListener(
+           'change',
+           () => setScreenHeight(getScreenHeight())
+       );
+       
+       return () => dimensionsHandler.remove();
+   }, []);

Don't forget to import the necessary dependencies:

-import { useState } from 'react';
+import { useState, useEffect } from 'react';
+import { Dimensions } from 'react-native';
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3a9d70f and 11453ba.

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

72-76: Image style looks good

The styles applied to the image will allow it to maintain an appropriate size while remaining responsive, which helps with the overflow issue.


89-89: State initialization looks good

Using useState to track image visibility is a good approach for conditional rendering.


98-111: Improved VStack layout with conditional image rendering

The changes to the VStack, including justifyContent="flex-end" and conditional rendering of the image, improve the layout's responsiveness.


112-143: Improved form layout structure

Wrapping the form in a Box with onLayout event handler is a good approach to handle responsive behavior based on available space.

Comment on lines +93 to +96
// Hide image if the screen is too small to fit both the image and the pin matrix.
const handlePinMatrixLayoutEvent = (event: LayoutChangeEvent) =>
setIsImageDisplayed(event.nativeEvent.layout.height <= 0.5 * SCREEN_HEIGHT);

Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Logic seems inverted in handlePinMatrixLayoutEvent

The current condition hides the image when there should be plenty of space (when layout height is small). This seems counterintuitive.

-    const handlePinMatrixLayoutEvent = (event: LayoutChangeEvent) =>
-        setIsImageDisplayed(event.nativeEvent.layout.height <= 0.5 * SCREEN_HEIGHT);
+    const handlePinMatrixLayoutEvent = (event: LayoutChangeEvent) =>
+        setIsImageDisplayed(event.nativeEvent.layout.height < 0.5 * screenHeight);

The exact condition might need further refinement based on your specific layout requirements. Consider this alternative that was suggested in a previous comment:

setIsImageDisplayed(event.nativeEvent.layout.height <= 0.5 * SCREEN_HEIGHT);

Committable suggestion skipped: line range outside the PR's diff.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PIN entry for T1 on mobile is out of view for some phones or displays
2 participants