Support GZIP compressed JSON string as push notification payload by VickyStash · Pull Request #56154 · Expensify/App

VickyStash · 2025-01-31T11:42:46Z

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

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.

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:

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.

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:

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.
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:

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

PR Author Checklist

Screenshots/Videos

Android: Native

android_old.mp4

iOS: Native

ios_gzip.mp4

ios_old.mp4

MacOS: Chrome / Safari

MacOS: Desktop

…covered paths

melvin-bot · 2025-02-05T11:48:31Z

@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 · 2025-02-05T11:51:33Z

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 · 2025-02-05T16:47:53Z

Can you merge main please? We've fixed this

AndrewGable · 2025-02-05T17:11:28Z

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

dominictb · 2025-02-12T02:42:59Z

Any updates on this PR?

VickyStash · 2025-02-12T07:39:57Z

@dominictb It's ready for your review! Besides that, we are waiting for @arosiclair to test it over BE changes, more info here.

arosiclair · 2025-02-12T17:43:06Z

@dominictb It's ready for your review! Besides that, we are waiting for @arosiclair to test it over BE changes, more info here.

Yup you can code review and test normal uncompressed push notifications to ensure those are still handled correctly. I'll update when I can start testing with backend changes.

dominictb · 2025-02-15T12:59:10Z

Cool. Can you merge main please @VickyStash?

VickyStash · 2025-02-17T08:21:43Z

@dominictb Done!

tests/unit/parsePushNotificationPayloadTest.ts

dominictb · 2025-02-16T16:38:21Z

tests/unit/parsePushNotificationPayloadTest.ts

+    app: 'new',
+};
+// gzip compressed json string
+const compressedPayloadWithOnyxData =


Can we perform compression of the payloadWithOnyxData above instead of hard-coding this value?

The app doesn't do gzip compression. I'm not sure we should add this functionality just for the mocked data.

dominictb · 2025-02-19T11:25:34Z

android/app/src/main/java/com/expensify/chat/customairshipextender/PayloadHandler.kt

