Skip to content

Support multi-instance unbind for pusher callbacks#85356

Merged
rlinoz merged 6 commits intoExpensify:mainfrom
callstack-internal:decompose/pusher-per-callback-handles
Mar 18, 2026
Merged

Support multi-instance unbind for pusher callbacks#85356
rlinoz merged 6 commits intoExpensify:mainfrom
callstack-internal:decompose/pusher-per-callback-handles

Conversation

@adhorodyski
Copy link
Contributor

@adhorodyski adhorodyski commented Mar 16, 2026

Explanation of Change

The Pusher module previously tracked subscriptions by channel+event key only, meaning multiple components subscribing to the same channel and event would share a single callback slot. When any one component unsubscribed, it would remove the binding for all subscribers — breaking other active listeners.

This change introduces per-callback tracking via a Map keyed by a unique handle ID. subscribe() now returns a PusherSubscription object (a Promise extended with an unsubscribe() method) that scopes the unbind operation to only the specific callback that was registered. Multiple components can now independently subscribe and unsubscribe from the same channel+event without interfering with each other.

This is PR 2 of a series decomposing ReportScreen into smaller, independently mountable units — a prerequisite for those components to safely manage their own Pusher subscriptions. Part of #84971.

Fixed Issues

$ #84895
PROPOSAL:

Tests

  1. Typing indicators (subscribes to USER_IS_TYPING per report)
    • Open a chat with another user
    • Have the other user start typing → verify "is typing..." appears
    • Navigate away from the report and back → typing indicator should still work
    • Verify no duplicate typing indicators appear
  2. Room leaving status (subscribes to USER_IS_LEAVING_ROOM)
    - Join a group chat or room
    - Have another user leave the room → verify the membership update appears
    - Navigate away and back → verify no stale subscriptions
  3. Pusher reconnection (onResubscribe callback)
    - Open a chat, toggle airplane mode on/off (or kill network briefly)
    - Verify Pusher reconnects and real-time events resume (typing, new messages via push)
  4. General real-time messaging (subscribes via PusherUtils.ts to private user channel)
    - Send a message from another device/user → verify it appears in real-time without refresh
    - Do this across multiple reports to verify channel multiplexing works

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
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

…bind

The Pusher module now tracks individual callbacks per channel+event using
a Map<Channel, Map<EventName, Set<Callback>>> structure. subscribe()
returns a PusherSubscription (Promise & { unsubscribe }) that removes
only the specific callback when called, leaving other subscribers intact.

This enables multiple components to independently subscribe to and
unsubscribe from the same Pusher channel+event without interfering with
each other. The existing unsubscribe(channel, event) API is preserved
for bulk removal of all callbacks.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@codecov
Copy link

codecov bot commented Mar 16, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/libs/Pusher/index.native.ts 78.74% <95.65%> (+4.32%) ⬆️
src/libs/Pusher/index.ts 0.00% <0.00%> (ø)
... and 208 files with indirect coverage changes

adhorodyski and others added 2 commits March 16, 2026 12:29
Extend PusherSubscribeTest with 6 new test cases covering the
per-callback subscription behavior:

- subscribe() returns a PusherSubscription with .unsubscribe()
- Two subscribers to the same channel+event both receive events
- Unsubscribing one callback does not affect the other
- Channel stays subscribed until the last callback unsubscribes
- Unsubscribe before subscription completes (disposed flag)
- Multiple events on same channel with independent cleanup

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@adhorodyski adhorodyski changed the title [No QA] Add per-callback Pusher subscription handles to fix multi-instance unbind Support multi-instance unbind for pusher callbacks Mar 16, 2026
@adhorodyski adhorodyski marked this pull request as ready for review March 16, 2026 11:49
@adhorodyski adhorodyski requested review from a team as code owners March 16, 2026 11:49
@melvin-bot melvin-bot bot requested a review from DylanDylann March 16, 2026 11:49
@melvin-bot
Copy link

melvin-bot bot commented Mar 16, 2026

@DylanDylann 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 JmillsExpensify and removed request for a team March 16, 2026 11:49
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: 388d9fe962

ℹ️ 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".

The web Pusher disconnect() was missing eventsBoundToChannels.clear(),
unlike the native implementation. This caused callback closures to
accumulate across disconnect/reconnect cycles (logout/login, upgrade
teardown), leaking memory over time.

Add the missing clear() call and a test verifying old callbacks do not
fire after a disconnect/re-init cycle.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@DylanDylann
Copy link
Contributor

@MelvinBot Could you review this PR?

@DylanDylann
Copy link
Contributor

@codex review

@MelvinBot
Copy link
Contributor

🤖 PR Review

Overall this is a solid, well-structured change. The approach of returning a PusherSubscription handle (Promise + unsubscribe()) is clean and backward-compatible since it extends Promise<void>. All existing callers chain .catch() without storing the handle, so nothing breaks.

