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

francoisl · 2025-03-19T17:33:14Z

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.

Let me know if you have any account you want to be added to the beta

cc @blazejkustra

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

Verify that no errors appear in the JS console

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

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

melvin-bot · 2025-03-19T17:59:35Z

@AndrewGable 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-19T19:41:47Z

First of all, thank you for adding this @francoisl 😄

Please add my test account: [email protected]

blazejkustra · 2025-03-19T19:46:05Z

Would you consider adding logic to put the side pane behind beta? I've prepared a diff for you:

diff --git a/src/hooks/useSidePane.ts b/src/hooks/useSidePane.ts
index a879696359f..3a56b8adadf 100644
--- a/src/hooks/useSidePane.ts
+++ b/src/hooks/useSidePane.ts
@@ -9,6 +9,7 @@ import variables from '@styles/variables';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import type * as OnyxTypes from '@src/types/onyx';
+import usePermissions from './usePermissions';
 import useResponsiveLayout from './useResponsiveLayout';
 import useWindowDimensions from './useWindowDimensions';
 
@@ -28,9 +29,10 @@ function useSidePane() {
     const {windowWidth} = useWindowDimensions();
 
     const [sidePaneNVP] = useOnyx(ONYXKEYS.NVP_SIDE_PANE);
+    const {canUseHelpSidePanel} = usePermissions();
     const [language] = useOnyx(ONYXKEYS.NVP_PREFERRED_LOCALE);
     const isLanguageUnsupported = language !== CONST.LOCALES.EN;
-    const isPaneHidden = isSidePaneHidden(sidePaneNVP, isExtraLargeScreenWidth) || isLanguageUnsupported;
+    const isPaneHidden = isSidePaneHidden(sidePaneNVP, isExtraLargeScreenWidth) || isLanguageUnsupported || !canUseHelpSidePanel;
 
     const sidePaneWidth = shouldUseNarrowLayout ? windowWidth : variables.sideBarWidth;
     const shouldApplySidePaneOffset = isExtraLargeScreenWidth && !isPaneHidden;
@@ -42,10 +44,10 @@ function useSidePane() {
     const shouldHideToolTip = isExtraLargeScreenWidth ? isAnimatingExtraLargeScree : !shouldHideSidePane;
 
     // The help button is hidden when:
-    // - side pane nvp is not set
+    // - side pane beta is disabled
     // - side pane is displayed currently
     // - language is unsupported
-    const shouldHideHelpButton = !sidePaneNVP || !isPaneHidden || isLanguageUnsupported;
+    const shouldHideHelpButton = !canUseHelpSidePanel || !isPaneHidden || isLanguageUnsupported;
 
     const sidePaneOffset = useRef(new Animated.Value(shouldApplySidePaneOffset ? variables.sideBarWidth : 0));
     const sidePaneTranslateX = useRef(new Animated.Value(isPaneHidden ? sidePaneWidth : 0));

francoisl · 2025-03-19T20:07:02Z

Sounds good. I didn't update useSidePane to avoid conflicts in case you were already working on another PR, but happy to do add it now.

brunovjk · 2025-03-20T00:09:13Z

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

58751_android_native.mov

Android: mWeb Chrome

58751_android_native.mov

iOS: Native

58751_ios_native.mov

iOS: mWeb Safari

58751_ios_web.mov

MacOS: Chrome / Safari

58751_web_chrome.mp4

MacOS: Desktop

58751_web_desktop.mov

brunovjk

As it stands in this PR, the Help Panel is initially controlled only by the beta permission, if we change the ONYXKEYS.NVP_SIDE_PANE we just close the panel:

58751_web_desktop_expected_behavior.mov

I believe this is intentional, but can you confirm @blazejkustra and @francoisl? If yes, the PR LGTM, if not, let me know and I will test again and update the checklist.

melvin-bot · 2025-03-20T00:19:08Z

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

melvin-bot · 2025-03-20T00:19:11Z

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

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

francoisl · 2025-03-20T03:55:20Z

As it stands in this PR, the Help Panel is initially controlled only by the beta permission, if we change the ONYXKEYS.NVP_SIDE_PANE we just close the panel:

Yeah, my view would be that from now on we'd only use the beta to tell which accounts can see the help button, and not the snippet anymore.

I fixed the conflict, not sure what's going on with the Jest actions that keep failing though :/

dangrous

Code seems fine to me - though it looks like sometimes we call it a side pane and sometimes a side panel (with / without the l) - do we want to standardize? Not really a blocker since it's pretty clear either way.

AndrewGable · 2025-03-20T15:51:41Z

Code looks good, would prefer not to merge with failing tests

blazejkustra · 2025-03-21T09:57:44Z

Tests fail with a cryptic message, seems unrelated 🤔

# Fatal error in , line 0
# Fatal JavaScript invalid size error 169220804 (see crbug.com/1201626)
#
#
#
#FailureMessage Object: 0x7ffd87e7cdd0
----- Native stack trace -----

 1: 0xd44db1  [/opt/hostedtoolcache/node/20.18.1/x64/bin/node]
 2: 0x218f121 V8_Fatal(char const*, ...) [/opt/hostedtoolcache/node/20.18.1/x64/bin/node]
 3: 0x10d52e8  [/opt/hostedtoolcache/node/20.18.1/x64/bin/node]
 4: 0x12b449f  [/opt/hostedtoolcache/node/20.18.1/x64/bin/node]
 5: 0x12b463a  [/opt/hostedtoolcache/node/20.18.1/x64/bin/node]
 6: 0x152eb76 v8::internal::Runtime_GrowArrayElements(int, unsigned long*, v8::internal::Isolate*) [/opt/hostedtoolcache/node/20.18.1/x64/bin/node]

@francoisl Could you merge the newest main? I believe it should fix this

blazejkustra · 2025-03-28T14:54:11Z

I created a new PR, turns out usePermissions was the culprit for some reason 🤔

francoisl · 2025-03-31T20:57:21Z

Sounds good, going to close this then.

Add beta const / permissions function for help side panel beta

89c4eaa

francoisl self-assigned this Mar 19, 2025

francoisl marked this pull request as ready for review March 19, 2025 17:59

francoisl requested a review from a team as a code owner March 19, 2025 17:59

Merge branch 'main' into francois-beta-help-side-panel

7b631ab

francoisl requested a review from brunovjk March 19, 2025 17:59

melvin-bot bot requested review from AndrewGable and removed request for a team March 19, 2025 17:59

blazejkustra approved these changes Mar 19, 2025

View reviewed changes

francoisl changed the title ~~[NoQA] Add const / permissions function for help side panel beta~~ Add const / permissions function for help side panel beta Mar 19, 2025

Update useSidePane hook to use the new beta

9a02023

francoisl force-pushed the francois-beta-help-side-panel branch from 7e8c91f to 9a02023 Compare March 19, 2025 20:15

Merge branch 'main' into francois-beta-help-side-panel

0487af6

brunovjk approved these changes Mar 20, 2025

View reviewed changes

melvin-bot bot requested a review from dangrous March 20, 2025 00:19

melvin-bot bot mentioned this pull request Mar 20, 2025

Payment issue for E/App PR#58751 #58779

Closed

Fix conflict

5081d73

dangrous previously approved these changes Mar 20, 2025

View reviewed changes

This was referenced Mar 21, 2025

Help Panel - Help panel opens when screen is changed to wide #58823

Closed

[Due for payment 2025-04-02] Help Panel - Help panel is shown on top of the testing preferences dialog #58831

Closed

Merge branch 'main' into francois-beta-help-side-panel

22d2ff4

pecanoro dismissed dangrous’s stale review via 22d2ff4 March 25, 2025 14:37

brunovjk mentioned this pull request Mar 26, 2025

Payment for Help Panel implementation for C+ #59081

Closed

francoisl mentioned this pull request Mar 28, 2025

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

Merged

48 tasks

francoisl closed this Mar 31, 2025

francoisl deleted the francois-beta-help-side-panel branch March 31, 2025 20:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

francoisl commented Mar 19, 2025 •

edited

Loading

Uh oh!

melvin-bot bot commented Mar 19, 2025

Uh oh!

blazejkustra commented Mar 19, 2025

Uh oh!

blazejkustra commented Mar 19, 2025

Uh oh!

francoisl commented Mar 19, 2025

Uh oh!

brunovjk commented Mar 20, 2025

Uh oh!

brunovjk left a comment

Uh oh!

melvin-bot bot commented Mar 20, 2025

Uh oh!

melvin-bot bot commented Mar 20, 2025

Uh oh!

francoisl commented Mar 20, 2025

Uh oh!

dangrous left a comment

Uh oh!

AndrewGable commented Mar 20, 2025

Uh oh!

blazejkustra commented Mar 21, 2025

Uh oh!

blazejkustra commented Mar 28, 2025

Uh oh!

francoisl commented Mar 31, 2025

Uh oh!

Uh oh!

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

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

Uh oh!

Conversation

francoisl commented Mar 19, 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 Mar 19, 2025

Uh oh!

blazejkustra commented Mar 19, 2025

Uh oh!

blazejkustra commented Mar 19, 2025

Uh oh!

francoisl commented Mar 19, 2025

Uh oh!

brunovjk commented Mar 20, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

brunovjk left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Mar 20, 2025

Uh oh!

melvin-bot bot commented Mar 20, 2025

Uh oh!

francoisl commented Mar 20, 2025

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

AndrewGable commented Mar 20, 2025

Uh oh!

blazejkustra commented Mar 21, 2025

Uh oh!

blazejkustra commented Mar 28, 2025

Uh oh!

francoisl commented Mar 31, 2025

Uh oh!

Uh oh!

francoisl commented Mar 19, 2025 •

edited

Loading