Style notifications using onyxData, increase payload bandwidth #15857

Julesssss · 2023-03-10T18:16:30Z

Details

The notification payload size limit is 4kb and going over this causes the notification to be dropped by FCM. To resolve multiple issues we need to reduce the amount of payload data that is being sent unnecessarily. This PR prepares for this by switching the notification data source from reportComment to the onyxData, allowing us to remove lots of duplicate fields once this PR has been deployed to users.

Fixed Issues

$ #14849
$ https://github.com/Expensify/Expensify/issues/269103
$ https://github.com/Expensify/Expensify/issues/260142
$ #15423
[UNBLOCKS] #14715
[UNBLOCKS] https://github.com/Expensify/Expensify/issues/265452

Tests

Screenshots for each of these tests are at the bottom of this description.

Setup steps

Use this StackOverflow guide to build a debuggable Android release build
- step 1 is optional
- step 2 is NOT optional!
Start your dev environment and NGROK
Open the app and accept the 'Allow notifications' prompt if using a newish OS version
Sign into the Android app using one of your dev users
Feel free to DM me for help!

1) Verify that messages longer than 115 chars are no longer being truncated

From a separate client, send this message to the Android user:
- this is a very very very very very very very very very very very very very very very very very very very very very very long message that wasn't previously possible! 😮😮😮😮😮😮😮😮
The full message should be displayed
The message should not contain a " symbol at the end

2) Verify that messages and 1:1 IOU requests are displayed correctly

From a separate client, send any message to the Android user
From a separate client, send an IOU request to the Android user for any amount
Both messages should be displayed correctly (ignoring the currency symbol issue)
Both messages should be part of the same thread/notification (this only applies to newer Android versions)
See the screenshot below for an example

3) Verify that bill split messages are displayed correctly

From a separate client, create a new group that includes the Android user
Send any message to the group
It should be received by the android user
Create a bill split between the group
It should be received by the android user and formatted correctly (ignoring the currency symbol issue)
These will not be threaded, as they are from two separate reports

Offline tests

N/A -- notifications cannot be received while the device is offline

QA Steps

Run the above tests, ignoring the setup steps

PR Author Checklist

Screenshots/Videos

Notes:

ONLY ANDROID NATIVE CODE IS MODIFIED
CURRENCY SYMBOLS NOT RENDERING IS A SEPARATE PRE-EXISTING ISSUE

1) Verify that messages longer than 115 chars are no longer being truncated

Android 8	Android 13

2) Verify that messages and 1:1 IOU requests are displayed correctly

Android 8	Android 13

3) Verify that bill split messages are displayed correctly

Android 8	Android 13

MelvinBot · 2023-03-16T18:34:11Z

@parasharrajat @jasperhuangg One of you needs to 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]

...d/app/src/main/java/com/expensify/chat/customairshipextender/CustomNotificationProvider.java

Julesssss · 2023-03-16T18:37:14Z

@jasperhuangg @parasharrajat @arosiclair @cristipaval

Ready for testing now. I used physical devices, but I think these steps should work fine on an emulator. DM me if you want me to save you all the setup steps and I'll send you a signed release apk file you can install to any emulator or physical device!

Julesssss · 2023-03-16T18:40:04Z

I just realized @parasharrajat won't be able to complete the dev env tests. I'm pretty sure you can simply create a release build from this branch and just test against staging though 👍

Julesssss · 2023-03-17T08:54:14Z

@jasperhuangg I'm preemptively sending you the signed apk file as I'm heading out now. Same you you @cristipaval @arosiclair, but no pressure to review if you're too busy

jasperhuangg · 2023-03-17T17:56:13Z

@parasharrajat I'll remove you for review from this, I'll handle screenshots

jasperhuangg · 2023-03-17T18:48:04Z

@Julesssss

All the test cases seem to work as expected for me except for test case 3.

It seems the split bill notification appears in the same thread for me as the message that I sent into that same group. Could I be missing something?

jasperhuangg · 2023-03-17T19:27:42Z

