Skip to content

Remove useDocumentTitle cleanup to fix tab title race condition#85473

Merged
yuwenmemon merged 2 commits intomainfrom
claude-removeDocumentTitleCleanup
Mar 20, 2026
Merged

Remove useDocumentTitle cleanup to fix tab title race condition#85473
yuwenmemon merged 2 commits intomainfrom
claude-removeDocumentTitleCleanup

Conversation

@MelvinBot
Copy link
Contributor

@MelvinBot MelvinBot commented Mar 16, 2026

cc @mananjadhav

Explanation of Change

The useDocumentTitle hook had a cleanup function (return () => setPageTitle('')) that cleared the browser tab title to an empty string whenever a screen lost focus. This caused a race condition with the asynchronous title-update pipeline:

  1. The updateDocumentTitle() function defers document.title updates via setTimeout(fn, 0)
  2. The navigation state change listener triggers a debounced (300ms) triggerUnreadUpdate that also calls updateDocumentTitle()
  3. The popstate listener triggers a non-debounced updateDocumentTitle() call

When navigating away from a page and returning, the cleanup would clear currentPageTitle to '', and any of these asynchronous callers executing while currentPageTitle was empty would fall back to CONFIG.SITE_TITLE ("New Expensify").

The fix removes the cleanup function entirely. Each page simply sets its own title on focus via setPageTitle(title), and the previous title naturally gets overwritten by the next focused page's title — no need to clear it first.

Fixed Issues

$ #85352
PROPOSAL: #85352 (comment)

Tests

  1. Log into the app on web (Chrome)
  2. Navigate to Home tab > Inbox
  3. Open any report — verify the tab title shows the report name
  4. Open a different report, then open the first report again
  5. Verify the tab title still shows the report name (not "New Expensify")
  6. Navigate to a workspace > Overview
  7. Verify the tab title shows "WorkspaceName - Overview"
  8. Navigate to Members, then back to Overview
  9. Verify the tab title still shows "WorkspaceName - Overview" (not "New Expensify")
  10. Navigate to Account > Profile
  11. Verify the tab title shows "Profile"
  12. Navigate to Subscription, then back to Profile
  13. Verify the tab title still shows "Profile" (not "New Expensify")
  • Verify that no errors appear in the JS console

Offline tests

  1. Go offline and navigate between pages
  2. Verify titles still display correctly from cached data
  3. Navigate away and back to a page — verify the title persists correctly

QA Steps

  1. Log into a workspace admin account on staging
  2. Navigate through: Home > Search > Workspaces > a Workspace > Overview
  3. Go to Members, then back to Overview — verify tab title shows "WorkspaceName - Overview"
  4. Go to Account > Profile, then Subscription, then back to Profile — verify tab title shows "Profile"
  5. Open a chat/report, navigate to a different report, then back — verify tab title shows the report name
  • Verify that no errors appear in the JS console

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
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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

N/A — This change only affects the browser tab title (document.title), which is web-only.

Android: mWeb Chrome

N/A — Browser tab titles are visible but the change is purely cosmetic metadata.

iOS: Native

N/A — This change only affects the browser tab title (document.title), which is web-only.

iOS: mWeb Safari

N/A — Browser tab titles are visible but the change is purely cosmetic metadata.

MacOS: Chrome / Safari

N/A — Manual testing required to verify tab title persistence during navigation.

…ondition

The cleanup function setPageTitle('') was clearing the browser tab title
to an empty string on blur, which caused a race condition with the
asynchronous title-update pipeline (setTimeout in updateDocumentTitle and
the debounced triggerUnreadUpdate). When navigating back to a previously
visited page, the title would revert to "New Expensify" instead of
showing the page-specific title.

By removing the cleanup, each page simply sets its own title on focus,
and the previous title naturally gets overwritten without any gap where
the title is empty.

Co-authored-by: Yuwen Memon <yuwenmemon@users.noreply.github.com>
@MelvinBot
Copy link
Contributor Author

The failing check is unrelated to this PR.

Analysis: The failing test is tests/ui/SessionTest.tsx — "should not remember the report path of the last deep link login after signing out and in again" (line 111), which times out after 120 seconds. This test deals with deep link login and session management and has zero references to useDocumentTitle, setPageTitle, or document.title.

This PR only removes a single cleanup line (return () => setPageTitle('')) from src/hooks/useDocumentTitle.ts.

Evidence: The exact same test with the exact same timeout failure is also failing on main (run 23162452674). This is a pre-existing flaky test.

@yuwenmemon yuwenmemon marked this pull request as ready for review March 16, 2026 23:59
@yuwenmemon yuwenmemon requested a review from a team as a code owner March 16, 2026 23:59
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team March 16, 2026 23:59
@melvin-bot
Copy link

