Handle if push notification doesn't have a payload #47123

jp928 · 2024-08-09T00:00:35Z

Details

If a push notification was send without a payload, the App would crash.

Fixed Issues

$ #46820
PROPOSAL: $ #46820 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

prepare a text with following contents:

{
  "Simulator Target Bundle": "com.expensify.chat.dev",
  "aps": {
    "alert": "Testing",
    "sound": "default",
    "badge": 1,
  },
}

Run the project in a simulator with npm run ios
Run the following command to see if the App still crash

xcrun simctl push  {simulator_uuid} com.expensify.chat.dev {path_to_the_file_in_step1}

QA Steps

1.Get a Hybrid App notification that an expense report has been reimbursed
2.Unlock phone (not even specifically opening the notification)
3. Verify that the app doesn't crash

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

andrid_native.webm

Android: mWeb Chrome

android_web.webm

iOS: Native

Screen.Recording.2024-08-09.at.10.09.15.AM.mov

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.-.2024-08-09.at.10.16.09.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-09.at.10.17.36.AM.mov

MacOS: Desktop

Screen.Recording.2024-08-09.at.10.22.21.AM.mov

melvin-bot · 2024-08-09T00:00:40Z

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

s77rt · 2024-08-09T13:19:04Z

@jp928 Please do not raise PRs until assigned in the issue

src/libs/Notification/PushNotification/shouldShowPushNotification.ts

s77rt

It seems we have a type error, pushPayload.extras.payload is shown to have type JsonValue but it's not always the case as it can be undefined. I think we should fix this upstream. Then we can just fix the ts errors which will prevent the crash.

This assertion is also false

const data = payload as PushNotificationData

jp928 · 2024-08-23T04:12:17Z

@arosiclair @s77rt Updated with respecting comments.

src/types/modules/react-native-airship.d.ts

src/libs/Notification/PushNotification/shouldShowPushNotification.ts

s77rt · 2024-08-23T10:56:42Z

