Create a Ping mechanism for Pusher

[tgolen]

• Held on https://github.com/Expensify/Web-Expensify/pull/45207 which incorporates the PONG reply

Explanation of Change

This PR will send a ping to the server every 30 seconds. The server has one minute to respond (an eternity really). If the client doesn't get a response, then the client will be put into offline mode.

Fixed Issues

$ #53826

Tests

1. Follow the QA tests
2. Modify the API endpoint on Web-E by modifying api.php to not ever send the pusher event
3. Verify the client goes offline when it doesn't get a PONG from pusher
4. Wait for about a minute
5. The client should naturally come back online when another network check is done and sees that you're still online

• Verify that no errors appear in the JS console

Offline tests

1. With the ping running, force your client to be offline
2. Wait for about a minute and you should see a couple of logs stating the PING is skipped because the client is offline
3. Go back online
4. Verify that the PING starts up again

QA Steps

1. Sign into NewDot
2. Open the JS console
3. Filter the console by entering PINGPONG into the filter bar at the top of the console
4. Verify that every minute you can see it pinging the server and the server is responding

• 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
  • 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 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: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[tgolen]

@adamgrzybowski I wanted to CC you on this change to ensure I'm not missing anything with the performance tracking library. Happy to give you more context if you need it. I mostly just want to ensure I'm using this correctly and I'd like to build a Grafana chart for this.

cc @mountiny

[mountiny]

@adhorodyski Wrong Adam @tgolen

[mountiny]

Also missed it the first time I read the comment 🤦 pinged Adam in Slack now

[adhorodyski]

Hey @tgolen, here's a breakdown:

• Performance module is mostly used for local measurements
• Timing module is reporting to external systems

If you want to send to Grafana, you can use the Timing module as per this example. Timing.start()/end() will ensure it's being sent.

I have plans for proposing a vision for these 2 going forward in a more unified way, but ^this is how they work now :)

[adhorodyski]

You can safely call one after the other

[tgolen]

Aha, perfect. I'll swap this out to use the timing module. Thanks!

[tgolen]

OK, I updated this and see it in the logs now:

Timing:development.new.expensify.pusher_ping_pong 949.5

[tgolen]

This is off HOLD now since the API endpoint has been deployed to staging. @abdulrahuman5196 can you start reviewing it please?

[mountiny]

@abdulrahuman5196 Will you be able to review this one? what is your eta?

[abdulrahuman5196]

Hi, @mountiny , I am having lesser availability this week. Could you re-apply the label for a different C+?

[ishpaul777]

NAB, its not imported anywhere else, why do we export it?

[tgolen]

Oh yeah, I was using this somewhere else eary on in the development of this PR, but then I went a different direction and didn't remove this. I'll clean it up.

[ishpaul777]

@tgolen do we need unit tests for this ?

For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.

[tgolen]

@tgolen do we need unit tests for this ?

I had considered doing some unit tests, but in the end, I decided against it. Since nearly everything would have to be mocked (the API requests and the PONG response from the server), all the unit tests would be doing is verifying that NetworkConnection.setOfflineStatus() was called and properly set the offline status. It felt like that was a really low-value test to add.

I'd be open to hearing any thoughts you have on providing a valuable unit test for this.

[tgolen]

OK, I've updated the branch to remove the submodules changes and to remove the unnecessary export.

[ishpaul777]

I had considered doing some unit tests, but in the end, I decided against it. Since nearly everything would have to be mocked (the API requests and the PONG response from the server), all the unit tests would be doing is verifying that NetworkConnection.setOfflineStatus() was called and properly set the offline status. It felt like that was a really low-value test to add.

this makes sense i am with you here, think we can skip it 👍

[ishpaul777]

i am completing the checklist video and testing on all platforms now 🙇

[ishpaul777]

@tgolen sorry i didnt notice it before, can you please fix lint?

[tgolen]

Oh yeah, sorry. I missed that one. It's all fixed now

[ishpaul777]

ooof! 🫣 more lint and jest check failing @tgolen

[tgolen]

Yay, all 🟢 now!

[melvin-bot]

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

One NAB, looks good to me @MariaHCD do you want to review?

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[github-actions]

🚀 Deployed to staging by https://github.com/MariaHCD in version: 9.0.92-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

[github-actions]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.92-6 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