...d/app/src/main/java/com/expensify/chat/customairshipextender/CustomNotificationProvider.java

        if (message.containsKey(PAYLOAD_KEY)) {
            try {
                JsonMap payload = JsonValue.parseString(message.getExtra(PAYLOAD_KEY)).optMap();

-                // Apply message style only for report comments
-                if (REPORT_COMMENT_TYPE.equals(payload.get(TYPE_KEY).getString())) {
+                // Apply message style when onyxData is present


to clarify, this has to be Onyx data that we receive from Pusher? Urban Airship? just curious

For Android/iOS we receive the onyxData update from both Pusher (only when the app is open) and Airship (we get the push notification regardless of whether the app is alive/killed).

So in this code we only care that the notification data includes onyxData. I'll update the comment to make this a bit clearer.

I updated this and another comment, hope that clarifies things a bit!

Julesssss · 2023-03-20T12:43:20Z

All the test cases seem to work as expected for me except for test case 3.

It seems the split bill notification appears in the same thread for me as the message that I sent into that same group. Could I be missing something?

Hey @jasperhuangg thanks for thorough testing. I should have explained better, but that is expected because you sent that message from the group chat. This is the logic for showing in multiple threads:

DM

All my 1:1 dm messages with you should be in a single notification thread
If I request money from you, that should show in the same thread

Group chat

Messaged in a group chat between me you and Gandalf will show in a separate notification thread
Group split notifications will show in the same group chat thread

There are some existing bugs which break the thread logic, but based on what you said I think this is totally expected 👍

Julesssss · 2023-03-21T10:59:23Z

@jasperhuangg please take another look, I think we're good here now. What you saw was expected.

jasperhuangg · 2023-03-21T17:58:38Z

@Julesssss Thanks for your patience was OOO, grabbing screenshots now and will merge when done!

jasperhuangg · 2023-03-21T18:45:18Z

@Julesssss

Ahh sorry, I can't seem to get any notifications on my android emulator and I can't figure out why, can someone else help with screenshots?

cc @arosiclair @cristipaval

Julesssss · 2023-03-21T18:51:36Z

@jasperhuangg I'd ask for help from someone with a physical deice, or to use browser stack (though I haven't tested notifications using that service). It's much easier using a compiled build on a physical device.

jasperhuangg · 2023-03-22T05:18:37Z

Tried a number of things and still am not getting any notifications on my Android emulator

@cristipaval @arosiclair Reached out on NewDot DMs for help with this, let's get this merged!

arosiclair · 2023-03-22T14:59:44Z

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 / Chrome
- iOS / native
- iOS / 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 correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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(themeColors.componentBG)
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 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.
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

Web

N/A

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

N/A

iOS

N/A

Android

arosiclair

Tests well for me 👍🏽

Julesssss · 2023-03-22T16:40:16Z

Thanks, I'm going to merge as we've had two successful tests now.

@jasperhuangg do you remember if you switched the airship keys? That might be the missing step.

OSBotify · 2023-03-22T16:44:50Z

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

jasperhuangg · 2023-03-22T17:04:51Z

@Julesssss

do you remember if you switched the airship keys? That might be the missing step.

I'm pretty sure I did, I took everything you removed from this commit and added it back locally: 3d816d3

Julesssss · 2023-03-22T18:03:32Z

Ah cool, next time we can try debugging together 👍

Julesssss · 2023-03-24T18:48:59Z

Verified on staging ✅

OSBotify · 2023-03-24T19:06:44Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.2.89-0 🚀

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

OSBotify · 2023-03-27T10:33:26Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

Julesssss added 10 commits March 9, 2023 10:47

persist temporary debugging changes

79854b5

slight formatting improvements

7b3d591

style notifications using onyxData to reduce payload size

0aa4db6

improve naming of onyxData json map

f2dd1f2

improve message timestamp retrieval logic

2c50d3a

reformat imports correctly

d0053d6

protect from malformed notification created data

01a53f0

simplify explanation

b3fa2da

minor improvements to the native android notification handler

fb7f42a

fix notification breaking condition

509c85b

Julesssss self-assigned this Mar 10, 2023

Julesssss added 4 commits March 13, 2023 14:14

Merge branch 'main' into jules-styleNotificationWithOnyxData

0180c38

fix invalid notification date parsing logic

dfdf086

Merge branch 'main' into jules-styleNotificationWithOnyxData

0d1c5ac

remove debuggable release build changes

3d816d3

Julesssss requested review from cristipaval and arosiclair March 16, 2023 17:57

Julesssss marked this pull request as ready for review March 16, 2023 18:33

Julesssss requested a review from a team as a code owner March 16, 2023 18:33

melvin-bot bot requested review from jasperhuangg and parasharrajat and removed request for a team March 16, 2023 18:34

Julesssss commented Mar 16, 2023

View reviewed changes

...d/app/src/main/java/com/expensify/chat/customairshipextender/CustomNotificationProvider.java Show resolved Hide resolved

jasperhuangg removed the request for review from parasharrajat March 17, 2023 17:56

jasperhuangg reviewed Mar 17, 2023

View reviewed changes

Julesssss added 2 commits March 20, 2023 12:34

improve comments for ANdroid notification styling

418eec2

Merge branch 'main' into jules-styleNotificationWithOnyxData

577ceab

cristipaval previously approved these changes Mar 20, 2023

View reviewed changes

Julesssss dismissed stale reviews from cristipaval and arosiclair via 577ceab March 20, 2023 12:35

cristipaval approved these changes Mar 20, 2023

View reviewed changes

jasperhuangg approved these changes Mar 21, 2023

View reviewed changes

arosiclair approved these changes Mar 22, 2023

View reviewed changes

Julesssss merged commit 75798f5 into main Mar 22, 2023

Julesssss deleted the jules-styleNotificationWithOnyxData branch March 22, 2023 16:40

Julesssss added the InternalQA This pull request required internal QA label Mar 22, 2023

OSBotify mentioned this pull request Mar 24, 2023

Deploy Checklist: New Expensify 2023-03-24 #16489

Closed

44 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Style notifications using onyxData, increase payload bandwidth #15857

Style notifications using onyxData, increase payload bandwidth #15857

Julesssss commented Mar 10, 2023 •

edited by jasperhuangg

Loading

MelvinBot commented Mar 16, 2023

Julesssss commented Mar 16, 2023

Julesssss commented Mar 16, 2023 •

edited

Loading

Julesssss commented Mar 17, 2023

jasperhuangg commented Mar 17, 2023 •

edited

Loading

jasperhuangg commented Mar 17, 2023 •

edited

Loading

jasperhuangg Mar 17, 2023

Julesssss Mar 20, 2023

Julesssss Mar 20, 2023

Julesssss commented Mar 20, 2023 •

edited

Loading

Julesssss commented Mar 21, 2023

jasperhuangg commented Mar 21, 2023

jasperhuangg commented Mar 21, 2023

Julesssss commented Mar 21, 2023

jasperhuangg commented Mar 22, 2023

arosiclair commented Mar 22, 2023 •

edited

Loading

arosiclair left a comment

Julesssss commented Mar 22, 2023

OSBotify commented Mar 22, 2023

jasperhuangg commented Mar 22, 2023

Julesssss commented Mar 22, 2023

Julesssss commented Mar 24, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

Style notifications using onyxData, increase payload bandwidth #15857

Style notifications using onyxData, increase payload bandwidth #15857

Conversation

Julesssss commented Mar 10, 2023 • edited by jasperhuangg Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 16, 2023

Julesssss commented Mar 16, 2023

Julesssss commented Mar 16, 2023 • edited Loading

Julesssss commented Mar 17, 2023

jasperhuangg commented Mar 17, 2023 • edited Loading

jasperhuangg commented Mar 17, 2023 • edited Loading

jasperhuangg Mar 17, 2023

Choose a reason for hiding this comment

Julesssss Mar 20, 2023

Choose a reason for hiding this comment

Julesssss Mar 20, 2023

Choose a reason for hiding this comment

Julesssss commented Mar 20, 2023 • edited Loading

Julesssss commented Mar 21, 2023

jasperhuangg commented Mar 21, 2023

jasperhuangg commented Mar 21, 2023

Julesssss commented Mar 21, 2023

jasperhuangg commented Mar 22, 2023

arosiclair commented Mar 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

arosiclair left a comment

Choose a reason for hiding this comment

Julesssss commented Mar 22, 2023

OSBotify commented Mar 22, 2023

jasperhuangg commented Mar 22, 2023

Julesssss commented Mar 22, 2023

Julesssss commented Mar 24, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

Julesssss commented Mar 10, 2023 •

edited by jasperhuangg

Loading

Julesssss commented Mar 16, 2023 •

edited

Loading

jasperhuangg commented Mar 17, 2023 •

edited

Loading

jasperhuangg commented Mar 17, 2023 •

edited

Loading

Julesssss commented Mar 20, 2023 •

edited

Loading

arosiclair commented Mar 22, 2023 •

edited

Loading