Fix/32302: Note editor open #32327

DylanDylann · 2023-12-01T03:30:03Z

Details

Issue: Private notes - Note editor opens instead of list for user with existing private notes.
RCA: The report`s private notes are only fetched when we go to the private notes list page or private note edit page. So In the report detail page, clicking on private notes to go to the private notes flow will navigate user to private notes edit page rather than private notes list page because the private notes is still empty at that time.
Solution: Fetch the private notes in report detail page.

Fixed Issues

$ #32302
PROPOSAL:

Tests

Step from here. Confirm there is no issue.

Sign out if signed in.
Sign in again
Open report that has private note
Click on the report header to open report detail page
Click on "Private notes"
Make sure it will navigate user to private notes list rather than private notes edit

Verify that no errors appear in the JS console

Offline tests

QA Steps

Step from here. Confirm there is no issue.

Sign out if signed in.
Sign in again
Open report that has private note
Click on the report header to open report detail page
Click on "Private notes"
Make sure it will navigate user to private notes list rather than private notes edit

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

NA

Android: mWeb Chrome

NA

iOS: Native

NA

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

Screencast.from.01-12-2023.10.40.57.webm

MacOS: Desktop

NA

melvin-bot · 2023-12-01T03:44:38Z

@ArekChr 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 · 2023-12-01T03:50:52Z

src/pages/ReportDetailsPage.js

+    const isPrivateNotesFetchTriggered = !_.isUndefined(props.report.isLoadingPrivateNotes);
+
+    useEffect(() => {
+        // Do not fetch private notes if isLoadingPrivateNotes is already defined, or if network is offline.
+        if (isPrivateNotesFetchTriggered || props.network.isOffline) {
+            return;
+        }
+
+        Report.getReportPrivateNote(props.report.reportID);
+        // eslint-disable-next-line react-hooks/exhaustive-deps -- do not add report.isLoadingPrivateNotes to dependencies
+    }, [props.report.reportID, props.network.isOffline, isPrivateNotesFetchTriggered]);
+


This change based on the existed logic:

App/src/pages/home/report/withReportAndPrivateNotesOrNotFound.js

Lines 60 to 68 in 6301426

useEffect(() => {

// Do not fetch private notes if isLoadingPrivateNotes is already defined, or if network is offline.

if (isPrivateNotesFetchTriggered || network.isOffline) {

return;

}

Report.getReportPrivateNote(report.reportID);

// eslint-disable-next-line react-hooks/exhaustive-deps -- do not add report.isLoadingPrivateNotes to dependencies

}, [report.reportID, network.isOffline, isPrivateNotesFetchTriggered]);

techievivek · 2023-12-01T04:30:39Z

src/pages/ReportDetailsPage.js

@@ -76,6 +77,17 @@ function ReportDetailsPage(props) {

    const isGroupDMChat = useMemo(() => ReportUtils.isDM(props.report) && participants.length > 1, [props.report, participants.length]);

+    const isPrivateNotesFetchTriggered = !_.isUndefined(props.report.isLoadingPrivateNotes);
+
+    useEffect(() => {


We have a hook WithReportAndPrivateNotesOrNotFound to fetch the private note, I think we can use that, right?

But we need to add more props to WithReportAndPrivateNotesOrNotFound to not display FullScreenLoadingIndicator or NotFoundPage (in case users are in report detail page) because this hook have the logic:

App/src/pages/home/report/withReportAndPrivateNotesOrNotFound.js

Lines 89 to 104 in 6301426

if (shouldShowFullScreenLoadingIndicator) {

return <FullScreenLoadingIndicator />;

}

if (shouldShowNotFoundPage) {

return <NotFoundPage />;

}

return (

<WrappedComponent

// eslint-disable-next-line react/jsx-props-no-spreading

{...props}

ref={forwardedRef}

/>

);

}

what do you think?

That might change behavior. The logic used in our current method is quite different and might not be suitable after replacing HOC. IMO we don't expect to see a 'not found' screen.

To clarify, changing the logic in the HOC won't reflect what it does based on its name.

That might change behavior

So I think we should keep the current logic rather than using WithReportAndPrivateNotesOrNotFound

I think that's fine, then. Thanks for having a look.

ArekChr · 2023-12-01T08:56:58Z

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

android.mov

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

Nagranie.z.ekranu.2023-12-1.o.10.51.35.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

OSBotify · 2023-12-01T17:51:43Z

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

chiragsalian · 2023-12-01T18:32:59Z

Nice thank you for the fix @DylanDylann.
I notice the test section is empty. You should add test steps so that QA does not skip testing this one. Since this is already on staging I'll add a little bit.

DylanDylann · 2023-12-01T18:44:16Z

@chiragsalian I just updated the QA steps. Thanks for notices me

OSBotify · 2023-12-05T02:56:59Z

🚀 Cherry-picked to staging by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-12-05T13:42:04Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.4.8-0 🚀

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

OSBotify · 2023-12-06T20:32:12Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

OSBotify · 2023-12-06T20:41:44Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

fix note editor open

6b1c3a8

DylanDylann marked this pull request as ready for review December 1, 2023 03:44

DylanDylann requested a review from a team as a code owner December 1, 2023 03:44

melvin-bot bot requested review from ArekChr and removed request for a team December 1, 2023 03:44

DylanDylann mentioned this pull request Dec 1, 2023

[$500] Private notes - Note editor opens instead of list for user with existing private notes #32302

Closed

6 tasks

DylanDylann commented Dec 1, 2023

View reviewed changes

fix remove used comment

0171212

techievivek reviewed Dec 1, 2023

View reviewed changes

ArekChr approved these changes Dec 1, 2023

View reviewed changes

melvin-bot bot requested a review from chiragsalian December 1, 2023 09:52

Merge branch 'Expensify:main' into fix/32302-private-notes-editer-open

5ef4b79

techievivek approved these changes Dec 1, 2023

View reviewed changes

techievivek merged commit 3208c62 into Expensify:main Dec 1, 2023
15 checks passed

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

Deploy Checklist: New Expensify 2023-12-05 #32463

Closed

66 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/32302: Note editor open #32327

Fix/32302: Note editor open #32327

DylanDylann commented Dec 1, 2023 •

edited

Loading

melvin-bot bot commented Dec 1, 2023

DylanDylann Dec 1, 2023

techievivek Dec 1, 2023

DylanDylann Dec 1, 2023 •

edited

Loading

ArekChr Dec 1, 2023

ArekChr Dec 1, 2023

DylanDylann Dec 1, 2023

techievivek Dec 1, 2023

ArekChr commented Dec 1, 2023 •

edited

Loading

OSBotify commented Dec 1, 2023

chiragsalian commented Dec 1, 2023

DylanDylann commented Dec 1, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

	useEffect(() => {
	// Do not fetch private notes if isLoadingPrivateNotes is already defined, or if network is offline.
	if (isPrivateNotesFetchTriggered \|\| network.isOffline) {
	return;
	}

	Report.getReportPrivateNote(report.reportID);
	// eslint-disable-next-line react-hooks/exhaustive-deps -- do not add report.isLoadingPrivateNotes to dependencies
	}, [report.reportID, network.isOffline, isPrivateNotesFetchTriggered]);

	if (shouldShowFullScreenLoadingIndicator) {
	return <FullScreenLoadingIndicator />;
	}

	if (shouldShowNotFoundPage) {
	return <NotFoundPage />;
	}

	return (
	<WrappedComponent
	// eslint-disable-next-line react/jsx-props-no-spreading
	{...props}
	ref={forwardedRef}
	/>
	);
	}

Fix/32302: Note editor open #32327

Fix/32302: Note editor open #32327

Conversation

DylanDylann commented Dec 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 1, 2023

DylanDylann Dec 1, 2023

Choose a reason for hiding this comment

techievivek Dec 1, 2023

Choose a reason for hiding this comment

DylanDylann Dec 1, 2023 • edited Loading

Choose a reason for hiding this comment

ArekChr Dec 1, 2023

Choose a reason for hiding this comment

ArekChr Dec 1, 2023

Choose a reason for hiding this comment

DylanDylann Dec 1, 2023

Choose a reason for hiding this comment

techievivek Dec 1, 2023

Choose a reason for hiding this comment

ArekChr commented Dec 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Dec 1, 2023

chiragsalian commented Dec 1, 2023

DylanDylann commented Dec 1, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

DylanDylann commented Dec 1, 2023 •

edited

Loading

DylanDylann Dec 1, 2023 •

edited

Loading

ArekChr commented Dec 1, 2023 •

edited

Loading