Fix issues with the bold (unread) status on Workspace Item

[cdOut]

Details

Fix issues with old phantom reports incorrectly being shown as unread in the workspace switcher.

Fixed Issues

$ #35682

Tests

1. Log into an old account, best to use one that had already been affected with this incorrect bold issue.
2. Press on the workspace switcher in the top left corner of the screen.
3. Confirm that the bold styling is correct for both the Everything section and also for user-created workspaces
4. If it's bold, there should be an unread report listed in it. If not, there shouldn't be any.

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• 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 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-NATIVE.mov

Android: mWeb Chrome

ANDROID-CHROME.mov

iOS: Native

IOS-NATIVE.mov

iOS: mWeb Safari

IOS-SAFARI.mov

MacOS: Chrome / Safari

CHROME.mov

MacOS: Desktop

DESKTOP.mov

[melvin-bot]

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

[situchan]

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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

[hayata-suenaga]

https://github.com/Expensify/App/actions/runs/8145545820

@trjExpensify the ad hoc build is being built above ⬆️

when the QA codes and links are posted in this PR, please them test the original bug. 🙇

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/37672/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/37672/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/37672/NewExpensify.dmg	https://37672.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[trjExpensify]

Boom! It's not bold anymore:

[cdOut]

cc: @situchan

[situchan]

For some reports, "Mark as unread" doesn't work. This also happens on main.
Not sure if this bug was reported elsewhere. If not, can we create GH?

Screen.Recording.2024-03-08.at.10.33.31.PM.mov

[situchan]

@cdOut I have the case where bug not fixed yet. I don't see any unread reports but workspace item is still bolded

Screen.Recording.2024-03-08.at.10.38.26.PM.mov

[situchan]

2 bugs (or expected?) in this video

1. unread transaction thread is hidden in LHN
2. selected workspace is hidden in workspace switcher (this happens only on specific workspace)

Screen.Recording.2024-03-08.at.10.44.14.PM.mov

[situchan]

I am not sure this should be fixed here. There are still mysterious unread reports hidden in LHN.

ios.mov

[situchan]

@hayata-suenaga here's summary of existing bugs:

1. some reports are never marked as unread
2. some selected workspaces disappear from workspace switcher
3. no unread reports in LHN (some unread reports are hidden) but that workspace is still bolded in switcher, which makes user confused

[hayata-suenaga]

@situchan thank you so much for checking for bugs 🙇

1. some reports are never marked as unread

Thank you for the screen recording of this issue. In the recording, it appears that you're attempting to mark a report (i.e., chat) with an error as unread. Does the "Mark as unread" function not work for reports with errors? Or does it fail for most reports, without a clear distinction between the ones it works for and those it doesn't?

2. some selected workspaces disappear from workspace switcher

I don't think a selected workspace should be hidden under any condition. Would you mind creating a GH ticket for this bug? @situchan 🙇

3. no unread reports in LHN (some unread reports are hidden) but that workspace is still bolded in switcher, which makes user confused

Thank you for reporting this issue. Are these reports are hidden because you're using the focus mode? Or are they hidden for no good reason?

[situchan]

@cdOut please merge main. I will re-test above mentioned issues on latest codebase.

[cdOut]

@situchan done, ready to re-test!

[cdOut]

If any phantom reports persist, please add the following code into WorkspaceSettingsUtils.ts at the end of the file into getWorkspacesUnreadStatuses() and paste the console.log results here, it will help me with debugging since I can't replicate any of that on my accounts:

if(ReportUtils.isUnread(report) && !!report.lastActorAccountID) { console.log(report); }

[situchan]

1. some reports are never marked as unread

Thank you for the screen recording of this issue. In the recording, it appears that you're attempting to mark a report (i.e., chat) with an error as unread. Does the "Mark as unread" function not work for reports with errors? Or does it fail for most reports, without a clear distinction between the ones it works for and those it doesn't?

I am not sure but I think it's related to whisper message.
If last message is whisper action, 100% fails.
This also happens on main so out of scope

2. some selected workspaces disappear from workspace switcher

I don't think a selected workspace should be hidden under any condition. Would you mind creating a GH ticket for this bug? @situchan 🙇

This seems not happening on latest main

3. no unread reports in LHN (some unread reports are hidden) but that workspace is still bolded in switcher, which makes user confused

Thank you for reporting this issue. Are these reports are hidden because you're using the focus mode? Or are they hidden for no good reason?

They are hidden for no good reason.

[situchan]

@cdOut here's console log as you requested:

The root cause is that this condition is perfectly met: lastReadTime < lastVisibleActionCreated but that report is not visible in LHN.

[situchan]

I think I know why that happens.
Unpinned transaction detail report is always hidden in LHN no matter unread or not.

[situchan]

@cdOut bump ^
Please let us know whether my concerns above are out of scope so we can merge, or you'll fix here.
I am fine either as this change doesn't cause any regressions, though bug not fully fixed yet due to unrelated root cause.

[cdOut]

@situchan So the fix for this issue would be changing the requirements for when we display a report in the LHN, which is not what I was mostly focusing on fixing in this PR (this was focused on workspace switcher requirements), so it does seem out of scope for this one.

However, if I were provided with the account on which the bug persists, I could work on fixing the issue in this PR. It's incredibly difficult to debug without an account with the bugged data and all my accounts have since been cleared of the phantom issues while I was debugging.

In short, it does seem a little out of scope for this PR, but I will be able to fix it in this one if you could provide me with the email address used for the account where you encountered it, you could let me log in through magic link so I don't need to access the email account itself.

[situchan]

If it's not constantly reproducible, not mandatory to fix it in the scope of this PR.

[hayata-suenaga]

🟢

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.