What's good

  • Backward-compatible return typePusherSubscription extends Promise<void>, so all existing call sites (PusherUtils.ts:56, Report/index.ts:476,526,587) continue to work without changes.
  • Bug fixes included — The PR fixes two pre-existing bugs in index.ts (web):
    • Missing eventsBoundToChannels.delete(channel) in the full-channel unsubscribe() path (line 357) — was leaking stale tracking entries.
    • Missing eventsBoundToChannels.clear() in disconnect() (line 433) — was leaving stale callbacks across disconnect/reconnect cycles.
  • disposed flag — Nice defensive pattern to handle unsubscribe() being called before the subscription promise resolves.
  • Comprehensive tests — The 7 new test cases cover the important scenarios well (dual callbacks, independent cleanup, early unsubscribe, disconnect+reinit).

Minor concerns

  1. Set mutation during iteration (native) — In index.native.ts:262-268, the onEvent handler iterates over the callbacks Set with for...of. If a callback synchronously calls handle.unsubscribe() on a different handle for the same channel+event, that other callback will be skipped per the ECMAScript Set iteration spec. This is safe for self-deletion and unlikely in practice for cross-deletion, but you could make it bulletproof by snapshotting:

    const snapshot = [...callbacks];
    for (const cb of snapshot) {
        cb(event.data as EventData<PusherEventName>);
    }

    Not a blocker — just a robustness consideration for future callers.

  2. // eslint-disable-next-line @typescript-eslint/no-explicit-any in index.ts:48 — The BoundCallback type uses any for the parameter. This is acceptable given the chunking wrapper's varying signatures, and the comment explains why. Just flagging it for visibility.

Verdict

The code is clean, tests are thorough, and CI passes (only failing check is checklist, which is unrelated). No blockers from my review. 👍

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: 002044c62c

ℹ️ 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".

@DylanDylann
Copy link
Contributor

@adhorodyski Could you check the above comments? The rest looks fine to me

@DylanDylann
Copy link
Contributor

DylanDylann commented Mar 17, 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
    • 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
Screen.Recording.2026-03-17.at.16.29.51.mov
Android: mWeb Chrome
Screen.Recording.2026-03-17.at.16.27.31.mov
iOS: HybridApp
Screen.Recording.2026-03-17.at.16.24.40.mov
iOS: mWeb Safari
Screen.Recording.2026-03-17.at.16.26.04.mov
MacOS: Chrome / Safari
Screen.Recording.2026-03-17.at.16.21.08.mov

@DylanDylann
Copy link
Contributor

@rlinoz Could you generate an ad-hoc build and ask QA to test a few flows before proceeding? Since this change affects the Pusher handler, I’d prefer additional testing before merging.

Copy link
Contributor

@JmillsExpensify JmillsExpensify left a comment

Choose a reason for hiding this comment

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

No product review required.

If handle.unsubscribe() is called after socket.subscribe() starts but
before onSubscriptionSucceeded fires, wrappedCb is still undefined so
the unsubscribe handler returns early without cleaning up the channel.
This leaves a live channel with no listeners that accumulates across
fast mount/unmount cycles.

Fix: in onSubscriptionSucceeded, when disposed is true, check if the
channel has any remaining callbacks in eventsBoundToChannels. If not,
unsubscribe the channel entirely. Applied to both web and native.

Also null wrappedCb/resolvedChannel after removal in unsubscribe
handlers for defensive cleanup (cosmetic, addresses review feedback).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@adhorodyski
Copy link
Contributor Author

adhorodyski commented Mar 17, 2026

@DylanDylann back to you
edit: fixing CI fails on TS checks

Two fixes:
1. Guard `channel` with `else if (channel)` in onSubscriptionSucceeded
   cleanup block — `channel` is typed `Channel | undefined` and
   eventsBoundToChannels is keyed by `Channel`.

2. Import MockedPusher directly from the __mocks__ file instead of the
   real SDK module. The jest __mocks__ override only affects runtime,
   not TypeScript's type resolution, so importing from the real package
   gives the wrong types. Direct import gives proper typing for
   .channels, .subscribe(), .trigger() — eliminates all `as` casts.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Contributor

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

@github-actions

This comment has been minimized.

@melvin-bot melvin-bot bot requested a review from rlinoz March 17, 2026 15:29
@DylanDylann
Copy link
Contributor

Let's wait for QA to finish testing before we merge.

@rlinoz rlinoz merged commit 1185070 into Expensify:main Mar 18, 2026
32 checks passed
@github-actions
Copy link
Contributor

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

@adhorodyski adhorodyski deleted the decompose/pusher-per-callback-handles branch March 18, 2026 11:00
@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/rlinoz in version: 9.3.40-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.3.40-0 🚀

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.

6 participants