Skip to content

Remove the HTTP PusherPing heartbeat - #63

Closed
adhorodyski wants to merge 1 commit into
mainfrom
2927-remove-pusher-ping
Closed

adhorodyski wants to merge 1 commit into
mainfrom
2927-remove-pusher-ping

Conversation

@adhorodyski

@adhorodyski adhorodyski commented Sep 3, 2026 •

Copy link
Copy Markdown
Collaborator

Explanation of Change

Delete the PusherPing HTTP heartbeat and the code and types that exist only to serve it. The pong is read by nothing, and the Pusher SDK already runs the real connection check.

Fixed Issues

$ https://github.com/callstack-internal/expensify-issues/issues/2927
PROPOSAL:

Tests

  1. Log in and open a report with live activity; verify new updates (e.g. an incoming message) appear in real time, confirming the Pusher socket is connected and delivering.
  2. Watch the network log / JS console: verify no PusherPing API request fires and no [Pusher PINGPONG] log line is emitted.
  • Verify that no errors appear in the JS console

Offline tests

  1. Drop the network, then restore it; verify the app re-establishes its Pusher connection and real-time updates resume with no new errors. The heartbeat already returned early while offline, so removing it does not change offline behavior.

QA Steps

  1. Verify no errors appear in the JS console.
  2. Verify a real-time update (e.g. a new message in a report) still arrives live.
  3. Verify the app recovers its Pusher connection after a network drop and reconnect.
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Summary by CodeRabbit

  • Changes
    • Removed the application-managed Pusher ping/pong heartbeat handling.
    • Pusher connection recovery is now left to the Pusher SDK.
    • Private channel subscriptions now process server update events without ping/pong payloads.
    • Updated subscription coverage for supported event types.

@adhorodyski adhorodyski closed this Sep 3, 2026
@coderabbitai

coderabbitai Bot commented Sep 3, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 72a92a06-fddc-4814-a66f-c42b2c0670dd

📥 Commits

Reviewing files that changed from the base of the PR and between af3078c and ffcc8e1.

📒 Files selected for processing (9)
  • src/libs/API/parameters/PusherPingParams.ts
  • src/libs/API/parameters/index.ts
  • src/libs/API/types.ts
  • src/libs/Pusher/EventType.ts
  • src/libs/Pusher/types.ts
  • src/libs/PusherUtils.ts
  • src/libs/actions/User.ts
  • tests/unit/PusherPingPongTest.ts
  • tests/unit/PusherSubscribeWebTest.ts

📝 Walkthrough

Walkthrough

The pull request removes the Pusher ping-pong heartbeat API, types, runtime logic, and tests. Pusher subscription tests now use REPORT_COMMENT instead of PONG.

Changes

Pusher heartbeat removal

Layer / File(s) Summary
Remove heartbeat contracts and runtime handling
src/libs/API/parameters/PusherPingParams.ts, src/libs/API/parameters/index.ts, src/libs/API/types.ts, src/libs/Pusher/EventType.ts, src/libs/Pusher/types.ts, src/libs/PusherUtils.ts, src/libs/actions/User.ts
The PusherPingParams, PUSHER_PING, PONG, and PingPongEvent contracts were removed. The heartbeat implementation and related imports were deleted. Pusher event callbacks now accept server update payloads only.
Update subscription event coverage
tests/unit/PusherPingPongTest.ts, tests/unit/PusherSubscribeWebTest.ts
The ping-pong test suite was deleted. Subscription tests now use REPORT_COMMENT and retain authorization, callback, rejection, and reconnect coverage.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: roryabraham

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2927-remove-pusher-ping

Comment @coderabbitai help to get the list of available commands.

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.

1 participant