Add const / permissions function for help side panel beta by blazejkustra · Pull Request #59221 · Expensify/App

blazejkustra · 2025-03-27T13:49:20Z

Explanation of Change

Add a function canUseHelpSidePanel() for the usePermissions() hook, that we can use to check if a user should see the help panel button. There was a bug that caused users on production to see the button at some point, so we thought it might be safer to use a beta instead.

Fixed Issues

N/A Part of #56988

Tests

Sign in with an account that's part of the beta newDotHelpSidePanel, or part of all betas
Make sure you can see the help panel button in the top right corner
Sign out, sign in again with an account
Make sure you do not see the help panel button in the top right corner

Offline tests

N/A

QA Steps

Sign in on staging with an *expensifail.com account
Make sure you can see the help button in the top right corner of the screen
Sign out, sign in with a gmail account or any other private domain
Make sure you cannot see the help button in the top right corner of the screen

PR Author Checklist

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

francoisl · 2025-03-28T18:36:11Z

Oh nice, I guess I can close #58751 if we go ahead with this then?

blazejkustra · 2025-03-31T07:34:58Z

Oh nice, I guess I can close #58751 if we go ahead with this then?

Yes please!

…e-flag

melvin-bot · 2025-03-31T07:49:08Z

@carlosmiceli 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]

blazejkustra · 2025-03-31T12:37:24Z

@carlosmiceli I think you can ignore this PR, @francoisl has context and will likely review it!

brunovjk · 2025-03-31T14:22:11Z

@blazejkustra Using an account with beta permissions, when setting the object to null Onyx.set('nvp_sidePanel', null), the help button does not disappear, we just cannot open the panel, was this expected? Thanks.

Screen.Recording.2025-03-31.at.11.04.56.mov

brunovjk · 2025-03-31T14:22:18Z

    const {isExtraLargeScreenWidth, shouldUseNarrowLayout} = useResponsiveLayout();
    const [sidePaneNVP] = useOnyx(ONYXKEYS.NVP_SIDE_PANE);
    const [language] = useOnyx(ONYXKEYS.NVP_PREFERRED_LOCALE);
+    const [canUseHelpSidePanel = false] = useOnyx(ONYXKEYS.BETAS, {selector: (betas) => !!betas?.includes(CONST.BETAS.HELP_SIDE_PANEL)});


I wonder why we don't use usePermissions() here? Thanks.

I don't know why but usePermissions was breaking GH checks here

brunovjk · 2025-03-31T14:22:20Z

+    const isSidePaneHiddenOrLargeScreen = !isSidePaneVisible || isLanguageUnsupported || isExtraLargeScreenWidth || !canUseHelpSidePanel;

    // The help button is hidden when:
    // - side pane nvp is not set


Also, do we need to update this comment like we did in the other PR.?

cc: @francoisl

…e-flag

… sidePaneNVP

blazejkustra · 2025-03-31T15:02:05Z

the help button does not disappear, we just cannot open the panel, was this expected? Thanks.

No it wasn't.. Great find @brunovjk! Fixed in the latest commit

brunovjk · 2025-03-31T15:17:24Z

Great @blazejkustra, I have to go now, I will complete the checklist by the end of the day.

blazejkustra · 2025-04-01T08:10:10Z

Great @blazejkustra, I have to go now, I will complete the checklist by the end of the day.

@brunovjk Any updates?

brunovjk · 2025-04-01T10:05:38Z

Sorry, I was dealing with the deploy blocker and ran out of time. I'll review it now.

blazejkustra · 2025-04-01T10:06:32Z

No worries! Thank you 🚀

brunovjk · 2025-04-01T14:47:29Z

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: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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: Native

59221_android_native.mov

Android: mWeb Chrome

Uploading 59221_android_web.mov…

iOS: Native

59221_ios_native.mov

iOS: mWeb Safari

Uploading 59221_ios_web.mov…

MacOS: Chrome / Safari

59221_web_chrome.mov

MacOS: Desktop

59221_web_desktop.mov

brunovjk

LGTM :D

melvin-bot · 2025-04-01T14:50:42Z

🎯 @brunovjk, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #59447.

brunovjk · 2025-04-01T14:51:30Z

All yours @francoisl :D

carlosmiceli · 2025-04-01T14:52:51Z

Oh, lol, just seeing the comments, went straight to review! All yours @francoisl :D

francoisl · 2025-04-01T17:46:42Z

+function canUseHelpSidePanel(betas: OnyxEntry<Beta[]>): boolean {
+    return !!betas?.includes(CONST.BETAS.HELP_SIDE_PANEL) || canUseAllBetas(betas);
+}


So this isn't used anywhere? If so let's remove it.

We have a tracking issue to remove the beta when it's no longer needed anyway, not blocking on this.

Ahh, I missed that one 🤦 I should've used this function as the selector of useOnyx. I'll refactor it for Stage 4

OSBotify · 2025-04-02T23:02:30Z

✋ 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-04-03T16:11:33Z

