fix: make consistent behavior of displaying green line for assign task by daledah · Pull Request #51174 · Expensify/App

daledah · 2024-10-21T11:00:56Z

Details

Fixed Issues

$ #50792
PROPOSAL: #50792 (comment)

Tests

Start a 1:1 chat
Assign a task using plus icon in composer
Navigate to LHN
Press FAB
Assign a task using QAB
Verify that: In both step 2 and 5, the green line is not displayed

Verify that no errors appear in the JS console

Offline tests

QA Steps

Start a 1:1 chat
Assign a task using plus icon in composer
Navigate to LHN
Press FAB
Assign a task using QAB
Verify that: In both step 2 and 5, the green line is not displayed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-10-22.at.02.24.35.mov

Android: mWeb Chrome

Screen.Recording.2024-10-22.at.02.26.51.mov

iOS: Native

Screen.Recording.2024-10-22.at.02.34.53.mov

iOS: mWeb Safari

Screen.Recording.2024-10-22.at.02.37.05.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-21.at.17.52.39.mp4

MacOS: Desktop

Screen.Recording.2024-10-22.at.02.40.25.mov

melvin-bot · 2024-10-21T19:41:56Z

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

daledah · 2024-10-22T04:54:56Z

@dukenv0307 I updated.

dukenv0307 · 2024-10-22T08:02:36Z

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-10-31.at.16.09.38.mov

Android: mWeb Chrome

Screen.Recording.2024-10-22.at.14.47.29.mov

iOS: Native

Screen.Recording.2024-10-31.at.16.07.09.mov

iOS: mWeb Safari

Screen.Recording.2024-10-22.at.14.46.43.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-22.at.14.43.15.mov

MacOS: Desktop

Screen.Recording.2024-10-31.at.21.04.32.mov

dukenv0307 · 2024-10-22T11:06:49Z

@daledah This issue still can reproduce on ios native

Screen.Recording.2024-10-22.at.18.06.20.mov

daledah · 2024-10-23T08:13:42Z

@dukenv0307 Investigating, will update soon.

daledah · 2024-10-24T19:06:39Z

I found the RCA on native device:

