Feature: refactor requiresAttentionFromCurrentUser function #32140

waterim · 2023-11-28T16:57:43Z

Details

This PR is about to refactor requiresAttentionFromCurrentUser function

Fixed Issues

$ #30668
PROPOSAL: $ #30668 (comment)

Tests

N/A tests

Verify that no errors appear in the JS console

Offline tests

N/A automated 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 / 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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

src/libs/ReportUtils.ts

tests/unit/ReportUtilsTest.js

melvin-bot · 2023-11-29T13:29:17Z

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

sobitneupane

I have raised a few concerns, most of which are for clarification purposes.

src/libs/ReportUtils.ts

sobitneupane · 2023-12-03T15:46:13Z

src/libs/ReportUtils.ts


-    if (isWaitingForAssigneeToCompleteTask(option, parentReportAction)) {
-        return true;
+        if (isWaitingForAssigneeToCompleteTask(option, parentReportAction)) {


Looks like isWaitingForAssigneeToCompleteTask expects the first param to be report not an option.

https://github.com/Expensify/App/pull/32140/files#diff-577fcc5f3a5e4930916ff310e61c38edfa093792fe3ab55b9a30d2aecd8811dbR1511

But only for option it was used

I raised this because first param report of isWaitingForAssigneeToCompleteTask has type OnyxEntry<Report>

function isWaitingForAssigneeToCompleteTask(report: OnyxEntry<Report>, parentReportAction: OnyxEntry<ReportAction> | EmptyObject = {}): boolean

Restricting the use of isWaitingForAssigneeToCompleteTask will change order of the report as requiresAttentionFromCurrentUser is being used in SidebarUtils to get ordered reportIDs (getOrderedReportIDs). This is the comparison between staging and PR.

Staging

Screen.Recording.2023-12-05.at.21.03.59.mov

PR

Screen.Recording.2023-12-05.at.21.04.31.mov

Yes, this is a correct behaviour, this one related to this issue which this PR should fix!

We can notice change in other chats with green dot indicator as well. Please let me know if it is expected.

Deleted tasks were created from "fds"?

This is the content of task fds

Okay, agree, it was an issue, researched into the old code(before rewriting this function at all)
There was an issue before that in SidebarUtils getOrderedReportIDs we didnt use at all the "isWaitingForAssigneeToCompleteTask", but its in the function, but another part of the SidebarUtils were using "isWaitingForAssigneeToCompleteTask", but I removed it fully for reports, thats why this issue were happening.
Updated the code, removed isOption verification as its not needed anymore, added "reportAction" to "getOrderedReportIDs" for a correct behaviour, please retest and let me know

Thanks for the update @waterim.

src/libs/ReportUtils.ts

…-requiresAttentionFromCurrentUser

sobitneupane

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(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 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 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.2023-12-07.at.16.06.33.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2023-12-07.at.15.48.17.mov

iOS: mWeb Safari

Screen.Recording.2023-12-07.at.15.40.11.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-07.at.15.37.38.mov

MacOS: Desktop

Screen.Recording.2023-12-07.at.15.43.45.mov

puneetlath · 2023-12-07T16:23:05Z

src/libs/ReportUtils.ts

@@ -1538,7 +1538,7 @@ function isUnreadWithMention(report: OnyxEntry<Report> | OptionData): boolean {
    // lastMentionedTime and lastReadTime are both datetime strings and can be compared directly
    const lastMentionedTime = report.lastMentionedTime ?? '';
    const lastReadTime = report.lastReadTime ?? '';
-    return lastReadTime < lastMentionedTime;
+    return Boolean('isUnreadWithMention' in report && report.isUnreadWithMention) || lastReadTime < lastMentionedTime;


Couldn't this just be this:

Suggested change

return Boolean('isUnreadWithMention' in report && report.isUnreadWithMention) || lastReadTime < lastMentionedTime;

return Boolean(report.isUnreadWithMention) || lastReadTime < lastMentionedTime;

Because if report.UnreadWithMention is undefined or null it'll be false? Or will it throw?

Ah, no, that was added because isUnreadWithMention is not exist in OnyxEntry and thats a verification to pass TS.
Boolean(report.isUnreadWithMention) - this will cause an error: Property 'isUnreadWithMention' does not exist on type 'Report | OptionData'.
Property 'isUnreadWithMention' does not exist on type 'Report'

Ahh ok, I see. Perhaps then, instead of calling the argument report we should call it reportOrOption. So that it's more clear that the thing we are doing these checks on could be a report or option.

puneetlath · 2023-12-11T17:02:27Z

@waterim let me know when you've addressed that small feedback and I can review again.

waterim · 2023-12-11T18:26:16Z

@puneetlath Updated the code!

OSBotify · 2023-12-11T21:38:51Z

✋ 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 · 2023-12-13T11:29:07Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T11:49:50Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T12:17:24Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-14T15:24:07Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.12-2 🚀

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

refactor requiresAttentionFromCurrentUserfunction

071db61

pac-guerreiro reviewed Nov 29, 2023

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

TMisiukiewicz reviewed Nov 29, 2023

View reviewed changes

tests/unit/ReportUtilsTest.js Outdated Show resolved Hide resolved

fix

14c7e9b

waterim marked this pull request as ready for review November 29, 2023 13:29

waterim requested a review from a team as a code owner November 29, 2023 13:29

melvin-bot bot requested review from sobitneupane and removed request for a team November 29, 2023 13:29

sobitneupane reviewed Dec 3, 2023

View reviewed changes

waterim added 2 commits December 4, 2023 15:04

change

ffe819a

Merge remote-tracking branch 'upstream/main' into feat-30668-refactor…

03c3dce

…-requiresAttentionFromCurrentUser

Christinadobrzyn mentioned this pull request Dec 6, 2023

[HOLD #30668] [$500] Chat - Unpinned deleted tasks assigned by another user are shown above other pinned messages #30798

Closed

6 tasks

updates

88bee57

sobitneupane approved these changes Dec 7, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath December 7, 2023 10:22

puneetlath requested changes Dec 7, 2023

View reviewed changes

updated

a4dcc97

puneetlath approved these changes Dec 11, 2023

View reviewed changes

puneetlath merged commit 6e533fa into Expensify:main Dec 11, 2023
15 checks passed

github-actions bot mentioned this pull request Dec 13, 2023

[$500] Deploy Checklist: New Expensify 2023-12-13 #32963

Closed

64 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: refactor requiresAttentionFromCurrentUser function #32140

Feature: refactor requiresAttentionFromCurrentUser function #32140

waterim commented Nov 28, 2023

melvin-bot bot commented Nov 29, 2023

sobitneupane left a comment

sobitneupane Dec 3, 2023

waterim Dec 4, 2023

sobitneupane Dec 5, 2023

sobitneupane Dec 5, 2023

waterim Dec 6, 2023

sobitneupane Dec 6, 2023 •

edited

Loading

waterim Dec 6, 2023

sobitneupane Dec 6, 2023

waterim Dec 6, 2023

sobitneupane Dec 7, 2023

sobitneupane left a comment

puneetlath Dec 7, 2023

waterim Dec 8, 2023

puneetlath Dec 8, 2023

puneetlath commented Dec 11, 2023

waterim commented Dec 11, 2023

OSBotify commented Dec 11, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

	return Boolean('isUnreadWithMention' in report && report.isUnreadWithMention) \|\| lastReadTime < lastMentionedTime;
	return Boolean(report.isUnreadWithMention) \|\| lastReadTime < lastMentionedTime;

Feature: refactor requiresAttentionFromCurrentUser function #32140

Feature: refactor requiresAttentionFromCurrentUser function #32140

Conversation

waterim commented Nov 28, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

melvin-bot bot commented Nov 29, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sobitneupane Dec 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

puneetlath commented Dec 11, 2023

waterim commented Dec 11, 2023

OSBotify commented Dec 11, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

sobitneupane Dec 6, 2023 •

edited

Loading