Jakubkalinski0/Help panel overlays with TestTools modal by jakubkalinski0 · Pull Request #66882 · Expensify/App

jakubkalinski0 · 2025-07-22T12:57:25Z

Explanation of Change

In this case where the problem was caused by the help side panel and not the TestTools.ts modal. To ensure it works properly the opening TestTools.ts modal with shortcut was tested with other right-docked modals open like AvatarCropModal.tsx, which responded well to the 'Cmd+D' command and closed accordingly, which assured me it was the help side panel responsible for the overlapping. The solution was straightforward, following the approach already used in HelpModal/index.tsx, where the side panel is closed directly in the HelpModal/index.tsx when the 'Cmd + D' shortcut is activated, similar to the shortcuts responsible for 'Escape', 'New chat', or 'Search' which also close the help side panel.

Fixed Issues

$ #66246
PROPOSAL: doesn't apply -> SWM engineer

Tests

Prerequisites:

Run the following command in the web console using the same account:
Onyx.set('nvp_sidePanel', {})
Click the Help button, then close the help panel.

Reproduction steps:

Launch web app on a large screen
Open help panel
Open TestTools Modal (Cmd+D)
The help panel should hide and TestTools modal should open

Verify that no errors appear in the JS console

Offline tests

SAME AS TESTS ^

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

SAME AS TESTS ^

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

macOS_safari.mov

MacOS: Desktop

macOS_desktop.mov

melvin-bot · 2025-07-23T10:38:03Z

@rojiphil Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

rojiphil · 2025-07-24T17:58:07Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified there are no new alerts related to the canBeMissing param for useOnyx
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp

66882-android-hybrid-001.mp4

Android: mWeb Chrome

NA

iOS: HybridApp

66882-ios-hybrid-001.mp4

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

66882-web-chrome-001.mp4

MacOS: Desktop

66882-desktop-001.mp4

rojiphil

Changes LGTM and works well too..
Approving to take this forward

melvin-bot · 2025-07-24T17:58:45Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #66246 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

marcochavezf · 2025-07-25T10:41:03Z

    // Close Side Panel on escape key press
    useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ESCAPE, () => closeSidePanel(), {isActive: !isExtraLargeScreenWidth, shouldBubble: false});
+    // Close Side Panel on debug key press i.e. opening the TestTools modal
+    useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.DEBUG, () => closeSidePanel(), {shouldBubble: true});


Can we add a unit test for this case?

Yeah, I will take care of that.

After looking into this, I'm not sure if we should test this, especially since we've never tested any shortcuts before and this would be a first. Considering this, are you sure we want to do the unit test here?

How difficult would it be to add a unit test for this case?

It would require some unpleasant mocks. However, I think it would be more beneficial to conduct unit tests on the KeyboardShortcut (it configures a global keyboard event handler), as it is the underlying component that hasn't been tested anywhere yet. Testing KeyboardShortcut would be more valuable and worthwhile, since it is responsible for executing the core functionality used across various places, while useKeyboardShortcut only utilizes it.

@marcochavezf Whats your opinion about this proposition?

Oh I see, thanks for the explanation! @mountiny what are your thoughts about this case? Should we add unit tests for KeyboardShortcut here, should we create a new issue for that or :donothing: for now?

I think this sounds quite complex at the moment and we could handle this next time. So do nothing for now

marcochavezf

LGTM, thanks guys!

OSBotify · 2025-07-30T11:11:22Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-07-31T12:17:20Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 9.1.88-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

github-actions · 2025-08-04T19:24:15Z

🚀 Deployed to production by https://github.com/grgia in version: 9.1.88-3 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

Proposition for fixing help side panel overlapping debug modal

b57dd76

jakubkalinski0 changed the title ~~Jakubkalinski0/Help panel overlays with TestTools modal #66246~~ Jakubkalinski0/Help panel overlays with TestTools modal Jul 22, 2025

Added comment

a9c70e7

blazejkustra approved these changes Jul 23, 2025

View reviewed changes

jakubkalinski0 marked this pull request as ready for review July 23, 2025 10:37

jakubkalinski0 requested a review from a team as a code owner July 23, 2025 10:37

melvin-bot Bot requested review from rojiphil and removed request for a team July 23, 2025 10:38

rojiphil approved these changes Jul 24, 2025

View reviewed changes

melvin-bot Bot requested a review from marcochavezf July 24, 2025 17:58

marcochavezf requested changes Jul 25, 2025

View reviewed changes

marcochavezf approved these changes Jul 30, 2025

View reviewed changes

marcochavezf merged commit 45120f9 into Expensify:main Jul 30, 2025

github-actions Bot mentioned this pull request Jul 31, 2025

Deploy Checklist: New Expensify 2025-07-31 #67499

Closed

90 tasks done

melvin-bot Bot mentioned this pull request Aug 4, 2025

[$250] [Due for payment 2025-08-11] Help panel overlays with TestTools modal #66246

Closed

4 of 16 tasks

Conversation

jakubkalinski0 commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jul 23, 2025

Uh oh!

rojiphil commented Jul 24, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

rojiphil left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Jul 24, 2025

Uh oh!

marcochavezf Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

jakubkalinski0 Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

jakubkalinski0 Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

marcochavezf Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

jakubkalinski0 Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jakubkalinski0 Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcochavezf Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

marcochavezf left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jul 30, 2025

Uh oh!

github-actions Bot commented Jul 31, 2025

Uh oh!

github-actions Bot commented Aug 4, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jakubkalinski0 commented Jul 22, 2025 •

edited

Loading

jakubkalinski0 Jul 28, 2025 •

edited

Loading

jakubkalinski0 Jul 29, 2025 •

edited

Loading