🚀 Deployed to staging by https://github.com/francoisl in version: 9.1.23-1 🚀

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

nlemma · 2025-04-03T19:42:50Z

@blazejkustra @brunovjk QA team is not seeing the help button even after using an Expensifail account and running Onyx.set('nvp_sidePanel', {}) or Onyx.set('nvp_sidePanel', null) or Onyx.set('nvp_sidePaneExpanded', null) in the console. Is there any additional step we need to take to be able to see the button?

Screenrecorder-2025-04-03-22-09-25-632.mp4

francoisl · 2025-04-03T21:21:16Z

@nlemma this is because we need to add accounts to a beta differently for this, it doesn't work on every expensifail account like other betas. I added applausetester+bp0104h@applause.expensifail.com, so it should work from that account now.

github-actions · 2025-04-07T20:32:25Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.23-7 🚀

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

…x key Revert "Merge pull request #59221 from software-mansion-labs/side-pane-feature-flag" This reverts commit 5f1a121, reversing changes made to b8b68af.

blazejkustra added 2 commits March 27, 2025 14:47

Add HELP_SIDE_PANEL constant and permission check

59f7a38

Add help side panel beta check to side pane display logic

f55e52f

blazejkustra mentioned this pull request Mar 28, 2025

Add const / permissions function for help side panel beta #58751

Closed

50 tasks

Merge branch 'main' of github.com:Expensify/App into side-pane-featur…

286f013

…e-flag

blazejkustra marked this pull request as ready for review March 31, 2025 07:48

blazejkustra requested a review from a team as a code owner March 31, 2025 07:48

melvin-bot Bot requested a review from carlosmiceli March 31, 2025 07:49

melvin-bot Bot removed the request for review from a team March 31, 2025 07:49

brunovjk reviewed Mar 31, 2025

View reviewed changes

blazejkustra added 2 commits March 31, 2025 16:54

Merge branch 'main' of github.com:Expensify/App into side-pane-featur…

6205e0d

…e-flag

refactor: simplify side pane logic by removing unnecessary checks for…

c967cd8

… sidePaneNVP

289Adam289 approved these changes Mar 31, 2025

View reviewed changes

francoisl self-requested a review March 31, 2025 20:56

brunovjk approved these changes Apr 1, 2025

View reviewed changes

melvin-bot Bot mentioned this pull request Apr 1, 2025

Payment issue for E/App PR#59221 #59447

Closed

carlosmiceli approved these changes Apr 1, 2025

View reviewed changes

francoisl reviewed Apr 1, 2025

View reviewed changes

francoisl merged commit 5f1a121 into Expensify:main Apr 2, 2025

github-actions Bot mentioned this pull request Apr 3, 2025

Deploy Checklist: New Expensify 2025-04-03 #59590

Closed

86 tasks

This was referenced Apr 4, 2025

[SIDEPANE] Build "Stage 3)" of "Add live-navigating help side pane" #58732

Closed

Payment for Help Panel implementation for C+ #59081

Closed

francoisl mentioned this pull request Apr 10, 2025

[Due for payment 2025-04-23] [Side Panel] Remove newDotHelpSidePanel beta, restore previous logic #60069

Closed

francoisl mentioned this pull request Apr 11, 2025

[CP Staging] Remove beta newDotHelpSidePanel, show help button only based on Onyx key #60135

Merged

50 tasks

Uh oh!

Conversation

blazejkustra commented Mar 27, 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!

francoisl commented Mar 28, 2025

Uh oh!

blazejkustra commented Mar 31, 2025

Uh oh!

melvin-bot Bot commented Mar 31, 2025

Uh oh!

blazejkustra commented Mar 31, 2025

Uh oh!

brunovjk commented Mar 31, 2025

Uh oh!

brunovjk Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

blazejkustra Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

brunovjk Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

blazejkustra Mar 31, 2025

Choose a reason for hiding this comment

Uh oh!

blazejkustra commented Mar 31, 2025

Uh oh!

brunovjk commented Mar 31, 2025

Uh oh!

blazejkustra commented Apr 1, 2025

Uh oh!

brunovjk commented Apr 1, 2025

Uh oh!

blazejkustra commented Apr 1, 2025

Uh oh!

brunovjk commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

brunovjk left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Apr 1, 2025

Uh oh!

brunovjk commented Apr 1, 2025

Uh oh!

carlosmiceli commented Apr 1, 2025

Uh oh!

francoisl Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

francoisl Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

blazejkustra Apr 3, 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!

OSBotify commented Apr 2, 2025

Uh oh!

github-actions Bot commented Apr 3, 2025

Uh oh!

nlemma commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

francoisl commented Apr 3, 2025

Uh oh!

github-actions Bot commented Apr 7, 2025

Uh oh!

Reviewers

blazejkustra commented Mar 27, 2025 •

edited

Loading

brunovjk commented Apr 1, 2025 •

edited

Loading

blazejkustra Apr 3, 2025 •

edited

Loading

nlemma commented Apr 3, 2025 •

edited

Loading