melvin-bot bot commented Mar 16, 2026

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

@melvin-bot melvin-bot bot requested review from heyjennahay and removed request for a team March 16, 2026 23:59
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c2b9dba9f3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines 7 to 9
useCallback(() => {
setPageTitle(title);
return () => setPageTitle('');
}, [title]),

Choose a reason for hiding this comment

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

P2 Badge Reset page title when focus effect is cleaned up

Dropping the cleanup here leaves currentPageTitle latched to the previous screen indefinitely, because updateUnread only falls back to CONFIG.SITE_TITLE when that value is empty. With NavigationContainer document titles disabled (src/libs/Navigation/NavigationRoot.tsx), any route that does not call useDocumentTitle (for example auth routes like SCREENS.VALIDATE_LOGIN in src/libs/Navigation/AppNavigator/AuthScreens.tsx) will inherit the last page title; a common case is leaving a report and then opening login/auth screens, where the tab can continue showing the old report name instead of the app title.

Useful? React with 👍 / 👎.

Copy link
Contributor

Choose a reason for hiding this comment

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

The new screen should update it with its title. The way proposed above introduced a race condition that caused page titles to be reset more often than they were set to the correct ones.

@MelvinBot
Copy link
Contributor Author

The failing check test (job 8) is unrelated to this PR.

Analysis: The failure is in tests/ui/SessionTest.tsx:111 — the test "should not remember the report path of the last deep link login after signing out and in again" times out at 120s. This PR only modifies src/hooks/useDocumentTitle.ts (removing a cleanup function), and SessionTest.tsx contains no references to useDocumentTitle, setPageTitle, or document.title.

Evidence: The exact same test is failing on main as well:

This is a pre-existing flaky test on main, not caused by this PR's changes.

@MelvinBot
Copy link
Contributor Author

The failing check is unrelated to this PR.

Failing test: tests/ui/SessionTest.tsx:111 — "should not remember the report path of the last deep link login after signing out and in again" — exceeded its 120s timeout.

Analysis: This PR only removes one line from src/hooks/useDocumentTitle.ts (the cleanup callback). The failing SessionTest.tsx has zero references to useDocumentTitle, documentTitle, or setPageTitle.

Evidence: The exact same test (SessionTest.tsx:111) is also failing on main — see run 23162452674 and run 23160326032. This is a known pre-existing flaky timeout.

The only other failing check is checklist (PR Author/Reviewer Checklist), which is not a code issue.

@yuwenmemon yuwenmemon requested review from mananjadhav and removed request for hoangzinh March 17, 2026 03:53
@yuwenmemon yuwenmemon requested a review from a team as a code owner March 17, 2026 03:56
@melvin-bot melvin-bot bot requested review from ikevin127 and yuwenmemon and removed request for a team March 17, 2026 03:56
@melvin-bot
Copy link

melvin-bot bot commented Mar 17, 2026

@ikevin127 @yuwenmemon One of you needs to 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]

@yuwenmemon yuwenmemon removed the request for review from ikevin127 March 17, 2026 03:57
@mananjadhav
Copy link
Collaborator

I had explicitly commented here about the clean up method bug. Will test this out today.

@yuwenmemon
Copy link
Contributor

Good call - my bad on that one!

@mananjadhav
Copy link
Collaborator

mananjadhav commented Mar 20, 2026

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
  • 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: HybridApp
android-dynamic-title.mov
Android: mWeb Chrome
mweb-chrome-dynamic-title.mov
iOS: HybridApp
ios-dynamic-title.mov
iOS: mWeb Safari
mweb-safari-dynamic-title.mov
MacOS: Chrome / Safari
web-dynamic-title.mov

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

:shipit:

@yuwenmemon yuwenmemon merged commit c3ef461 into main Mar 20, 2026
38 checks passed
@yuwenmemon yuwenmemon deleted the claude-removeDocumentTitleCleanup branch March 20, 2026 17:23
@github-actions
Copy link
Contributor

🚧 @yuwenmemon has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions
Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
Built from App PR #85473.

Android 🤖 iOS 🍎
❌ FAILED ❌ https://ad-hoc-expensify-cash.s3.us-east-1.amazonaws.com/rock-artifacts/ad-hoc/rock-ios-device-AdHoc-c3ef461-9be7b50-c2e4e52dd4c3b18d9aa456573fc568050ff894b6/index.html
The QR code can't be generated, because the Android build failed iOS
Web 🕸️
https://85473.pr-testing.expensify.com
Web

👀 View the workflow run that generated this build 👀

@OSBotify
Copy link
Contributor

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

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 9.3.42-0 🚀

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

Bundle Size Analysis (Sentry):

@jponikarchuk
Copy link

Deploy Blocker #86087 was identified to be related to this PR.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.3.42-3 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 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.

7 participants