Skip to content

Prepare Side Panel for Stage 4 #59740

Merged
francoisl merged 13 commits into
Expensify:mainfrom
software-mansion-labs:side-panel/prep-for-stage4
Apr 7, 2025
Merged

Prepare Side Panel for Stage 4 #59740
francoisl merged 13 commits into
Expensify:mainfrom
software-mansion-labs:side-panel/prep-for-stage4

Conversation

@blazejkustra

@blazejkustra blazejkustra commented Apr 7, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

  1. Rename SidePane to be SidePanel everywhere
  2. Create a single App/src/components/SidePanel/HelpContent/helpContentMap.tsx file
  • Just specify everything directly in that one file -- no imports. It's all going to be loaded at runtime anyway, and this file will be auto-generated eventually
  • Don't use constants (eg, `:${CONST.REPORT.HELP_TYPE.POLICY_ADMINS}) because the code we generate isn't going to use them either.

Fixed Issues

$ #58732
PROPOSAL: https://expensify.slack.com/archives/C07NZ8B1VTQ/p1743366805812629

Tests

  • Ensure the Side Panel functions as expected (note: it's currently hidden behind a beta flag and displays custom content based on chat type).
  • Confirm that there are no user-facing changes.

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
android.webm
Android: mWeb Chrome
and-web.webm
iOS: Native
ios.mp4
MacOS: Chrome / Safari
web.mov

@blazejkustra blazejkustra marked this pull request as ready for review April 7, 2025 15:18
@blazejkustra blazejkustra requested review from a team as code owners April 7, 2025 15:18
@melvin-bot melvin-bot Bot requested review from brunovjk and removed request for a team April 7, 2025 15:18
@melvin-bot

melvin-bot Bot commented Apr 7, 2025

Copy link
Copy Markdown

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

@shawnborton

Copy link
Copy Markdown
Contributor

Anything needed from the design team in terms of a review, or is this mostly just restructuring some code?

@blazejkustra

Copy link
Copy Markdown
Contributor Author

Anything needed from the design team in terms of a review, or is this mostly just restructuring some code?

@shawnborton Just code restructuring this time

@francoisl francoisl requested a review from ikevin127 April 7, 2025 17:03
@francoisl

Copy link
Copy Markdown
Contributor

Assigning @ikevin127 as a one-off for the review and checklist.

@ikevin127

ikevin127 commented Apr 7, 2025

Copy link
Copy Markdown
Contributor

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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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.js 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.
  • 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
android.mp4
Android: mWeb Chrome
android-mweb.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
ios-mweb.mp4
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@blazejkustra

Copy link
Copy Markdown
Contributor Author

Please ping me on Slack if you have any questions @ikevin127 as I'm wrapping up for the day.

Comment thread src/hooks/useSidePanel.ts
const [sidePanelNVP] = useOnyx(ONYXKEYS.NVP_SIDE_PANEL);
const [language] = useOnyx(ONYXKEYS.NVP_PREFERRED_LOCALE);
const [canUseHelpSidePanel = false] = useOnyx(ONYXKEYS.BETAS, {selector: (betas) => !!betas?.includes(CONST.BETAS.HELP_SIDE_PANEL)});
const [canUseHelpSidePanel = false] = useOnyx(ONYXKEYS.BETAS, {selector: Permissions.canUseHelpSidePanel});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

To confirm, we're doing this because using usePermissions() still made some tests fail?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, exactly. And I forgot to use canUseHelpSidePanel in the previous PR

isExact?: boolean;
};

const helpContentMap: HelpContent = {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@francoisl I'm assuming we're not adding translations for all this english copy ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Correct

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@francoisl Another thing here related to PRs Explanation of Change mentioning:

Create a single App/src/components/SidePanel/HelpContent/helpContentMap.tsx file

  • Just specify everything directly in that one file -- no imports. It's all going to be loaded at runtime anyway, and this file will be auto-generated eventually

we still have imports here like BulletList, ExpandableHelp, Text, and TextLink which are imported rather than being defined directly in the file.

Would these pose a problem given that this file will be loaded at runtime / auto-generated ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good point. I'm trying to think how we could avoid any of these imports. We could probably have a dumbed-down version of the map, where each element is defined by a type key so that we can differentiate between what's a title, what's a subsection, what's a link, what's a bullet list, etc. And then some other helper ingests that map and converts each element to a ReactNode on the fly.

Rough example:

const helpContentMap = {
    example: [
        {
            type: 'title',
            text: 'Chat',
        },
        {
            type: 'text',
            text: 'Chat is the foundation of New Expensify. Every [....]',
        },
        {
            type: 'bulletlist',
            title: 'The core of the chat are its comments, which come in many forms:',
            items: [
                {
                    type: 'text',
                    text: 'Rich text messages stored securely and delivered via web, app, email',
                }
            ]
        },
    ]
}

But even with this, if you want to add some style variations, or nested elements with different styles like we have here:

<Text style={styles.textNormal}>
    <Text style={styles.textBold}>Text</Text> - Rich text messages stored securely and delivered via web, app, email, or SMS.
</Text>,

the format becomes more complex.

Thoughts? This is also probably something we can iterate on as we go.

</Text>,
<Text style={styles.textNormal}>
<Text style={styles.textBold}>Mention</Text> - Invite or tag anyone in the world to any chat by putting an @ in front of their email address or phone
number (e.g., <Text style={styles.textBold}>@awong@marslink.web</Text>, or <Text style={styles.textBold}>@415-867-5309</Text>).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are dummy email and phone numbers, right? I'm seeing a ton of various matches for the phone number online so I assume, but just double-checking.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think so, we might want to change it 😅

Comment on lines +633 to +636
<Text style={styles.textBold}>Collect</Text> workspaces start at $5/member, and include all the basics for running a small business.
</Text>,
<Text style={styles.textNormal}>
<Text style={styles.textBold}>Control</Text> workspaces start at $9/member, and provide advanced capabilities, more powerful accounting sync, and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Out of scope for this PR, but maybe we should consider using the pricing constants instead (e.g. SUBSCRIPTION_PRICES) down the line

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Let's not use any CONST due to this:

Don't use constants (eg, `:${CONST.REPORT.HELP_TYPE.POLICY_ADMINS}) because the code we generate isn't going to use them either.

},
},
home: {
content: ({styles}: {styles: ThemeStyles}) => (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This whole function returns the same thing as at the root (lines 30-148). Thoughts on reusing a const that's defined beforehand instead? We don't necessarily have to do it now, but as it stands I'm thinking that down the line, we might want to edit the copy and risk forgetting to edit both places at the same time.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I wanted to keep it simple due to the fact this file is going to be generated going forward, but I totally agree with you.

@ikevin127 ikevin127 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 If this is expected, everything else LGTM 🚀

@melvin-bot melvin-bot Bot requested a review from francoisl April 7, 2025 19:32
@blazejkustra

Copy link
Copy Markdown
Contributor Author

🟢 If this is expected, everything else LGTM 🚀

We have an answer here! @francoisl @ikevin127 let's proceed with a merge 😄

@github-actions

github-actions Bot commented Apr 7, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.1.24-2 🚀

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

@mvtglobally

Copy link
Copy Markdown

@francoisl @shawnborton Can you pls help us with QA steps here?
Do we need to run any specific validations on the Expensifail account under Beta or Gmail with non-Beta? And what exactly need to be verified?

@blazejkustra

blazejkustra commented Apr 8, 2025

Copy link
Copy Markdown
Contributor Author

@francoisl @shawnborton Can you pls help us with QA steps here? Do we need to run any specific validations on the Expensifail account under Beta or Gmail with non-Beta? And what exactly need to be verified?

@mvtglobally I assume Expensifail accounts have side panel beta enabled, right?

Please verify that Side Panel opens on various pages when you have beta, the appropriate content is displayed according to this document.

For a non-beta account just verify that help button is not displayed anywhere.

@github-actions

github-actions Bot commented Apr 9, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.24-10 🚀

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

@github-actions

github-actions Bot commented Apr 9, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.24-10 🚀

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants