Skip to content

An additional entry is added to the browser history when opening the app #67610

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

An additional entry is added to the browser history when opening the app #67610

wants to merge 1 commit into from

Conversation

WojtekBoman
Copy link
Contributor

@WojtekBoman WojtekBoman commented Aug 1, 2025 •
edited
Loading

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
  1. 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).
  2. Verify if the browser history is synced correctly with the side panel, when it is opened from the different browser tab.

Offline tests

  1. 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
  1. 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).
  2. Verify if the browser history is synced correctly with the side panel, when it is opened from the different browser tab.

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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: 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

@WojtekBoman WojtekBoman force-pushed the nav/side-panel-custom-history branch from 2340a30 to 2a29f59 Compare August 1, 2025 08:53
blazejkustra
blazejkustra suggested changes Aug 1, 2025
View reviewed changes
src/components/SidePanel/index.tsx

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

useSyncSidePanelWithHistory();
Copy link
Contributor

@blazejkustra blazejkustra Aug 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

@WojtekBoman WojtekBoman Aug 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's the described case

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

adamgrzybowski
adamgrzybowski approved these changes Aug 1, 2025
View reviewed changes
Copy link
Contributor

@adamgrzybowski adamgrzybowski left a comment

Choose a reason for hiding this comment

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

🚀 🎸

@WojtekBoman WojtekBoman marked this pull request as ready for review August 1, 2025 13:01
@WojtekBoman WojtekBoman requested a review from a team as a code owner August 1, 2025 13:01
@melvin-bot melvin-bot bot requested review from alitoshmatov and removed request for a team August 1, 2025 13:01
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Aug 1, 2025

@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
Copy link
Contributor

mountiny commented Aug 1, 2025

@alitoshmatov can you review please?

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

@blazejkustra blazejkustra blazejkustra requested changes

@adamgrzybowski adamgrzybowski adamgrzybowski approved these changes

@alitoshmatov alitoshmatov Awaiting requested review from alitoshmatov

At least 1 approving review is required to merge this pull request.

Assignees

@WojtekBoman WojtekBoman

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@WojtekBoman @mountiny @blazejkustra @adamgrzybowski