Show only one update available notification at a time #37595

ShridharGoel · 2024-03-01T11:37:29Z

Details

Show only one update available notification at a time.

Fixed Issues

$ #36081
PROPOSAL: #36081 (comment)

Tests

Open the Expensify App.
Wait for a new deployment.
Check that "Update Available" notification is showing.
Wait for more deployments.
Only one update notification should show.

Offline

Does not have any changes related to offline flow.

QA Steps

Open the Expensify App.
Wait for a new deployment.
Check that "Update Available" notification is showing.
Wait for more deployments.
Only one update notification should show.

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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Mac.Web.One.Notif.mov

MacOS: Desktop

Mac.Desktop.One.Notif.mov

melvin-bot · 2024-03-01T11:37:34Z

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

github-actions · 2024-03-01T11:37:44Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

ShridharGoel · 2024-03-01T11:41:25Z

@DylanDylann What should be added for the screenshots? This change is about the notifications count, does it still need screenshots?

DylanDylann · 2024-03-05T15:41:03Z

@ShridharGoel Please update screenshot/video for this PR. And I think we should have a mock to test this change

ShridharGoel · 2024-03-05T16:50:45Z

For testing:

Added this code in Expensify.js to emulate a set of updates becoming available at intervals of 5 seconds:

useEffect(() => {
        const interval = setInterval(() => {
            console.log("Update available")
            BrowserNotifications.pushUpdateAvailableNotification()
        }, 5000);

        return () => clearInterval(interval);
    }, [])

Mac.Web.One.Notif.mov

Mac.Desktop.One.Notif.mov

ShridharGoel · 2024-03-05T16:52:01Z

@DylanDylann The videos can be found above.

DylanDylann

reviewing

src/libs/Notification/LocalNotification/BrowserNotifications.ts

DylanDylann · 2024-03-06T07:14:19Z

@ShridharGoel Please follow this comment to sign CLA

src/libs/Notification/LocalNotification/BrowserNotifications.ts

ShridharGoel · 2024-03-07T05:25:30Z

I have read the CLA Document and I hereby sign the CLA

DylanDylann · 2024-03-07T05:35:36Z

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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

only can test on desktop App

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

notification.MOV

DylanDylann

LGTM

This is a reference about tag property

For testing on dev:
Many same notifications display at the same time because we have multiple updates and each update triggers a notification.

To reproduce it, we need to add 2 notification creators in Expensify.tsx

useEffect(() => {
    const interval = setInterval(() => {
        console.log("Update available 1")
        LocalNotification.showUpdateAvailableNotification();
    }, 15000);
    return () => clearInterval(interval);
}, [])
useEffect(() => {
    const interval = setInterval(() => {
        console.log("Update available 2")
        LocalNotification.showUpdateAvailableNotification();
    }, 15000);
    return () => clearInterval(interval);
}, [])

src/libs/Notification/LocalNotification/BrowserNotifications.ts

src/CONST.ts

src/libs/Notification/LocalNotification/BrowserNotifications.ts

arosiclair · 2024-03-07T16:25:10Z

@ShridharGoel it looks like some of the commits on this PR are not signed. It's possible to revise them, but it's probably more simple to recreate the PR. Review the guidelines for more info.

DylanDylann · 2024-03-08T04:41:21Z

@ShridharGoel Could you run "npm run prettier" before commiting code? About unsigned commit, you can squash commit and push again with a signed commit

DylanDylann · 2024-03-08T10:40:06Z

We need to sign commits with GPG Keys as in the guideline

ShridharGoel · 2024-03-08T10:41:09Z

I had followed the same steps, checking again

ShridharGoel · 2024-03-08T10:48:43Z

@DylanDylann Updated.

DylanDylann · 2024-03-08T10:51:22Z

@arosiclair Please help to trigger workflows again. Thanks

arosiclair

This LGTM. @ShridharGoel can you confirm the Notification.tag property correctly replaces the old notification on both web and desktop (testing with just one useEffect)?

ShridharGoel · 2024-03-09T03:44:52Z

@arosiclair Tested on both web and desktop, it is working fine.

DylanDylann · 2024-03-11T03:59:44Z

@ShridharGoel We failed the perf test. Please check if it relates to this PR.

DylanDylann · 2024-03-11T04:02:05Z

Also please help to merge the latest main

DylanDylann · 2024-03-11T04:09:01Z

I merged the latest main locally and tested it well

ShridharGoel · 2024-03-11T06:00:45Z

Please check if it relates to this PR.

Does not seem related.

…nto notif-tags

OSBotify · 2024-03-12T18:50:00Z

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

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

kavimuru · 2024-03-12T18:57:42Z

@ShridharGoel @DylanDylann Not sure if QA team can test. We need to wait for multiple deploys. Could you help with this please?

ShridharGoel · 2024-03-13T07:24:03Z

@kavimuru Can you modify Expensify.tsx and run a build locally? This can be done: #37595 (comment)

Otherwise, we might have to just go through sanity check to ensure other things are working fine and skip this part since there's no direct way of testing apart from waiting for deploys or changing the code.

kavimuru · 2024-03-13T14:19:36Z

@ShridharGoel Applause QA team don't have access. But we can validate

Otherwise, we might have to just go through sanity check to ensure other things are working fine and skip this part since there's no direct way of testing apart from waiting for deploys or changing the code.

