Persist notification cache to internal storage #23825

arosiclair · 2023-07-28T20:42:32Z

Details

Moves our notification cache to a static class that writes and reads its data to internal storage. Fixes an issue where messages don't thread after the app has been killed because the in-memory cache was lost.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/258537
$ #22972

Tests

Android test only

Notification threading

Log into NewDot on Android
Send yourself three messages
Verify each message is threaded in a single notification

Notification threading after the app is killed

Kill the app by swiping it away in the recent apps view
Send yourself another message
Verify the 4th message is also threaded in the existing notification

Dismissing notification

Dismiss the notification
Send yourself another message
Verify a new separate notification appears

Opening the notification

Tap the notification to open the conversation
Verify the notification is also dismissed
Navigate back to the home screen
Send yourself another message
Verify a new separate notification appears

Offline tests

None

QA Steps

Same as Tests

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 / Chrome
- iOS / native
- iOS / 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 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed 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 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 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.js 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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 author 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

screen-20230801-152047.2.mp4

…atic/non-static references

Santhosh-Sellavel · 2023-08-02T00:42:33Z

@Julesssss I think C+ Help might not be needed here, If needed let me know I'm happy to assist, thanks!

Julesssss · 2023-08-02T15:19:40Z

android/app/src/main/java/com/expensify/chat/customairshipextender/NotificationCache.java

+            e.printStackTrace();
+            result = new HashMap<>();


In the case where casting the object to result fails, can we assume it is malformed and wipe it?

Reading the file could fail in a few ways, but in any case, the file will get overwritten once we're done processing the notification and update the cache

android/app/src/main/java/com/expensify/chat/customairshipextender/NotificationCache.java

Issues resolved

Julesssss

Haven't had a chance to test it manually yet but the code is looking good.

OSBotify · 2023-08-02T19:24:40Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/23825/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/23825/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/23825/NewExpensify.dmg	https://23825.pr-testing.expensify.com

arosiclair · 2023-08-03T19:34:33Z

@Santhosh-Sellavel Jules is OOO until next week. If you can review in the meantime it'd be appreciated

Santhosh-Sellavel · 2023-08-03T19:48:16Z

@arosiclair I will do it, later today!

Santhosh-Sellavel · 2023-08-06T17:45:12Z

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

TestPR.mp4

Santhosh-Sellavel · 2023-08-06T18:54:43Z

Bug: An inconsistent default picture is shown between notification & app

Santhosh-Sellavel

Except this everything else looks good and tests well!

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

Julesssss

👍

Julesssss · 2023-08-07T11:03:16Z

Bug: An inconsistent default picture is shown between notification & app

@Santhosh-Sellavel good spot but I already have an issue for this (it exists, but I don't have the link ATM)

OSBotify · 2023-08-07T11:10:32Z

✋ 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 · 2023-08-07T18:54:46Z

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

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

OSBotify · 2023-08-09T08:43:54Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:12:53Z

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

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

OSBotify · 2023-08-09T09:51:36Z

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

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

OSBotify · 2023-08-10T20:10:02Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

arosiclair added 22 commits July 18, 2023 15:47

rename and move notification cache to its own file

0d201fe

move notification cache hashmap over

f0d1811

implement Parcelable for Message

5891d85

convert hashmaps to bundles

9e3452d

fix bundling Person objects by converting icon to bundle

43893e2

safety check

05cb476

rename and lift NotificationMessage out of NotificationData to fix st…

56a1dc1

…atic/non-static references

fix parcelable creator for NotificationMessage

3bf3bf5

implement parcelable for NotificationData

e643107

convert cache to Bundle

5ef1f63

add helper for writing cache to file

43dfbc6

encode bitmaps so we can marshal the final parcel to bytes

949fb1c

de-dupe person reference

6fa2aac

use Serializable instead

907fb2e

switch back to Serializable

5170132

switch back to hashmaps in NotificationData

17b882d

switch cache back to HashMap

46687de

write the cache to internal storage

e03a51c

encode bitmap to string so it's serializable

dd8f47c

persist just the person name to make it serializable

1e06cf0

read cache from storage when it's null

3704944

save a static reference for application context

6189be7

arosiclair self-assigned this Jul 28, 2023

arosiclair added 6 commits July 28, 2023 16:45

restore the cache on set as well

38f55c0

handle the notification getting dismissed on open

93fa41e

use constant for cache file name

32f2027

add comment explaining encoded bitmaps

887b1bc

remove unused data class

e7188b8

linter suggestions

6df512d

arosiclair requested a review from Julesssss July 28, 2023 21:20

arosiclair added Ready To Build and removed Ready To Build labels Aug 1, 2023

Julesssss reviewed Aug 2, 2023

View reviewed changes

android/app/src/main/java/com/expensify/chat/customairshipextender/NotificationCache.java Outdated Show resolved Hide resolved

Julesssss reviewed Aug 2, 2023

View reviewed changes

android/app/src/main/java/com/expensify/chat/customairshipextender/NotificationCache.java Show resolved Hide resolved

Julesssss previously approved these changes Aug 2, 2023

View reviewed changes

arosiclair added 2 commits August 2, 2023 14:24

add doc for NotificationData class

b396b5e

safely close file streams

6b3ff25

arosiclair dismissed Julesssss’s stale review via 6b3ff25 August 2, 2023 18:59

arosiclair requested a review from Julesssss August 2, 2023 19:02

Santhosh-Sellavel reviewed Aug 6, 2023

View reviewed changes

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

Julesssss approved these changes Aug 7, 2023

View reviewed changes

Julesssss merged commit 81317d2 into main Aug 7, 2023

Julesssss deleted the arosiclair-persist-notification-cache branch August 7, 2023 11:06

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Persist notification cache to internal storage #23825

Persist notification cache to internal storage #23825

arosiclair commented Jul 28, 2023 •

edited

Loading

Santhosh-Sellavel commented Aug 2, 2023

Julesssss Aug 2, 2023

arosiclair Aug 2, 2023

Julesssss left a comment

OSBotify commented Aug 2, 2023

arosiclair commented Aug 3, 2023

Santhosh-Sellavel commented Aug 3, 2023

Santhosh-Sellavel commented Aug 6, 2023 •

edited

Loading

Santhosh-Sellavel commented Aug 6, 2023

Santhosh-Sellavel left a comment

Julesssss left a comment

Julesssss commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

Persist notification cache to internal storage #23825

Persist notification cache to internal storage #23825

Conversation

arosiclair commented Jul 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Santhosh-Sellavel commented Aug 2, 2023

Julesssss Aug 2, 2023

Choose a reason for hiding this comment

arosiclair Aug 2, 2023

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 2, 2023

arosiclair commented Aug 3, 2023

Santhosh-Sellavel commented Aug 3, 2023

Santhosh-Sellavel commented Aug 6, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel commented Aug 6, 2023

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

Julesssss commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

arosiclair commented Jul 28, 2023 •

edited

Loading

Santhosh-Sellavel commented Aug 6, 2023 •

edited

Loading