Create the new task from QAB
We will open the parent report
userActiveSince is t for example.
The lastReadTime here is still the outdated value: t-1 (haven't been updated yet)
CreateTask API update the last action created time ~ t+1 that is larger than userActiveSince

So we have unreadMarkerReportActionID

Then OpenReport API is triggered that update the lastReadTime to t+2

So the unreadMarkerReportActionID is cleared

I'm trying to find the solution

daledah · 2024-10-25T18:15:58Z

Create the getReport function in https://github.com/Expensify/App/blob/main/src/libs/ReportConnection.ts
Update this line to

    const [unreadMarkerTime, setUnreadMarkerTime] = useState(ReportConnection.getReport(report.reportID)?.lastReadTime ?? '');

The currentTime here should be

    const currentTime = DateUtils.getDBTimeWithSkew(Date.now() + CONST.ANIMATED_TRANSITION);

we can consider to use CONST.ANIMATED_TRANSITION in case of small screen only since in this case we need to close the modal and open report

daledah · 2024-10-25T18:16:20Z

@dukenv0307 Can you take a look at it? Thanks

dukenv0307 · 2024-10-29T17:01:06Z

@daledah Looks promising, can you update your PR with that change? Thanks

daledah · 2024-10-30T11:00:09Z

@dukenv0307 I updated.

daledah · 2024-10-31T11:02:42Z

@dukenv0307 I updated. Tests well on my end.

dukenv0307 · 2024-10-31T14:14:57Z

LGTM and tests well

daledah · 2024-11-01T03:33:31Z

@stitesExpensify I updated.

dukenv0307 · 2024-11-05T02:25:42Z

@stitesExpensify We're good to merge

daledah · 2024-11-07T06:34:15Z

@stitesExpensify Can you review again please?

dukenv0307 · 2024-11-12T03:22:37Z

@stitesExpensify we're good to merge

OSBotify · 2024-11-13T23:13:56Z

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

github-actions · 2024-11-14T00:52:41Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 9.0.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2024-11-15T14:16:01Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.62-4 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

tgolen

Please revert this PR due to the bad patterns it introduces.

tgolen · 2024-12-02T15:34:43Z

+    return allReports[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`];
+}
+
+function updateReportData(reportID: string, reportData?: Partial<Report>) {


Please remove this function. Any data in Onyx that needs to be updated should be done via one of the proper Onyx methods (merge, set, etc.).

This method will introduce bad side-effects which could have unknown consequences and lead to many bugs without the ability to track them down.

Context https://expensify.slack.com/archives/C01GTK53T8Q/p1732889804245739

FYI I'm working on the PR where ReportConnection file is removed. There updateReportData function usage is replaced with Onyx.merge

Just to confirm, @stitesExpensify was there any specific reason why you created this function instead of using Onyx.merge?

To clarify, this was written by @daledah I was just the reviewer, so I'll leave that answer to him

As I said in the proposal. createTaskAndNavigate will update lastReadTime as currentTime. After that we dismiss modal and navigate to report:

App/src/libs/actions/Task.ts

Line 304 in ce23fb5

Navigation.dismissModal(parentReportID);

, but the lastReadTime here:

App/src/libs/actions/Report.ts

Line 955 in e9de4f2

parameters.clientLastReadTime = ReportConnection.getAllReports()?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]?.lastReadTime ?? '';

and here:

App/src/pages/home/report/ReportActionsList.tsx

Line 209 in e9de4f2

const [unreadMarkerTime, setUnreadMarkerTime] = useState(report.lastReadTime ?? '');

have not been updated yet so other logics can use the outdated value.
That’s the reason we decided to use getReport to get the up-to-date data.

I think we can’t use useOnyx in this case since its value can be outdated in this case. Please forgive me If I did something wrong, I’ll raise other PR to fix If we have the better idea.

@daledah Can you remove your change and test the original issue? I think it's fixed somewhere else.

tgolen · 2024-12-02T15:35:26Z

    const prevSortedVisibleReportActionsObjects = usePrevious(sortedVisibleReportActionsObjects);

+    const reportLastReadTime = useMemo(() => {
+        return ReportConnection.getReport(report.reportID)?.lastReadTime ?? report.lastReadTime ?? '';


This should never use getReport() from a lib. It should be useOnyx instead to connect to the report data.

hungvu193 · 2024-12-20T04:26:14Z

+    const [unreadMarkerTime, setUnreadMarkerTime] = useState(reportLastReadTime);
    useEffect(() => {
-        setUnreadMarkerTime(report.lastReadTime ?? '');
+        setUnreadMarkerTime(reportLastReadTime);

        // eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
    }, [report.reportID]);


Causes this issue: #53000

More details: #53000 (comment)

daledah added 2 commits October 21, 2024 17:54

fix: make consistent behavior of displaying green line for assign task

3afe1b8

fix: typecheck

326332e

daledah marked this pull request as ready for review October 21, 2024 19:41

daledah requested a review from a team as a code owner October 21, 2024 19:41

melvin-bot Bot requested review from dukenv0307 and removed request for a team October 21, 2024 19:41

daledah mentioned this pull request Oct 21, 2024

[HOLD for payment 2024-11-22] [$250] mWeb - QAB - Create assign task via qab displays green line briefly #50792

Closed

6 tasks

dukenv0307 reviewed Oct 22, 2024

View reviewed changes

Comment thread src/libs/ReportConnection.ts Outdated

fix: update function

6054ad5

Merge branch 'main' into fix/50792

42d4444

daledah added 2 commits October 30, 2024 17:58

Merge branch 'main' into fix/50792

ce5f2f6

fix: marker appears briefly on ios

7447a12