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: hidden chat appears in finder page #50127

Merged
merged 10 commits into from
Oct 23, 2024
Merged

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Oct 3, 2024

Details

Fixed Issues

$ #50100
PROPOSAL: #50100 (comment)

Tests

  1. Submit some expenses in a WS chat or DM chat
  2. Open the expense report
  3. Mark this report as unread
  4. Open another report
  5. Open the finder page
  6. Verify that the expense report doesn't has bold style in the finder page
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Submit some expenses in a WS chat or DM chat
  2. Open the expense report
  3. Mark this report as unread
  4. Open another report
  5. Open the finder page
  6. Verify that the expense report doesn't has bold style in the finder page
  • 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
android.mov
Android: mWeb Chrome
android-mweb.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-mweb.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@nkdengineer nkdengineer marked this pull request as ready for review October 3, 2024 09:34
@nkdengineer nkdengineer requested a review from a team as a code owner October 3, 2024 09:34
Copy link

melvin-bot bot commented Oct 3, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team October 3, 2024 09:34
@ZhenjaHorbach
Copy link
Contributor

@nkdengineer
Before we go on
Could you please check this comment ?
#50100 (comment)

@nkdengineer nkdengineer changed the title fix: Unread chats are missing from LHN fix: hidden chat appears in finder page Oct 4, 2024
@ZhenjaHorbach
Copy link
Contributor

@nkdengineer
Is this PR ready for review?

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Oct 5, 2024

@ZhenjaHorbach I need to re-record videos on all platforms, will update soon

@nkdengineer
Copy link
Contributor Author

@ZhenjaHorbach this PR is ready for review

@ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach this PR is ready for review

Cool !
I will check on the weekend

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Oct 5, 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
android.mov
Android: mWeb Chrome
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@ZhenjaHorbach
Copy link
Contributor

Plus I'm a little confused
Should we be able to find the hidden chat using search?

@nkdengineer
Copy link
Contributor Author

Should we be able to find the hidden chat using search?

@ZhenjaHorbach I think if we decided to hide this chat on the finder page, we would not be able to find this chat using search.

@ZhenjaHorbach
Copy link
Contributor

https://expensify.slack.com/archives/C05LX9D6E07/p1728288169805139?thread_ts=1727795413.457949&cid=C05LX9D6E07

We should be able to find the hidden chat
But as far as I understand finder page will soon be removed
But I think we should make sure that searching for hidden chats will be available

@melvin-bot melvin-bot bot requested a review from tgolen October 7, 2024 13:44
@ZhenjaHorbach
Copy link
Contributor

I approve these changes

But only this question remains
But since the Finder screen will be removed soon
We can move on

@tgolen
What do you think ?

@tgolen
Copy link
Contributor

tgolen commented Oct 7, 2024

The decision that we came to on Slack is that if a chat has "hidden" for the notification preference, it should appear in the LHN (and global search), but it should NOT be shown in bold which would indicate it is unread.

So, I think this PR is incorrect if I read the tests properly.

@nkdengineer
Copy link
Contributor Author

@tgolen So here is what we should do in this PR, right?

  • Display the hidden chat in LHN
  • Do not display this chat with bold style

@tgolen
Copy link
Contributor

tgolen commented Oct 8, 2024

Correct, yeah.

@ZhenjaHorbach
Copy link
Contributor

@nkdengineer
Could you please fix conflicts and update PR following requirements?
Thanks !

@nkdengineer
Copy link
Contributor Author

@tgolen A bit confused here. Currently, we're not displaying the hidden chat in LHN except for some special cases in shouldOverrideHidden. I want to ask which case below is the correct new behavior that we want:

  1. Display the additional hidden unread chat but will not display it with the bold style
  2. Display all hidden chat in LHN but will not display it with the bold style

if (isHidden && !shouldOverrideHidden) {

@tgolen
Copy link
Contributor

tgolen commented Oct 9, 2024

Sorry, I don't think I can answer that because I don't know what the impact of either decision would be. Can you help me understand the difference and what the impact might be of either choice?

To restate the way I understand the bug today (going back to the OG description):

  • I have several chats with notificationPreference: hidden
  • This means that the chat will NOT be shown in the LHN (which is good 👍 )
  • This means that the chat is shown as bold (unread) in the chat finder (which is bad 👎 )

All this PR should do is stop making the chat shown as bold in the chat finder.

@nkdengineer
Copy link
Contributor Author

@tgolen Alright, thanks for your detail. I got what I need to do now. Will update the PR soon.

@nkdengineer
Copy link
Contributor Author

@ZhenjaHorbach i updated code change and all screenshots, please check again

@ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach i updated code change and all screenshots, please check again

Thanks !
I will review today

@nkdengineer
Copy link
Contributor Author

@ZhenjaHorbach Based on the comment above, I removed shouldBoldHiddenChat param.

@ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach Based on the comment above, I removed shouldBoldHiddenChat param.

Cool !
I will check today or tomorrow

@ZhenjaHorbach
Copy link
Contributor

@nkdengineer
Did you check this comment ?
#50127 (comment)

After your changes we have no chats that are displayed in bold
Because we use HIDDEN by default if don't have notificationPreference in report

return report?.participants?.[currentUserAccountID ?? -1]?.notificationPreference ?? CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN;

As result shouldUseBoldText returns false

But here we first need to find out why we are missing notificationPreference info in the LHN report
Because if we open Notification Preference page we will have notificationPreference in report

We use getReportNotificationPreference in both cases

Before

2024-10-17.22.10.38.mov

After

2024-10-17.22.10.00.mov

@nkdengineer
Copy link
Contributor Author

I'm checking this.

@nkdengineer
Copy link
Contributor Author

@ZhenjaHorbach The problem is optionItem in LHN doesn't have participant field then when we call this function in LHN it always returns hidden.

@ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach The problem is optionItem in LHN doesn't have participant field then when we call this function in LHN it always returns hidden.

I think everything will be fine now
Thanks !
I'll check today

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Oct 22, 2024

LGTM

@tgolen tgolen merged commit 6801de7 into Expensify:main Oct 23, 2024
17 checks passed
@melvin-bot melvin-bot bot added the Emergency label Oct 23, 2024
Copy link

melvin-bot bot commented Oct 23, 2024

@tgolen looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.53-0 🚀

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

@tgolen tgolen removed the Emergency label Oct 23, 2024
Copy link
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.53-0 🚀

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

@tgolen
Copy link
Contributor

tgolen commented Oct 23, 2024

This wasn't an emergency. I just merged too quickly and didn't realize that there was a running test.

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.53-1 🚀

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

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