Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: No notification on web if window is not active #17493

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Apr 17, 2023

Details

Desktop shows the notification but web does not when we focus on the tab then open another app to blur the window. That is caused by different implementations of Visibility.isVisible() function across platforms. This PR fixes the issue.

Fixed Issues

$ #17242
PROPOSAL: #17242 (comment)

Tests

  1. Login with account A on Web
  2. Go to any chat with account B
  3. Open any other app so that the browser window gets defocused
  4. Login with account B on another device
  5. Send message from that device to account A
  6. Verify that the account A's device receives new message notification
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

  1. Login with account A on Web
  2. Go to any chat with account B
  3. Open any other app so that the browser window gets defocused
  4. Login with account B on another device
  5. Send message from that device to account A
  6. Verify that the account A's device receives new message notification
  • Verify that no errors appear in the JS console

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 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 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 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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screencast.from.17-04-2023.15.59.02.webm
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@tienifr tienifr marked this pull request as ready for review April 17, 2023 09:24
@tienifr tienifr requested a review from a team as a code owner April 17, 2023 09:24
@melvin-bot melvin-bot bot requested review from luacmartins and Santhosh-Sellavel and removed request for a team April 17, 2023 09:24
@MelvinBot
Copy link

@luacmartins @Santhosh-Sellavel 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]

@tienifr
Copy link
Contributor Author

tienifr commented Apr 17, 2023

Note: This only happens on Web so I only included Web screenshot. Please let me know if there were ways to enable notification on mWeb. What do you think if I didn't included other platforms' screenshots?

@luacmartins
Copy link
Contributor

@Santhosh-Sellavel all yours!

@tienifr
Copy link
Contributor Author

tienifr commented Apr 18, 2023

@Santhosh-Sellavel Just a friendly reminder in case you missed this.

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tienifr I'm having issues testing these changes. I'm only getting notifications when the browser is minimized, but nothing comes up when I have it open and the window is unfocused. Am I doing something wrong?

@Santhosh-Sellavel
Copy link
Collaborator

@Santhosh-Sellavel Just a friendly reminder in case you missed this.

@tienifr
Sorry we discussed this internally and forgot to leave a comment here, everything perfectly works fine for me on the staging itself and I'm not sure what we are trying to do here.

cc: @luacmartins

@tienifr
Copy link
Contributor Author

tienifr commented Apr 19, 2023

@luacmartins I still get notified without minimizing the browser. Don't know if you miss any test step in the PR description. Could you please try again? Thanks a lot!

Screencast.from.19-04-2023.15.33.18.webm

@tienifr
Copy link
Contributor Author

tienifr commented Apr 19, 2023

@Santhosh-Sellavel

I didn't get notified when the window is unfocused/not active. Reproduced on Staging.

Screencast.from.19-04-2023.15.37.53.webm

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 19, 2023

Alright, I got to reproduce the issue now, but the issue is not the same as it was described slightly differently.

We receive notifications even when the window is not active. We don't show when the same chat is active for which the notifications are received.

@Santhosh-Sellavel
Copy link
Collaborator

@tienifr Doesn't it affect mWeb also?

@tienifr
Copy link
Contributor Author

tienifr commented Apr 19, 2023

@Santhosh-Sellavel I've raised my concern here: #17493 (comment).

Actually I don't know if we can receive notifications on mWeb. In case we can, please let me know how to because I couldn't do it on my phone/emulator 🤓.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 19, 2023

We receive notifications even when the window is not active. We don't show when the same chat is active

Absolutely! We don't show when that chat is being opened and the window is active, to be more concise.

@luacmartins
Copy link
Contributor

Supposedly you can enable notifications on Chrome mWeb, but I couldn't get it to work 😕

Screenshot_1681921185

@tienifr
Copy link
Contributor Author

tienifr commented Apr 19, 2023

@luacmartins Thanks! I already tried but it yielded no result. In Chrome mobile (Android & iOS), we can't manually add allowed sites for notifications. Instead, the site must ask for permission first. While it's different on Computer where we can manually add or remove any site.

Reference: https://support.google.com/chrome/answer/3220216?hl=en&co=GENIE.Platform%3DAndroid&oco=1

@luacmartins
Copy link
Contributor

Yea, I'd say that's out of scope for this PR.

cc @Julesssss @arosiclair since you worked on notifications. Are we asking for permission to show notifications on mWeb?

@Santhosh-Sellavel
Copy link
Collaborator

Alright if the notification is itself not working on mWeb it's a different problem, can you create a new tracking issue for that @luacmartins? And let's move forward here

@Julesssss
Copy link
Contributor

Are we asking for permission to show notifications on mWeb?

Pretty sure mWeb is completely unsupported for now

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 19, 2023

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 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 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
Screen.Recording.2023-04-19.at.8.25.50.PM.mov
Desktop
Screen.Recording.2023-04-19.at.10.07.37.PM.mov

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, tests well!

@luacmartins
Copy link
Contributor

@Julesssss is mWeb notification covered anywhere in the notifications project? do we already have an issue for it?

@luacmartins luacmartins merged commit 1100127 into Expensify:main Apr 19, 2023
@Julesssss
Copy link
Contributor

@cead22 no, it's not something we care about

@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.2-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.2-5 🚀

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

@cristipaval
Copy link
Contributor

FYI: this PR introduced this regression.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 25, 2023

@cristipaval I'm confused about how this causes a regression, can you explain please with a bit more context thanks!

@cristipaval
Copy link
Contributor

@tienifr @Santhosh-Sellavel @luacmartins I am reverting this PR since automatic authentication with the magic link is a very important feature.

@cristipaval
Copy link
Contributor

cristipaval commented Apr 25, 2023

@cristipaval I'm confused about how this causes a regression, can you explain please with a bit more context thanks!

@Santhosh-Sellavel Please see follow here the link to the Slack conversation with more context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants