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

Side Pane Stage 2: Add baseline content for each major section #58004

Merged
merged 24 commits into from
Mar 7, 2025

Conversation

blazejkustra
Copy link
Contributor

@blazejkustra blazejkustra commented Mar 7, 2025

Explanation of Change

Design doc: https://docs.google.com/document/d/1prFcvgUlEGRuL3zE-JH-lhv_BWX2lL2YNw61w4YVnyY/edit?tab=t.0

This PR expands the Help Pane by adding initial content for key sections and ensuring users always see relevant information.

Key Changes:

  • Contextual Help Content: Implemented a content map to show help content based on the current route, falling back to the closest parent if none is available.
  • Initial Content Added: Covers /r, /search, /settings, /settings/workspaces, and /settings/workspaces/:policyID.
  • Handling Missing Content:
    • On staging, missing content shows diagnostic info.
    • On production, the parent page content remains visible instead of an empty panel.
  • Testing & Deployment: Button visibility is still controlled via NVP on production, and all logic remains client-side (no backend integration yet).
    • On staging Help Button and Side Pane will be visible to anyone

Fixed Issues

$ #57860
PROPOSAL: N/A

Also fixes:

Tests

Staging & Development

  1. Run the following snippet in the JS console
    Onyx.set('nvp_sidePane', {})
  2. Verify that the help button appears in the top bar
  3. Click on it to open the help pane
  4. Verify that help content is changed dynamically based on the route
  5. Verify that diagnostic data is displayed at the top of the section if there is no help content for that specific route
  • For example /settings/workspaces/:policyID content exists but child like /settings/workspaces/:policyID/members does not and it should display its parent content

Production (@brunovjk will be able to test it - hardcode isProduction to true in useSidePane.ts and SidePane/index.tsx)

  1. Verify that Side Pane and HelpButton is displayed only if nvp_sidePane is defined in the console:
    Onyx.set('nvp_sidePane', {})
  2. Verify that help content is changed dynamically based on the route
  3. Verify that no 'diagnostic data' is displayed in the help pane for any route that starts with:
  • /r/...
  • /settings/...
  • /search/...

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
untitled.mp4
Android: mWeb Chrome
and-web.webm

☝️ for a brief moment there was no bottom tab on Reports screen, this got fixed in a recent commit

iOS: Native
ios.mp4
iOS: mWeb Safari
ios-web.mp4
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@blazejkustra
Copy link
Contributor Author

blazejkustra commented Mar 7, 2025

PR is almost ready, there is one known issue that me and @adamgrzybowski are trying to fix:

On web, help content is not in sync with the URL when opening RHP for the first time (if you click deeper into RHP it works)

Screen.Recording.2025-03-07.at.11.43.45.mov

Update: fixed!

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Mar 7, 2025

🚧 @shawnborton has triggered a test app build. You can view the workflow run here.

Copy link
Contributor

github-actions bot commented Mar 7, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/58004/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/58004/index.html
Android iOS
Android Hybrid 🤖🔄 iOS Hybrid 🍎🔄
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the Android Hybrid build failed The QR code can't be generated, because the iOS Hybrid build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/58004/NewExpensify.dmg https://58004.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

On small screens, the icon position is a bit inconsistent in my opinion, do you think we can fix it? Thanks.

58004_ios_web_bug.mov

cc: @shawnborton

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

@blazejkustra In "production" and on a small screen, the Help button appears in the header normally, but the content is showing the missing route, not the "Production content":

Screen.Recording.2025-03-07.at.12.43.54.mov

@shawnborton
Copy link
Contributor

On small screens, the icon position is a bit inconsistent in my opinion, do you think we can fix it? Thanks.

What do you mean exactly?

@shawnborton
Copy link
Contributor

Though I could see where maybe those two icons could be slightly closer together. We should match whatever we had in the mocks, which looks like 20px of gap between them:
CleanShot 2025-03-07 at 17 01 59@2x

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

@blazejkustra ESC is not working as it should in android (both native and mWeb), it is returning navigation within the Pane itself instead of closing it:

Android: Native - Staging
58004_android_native_stag.mov
Android: Native - Prod
58004_android_native_prod.mov
Android: mWeb Chrome - Staging
58004_android_web_stag.mov
Android: mWeb Chrome - Prod
58004_android_web_prod.mov

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

On other platforms it looks good to me:

iOS: Native
58004_ios_native_prod.mov
iOS: mWeb Safari
58004_ios_web_prod.mov
58004_ios_web_stag.mov
MacOS: Chrome / Safari
58004_web_chrome_prod.mov
MacOS: Desktop
58004_ios_web_stag.mov
58004_web_chrome_stag.mov

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

On small screens, the icon position is a bit inconsistent in my opinion, do you think we can fix it? Thanks.

What do you mean exactly?

Exactly this:

Though I could see where maybe those two icons could be slightly closer together

Thank you @shawnborton 😃

@blazejkustra
Copy link
Contributor Author

