Skip to content

fix: prevent side panel report live tail from crashing on setParams - #99533

Open
WojtekBoman wants to merge 3 commits into
Expensify:mainfrom
software-mansion-labs:fix-side-panel-live-tail-set-params-crash
Open

fix: prevent side panel report live tail from crashing on setParams#99533
WojtekBoman wants to merge 3 commits into
Expensify:mainfrom
software-mansion-labs:fix-side-panel-live-tail-set-params-crash

Conversation

@WojtekBoman

@WojtekBoman WojtekBoman commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Concierge Anywhere on web renders the report in the side panel, which sits outside any navigator screen, so ScreenWrapper (exported as withNavigationFallback(ScreenWrapper)) hands the whole subtree a stub navigation object exposing only isFocused / addListener / removeListener. useReportActionsNewActionLiveTail runs inside that subtree and called navigation.setParams({reportActionID: ''}), which was undefined on the stub - a TypeError inside a passive effect, so the error boundary showed a crash screen. Native is unaffected (isSidePanelReportSupported is false), matching the zero native events in Sentry.

Two changes, each individually sufficient; both kept on purpose:

  1. useReportActionsNewActionLiveTail.ts - use the route-targeted global dispatch already used in this tree (Navigation.setParams({reportActionID: ''}, route.key, navigatorKey), same as LinkedActionNotFoundGuard). It goes through navigationRef, which is always real, and targets this route rather than the focused one, preserving the existing behavior of not clobbering an open RHP's params. The dispatch is skipped in the side panel, whose synthetic route carries no reportActionID to clear. Only the dispatch is skipped - the rest of the jump still runs, so the side-panel live tail still scrolls to the newest message.

  2. withNavigationFallback.tsx - harden the stub with the rest of the surface used under ScreenWrapper so descendants degrade instead of throwing. Action-shaped no-ops log via Log.hmmm, since this HOC also wraps Button and ButtonKeyboardShortcut and a bare no-op would turn a loud crash into a silently dead button.

Unit tests cover the route-targeted dispatch, the side-panel skip, the fallback-stub path not throwing, and the stub's callable surface.

Before:

Screen.Recording.2026-08-26.at.10.55.51.mov

After:

Screen.Recording.2026-08-26.at.10.59.49.mov

Fixed Issues

$ #99517
PROPOSAL:

Tests

  1. On web, open the Inbox with a chat open in the central pane.
  2. In the LHN, right-click the Concierge chat and choose Mark as unread. (Alternatively, right-click a message inside the Concierge chat and choose Mark as unread.) This sets the unread marker, which is what triggers the live-tail jump.
  3. Navigate to a different chat, staying on the Inbox. Do not open Concierge in the central pane.
  4. Click the Concierge entry point in the header to open Concierge Anywhere. The chat must render in the side panel overlay.
  5. Verify the green "New" divider is visible in the side-panel chat. If it is not, repeat from step 2 - the live tail will not fire without it.
  6. Click a suggested followup chip, or type any message and press Enter.
  7. Verify the side-panel chat scrolls to the newest message, no error-boundary crash screen appears, and there is no setParams is not a function in the console.
  8. Verify the browser URL still points at whatever route was underneath the side panel - it must not change.

Regression check on real navigator screens:

  1. Open a chat deep-linked to an old action (/r/<reportID>/<reportActionID>) in the central pane.
  2. Open an RHP on top of it (e.g. report details) and leave it open.
  3. Post a message in the chat.
  4. Verify the live-tail jump clears reportActionID from the report route - the URL drops back to /r/<reportID> - while the RHP stays open with its params untouched.

Negative control (confirms the crash was side-panel-specific, not Concierge-specific):

  1. Open the Concierge chat normally from the LHN in the central pane and repeat steps 2 and 6. The same live-tail jump runs and there is no crash, before or after this change.
  • Verify that no errors appear in the JS console

Offline tests

The live-tail jump is gated on !isOffline, so none of this runs while offline.

  1. Go offline.
  2. Open Concierge Anywhere in the side panel and send a message.
  3. Verify the message is queued optimistically and no crash occurs.
  4. Go back online and verify the message sends and the chat behaves normally.

QA Steps

Same as tests. Web only - the side panel report is not supported on native, so there is nothing to verify on iOS or Android native.

  • 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 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 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)
  • 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)
  • 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.
  • 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 - the side panel report is not supported on native (isSidePanelReportSupported is false).

Android: mWeb Chrome
iOS: Native

N/A - the side panel report is not supported on native (isSidePanelReportSupported is false).

iOS: mWeb Safari
MacOS: Chrome / Safari

@codecov

codecov Bot commented Aug 26, 2026

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/libs/telemetry/forwardLogsToSentry.ts 81.35% <100.00%> (ø)
.../inbox/report/useReportActionsNewActionLiveTail.ts 83.01% <100.00%> (+1.38%) ⬆️
src/components/withNavigationFallback.tsx 90.90% <90.00%> (-0.76%) ⬇️
... and 6 files with indirect coverage changes

@WojtekBoman

Copy link
Copy Markdown
Contributor Author

@codex

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Chef's kiss.

Reviewed commit: 85d8df2222

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/pages/inbox/report/useReportActionsNewActionLiveTail.ts Outdated
isFocused: () => true,
addListener: () => () => {},
removeListener: () => () => {},
setParams: () => logInertCall('setParams'),

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.

I wonder if we should avoid making these functions silent noops. Previously, the crashes actually helped us catch when something wasn't right. I just worry this might introduce silent bugs that are harder to track down. What do you think?

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've added it to mechanism that forwards logs to sentry, I believe it will help in this case!

@WojtekBoman
WojtekBoman force-pushed the fix-side-panel-live-tail-set-params-crash branch from 85d8df2 to 79384aa Compare August 26, 2026 09:50

@collectioneur collectioneur 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.

LGTM 🚀

@WojtekBoman
WojtekBoman marked this pull request as ready for review August 26, 2026 10:02
@WojtekBoman
WojtekBoman requested review from a team as code owners August 26, 2026 10:02
@melvin-bot
melvin-bot Bot requested review from mananjadhav and removed request for a team August 26, 2026 10:02
@melvin-bot

melvin-bot Bot commented Aug 26, 2026

Copy link
Copy Markdown

@mananjadhav 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 joekaufmanexpensify and removed request for a team August 26, 2026 10:02
Comment thread src/components/withNavigationFallback.tsx Outdated

@joekaufmanexpensify joekaufmanexpensify 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.

Good for product

@mananjadhav

mananjadhav commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

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 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 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)
  • 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)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately
    • 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
    • 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 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.
  • 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
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
web-set-params-1.mov
web-set-params-2.mov

@melvin-bot
melvin-bot Bot requested a review from mountiny August 27, 2026 20:55
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.

4 participants