+import java.util.zip.GZIPInputStream
+
+class PayloadHandler {
+    private val BUFFER_SIZE = 4096


Where does this BUFFER_SIZE value come from? Is it the 4KB notification limit constraint?

What if the input stream size exceeds 4KB? I know we're trying to not let that happen in the BE but just "what if".

Yeah, in this case 4KB is a notification payload size limit.

What if the input stream size exceeds 4KB?

Hm, I'm not sure if it's possible since it's the limitation on the Apple Push Notification service (APNs) / Android's Firebase Cloud Messaging (FCM) level

dominictb · 2025-02-19T12:18:16Z

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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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: Native

Android: mWeb Chrome

iOS: Native

Screen.Recording.2025-02-20.at.00.22.30-compressed.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-02-19.at.21.48.59-compressed.mov

MacOS: Desktop

dominictb

🎀👀🎀

arosiclair · 2025-02-20T17:31:18Z

@VickyStash can you pull main please? I pushed some changes that fix iOS build issues recently.

github-actions · 2025-02-21T08:27:14Z

⚠️ This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. ⚠️

# Conflicts: # package-lock.json # package.json

github-actions · 2025-02-21T08:37:34Z

⚠️ This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. ⚠️

VickyStash · 2025-02-21T08:45:56Z

@VickyStash can you pull main please? I pushed some changes that fix iOS build issues recently.

Done!

arosiclair · 2025-02-21T16:33:48Z

Alright this is testing well for both compressed and uncompressed push notifications!

Android	iOS
	!

arosiclair · 2025-02-21T16:39:42Z

Great work on this, @VickyStash and @adhorodyski!

OSBotify · 2025-02-21T16:50:41Z

✋ 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 · 2025-02-21T23:10:53Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 9.1.4-0 🚀

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

github-actions · 2025-02-24T19:42:29Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.1.4-4 🚀

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

adhorodyski and others added 14 commits January 20, 2025 11:23

feat: js payload parser for gzipped json strings

0c70673

chore: update logs

5850f72

feat: init android implementation

6a7db39

fix: adjust the js implementation to work with RN, add tests for all …

87815ee

…covered paths

Merge branch 'Expensify:main' into feat/compressed-push-notifications

b14244d

fix: android implementation

34ee570

Merge branch 'Expensify:main' into feat/compressed-push-notifications

3cc57fa

feat: initial implementation for ios

959478f

Merge branch 'Expensify:main' into feat/compressed-push-notifications

7f6d9b0

Merge branch 'Expensify:main' into feat/compressed-push-notifications

de47c99

chore: Podfile.lock update

c8511be

chore: update unit test to use more realistic data

7c0fde2

fix: android implementation improvements

9a61c8d

Merge branch 'refs/heads/main' into feat/compressed-push-notifications

c009ee4

VickyStash mentioned this pull request Feb 4, 2025

[PAID][MEDIUM] Support compressed push notification payloads #54820

Closed

5 tasks

VickyStash changed the title ~~[WIP] Support GZIP compressed JSON string as push notification payload~~ Support GZIP compressed JSON string as push notification payload Feb 5, 2025

VickyStash marked this pull request as ready for review February 5, 2025 11:48

VickyStash requested a review from a team as a code owner February 5, 2025 11:48

melvin-bot bot requested review from dominictb and removed request for a team February 5, 2025 11:48

Merge branch 'refs/heads/main' into feat/compressed-push-notifications

a7593e3

AndrewGable mentioned this pull request Feb 5, 2025

[No QA]Add another trigger to fix comment on HybridApp changes #56417

Merged

48 tasks

VickyStash added 2 commits February 6, 2025 09:27

chore: minor code updates

1e50439

re-run tests

bad3241

Merge branch 'refs/heads/main' into feat/compressed-push-notifications

f8922cf

dominictb suggested changes Feb 19, 2025

View reviewed changes

VickyStash added 2 commits February 19, 2025 12:48

Minor improvement

799b149

re-run checks

fcab066

dominictb approved these changes Feb 19, 2025

View reviewed changes

melvin-bot bot requested a review from arosiclair February 19, 2025 18:59

Merge branch 'refs/heads/main' into feat/compressed-push-notifications

510df80

VickyStash added 2 commits February 21, 2025 09:30

Merge branch 'refs/heads/main' into feat/compressed-push-notifications

563c180

# Conflicts: # package-lock.json # package.json

package-lock.json updates

1fc6c25

arosiclair approved these changes Feb 21, 2025

View reviewed changes

arosiclair merged commit f060149 into Expensify:main Feb 21, 2025
24 checks passed

github-actions bot mentioned this pull request Feb 21, 2025

Deploy Checklist: New Expensify 2025-02-21 #57263

Closed

29 tasks

Conversation

VickyStash commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 5, 2025

Uh oh!

VickyStash commented Feb 5, 2025

Uh oh!

AndrewGable commented Feb 5, 2025

Uh oh!

AndrewGable commented Feb 5, 2025

Uh oh!

dominictb commented Feb 12, 2025

Uh oh!

VickyStash commented Feb 12, 2025

Uh oh!

arosiclair commented Feb 12, 2025

Uh oh!

dominictb commented Feb 15, 2025

Uh oh!

VickyStash commented Feb 17, 2025

Uh oh!

Uh oh!

dominictb Feb 16, 2025

Choose a reason for hiding this comment

Uh oh!

VickyStash Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

dominictb Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

VickyStash Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

dominictb commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

dominictb left a comment

Choose a reason for hiding this comment

Uh oh!

arosiclair commented Feb 20, 2025

Uh oh!

github-actions bot commented Feb 21, 2025

Uh oh!

github-actions bot commented Feb 21, 2025

Uh oh!

VickyStash commented Feb 21, 2025

Uh oh!

arosiclair commented Feb 21, 2025

Uh oh!

arosiclair commented Feb 21, 2025

Uh oh!

Uh oh!

OSBotify commented Feb 21, 2025

Uh oh!

github-actions bot commented Feb 21, 2025

Uh oh!

github-actions bot commented Feb 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

VickyStash commented Jan 31, 2025 •

edited

Loading

dominictb commented Feb 19, 2025 •

edited

Loading