Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: set initial task title and description values from Onyx if present #19908

Merged
merged 9 commits into from
Jun 5, 2023

Conversation

akinwale
Copy link
Contributor

@akinwale akinwale commented May 31, 2023

Details

Set the the task title and description on the initial page in the assign task flow using values from Onyx if they are present.

Fixed Issues

$ #19460
PROPOSAL: #19460 (comment)

Tests

  1. Click on Assign Task in global create menu.
  2. Add title and description.
  3. Click on the Next button.
  4. On the Confirm Task page, click on the Title.
  5. Change the value for the Title.
  6. Click on Next.
  7. Repeat steps 4 through 6 for the Description.
  8. Click on the back chevron button at the left hand side of the assign task heading.
  9. Verify that the Title and Description are updated with the new values set.
  • Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

Same as tests.

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

Screenshots/Videos

Web
19460-web.mp4
Mobile Web - Chrome
19460-android-chrome.webm
Mobile Web - Safari
19460-ios-safari.mp4
Desktop
19460-desktop.mp4
iOS
19460-ios-native.mp4
Android
19460-android-native.webm

@akinwale akinwale requested a review from a team as a code owner May 31, 2023 20:56
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and aldo-expensify and removed request for a team May 31, 2023 20:56
@melvin-bot
Copy link

melvin-bot bot commented May 31, 2023

@aldo-expensify @abdulrahuman5196 One of you needs to 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]

@akinwale
Copy link
Contributor Author

akinwale commented May 31, 2023

@abdulrahuman5196 A note regarding clearing the values when the "x" button is clicked: It looks like this is already working as expected. Clicking on the close button and then selecting Assign task to create a new task opens the form with empty fields (when the title and description have been previously filled), so there is no need to implement this here.

@abdulrahuman5196
Copy link
Contributor

@akinwale but when we open the task page directly via url after previously filling details in assign page and closing, we will be showing the old data.

@akinwale
Copy link
Contributor Author

@akinwale but when we open the task page directly via url after previously filling details in assign page and closing, we will be showing the old data.

I don't think we need to do anything in this case in my opinion. If the user accidentally closes or refreshes the page, it's a good experience for the input data to be preserved.