OSBotify · 2024-03-13T19:45:15Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.51-3 🚀

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

ShridharGoel requested a review from a team as a code owner March 1, 2024 11:37

melvin-bot bot requested review from DylanDylann and removed request for a team March 1, 2024 11:37

ShridharGoel mentioned this pull request Mar 1, 2024

[HOLD for payment 2024-03-20] [$500] duplicate update available notifications #36081

Closed

6 tasks

DylanDylann suggested changes Mar 6, 2024

View reviewed changes

src/libs/Notification/LocalNotification/BrowserNotifications.ts Outdated Show resolved Hide resolved

DylanDylann reviewed Mar 6, 2024

View reviewed changes

src/libs/Notification/LocalNotification/BrowserNotifications.ts Outdated Show resolved Hide resolved

ShridharGoel force-pushed the notif-tags branch from f92b431 to 4a1882b Compare March 7, 2024 05:24

DylanDylann approved these changes Mar 7, 2024

View reviewed changes

melvin-bot bot requested a review from arosiclair March 7, 2024 05:49

arosiclair reviewed Mar 7, 2024

View reviewed changes

ShridharGoel force-pushed the notif-tags branch from c72b993 to f9aaa08 Compare March 8, 2024 10:26

ShridharGoel force-pushed the notif-tags branch from f9aaa08 to fdbab86 Compare March 8, 2024 10:48

Show only one update available notification at a time

ee9a78a

ShridharGoel force-pushed the notif-tags branch from fdbab86 to ee9a78a Compare March 8, 2024 18:20

arosiclair reviewed Mar 8, 2024

View reviewed changes

Merge branch 'main' of https://github.com/ShridharGoel/ExpensifyApp i…

8dd0a39

…nto notif-tags

arosiclair approved these changes Mar 11, 2024

View reviewed changes

arosiclair merged commit d21bda0 into Expensify:main Mar 11, 2024
15 checks passed

github-actions bot mentioned this pull request Mar 12, 2024

Deploy Checklist: New Expensify 2024-03-12 #38162

Closed

84 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show only one update available notification at a time #37595

Show only one update available notification at a time #37595

ShridharGoel commented Mar 1, 2024 •

edited

Loading

melvin-bot bot commented Mar 1, 2024

github-actions bot commented Mar 1, 2024 •

edited

Loading

ShridharGoel commented Mar 1, 2024

DylanDylann commented Mar 5, 2024

ShridharGoel commented Mar 5, 2024

ShridharGoel commented Mar 5, 2024

DylanDylann left a comment •

edited

Loading

DylanDylann commented Mar 6, 2024

ShridharGoel commented Mar 7, 2024

DylanDylann commented Mar 7, 2024 •

edited

Loading

DylanDylann left a comment •

edited

Loading

arosiclair commented Mar 7, 2024

DylanDylann commented Mar 8, 2024

DylanDylann commented Mar 8, 2024

ShridharGoel commented Mar 8, 2024

ShridharGoel commented Mar 8, 2024

DylanDylann commented Mar 8, 2024

arosiclair left a comment

ShridharGoel commented Mar 9, 2024 •

edited

Loading

DylanDylann commented Mar 11, 2024

DylanDylann commented Mar 11, 2024

DylanDylann commented Mar 11, 2024

ShridharGoel commented Mar 11, 2024

OSBotify commented Mar 12, 2024

kavimuru commented Mar 12, 2024

ShridharGoel commented Mar 13, 2024

kavimuru commented Mar 13, 2024

OSBotify commented Mar 13, 2024

Show only one update available notification at a time #37595

Show only one update available notification at a time #37595

Conversation

ShridharGoel commented Mar 1, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 1, 2024

github-actions bot commented Mar 1, 2024 • edited Loading

ShridharGoel commented Mar 1, 2024

DylanDylann commented Mar 5, 2024

ShridharGoel commented Mar 5, 2024

ShridharGoel commented Mar 5, 2024

DylanDylann left a comment • edited Loading

Choose a reason for hiding this comment

DylanDylann commented Mar 6, 2024

ShridharGoel commented Mar 7, 2024

DylanDylann commented Mar 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann left a comment • edited Loading

Choose a reason for hiding this comment

arosiclair commented Mar 7, 2024

DylanDylann commented Mar 8, 2024

DylanDylann commented Mar 8, 2024

ShridharGoel commented Mar 8, 2024

ShridharGoel commented Mar 8, 2024

DylanDylann commented Mar 8, 2024

arosiclair left a comment

Choose a reason for hiding this comment

ShridharGoel commented Mar 9, 2024 • edited Loading

DylanDylann commented Mar 11, 2024

DylanDylann commented Mar 11, 2024

DylanDylann commented Mar 11, 2024

ShridharGoel commented Mar 11, 2024

OSBotify commented Mar 12, 2024

kavimuru commented Mar 12, 2024

ShridharGoel commented Mar 13, 2024

kavimuru commented Mar 13, 2024

OSBotify commented Mar 13, 2024

ShridharGoel commented Mar 1, 2024 •

edited

Loading

github-actions bot commented Mar 1, 2024 •

edited

Loading

DylanDylann left a comment •

edited

Loading

DylanDylann commented Mar 7, 2024 •

edited

Loading

DylanDylann left a comment •

edited

Loading

ShridharGoel commented Mar 9, 2024 •

edited

Loading