@jp928 Did you raise a PR? (#47123 (comment))

jp928 · 2024-08-23T11:53:59Z

@jp928 Did you raise a PR? (#47123 (comment))

$ urbanairship/react-native-airship#583

s77rt · 2024-08-23T13:24:48Z

@jp928 Can you please create a patch so we can have the type corrected without waiting for the upstream PR to be merged

rlepinski · 2024-08-23T16:21:50Z

@s77rt I can get an airship patch out today with the PR

patches/@ua+react-native-airship+17.2.1.patch

src/libs/Notification/PushNotification/shouldShowPushNotification.ts

s77rt

Can you please apply same solution for other affected places (in editor search for: as PushNotificationData)

jp928 · 2024-08-23T20:42:59Z

Can you please apply same solution for other affected places (in editor search for: as PushNotificationData)

Thx. Just apply same cast as other places.

arosiclair · 2024-08-23T20:47:22Z

patches/@ua+react-native-airship+17.2.1.patch

Is the airship package getting updated with this fix soon? If so, can we just use the new version instead of adding this patch?

s77rt · 2024-08-23T20:54:48Z

@jp928

Just apply same cast as other places.

This is not what I meant. Actually the new cast is the correct one. What I meant is that in other places the payload can be undefined and we are still accessing fields on undefined e.g.

App/src/libs/Notification/clearReportNotifications/index.native.ts

Lines 8 to 18 in f5e6354

    
           const parseNotificationAndReportIDs = (pushPayload: PushPayload) => { 
        
               let payload = pushPayload.extras.payload; 
        
               if (typeof payload === 'string') { 
        
                   payload = JSON.parse(payload) as string; 
        
               } 
        
               const data = payload as PushNotificationData; 
        
               return { 
        
                   notificationID: pushPayload.notificationId, 
        
                   reportID: String(data.reportID), 
        
               }; 
        
           };

rlepinski · 2024-08-23T21:29:51Z

Airship release - https://github.com/urbanairship/react-native-airship/releases/tag/19.2.1

src/libs/Notification/PushNotification/index.native.ts

src/libs/Notification/clearReportNotifications/index.native.ts

src/libs/Notification/PushNotification/shouldShowPushNotification.ts

s77rt · 2024-08-24T19:12:48Z

@jp928 The QA steps are not clear (sending a notification without payload). Can you instead use the steps from the reported issue?

s77rt · 2024-08-24T19:22:48Z

@jp928 Did you find a way to send a notification to the Android Emulator?

jp928 · 2024-08-24T22:01:51Z

@jp928 Did you find a way to send a notification to the Android Emulator?

Unfortunately no.

s77rt · 2024-08-25T04:09:59Z

@jp928 In QA Steps add a third step to verify that the app didn't crash

s77rt · 2024-08-25T17:28:58Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.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(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.
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

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/libs/Notification/PushNotification/shouldShowPushNotification.ts

s77rt · 2024-08-26T20:05:20Z

@jp928 Looks we have conflicts

…ive-ariship version,

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

…ion.ts Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

s77rt · 2024-08-26T20:52:54Z

@jp928 For future PRs please avoid force-pushing, it causes review progress to be lost and can't use the "Show changes since your last review" option. Instead merge main.

OSBotify · 2024-08-26T21:07:07Z

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

OSBotify · 2024-08-26T23:18:09Z

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

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

OSBotify · 2024-08-27T00:08:31Z

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

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

jp928 requested a review from a team as a code owner August 9, 2024 00:00

melvin-bot bot requested a review from s77rt August 9, 2024 00:00

melvin-bot bot removed the request for review from a team August 9, 2024 00:00

arosiclair reviewed Aug 22, 2024

View reviewed changes

src/libs/Notification/PushNotification/shouldShowPushNotification.ts Outdated Show resolved Hide resolved

s77rt suggested changes Aug 22, 2024

View reviewed changes

s77rt suggested changes Aug 23, 2024

View reviewed changes

src/types/modules/react-native-airship.d.ts Outdated Show resolved Hide resolved

src/libs/Notification/PushNotification/shouldShowPushNotification.ts Show resolved Hide resolved

war-in mentioned this pull request Aug 23, 2024

[HOLD for Payment] [$250] [Hybrid App] Crashes in Background When I Get a Notification #46820

Closed

6 tasks

s77rt suggested changes Aug 23, 2024

View reviewed changes

arosiclair reviewed Aug 23, 2024

View reviewed changes

s77rt suggested changes Aug 24, 2024

View reviewed changes

src/libs/Notification/PushNotification/index.native.ts Outdated Show resolved Hide resolved

src/libs/Notification/clearReportNotifications/index.native.ts Outdated Show resolved Hide resolved

s77rt suggested changes Aug 24, 2024

View reviewed changes

src/libs/Notification/clearReportNotifications/index.native.ts Outdated Show resolved Hide resolved

s77rt suggested changes Aug 24, 2024

View reviewed changes

src/libs/Notification/PushNotification/shouldShowPushNotification.ts Outdated Show resolved Hide resolved

s77rt approved these changes Aug 25, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen August 25, 2024 17:29

jp928 requested review from arosiclair and tgolen August 26, 2024 19:24

s77rt suggested changes Aug 26, 2024

View reviewed changes

src/libs/Notification/PushNotification/shouldShowPushNotification.ts Outdated Show resolved Hide resolved

jp928 and others added 16 commits August 27, 2024 06:22

Handle if push notification doesn't have a payload

20e8d94

issue/46820 add more type definitions

144dd4d

Revert

25217f1

Update based on comment

4d55652

Add patch file

1529b3c

Update based on review

c819ec0

cast to string to keep consistent to other places

0b01398

Apply payload extract logic to other places and install new react-nat…

91a50c8

…ive-ariship version,

Bump react-native-airship version

ee23322

Update src/libs/Notification/PushNotification/index.native.ts

a27a0f2

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

Update based on review

3be703d

Add missing import

930b9ac

Update src/libs/Notification/clearReportNotifications/index.native.ts

98dbb88

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

Update src/libs/Notification/PushNotification/shouldShowPushNotificat…

0c329dd

…ion.ts Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

Extract parse payload to a function

f8188b0

Update src/libs/Notification/PushNotification/shouldShowPushNotificat…

efffbe9

…ion.ts Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

jp928 force-pushed the jp928/issue/46820 branch from 1adac8c to efffbe9 Compare August 26, 2024 20:26

arosiclair mentioned this pull request Aug 26, 2024

iOS: Push notifications do not wake the app in the background #43048

Closed

6 tasks

arosiclair approved these changes Aug 26, 2024

View reviewed changes

arosiclair merged commit fb73863 into Expensify:main Aug 26, 2024
17 checks passed

github-actions bot mentioned this pull request Aug 26, 2024

Deploy Checklist: New Expensify 2024-08-26 #48035

Closed

puneetlath mentioned this pull request Aug 28, 2024

Deploy Checklist: New Expensify 2024-08-28 #48221

Closed

93 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle if push notification doesn't have a payload #47123

Handle if push notification doesn't have a payload #47123

jp928 commented Aug 9, 2024 •

edited

Loading

melvin-bot bot commented Aug 9, 2024

s77rt commented Aug 9, 2024

s77rt left a comment

jp928 commented Aug 23, 2024

s77rt commented Aug 23, 2024

jp928 commented Aug 23, 2024

s77rt commented Aug 23, 2024

rlepinski commented Aug 23, 2024

s77rt left a comment

jp928 commented Aug 23, 2024

arosiclair Aug 23, 2024

s77rt commented Aug 23, 2024

rlepinski commented Aug 23, 2024

s77rt commented Aug 24, 2024

s77rt commented Aug 24, 2024

jp928 commented Aug 24, 2024

s77rt commented Aug 25, 2024

s77rt commented Aug 25, 2024

s77rt commented Aug 26, 2024

s77rt commented Aug 26, 2024

OSBotify commented Aug 26, 2024

OSBotify commented Aug 26, 2024

OSBotify commented Aug 27, 2024

Handle if push notification doesn't have a payload #47123

Handle if push notification doesn't have a payload #47123

Conversation

jp928 commented Aug 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 9, 2024

s77rt commented Aug 9, 2024

s77rt left a comment

Choose a reason for hiding this comment

jp928 commented Aug 23, 2024

s77rt commented Aug 23, 2024

jp928 commented Aug 23, 2024

s77rt commented Aug 23, 2024

rlepinski commented Aug 23, 2024

s77rt left a comment

Choose a reason for hiding this comment

jp928 commented Aug 23, 2024

arosiclair Aug 23, 2024

Choose a reason for hiding this comment

s77rt commented Aug 23, 2024

rlepinski commented Aug 23, 2024

s77rt commented Aug 24, 2024

s77rt commented Aug 24, 2024

jp928 commented Aug 24, 2024

s77rt commented Aug 25, 2024

s77rt commented Aug 25, 2024

Reviewer Checklist

Screenshots/Videos

s77rt commented Aug 26, 2024

s77rt commented Aug 26, 2024

OSBotify commented Aug 26, 2024

OSBotify commented Aug 26, 2024

OSBotify commented Aug 27, 2024

jp928 commented Aug 9, 2024 •

edited

Loading