Support GZIP compressed JSON string as push notification payload

[VickyStash]

Explanation of Change

This PR updates push notifications payload processing to support GZIP compressed JSON string.

Fixed Issues

$ #54820
PROPOSAL: N/A
MOBILE-EXPENSIFY: https://github.com/Expensify/Mobile-Expensify/pull/13406

Tests

• Verify that no errors appear in the JS console

iOS

1. First of all, we should make sure that we didn't break anything. So we need to check that push notifications with the usual payload are processed as expected. To do that - compose the .apns file.

Example:

{
   "Simulator Target Bundle":"com.expensify.chat.dev",
   "aps":{
      "alert":{
         "title":"Test",
         "body":"Test Push Notification"
      }
   },
   "payload":{
      "type":"reportComment",
      "title":"Test",
      "onyxData":[
         {
            "key":"reportActions_2170976176751360",
            "onyxMethod":"merge",
            "value":{
              "2463291366241014308": {
               "actionName":"ADDCOMMENT",
               "reportID":"2170976176751360",
               "reportActionID":"2463291366241014308",
               "message":[
                  {
                     "type":"COMMENT",
                     "html":"Hello world!",
                     "text":"Hello world!"
                  }
               ]
            }}
         }
      ],
      "lastUpdateID":4024059044,
      "previousUpdateID":4024059043,
      "reportID":2170976176751360,
      "reportActionID":"2463291366241014308",
      "roomName":"",
      "app":"new"
   }
}

Drag-n-drop the .apns file into simulator to simulate a push notification. Check the xcode logs - you should see that the push notification was received and the app tried to apply the onyx data provided in the payload.

2. Then check the same, but for the push notification with GZIP compressed json string as the payload. Make sure it works as expected.

Example:

{
   "Simulator Target Bundle":"com.expensify.chat.dev",
   "aps":{
      "alert":{
         "title":"Test",
         "body":"Test Push Notification"
      }
   },
   "payload": "H4sIAFKOnGcC/5VQy07DMBD8leBzD07iJoRb1SDBIeVSuKAKWWTVRrVjy94+osj/TuwSUWgu3Lwzs56Z7Ql2GshDRAxoZXCppIQWySwi2KAIzFuz59EabEBV251Ljnwg3nuyh+5nd/GJjWrtRxLntMizOM/yeZxmdFyrAHeq9noJZgsePnJx8B49SViWJsUgzxIW05il9D7gPHy64jJEWZTl8qWqHldrv32xfS49M2V6HetbNeEy83ms5Vu4dBoPcmW0Qyk89ARCqOikjKjvwongjDe42zjnNgMruMVXXXOEYM5owui8oIwNnDZwbNTBTvHp72p/m/2nmFFKjrfzM9faP1s4EfcFqCcQ9fsBAAA="
}

---

Android:

1. First of all, we should make sure that we didn't break anything. So we need to test the usual push notifications receiving. For that:

• Copy the production config to the development config.
• Run android app as a User A and agree to receive push notifications
• Write to the User A as User B from another device.
• See, that User A got the notification.

2. We will test newly implemented processPayload function. To do so, let's add temp updates to the CustomAirshipExtender.java file:

import com.expensify.chat.customairshipextender.PayloadHandler; // add next to other imports
...
PayloadHandler handler = new PayloadHandler(); // put it in the top of onAirshipReady method
String processedPayload = handler.processPayload("H4sIAAAAAAAAA6tWyk6tVLJSKkvMKU1VqgUAv5wYPw8AAAA="); // you can pass any GZIP compressed json string
System.out.println("Processed Payload: " + processedPayload);

After the updates are done - rebuild the app.
Once it’s running you should see the log with processed payload in the Logcat in Android studio.

Web/Desktop:

1. Make sure push notifications are working the same way as before. You can trigger push notifications by sending a message from User A to User B.
2. Updates of the parsePushNotificationPayload function are covered by unit tests.

Offline tests

N/A

QA Steps

• Verify that no errors appear in the JS console

Make sure push notifications are working the same way as before.
You can trigger push notifications by:

1. Sending a message from User A to User B.
2. Paying money request.

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_old.mp4

iOS: Native

ios_gzip.mp4

ios_old.mp4

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[VickyStash]

Verify HybridApp build check is failing in this PR with the next error:
GraphQL: Resource not accessible by integration (addComment)

It doesn't look like it's related to this PR, I saw something similar in others as well.
@AndrewGable is it a known issue?

[AndrewGable]

Can you merge main please? We've fixed this

[AndrewGable]

Looks like it's not fixed 😄 - I will now