@@ -80,13 +98,18 @@ const NewTaskPage = (props) => {
ref={(el) => (inputRef.current = el)}
inputID="taskTitle"
label={props.translate('newTaskPage.title')}
defaultValue={props.task.title}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't defaultValue reduntant here? Can we remove it if so?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is correct. Will remove it.

@abdulrahuman5196
Copy link
Contributor

I don't think we need to do anything in this case in my opinion. If the user accidentally closes or refreshes the page, it's a good experience for the input data to be preserved.

@akinwale I wasn't mentioning about tab close or refresh. I meant to clear when user manually closed the drawer with the close button. I don't think we retain old values user manually presses the header x button

@aldo-expensify Correct me if wrong.

Untitled.45.mp4

@akinwale
Copy link
Contributor Author

akinwale commented Jun 1, 2023

I don't think we need to do anything in this case in my opinion. If the user accidentally closes or refreshes the page, it's a good experience for the input data to be preserved.

@akinwale I wasn't mentioning about tab close or refresh. I meant to clear when user manually closed the drawer with the close button. I don't think we retain old values user manually presses the header x button

@aldo-expensify Correct me if wrong.

Untitled.45.mp4

@abdulrahuman5196 Ah, I see what you mean.

The task info is actually being cleared out when the Assign task menu item is clicked. This is happening here:

onSelected: () => TaskUtils.clearOutTaskInfoAndNavigate(this.props.reportID),

To clear out the information when the close button is clicked / pressed, then I'll need to add a call to TaskUtils.clearOutTaskInfo to the event handler on every page related to the task creation flow. If this is the desired approach, I can push a commit with the changes now.

@akinwale akinwale requested a review from abdulrahuman5196 June 1, 2023 21:43
@@ -80,13 +98,18 @@ const NewTaskPage = (props) => {
ref={(el) => (inputRef.current = el)}
inputID="taskTitle"
label={props.translate('newTaskPage.title')}
defaultValue={props.task.title}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -70,7 +70,10 @@ const NewTaskDescriptionPage = (props) => {
>
<HeaderWithCloseButton
title={props.translate('newTaskPage.description')}
onCloseButtonPress={() => Navigation.dismissModal()}
onCloseButtonPress={() => {
Navigation.dismissModal();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Navigation.dismissModal() and TaskUtils.clearOutTaskInfo() is repeated at multiple places.

Can we create a util function like this?

function clearOutTaskInfoAndNavigate(reportID) {
clearOutTaskInfo();
setParentReportID(reportID);
Navigation.navigate(ROUTES.NEW_TASK_DETAILS);
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akinwale akinwale requested a review from abdulrahuman5196 June 2, 2023 20:15
/>
</View>
<View style={styles.mb5}>
<TextInput
inputID="taskDescription"
defaultValue=""
defaultValue={props.task.description}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the previous comment. DefaultValue is redundant here @akinwale

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akinwale akinwale requested a review from abdulrahuman5196 June 4, 2023 15:52
if (taskDescription !== props.task.description) {
setTaskDescription(props.task.description);
}
}, [props.task, taskTitle, taskDescription]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think have taskTitle, taskDescription here causing the below issue

I am unable to update the title value when coming back to new task page.

Untitled.2.mp4

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed the comparison from the useEffect which was causing this. The useEffect will now run only once when the component mounts, since the only dependency is props.task which is coming from Onyx.

const [taskDescription, setTaskDescription] = useState(props.task.description);

useEffect(() => {
if (taskTitle !== props.task.title) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to compare?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this since the useEffect call will run only once when the component mounts.

@abdulrahuman5196
Copy link
Contributor

@akinwale Kindly check on the above issues

@akinwale
Copy link
Contributor Author

akinwale commented Jun 4, 2023

@akinwale Kindly check on the above issues

@abdulrahuman5196 Thanks for the review. I have pushed a new commit with the necessary fixes.

@@ -63,7 +77,7 @@ const NewTaskPage = (props) => {
>
<HeaderWithCloseButton
title={props.translate('newTaskPage.assignTask')}
onCloseButtonPress={() => Navigation.dismissModal()}
onCloseButtonPress={() => TaskUtils.dismissModalAndClearOutTaskInfo()}
shouldShowBackButton
onBackButtonPress={() => Navigation.goBack()}
Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 Jun 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akinwale On this page alone, kindly clear out the task TaskUtils.dismissModalAndClearOutTaskInfo() since back action here closes the modal and has to reset the onyx data.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akinwale akinwale requested a review from abdulrahuman5196 June 4, 2023 18:32
@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 4, 2023

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 / Chrome
    • iOS / native
    • iOS / 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 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
Untitled.6.mp4
Mobile Web - Chrome
Untitled.3.mp4
Mobile Web - Safari
Untitled.7.mp4
Desktop
Untitled.4.mp4
iOS
Untitled.5.mp4
Android
Untitled.10.mp4

@abdulrahuman5196
Copy link
Contributor

@akinwale Offline test should Same as Tests in author's checklist instead of N/A? This is expected to work offline as well.

@abdulrahuman5196
Copy link
Contributor

@akinwale Kindly fix these issues

  1. In author's checklist Offline tests should be Same as test right? Since we expect this fix to work offline as well.

  2. I am getting error when we don't enter description and click next

Untitled.9.mp4

@akinwale
Copy link
Contributor Author

akinwale commented Jun 4, 2023

@akinwale Kindly fix these issues

  1. In author's checklist Offline tests should be Same as test right? Since we expect this fix to work offline as well.
  2. I am getting error when we don't enter description and click next

Untitled.9.mp4

  1. Correct.
  2. This is because we removed the defaultValue for description. Do we want this to be empty string or props.task.description? Or I can set the value to props.task.description || '' which makes more sense.

@akinwale
Copy link
Contributor Author

akinwale commented Jun 4, 2023

@akinwale Kindly fix these issues

  1. In author's checklist Offline tests should be Same as test right? Since we expect this fix to work offline as well.
  2. I am getting error when we don't enter description and click next

Untitled.9.mp4

@abdulrahuman5196 Done. See comments here.

@abdulrahuman5196
Copy link
Contributor

@akinwale

Is form setting the value as undefined for not passing default value or since props.task.description is undefined while calling useState() and we pass undefined value to form ?

If later we should update the useState() to not set undefined on taskDescription

@abdulrahuman5196
Copy link
Contributor

I think the latter mentioned is the issue here #19908 (comment). Correct me if wrong. @akinwale

@akinwale
Copy link
Contributor Author

akinwale commented Jun 4, 2023

@akinwale

Is form setting the value as undefined for not passing default value or since props.task.description is undefined while calling useState() and we pass undefined value to form ?

If later we should update the useState() to not set undefined on taskDescription

@abdulrahuman5196 I believe it's the latter where props.task.description is undefined with useState.

What do you suggest here? Set useState('') for both taskTitle and taskDescription, or just taskDescription alone?

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 4, 2023

@akinwale

  1. then we can use it this way

useState(props.task.description || '')

and similar way inside useEffect.(both should be only for description since task is not expected to have a default value)

This should be best way since we handle value and onValueChange.

  1. One more thing. We have used onChangeText but onValueChange is the Form recommended - https://github.com/Expensify/App/blob/main/contributingGuides/FORMS.md
    Kindly update this as well and kindly test from your end as well and update here.

@akinwale
Copy link
Contributor Author

akinwale commented Jun 4, 2023

@akinwale

  1. then we can use it this way

useState(props.task.description || '')

and similar way inside useEffect.(both should be only for description since task is not expected to have a default value)

This should be best way since we handle value and onValueChange.

  1. One more thing. We have used onChangeText but onValueChange is the Form recommended - https://github.com/Expensify/App/blob/main/contributingGuides/FORMS.md
    Kindly update this as well and kindly test from your end as well and update here.

@abdulrahuman5196 Thanks for the update. All done.

Tested and it works properly.

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes looks good and works well. Reviewers checklist is also complete here - #19908 (comment)

All yours @aldo-expensify

Copy link
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@aldo-expensify aldo-expensify merged commit dc398d1 into Expensify:main Jun 5, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2023

✋ 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
Copy link
Contributor

OSBotify commented Jun 5, 2023

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.3.24-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants