Fix/27634: Improve private notes flow

[DylanDylann]

Details

• Improvements to private notes

Fixed Issues

$ #27634
PROPOSAL: #27634 (comment)

Tests

a. Case 1: User did not have not in report yet

1. Open expensify app
2. Open any report
3. Open report detail screen
4. Click on "Private notes"
5. User is navigated to edit note screen
6. Click on save, user is navigate to report detail screen

b. Case 2: User already had a note in report

1. Open expensify app
2. Open any report
3. Open report detail screen
4. Click on "Private notes"
5. User is navigated to private note list screen
6. Click on the current user `s private note, user is navigated to edit note screen

• Verify that no errors appear in the JS console

Offline tests

QA Steps

a. Case 1: User did not have not in report yet

1. Open expensify app
2. Open any report
3. Open report detail screen
4. Click on "Private notes"
5. User is navigated to edit note screen
6. Click on save, user is navigate to report detail screen

b. Case 2: User already had a note in report

1. Open expensify app
2. Open any report
3. Open report detail screen
4. Click on "Private notes"
5. User is navigated to private note list screen
6. Click on the current user `s private note, user is navigated to edit note screen

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

Screenshots/Videos

Android: Native

Screencast.from.15-11-2023.18.11.41.webm

Android: mWeb Chrome

Screencast.from.15-11-2023.16.57.26.webm

iOS: Native

iOS: mWeb Safari

Screencast.from.15-11-2023.18.03.45.webm

MacOS: Chrome / Safari

Screencast.from.15-11-2023.15.28.20.webm

MacOS: Desktop

Screencast.from.15-11-2023.17.23.43.webm

[melvin-bot]

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

[ArekChr]

@DylanDylann Please update the branch with the latest main, testing...

[ArekChr]

@DylanDylann, I have noticed an issue. When we try to delete some private notes by setting them to empty and then save, it unexpectedly redirects back to edit mode. Could you please look into this?

cc: @techievivek, what expected behaviour should be in this case?

Nagranie.z.ekranu.2023-11-16.o.13.24.06.mov

[techievivek]

We would take them to the details page or profile page, whichever page they came from? CC @trjExpensify for cross-checking.

[trjExpensify]

Yeah, interesting. I say return to the profile page if there's no notes to preview upon deleting one.

[DylanDylann]

@ArekChr Just updated the PR. Please help check.

1. Merge the latest branch.
2. Handle case "Return to the profile page if there's no notes to preview upon deleting one."

[ArekChr]

@DylanDylann, I've encountered a new regression issue. When accessing Private Notes via a deep link, the app unexpectedly re-opens the Private Notes after entering and saving a note.

Steps to Reproduce:

1. Open any Private Note.
2. Copy the link for editing.
3. Delete the Private Note from input and save.
4. Log out of the app.
5. Paste the copied link.
6. Log back in.
7. Enter data in Private Notes and hit 'Save'.

After these steps, the input field for Private Notes appears again, which seems unintended.

This issue is not reproducible on staging.

Nagranie.z.ekranu.2023-11-20.o.11.22.11.mov

[DylanDylann]

@ArekChr Updated PR to fix the issue you`ve mentioned.

• RCA: After saving the private notes, it will navigate to the private notes list page but the first time the useEffect `s callback is called, the private notes list is still empty, which leads to navigating back to the edit page
• Solution: Use setimeout to delay 300ms before deciding whether the private notes list is empt or not
• Result:

Screencast.from.21-11-2023.11.54.32.webm

[ArekChr]

@ArekChr Updated PR to fix the issue you`ve mentioned.

• RCA: After saving the private notes, it will navigate to the private notes list page but the first time the useEffect `s callback is called, the private notes list is still empty, which leads to navigating back to the edit page
• Solution: Use setimeout to delay 300ms before deciding whether the private notes list is empt or not
• Result:

Screencast.from.21-11-2023.11.54.32.webm

@DylanDylann Can we do this instead?

    useEffect(() => {
        if (report.privateNotes === undefined) {
            return;
        }
        if (_.some(report.privateNotes, (item) => item.note) || !isFocused) {
            return;
        }
        Navigation.navigate(ROUTES.PRIVATE_NOTES_EDIT.getRoute(report.reportID, session.accountID));
    }, [report.privateNotes, report.reportID, session.accountID, isFocused]);

Assuming that undefined private notes are not initialised or not fetched, are we skipping navigation until private notes will load. That is much more readable and less hacky.

This might require changing the initial value to undefined if it is an empty array.
WDYT?

[DylanDylann]

@ArekChr Currently, the initial private note is something like {123456: {note: ''}}. So, I am not sure whether changing the initial value to undefined leads to regression or not

[DylanDylann]

@ArekChr Please help review this one in case you miss it

[ArekChr]

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

mweb.safari.mov

MacOS: Chrome / Safari

web.deeplink.test.mov

web.empty.notes.case.workspace.mov

web.existing.notes.workspace.mov

web.editing.removing.mov

MacOS: Desktop

desktop.mov

[ArekChr]

@DylanDylann please update with latest main

[DylanDylann]

@ArekChr Fixed all your comments and merge latest main, please help check

[ArekChr]

@DylanDylann, after removing private notes and opening other private notes that are not empty, the app redirects us to edit private notes, but should it redirect us to the private notes list?

Nagranie.z.ekranu.2023-11-27.o.10.53.30.mov

[DylanDylann]

@ArekChr It seems that I cannot reproduce the bug that you mentioned #31344 (comment). Here is the steps:

1. Make sure we have 2 report A and B with private notes
2. Open report A => report A `s detail page => private notes => remove private notes
3. Open report B => report B s detail page => private notes => it will navigate user to report B s private notes list (expected)

[ArekChr]

Retesting

[ArekChr]

After retesting all good, thanks for PR!

[techievivek]

Will test this today.

[techievivek]

Looks good and tests well with multiple notes.

Screen.Recording.2023-11-30.at.2.26.42.PM.mov

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

[chiragsalian]

Issue found here while testing. Can you fix the code for this case @DylanDylann? More details here.

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.6-2 🚀

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

[brunovjk]

I don't believe it was a bug per se, however, we resolved an issue that seems to be present since the update of PrivateNotesListPage.js here, where it was added <Text ... 'privateNotes.personalNoteMessage .... This <Text .. block should be added inside the <ScrollView to "roll along"