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: default notification to be hidden for new chat #43638

Merged
merged 6 commits into from
Jun 24, 2024

Conversation

dominictb
Copy link
Contributor

@dominictb dominictb commented Jun 13, 2024

Details

fix: default notification to be hidden for new chat

Fixed Issues

$ #43218
PROPOSAL: #43218 (comment)

Tests

Start a new chat/a new group chat
Click on the header of the newly created chat

Verify that the notify me about new messages option should not appear

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Start a new chat/a new group chat
Click on the header of the newly created chat

Verify that the notify me about new messages option should not appear

  • 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: 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 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 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 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.

Screenshots/Videos

Android: Native
compressed_android.webm.mp4
Android: mWeb Chrome
compressed_aweb.webm.mp4
iOS: Native
compressed_iosweb.mp4.mp4
iOS: mWeb Safari
compressed_ios.mp4.mp4
MacOS: Chrome / Safari
compressed_web.mov.mp4
MacOS: Desktop
compressed_web.mov.mp4

@dominictb dominictb marked this pull request as ready for review June 13, 2024 09:22
@dominictb dominictb requested a review from a team as a code owner June 13, 2024 09:22
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team June 13, 2024 09:22
Copy link

melvin-bot bot commented Jun 13, 2024

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

@DylanDylann
Copy link
Contributor

DylanDylann commented Jun 18, 2024

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
Screen.Recording.2024-06-18.at.11.17.38.mov
Android: mWeb Chrome
Screen.Recording.2024-06-18.at.11.16.35.mov
iOS: Native
Screen.Recording.2024-06-18.at.11.18.18.mov
iOS: mWeb Safari
Screen.Recording.2024-06-18.at.11.17.09.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-18.at.11.10.49.mov
MacOS: Desktop
Screen.Recording.2024-06-18.at.11.14.48.mov

Copy link
Contributor

@DylanDylann DylanDylann left a comment

Choose a reason for hiding this comment

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

The change looks good. We will hide the notification option until we get a response from BE (discussion here)

@melvin-bot melvin-bot bot requested a review from cead22 June 18, 2024 04:21
@dominictb
Copy link
Contributor Author

@DylanDylann do we change the default notification pref for group chat to be hidden as well? If yes then I'll need to revert my latest commit.

@DylanDylann
Copy link
Contributor

@dominictb Yep, Let's update it again

@DylanDylann
Copy link
Contributor

@cead22 All yours

@cead22
Copy link
Contributor

cead22 commented Jun 20, 2024

[x] Verify that no errors appear in the JS console
[x] 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)

@dominictb @DylanDylann you checked these, but there are console errors. Can you link to where they're being addressed?

  • encountered two children with the same key
  • this syntethic event is reused for performance
  • function components cannot be given refs

And out of curiosity, do you fill out the checklist by reading each item for each PR, or do you check them all in one go now that you're used to submitting PRs in this repo? It's ok if it's the latter, you wouldn't be the first that do these, and I want to know to see if we need to change this solution

Also, do you know if these bugs have been reported? If not, can you report them?

Menu items truncated / not full width

one two
Screenshot 2024-06-20 at 2 47 38 PM image

Floating referral box and compose box / Bottom of the screen not calculated correctly

one two three
Screenshot 2024-06-20 at 2 51 30 PM Screenshot 2024-06-20 at 2 51 40 PM Screenshot 2024-06-20 at 2 51 58 PM

@dominictb
Copy link
Contributor Author

encountered two children with the same key
this syntethic event is reused for performance
function components cannot be given refs

Only the first and the third warning logs will need to be fixed, the second one is from warning log from RN devtool I believe so @cead22 . I believe we don't need to fix that, or I'm not really sure whether we can fix/disable it properly. For the first and the third one, should I report that on Slack or what @cead22 @DylanDylann?

And out of curiosity, do you fill out the checklist by reading each item for each PR, or do you check them all in one go now that you're used to submitting PRs in this repo?

It's more on the latter, even though I think as a contributor I could still follow the checklist consistently without explicitly checking for individual items. For example, if I encounter some weird error logs, I will report it immediately, but the warning logs you saw seem date back long time ago, so probably me (and some others) are well trained to ignore it, thinking it might have been reported/fixed by someone else.

Also, do you know if these bugs have been reported? If not, can you report them?

@cead22 I recalled these bugs have been reported somewhere as deploy blockers? I haven't been able to pin down the exact reported issue numbers, maybe @DylanDylann can try? ll try to merge main again to see if the issues are fixed.

@dominictb
Copy link
Contributor Author

Menu items truncated / not full width

@cead22 this issue should have been fixed in the latest main. I have merged main and test it!

@cead22
Copy link
Contributor

cead22 commented Jun 21, 2024

Only the first and the third warning logs will need to be fixed, the second one is from warning log from RN devtool I believe so @cead22 . I believe we don't need to fix that, or I'm not really sure whether we can fix/disable it properly. For the first and the third one, should I report that on Slack or what @cead22 @DylanDylann?

Yes, please report them on slack, including the RN dev tool one, so we can have a discussion about it. And link those discussions here

It's more on the latter, even though I think as a contributor I could still follow the checklist consistently without explicitly checking for individual items. For example, if I encounter some weird error logs, I will report it immediately, but the warning logs you saw seem date back long time ago, so probably me (and some others) are well trained to ignore it, thinking it might have been reported/fixed by someone else.

Totally. I think it'd be ideal if we start reporting every single console warning or error, and that way we can prioritize fixing them, so it'll be uncommon when they happen. As opposed to now, where they're very common, but we've been seeing them for a while so they don't get as much attention. What do you think?

@cead22 I recalled these bugs have been reported somewhere as deploy blockers? I haven't been able to pin down the exact reported issue numbers, maybe @DylanDylann can try? ll try to merge main again to see if the issues are fixed.

If you find the slack convos, feel free to revive them, and if not, let's start new ones

@dominictb
Copy link
Contributor Author

Totally. I think it'd be ideal if we start reporting every single console warning or error, and that way we can prioritize fixing them, so it'll be uncommon when they happen. As opposed to now, where they're very common, but we've been seeing them for a while so they don't get as much attention. What do you think?

👍 for this point

If you find the slack convos, feel free to revive them, and if not, let's start new ones

I'll ask on Slack if someone knew or fixed this. Will link back the relevant issues/PRs here.

Yes, please report them on slack, including the RN dev tool one, so we can have a discussion about it. And link those discussions here

Ok will do this as well on Monday!

@dominictb
Copy link
Contributor Author

@cead22 reported and tagged you on Slack: https://expensify.slack.com/archives/C01GTK53T8Q/p1719213192132509

@DylanDylann
Copy link
Contributor

@cead22 Thanks for the reminder, I'll keep that in mind in the next PRs. @dominictb created a Slack thread on the Open Source Channel. Should I bring these bugs to #expensify-bugs channel?

@cead22
Copy link
Contributor

cead22 commented Jun 24, 2024

Should I bring these bugs to #expensify-bugs channel?

If the convos aren't moving forward, or we don't have issues for these warnings, then yes let's report them on expensify-bugs to get issues created for these and get them fixed

@cead22 cead22 merged commit fecb740 into Expensify:main Jun 24, 2024
15 checks passed
@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/cead22 in version: 9.0.2-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

@dominictb dominictb deleted the fix/43218 branch July 28, 2024 03:48
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.

4 participants