Fix/28599: Pressing back while writting notes make text disappear #29149

DylanDylann · 2023-10-10T04:59:42Z

Details

[Feature Request] Pressing back while writing notes makes text disappear

Fixed Issues

$ #28599
PROPOSAL: #28599 (comment)

Tests

Go to a contacts DM
Click on Private Note
Click on My Note
Type something (don't save)
Press the back button
Click on My Note again.
Verify that the draft note you wrote has appeared

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to a contacts DM
Click on Private Note
Click on My Note
Type something (don't save)
Press the back button
Click on My Note again.
Verify that the draft note you wrote has appeared

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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screencast.from.10-10-2023.12.56.09.webm

Android: mWeb Chrome

private-chrome-android.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

Mios.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

deks.mov

melvin-bot · 2023-10-10T09:26:05Z

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

robertKozik · 2023-10-10T16:03:48Z

src/libs/actions/Report.js

+const draftNoteMap = {};
+Onyx.connect({
+    key: ONYXKEYS.COLLECTION.PRIVATE_NOTES_DRAFT,
+    callback: (value, key) => {
+        if (!key) {
+            return;
+        }
+
+        const reportID = key.replace(ONYXKEYS.COLLECTION.PRIVATE_NOTES_DRAFT, '');
+        draftNoteMap[reportID] = value;
+    },
+});


As I see most of the similar statements are on the top of the file, can we move it there?

Yeah, we can do it. just updated it, please help check

robertKozik · 2023-10-10T19:10: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

Web

web.mov

Mobile Web - Chrome

ios.-.android.-.web.mov

Mobile Web - Safari

ios.-.android.-.web.mov

Desktop

desktop.mov

iOS

ios.-.android.-.native.mov

Android

ios.-.android.-.native.mov

robertKozik · 2023-10-10T19:18:22Z

src/libs/actions/Report.js

@@ -2183,6 +2196,21 @@ function clearPrivateNotesError(reportID, accountID) {
    Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`, {privateNotes: {[accountID]: {errors: null}}});
 }

+export default function getDraftPrivateNote(reportID) {


I missed that one before, why this function is export default? Can we get rid of it? Other functions don't need it @DylanDylann

Updated. Please help check

Great thanks!

robertKozik

LGTM 🚀

techievivek

Great work. 🚀

techievivek · 2023-10-11T08:52:50Z

src/libs/actions/Report.js

@@ -87,6 +87,19 @@ Onyx.connect({
    },
 });

+const draftNoteMap = {};


NAB: Maybe privateNotesDraftMap? So we exactly know it is something related to private notes feature.

OSBotify · 2023-10-11T10:39:15Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.81-4 🚀

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

OSBotify · 2023-10-12T04:48:47Z

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

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

OSBotify · 2023-10-13T21:58:26Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:10:29Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:26:43Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T23:02:07Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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

robertKozik · 2023-10-23T19:11:53Z

src/pages/PrivateNotes/PrivateNotesEditPage.js

@@ -63,7 +63,23 @@ function PrivateNotesEditPage({route, personalDetailsList, session, report}) {

    // We need to edit the note in markdown format, but display it in HTML format
    const parser = new ExpensiMark();
-    const [privateNote, setPrivateNote] = useState(parser.htmlToMarkdown(lodashGet(report, ['privateNotes', route.params.accountID, 'note'], '')).trim());
+    const [privateNote, setPrivateNote] = useState(
+        Report.getDraftPrivateNote(report.reportID) || parser.htmlToMarkdown(lodashGet(report, ['privateNotes', route.params.accountID, 'note'], '')).trim(),


We forgot to trim the value acquired from Report.getDraftPrivateNote

@DylanDylann can you spin up a PR to fix this? 🙏🏼

@MariaHCD @robertKozik Sorry for the wait there. I am working on it now

#30357 PR is ready for review @robertKozik

fedirjh · 2023-11-21T21:48:02Z

Coming from #30076. The draft value should be cleared when the save button is pressed.

DylanDylann added 2 commits October 10, 2023 11:57

fix pressing back while writting notes make text disappear

2404e45

fix lint

a090cef

DylanDylann marked this pull request as ready for review October 10, 2023 09:25

DylanDylann requested a review from a team as a code owner October 10, 2023 09:26

melvin-bot bot requested review from robertKozik and removed request for a team October 10, 2023 09:26

DylanDylann mentioned this pull request Oct 10, 2023

[HOLD for payment 2023-10-23] [$500] [Feature Request] Pressing back while writing notes makes text disappear #28599

Closed

6 tasks

robertKozik suggested changes Oct 10, 2023

View reviewed changes

fix move the get onyx data to top

76791cc

robertKozik reviewed Oct 10, 2023

View reviewed changes

fix: remove default export

c41600e

robertKozik approved these changes Oct 11, 2023

View reviewed changes

melvin-bot bot requested a review from techievivek October 11, 2023 08:39

techievivek approved these changes Oct 11, 2023

View reviewed changes

techievivek merged commit d1ff84b into Expensify:main Oct 11, 2023

OSBotify mentioned this pull request Oct 11, 2023

Deploy Checklist: New Expensify 2023-10-11 #29252

Closed

OSBotify mentioned this pull request Oct 12, 2023

Deploy Checklist: New Expensify 2023-10-12 #29417

Closed

97 tasks

jayeshmangwani mentioned this pull request Oct 18, 2023

[HOLD for payment 2023-10-05] [$500] Dev: Web - Trailing Newlines are not trimmed on the My Note page. #27596

Closed

6 tasks

robertKozik reviewed Oct 23, 2023

View reviewed changes

DylanDylann mentioned this pull request Oct 25, 2023

Fix/28599: Trim the draft private note #30357

Merged

59 tasks

fedirjh mentioned this pull request Nov 21, 2023

[$500] Private Note - Link changed to text in the Private Note after saved 2nd time. #30076

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/28599: Pressing back while writting notes make text disappear #29149

Fix/28599: Pressing back while writting notes make text disappear #29149

DylanDylann commented Oct 10, 2023 •

edited

Loading

melvin-bot bot commented Oct 10, 2023

robertKozik Oct 10, 2023

DylanDylann Oct 10, 2023

robertKozik commented Oct 10, 2023

robertKozik Oct 10, 2023

DylanDylann Oct 10, 2023

robertKozik Oct 11, 2023

robertKozik left a comment

techievivek left a comment

techievivek Oct 11, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 12, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

robertKozik Oct 23, 2023

MariaHCD Oct 25, 2023

DylanDylann Oct 25, 2023

DylanDylann Oct 25, 2023

fedirjh commented Nov 21, 2023

Fix/28599: Pressing back while writting notes make text disappear #29149

Fix/28599: Pressing back while writting notes make text disappear #29149

Conversation

DylanDylann commented Oct 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertKozik commented Oct 10, 2023

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

robertKozik left a comment

Choose a reason for hiding this comment

techievivek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Oct 11, 2023

OSBotify commented Oct 12, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

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

fedirjh commented Nov 21, 2023

DylanDylann commented Oct 10, 2023 •

edited

Loading