content is showing the missing route for /home

Yes, that is correct. There is no content available for /home, and there is no parent route to inherit the content from. When we populate help with content the aim is to have all top level routes covered as per this message form David.

Does that make sense @brunovjk?

@blazejkustra
Copy link
Contributor Author

ESC is not working as it should in android (both native and mWeb), it is returning navigation within the Pane itself instead of closing it:

I think mobile platforms (at least physical devices) don't have an ESC key at all. Do we still need to handle this behavior? 🤔

@blazejkustra
Copy link
Contributor Author

On small screens, the icon position is a bit inconsistent in my opinion, do you think we can fix it? Thanks.

Let's not block on this, @brunovjk. We can fix it in a follow-up. Maybe another contributor could take it on, as this requires a lot of manual work, and I don’t have the time for it right now. 😅

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

Great!!! Thank you for clarifying!! My bad on the Esc thing hahahaha
I will fill out the checklist in a moment. But all looks good

@brunovjk
Copy link
Contributor

brunovjk commented Mar 7, 2025

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
58004_android_native_stag.mov
Android: mWeb Chrome
58004_android_web_stag.mov
58004_android_native_prod.mov
iOS: Native
58004_android_web_prod.mov
iOS: mWeb Safari
58004_ios_web_prod.mov
58004_ios_web_stag.mov
MacOS: Chrome / Safari
58004_web_chrome_prod.mov
MacOS: Desktop
58004_web_chrome_stag.mov

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

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

Looks good to me, let's address the smallest issues encountered sequentially.

Copy link

melvin-bot bot commented Mar 7, 2025

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

@melvin-bot melvin-bot bot requested a review from amyevans March 7, 2025 20:45
@francoisl francoisl self-requested a review March 7, 2025 20:58
@francoisl
Copy link
Contributor

francoisl commented Mar 7, 2025

On a fresh sign in, the help button doesn't show up on the /r/ route until you open the help pane from another route like /search or /settings, is that expected?

Screen.Recording.2025-03-07.at.1.47.32.PM.mov

@francoisl
Copy link
Contributor

My understanding is that shouldDisplaySidePane here is only based on the NVP, so if it the NVP is not set, we don't render the <HelpButton>. Was that an oversight that we needed to update in this PR?

{shouldDisplaySidePane && <HelpButton style={styles.ml2} />}

@francoisl
Copy link
Contributor

I got it to show regardless of whether the NVP exists in Onyx with this change, but @blazejkustra I'll let you confirm and address in a follow-up PR if needed, in case there's a better solution :)

diff --git a/src/pages/home/HeaderView.tsx b/src/pages/home/HeaderView.tsx
index f6874093ebd..b0c744c5932 100644
--- a/src/pages/home/HeaderView.tsx
+++ b/src/pages/home/HeaderView.tsx
@@ -72,6 +72,7 @@ import SCREENS from '@src/SCREENS';
 import type {Report, ReportAction} from '@src/types/onyx';
 import type {Icon as IconType} from '@src/types/onyx/OnyxCommon';
 import {isEmptyObject} from '@src/types/utils/EmptyObject';
+import useSidePane from '@hooks/useSidePane';
 
 type HeaderViewProps = {
     /** Toggles the navigationMenu open and closed */
@@ -206,6 +207,7 @@ function HeaderView({report, parentReportAction, onNavigationMenuButtonClicked,
 
     const isReportInRHP = route.name === SCREENS.SEARCH.REPORT_RHP;
     const shouldDisplaySidePane = !!sidePane;
+    const {shouldHideHelpButton} = useSidePane();
     const shouldDisplaySearchRouter = !isReportInRHP || isSmallScreenWidth;
     const [onboardingPurposeSelected] = useOnyx(ONYXKEYS.ONBOARDING_PURPOSE_SELECTED);
     const isChatUsedForOnboarding = isChatUsedForOnboardingReportUtils(report, onboardingPurposeSelected);
@@ -355,7 +357,7 @@ function HeaderView({report, parentReportAction, onNavigationMenuButtonClicked,
                                     {!shouldUseNarrowLayout && isOpenTaskReport(report, parentReportAction) && <TaskHeaderActionButton report={report} />}
                                     {!isParentReportLoading && canJoin && !shouldUseNarrowLayout && joinButton}
                                 </View>
-                                {shouldDisplaySidePane && <HelpButton style={styles.ml2} />}
+                                {!shouldHideHelpButton && <HelpButton style={styles.ml2} />}
                                 {shouldDisplaySearchRouter && <SearchButton style={!shouldDisplaySidePane && styles.ml2} />}
                             </View>
                             <ConfirmModal

* route: /workspaces/123/rules/456
* params: {workspaceID: '123', ruleID: '456'}
* result: /workspaces/:workspaceID/rules/:ruleID
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB - in a follow-up PR let's add a unit test for this function

@francoisl francoisl merged commit f16edc7 into Expensify:main Mar 7, 2025
26 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Mar 7, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants