An additional entry is added to the browser history when opening the app by WojtekBoman · Pull Request #67610 · Expensify/App

WojtekBoman · 2025-08-01T05:53:39Z

Explanation of Change

This PR fixes an issue where an extra history entry was added when opening the app. It was caused by the old mechanism used to sync the side panel with the browser history. Now this mechanism has been refactored using the custom history system introduced in this PR.

How does the side panel sync with browser history?

A new history entry for the side panel is added when it is displayed as RHP.
Thanks to that it's possible to open/close the side panel with the browser arrow buttons.
When the browser window is resized to the wide layout when the side panel is no longer displayed as RHP, the side panel history entry is removed.

Fixed Issues

$ #66254
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Verify if the opening/closing the side panel works fine using different methods (exit using the overlay, navigating using the app buttons, navigating using the browser buttons).
Verify if the browser history is synced correctly with the side panel, when it is opened from the different browser tab.

Offline tests

Verify if the opening/closing the side panel works fine using different methods (exit using the overlay, navigating using the app buttons, navigating using the browser buttons).

QA Steps

Verify that no errors appear in the JS console

Verify if the opening/closing the side panel works fine using different methods (exit using the overlay, navigating using the app buttons, navigating using the browser buttons).
Verify if the browser history is synced correctly with the side panel, when it is opened from the different browser tab.

PR Author Checklist

Screenshots/Videos

Android: mWeb Chrome

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-08-01.at.12.23.06.mov

Screen.Recording.2025-08-01.at.12.18.52.mov

Screen.Recording.2025-08-01.at.12.17.17.mov

MacOS: Desktop

Screen.Recording.2025-08-01.at.12.27.54.mov

blazejkustra · 2025-08-01T08:57:49Z

src/components/SidePanel/index.tsx

 function SidePanel() {
    const {isSidePanelTransitionEnded, shouldHideSidePanel, sidePanelTranslateX, shouldHideSidePanelBackdrop, closeSidePanel} = useSidePanel();

+    useSyncSidePanelWithHistory();


Are you sure this is the right spot for this hook? It will be called even when side panel is not available/closed

Yes, I need to open it when I go forward in the browser history, then the side panel is not rendered, so the hook will not be called if I call it from HelpModal

It's the described case

Screen.Recording.2025-08-01.at.11.02.42.mov

adamgrzybowski

🚀 🎸

melvin-bot · 2025-08-01T13:01:09Z

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

mountiny · 2025-08-01T14:23:06Z

@alitoshmatov can you review please?

WojtekBoman · 2025-08-06T09:19:34Z

@alitoshmatov friendly bump 😄

alitoshmatov · 2025-08-06T11:30:27Z

Working on it

mountiny · 2025-08-06T22:16:18Z

@alitoshmatov how is it looking?

alitoshmatov · 2025-08-11T05:00:01Z

@WojtekBoman Is this supposed to happen? When info page is opened not as RHP it is not closing when pressing back button of the browser

Screen.Recording.2025-08-11.at.9.58.40.AM.mov

alitoshmatov · 2025-08-11T05:09:59Z

Also when I logged out and logged in with new email the website crashed and showed this error. After refreshing it worked again. I consistently reproduced this issue twice

Screen.Recording.2025-08-11.at.10.09.09.AM.mov

WojtekBoman · 2025-08-11T06:39:33Z

@WojtekBoman Is this supposed to happen? When info page is opened not as RHP it is not closing when pressing back button of the browser

Yes, it's planned :) On this screen width, help panel is part of the page, on a smaller layout it's displayed as a separate RHP page - then we push a new entry to the history

WojtekBoman · 2025-08-11T07:41:08Z

Also when I logged out and logged in with new email the website crashed and showed this error. After refreshing it worked again. I consistently reproduced this issue twice
Screen.Recording.2025-08-11.at.10.09.09.AM.mov

Great catch! I added optional chaining to the lastHistoryEntry variable in the new hook and it should work fine now :)
@alitoshmatov Could you check if it works correctly with the latest fix?

mountiny · 2025-08-11T10:41:42Z

@alitoshmatov can you please prioritize now

alitoshmatov · 2025-08-12T17:55:57Z

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: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- 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 there are no new alerts related to the canBeMissing param for useOnyx
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: HybridApp

Android: mWeb Chrome

nav-mweb.mov

iOS: HybridApp

nav-ios.mp4

iOS: mWeb Safari

nav-safari.mp4

MacOS: Chrome / Safari

nav-web2.mov

MacOS: Desktop

nav-desktop.mov

alitoshmatov

LGTM

mountiny

Thanks looks good, just requesting one more comment

src/components/SidePanel/index.tsx

WojtekBoman · 2025-08-13T14:32:48Z

@mountiny all checks passed

src/components/SidePanel/index.tsx

WojtekBoman · 2025-08-18T07:40:54Z

@mountiny friendly bump

mountiny

thank you!

OSBotify · 2025-08-18T09:12:53Z

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

OSBotify · 2025-08-18T15:52:23Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.96-0 🚀

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

pecanoro · 2025-08-18T17:52:08Z

I think this PR might have caused this console error: #68676

OSBotify · 2025-08-19T18:58:17Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.1.96-2 🚀

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

OSBotify · 2025-08-19T20:12:27Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.1.96-2 🚀

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

WojtekBoman force-pushed the nav/side-panel-custom-history branch from 2340a30 to 2a29f59 Compare August 1, 2025 08:53

blazejkustra suggested changes Aug 1, 2025

View reviewed changes

adamgrzybowski approved these changes Aug 1, 2025

View reviewed changes

WojtekBoman marked this pull request as ready for review August 1, 2025 13:01

WojtekBoman requested a review from a team as a code owner August 1, 2025 13:01

melvin-bot bot requested review from alitoshmatov and removed request for a team August 1, 2025 13:01

mountiny assigned WojtekBoman Aug 1, 2025

WojtekBoman force-pushed the nav/side-panel-custom-history branch from 2a29f59 to f2ab0af Compare August 11, 2025 07:39

blazejkustra approved these changes Aug 11, 2025

View reviewed changes

alitoshmatov reviewed Aug 12, 2025

View reviewed changes

alitoshmatov approved these changes Aug 12, 2025

View reviewed changes

melvin-bot bot requested a review from mountiny August 12, 2025 17:56

mountiny previously approved these changes Aug 13, 2025

View reviewed changes

src/components/SidePanel/index.tsx Show resolved Hide resolved

WojtekBoman dismissed mountiny’s stale review via 76bd28c August 13, 2025 14:12

WojtekBoman force-pushed the nav/side-panel-custom-history branch 2 times, most recently from 76bd28c to 665c801 Compare August 13, 2025 14:17

mountiny reviewed Aug 13, 2025

View reviewed changes

src/components/SidePanel/index.tsx Show resolved Hide resolved

WojtekBoman force-pushed the nav/side-panel-custom-history branch from 665c801 to d9e55ac Compare August 14, 2025 06:40

Use custom history to handle showing side panel

e1dd0bf

WojtekBoman force-pushed the nav/side-panel-custom-history branch from d9e55ac to e1dd0bf Compare August 14, 2025 07:27

mountiny approved these changes Aug 18, 2025

View reviewed changes

mountiny merged commit e9a3ad1 into Expensify:main Aug 18, 2025
20 checks passed

OSBotify mentioned this pull request Aug 18, 2025

Deploy Checklist: New Expensify 2025-08-18 #68664

Closed

47 tasks

melvin-bot bot mentioned this pull request Aug 19, 2025

[Due for payment 2025-08-26] [$250] An additional entry is added to the browser history when opening the app #66254

Closed

8 tasks

Conversation

WojtekBoman commented Aug 1, 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!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WojtekBoman Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WojtekBoman Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

adamgrzybowski left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Aug 1, 2025

Uh oh!

mountiny commented Aug 1, 2025

Uh oh!

WojtekBoman commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alitoshmatov commented Aug 6, 2025

Uh oh!

mountiny commented Aug 6, 2025

Uh oh!

alitoshmatov commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alitoshmatov commented Aug 11, 2025

Uh oh!

WojtekBoman commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WojtekBoman commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Aug 11, 2025

Uh oh!

alitoshmatov commented Aug 12, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

alitoshmatov left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

WojtekBoman commented Aug 13, 2025

Uh oh!

Uh oh!

WojtekBoman commented Aug 18, 2025

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Aug 18, 2025

Uh oh!

OSBotify commented Aug 18, 2025

Uh oh!

pecanoro commented Aug 18, 2025

Uh oh!

OSBotify commented Aug 19, 2025

Uh oh!

OSBotify commented Aug 19, 2025

Uh oh!

Reviewers

WojtekBoman commented Aug 1, 2025 •

edited

Loading

blazejkustra Aug 1, 2025 •

edited

Loading

WojtekBoman Aug 1, 2025 •

edited

Loading

WojtekBoman commented Aug 6, 2025 •

edited

Loading

alitoshmatov commented Aug 11, 2025 •

edited

Loading

WojtekBoman commented Aug 11, 2025 •

edited

Loading

WojtekBoman commented Aug 11, 2025 •

edited

Loading