Side Pane Stage 3: Specific help content for different types of reports #58847

blazejkustra · 2025-03-20T19:45:20Z

Explanation of Change

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

This update adds contextual help for special reports like #admins rooms and expense reports by replacing generic report IDs with meaningful labels (e.g., /r/:reportID → /r/:admins). The report type is determined using Onyx.

Fixed Issues

$ #58732
$ #58818
$ #58831
PROPOSAL: N/A

Tests

(Briefly) compare the copy from this document with what is displayed in the Help Pane.
Ensure that the appropriate sections are displayed, accoring to the document above
- For example #admins room has it own copy at the top, same for expenses, concierge etc
Confirm that the app does not crash on various pages, including chat, reports, settings, and other relevant pages.

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.web.mp4

MacOS: Chrome / Safari

web.mov

…styling

…ction

…verrides

…ries

brunovjk · 2025-03-21T13:56:03Z

I encountered some strange behavior when we try to create a Chat with users we haven't interacted with yet:

bug_chat_no_help.mov

blazejkustra · 2025-03-21T14:17:09Z

@brunovjk Can you retest? Should be fixed with the latest commit 😄

brunovjk · 2025-03-21T15:12:52Z

Great!

brunovjk · 2025-03-22T13:20:45Z

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

Screen.Recording.2025-03-24.at.10.05.45.mov

Android: mWeb Chrome

58847_android_web.mov

iOS: Native

58847_ios_native.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

58847_web_chome.mp4

MacOS: Desktop

58847_web_desktop.mov

brunovjk · 2025-03-22T13:38:07Z

@blazejkustra I can still reproduce the issue Help panel is shown on top of the testing preferences dialog
on large screens:

repro_bug_58831.mov

…_SMALL type

blazejkustra · 2025-03-22T14:02:05Z

@blazejkustra I can still reproduce the issue Help panel is shown on top of the testing preferences dialog on large screens:

repro_bug_58831.mov

Should be fixed with two latest commit @brunovjk

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

@blazejkustra can you merge main here? I cant build Android, but on my lastest main I can. Thank you.

brunovjk · 2025-03-22T14:25:16Z

@blazejkustra I would like to confirm one behavior

The tab /r/:expenseReport - Explains how the expense report chat works only appears when we enter the reports of a workspace chat, if we enter an expense report page of a 1:1 chat, we continue with the explanation of Chat only:

bug_58847_android_web.mov

brunovjk

There is this detail above that we need to confirm, but I don't believe it would be a blocker. I couldn't test it on native Android, I think we need to merge the last main to test it. But other than that everything seems good to me!

blazejkustra · 2025-03-24T08:53:50Z

There is this #58847 (comment) that we need to confirm, but I don't believe it would be a blocker.

I'll confirm this with David on slack. We don't need to block on this

blazejkustra · 2025-03-24T08:54:11Z

I think we need to merge the last main to test it.

@brunovjk Just merged the newest main for you!

brunovjk

Thanks @blazejkustra, I was able to test it and it looks fine 🚀

pecanoro · 2025-03-24T13:39:40Z

src/components/SidePane/HelpContent/chat/admins.tsx

+            <Text style={[styles.textHeadlineH1, styles.mb4]}>#admins</Text>
+            <ExpandableHelp
+                styles={styles}
+                title="Every workspace automatically receives a special #admins chat room. Every admin is automatically added to this room as a member. The #admins room is used for several purposes:"


Hmm, is it normal to have all these copies here instead of using the translation keys as everywhere else? The same applies to the other files. Not sure if we are planning to do it later

The side pane is only displayed when English is selected in the settings, so we decided to hardcode the text in these components.

(Eventually everything will be moved to markdown files so it doesn't matter)

Discussed here: https://expensify.slack.com/archives/C07NZ8B1VTQ/p1742827061945449?thread_ts=1742502068.420729&cid=C07NZ8B1VTQ

pecanoro · 2025-03-24T14:48:30Z

@francoisl is on vacation so merging

OSBotify · 2025-03-24T14:56:42Z

✋ 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-03-24T21:30:51Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 9.1.18-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	cancelled 🔪
🍎🔄 iOS HybridApp 🍎🔄	cancelled 🔪

github-actions · 2025-03-26T05:04:35Z

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.18-4 🚀

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

blazejkustra added 30 commits March 20, 2025 09:45

Temporarily hide the help pane when centered modal is displayed

4051ae9

Implement ExpandableHelp

2402bf8

Move content to separate files

10aa442

Improve algorithm to show help content

88db295

Fix scroll issue on native devices

ad26070

Implement HelpBulletList

8a8bb49

Rename ExpandableHelp

fec00de

Rename inbox to chat

6ec3f41

Add remaining content to search

6e32022

Fix selecting text

a64d85d

Add userSelectNone style to HelpBulletList items

818989a

Update margin style for bullet list items in HelpBulletList component

a666d0c

Add containerStyle prop to HelpExpandable component for customizable …

baa32b3

…styling

Add missing content to Settings

12e9f81

Add missing content to Workspaces

c2517e3

Add missing content to Workspace

ecc2ea3

Fix margin style for Reports head

9c30165

Add default text for routes with no content

e084f8d

Fix lint

21ddd81

Rename Help components

16f90ac

Add HELP_TYPE constant to CONST

9e0e1b3

Add getHelpPaneReportType function to determine help pane report type

4bca2d1

Add getExpenseType function to determine the expense type of a transa…

5e7cae7

…ction

Enhance substituteRouteParameters to support route parameter overrides

432bd36

Add tests for substituteRouteParameters to validate route parameter o…

172cf09

…verrides

Refactor HelpContent to dynamically change :reportID into report types

d4bda5c

Add help content mappings for various report types and expense catego…

0938d7b

…ries

Move chat to index

8bccc1c

Add AdminsChatRoom component

7b83975

Add Concierge component

5773223

pecanoro self-requested a review March 21, 2025 13:53

Fix onyx warning in an edge case

6137785

289Adam289 approved these changes Mar 21, 2025

View reviewed changes

Update modal visibility logic in useSidePane hook to include CENTERED…

858d2a2

…_SMALL type

Remove keyboard shortcut for DEBUG action in HelpModal

6e34704

brunovjk approved these changes Mar 23, 2025

View reviewed changes

melvin-bot bot requested a review from francoisl March 23, 2025 13:16

Merge branch 'main' into side-pane/stage-3

6c24bdd

brunovjk approved these changes Mar 24, 2025

View reviewed changes

pecanoro requested changes Mar 24, 2025

View reviewed changes

pecanoro approved these changes Mar 24, 2025

View reviewed changes

pecanoro merged commit 84c3b29 into Expensify:main Mar 24, 2025
20 checks passed

github-actions bot mentioned this pull request Mar 24, 2025

Deploy Checklist: New Expensify 2025-03-24 #59011

Closed

48 tasks

jponikarchuk mentioned this pull request Mar 25, 2025

[Due for payment 2025-04-08] [$250] Help Panel - the cursor is shown on unfocused composer box #59054

Closed

8 tasks

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

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

Closed

brunovjk mentioned this pull request Mar 26, 2025

Payment for Help Panel implementation for C+ #59081

Closed

Side Pane Stage 3: Specific help content for different types of reports #58847

Side Pane Stage 3: Specific help content for different types of reports #58847

Uh oh!

Conversation

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

brunovjk commented Mar 21, 2025

Uh oh!

blazejkustra commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brunovjk commented Mar 21, 2025

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

brunovjk commented Mar 22, 2025

Uh oh!

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

Uh oh!

Uh oh!

brunovjk commented Mar 22, 2025

Uh oh!

brunovjk commented Mar 22, 2025

Uh oh!

brunovjk left a comment

Choose a reason for hiding this comment

Uh oh!

blazejkustra commented Mar 24, 2025

Uh oh!

blazejkustra commented Mar 24, 2025

Uh oh!

brunovjk left a comment

Choose a reason for hiding this comment

Uh oh!

pecanoro Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

blazejkustra Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

pecanoro Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

pecanoro commented Mar 24, 2025

Uh oh!

Uh oh!

OSBotify commented Mar 24, 2025

Uh oh!

github-actions bot commented Mar 24, 2025

Uh oh!

github-actions bot commented Mar 26, 2025

Uh oh!

Uh oh!

blazejkustra commented Mar 20, 2025 •

edited

Loading

blazejkustra commented Mar 21, 2025 •

edited

Loading

brunovjk commented Mar 22, 2025 •

edited

Loading

blazejkustra commented Mar 22, 2025 •

edited

Loading