Add const / permissions function for help side panel beta#58751
Closed
francoisl wants to merge 6 commits into
Closed
Add const / permissions function for help side panel beta#58751francoisl wants to merge 6 commits into
francoisl wants to merge 6 commits into
Conversation
|
@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] |
Contributor
|
First of all, thank you for adding this @francoisl 😄 Please add my test account: |
Contributor
|
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)); |
blazejkustra
approved these changes
Mar 19, 2025
Contributor
Author
|
Sounds good. I didn't update |
7e8c91f to
9a02023
Compare
Contributor
Reviewer Checklist
Screenshots/VideosAndroid: Native58751_android_native.movAndroid: mWeb Chrome58751_android_native.moviOS: Native58751_ios_native.moviOS: mWeb Safari58751_ios_web.movMacOS: Chrome / Safari58751_web_chrome.mp4MacOS: Desktop58751_web_desktop.mov |
brunovjk
approved these changes
Mar 20, 2025
brunovjk
left a comment
Contributor
There was a problem hiding this comment.
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.
Contributor
Author
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
previously approved these changes
Mar 20, 2025
dangrous
left a comment
Contributor
There was a problem hiding this comment.
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.
Contributor
|
Code looks good, would prefer not to merge with failing tests |
Contributor
|
Tests fail with a cryptic message, seems unrelated 🤔 @francoisl Could you merge the newest main? I believe it should fix this |
This was referenced Mar 21, 2025
Contributor
|
I created a new PR, turns out usePermissions was the culprit for some reason 🤔 |
48 tasks
Contributor
Author
|
Sounds good, going to close this then. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation of Change
Add a function
canUseHelpSidePanel()for theusePermissions()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
newDotHelpSidePanel, or part of all betasOffline tests
N/A
QA Steps
*expensifail.comaccountPR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop