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

Allow Editing Distance Requests #26141

Merged
merged 167 commits into from
Sep 28, 2023
Merged

Allow Editing Distance Requests #26141

merged 167 commits into from
Sep 28, 2023

Conversation

jasperhuangg
Copy link
Contributor

@jasperhuangg jasperhuangg commented Aug 28, 2023

Need https://github.com/Expensify/Web-Expensify/pull/38594 and #25707

Details

Fixed Issues

$ #22715

Tests/QA

Comment out this block so you can receive Pusher events.

  1. Create a distance request following the steps here.
  2. Navigate to the workspace chat that you created the distance request in. Click on the distance request preview to open the distance request.
  3. Select the "Distance" menu item. Input new waypoints.
  4. Click "Save". Verify that a loading spinner appears on the Save button and the modal closes after the transaction is saved.
  5. After a bit (this could take a few seconds) verify the distance request amount and the title in the "Distance" menu item are updated to reflect your new waypoints.
  6. Close the EditRequestDistancePage and edit all of the other fields. Verify that they still work as expected.

Offline tests

  1. Go offline.
  2. Edit any distance request fields.
  3. Save the changes
  4. Verify the modal closes and the distance field is greyed out in the pending state
  5. Go online
  6. Verify that after a few moments, the field is no longer pending and the changes were synced with the server

Note: There is a separate issue for implementing the RBR for server errors during this process.

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

Web
web_1.mov
Mobile Web - Chrome
Mobile Web - Safari
mweb_safari_1.mp4
Desktop
desktop_1.mov
iOS
ios_1.mp4
Android

@jasperhuangg jasperhuangg self-assigned this Aug 28, 2023
@fedirjh
Copy link
Contributor

fedirjh commented Sep 26, 2023

We have some weird bugs

  1. Open waypoint editor
  2. Select a duplicate waypoint -> an error should appears
  3. Close the modal
  4. Open amount modal && Update the amount
  5. Check the server response , it return the same error as step 2 💥
  6. Verify the amount is not reset to its old value (since the request failed) 💥
  7. Open the waypoints editor and remove the duplicate waypoint && press save
  8. Verify the amount is not update 💥
  9. Open amount modal again and update the amount
  10. Check the server response , verify it return the same error related the waypoints even after you fixed it inside in previous steps 💥
  11. Navigate again to the waypoint editor
  12. Verify you see the sale error even when the duplicate point is removed 💥
CleanShot.2023-09-26.at.11.13.01.mp4

@tgolen
Copy link
Contributor

tgolen commented Sep 27, 2023

@fedirjh Thank you for reporting that. I am finding it extremely difficult to work around the API limitations here, so I don't think this is going to work very well until the API is refactored in https://github.com/Expensify/Expensify/issues/312241. I am going to chat with @neil-marcellini and @arosiclair about it this morning to see if we can come up with a better API strategy to deal with this problem.

For now, I think it's OK to merge this with this known limitation (so we can unblock others that are waiting on a lot of the changes in this PR).

@tgolen
Copy link
Contributor

tgolen commented Sep 27, 2023

@neil-marcellini this is ready for another review from you. Also, let me know what you think about the API issues above. The problem is that the UpdateDistanceRequest API command is used when updating amount (or any field other than distance). This requires each of those requests to have a valid set of waypoints. Effectively, if you end up with an error on the waypoints, all the other fields won't update until the errors have been cleared on the waypoints. Also, I tried omitting the waypoints completely when editing the other fields and the API returns an error that 2 valid waypoints are required.

@fedirjh
Copy link
Contributor

fedirjh commented Sep 27, 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 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
CleanShot.2023-09-27.at.16.17.46.mp4
CleanShot.2023-09-27.at.16.19.08.mp4
Mobile Web - Chrome
CleanShot.2023-09-27.at.16.49.55.mp4
Mobile Web - Safari
CleanShot.2023-09-27.at.16.22.36.mp4
Desktop
CleanShot.2023-09-27.at.17.03.47.mp4
iOS
CleanShot.2023-09-27.at.16.36.51.mp4
Android
CleanShot.2023-09-27.at.17.07.58.mp4

@fedirjh
Copy link
Contributor

fedirjh commented Sep 27, 2023

  • Deep linking seems to be broken
CleanShot.2023-09-27.at.17.27.21.mp4
  • On the desktop, the save button is not stacked at the bottom; there is an extra margin at the bottom compared to other pages.
Screenshot 2023-09-27 at 5 06 32 PM

@tgolen
Copy link
Contributor

tgolen commented Sep 28, 2023

Thank you!

I will handle the first bug as part of #26538 and is not a blocker for this PR.

For the second bug, I would prefer to merge this PR as-is, and then can you please report that bug through normal channels so that (you) or a contributor can pick it up to fix it?

@tgolen tgolen dismissed neil-marcellini’s stale review September 28, 2023 01:59

Comments were addressed and I am trying to get this merged

@tgolen tgolen merged commit e1ba6aa into main Sep 28, 2023
15 checks passed
@tgolen tgolen deleted the jasper-editDistanceRequests branch September 28, 2023 02:14
@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.75-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.76-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

Comment on lines +219 to +220
subtitle={hasErrors && isEmptyMerchant ? translate('common.error.enterMerchant') : ''}
subtitleTextStyle={styles.textLabelError}
Copy link
Contributor

Choose a reason for hiding this comment

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

This caused a regression #28498. The error was displayed via the errors prop and not as a subtitle. This made the error appears next to the field instead of below.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, thanks! I imagine that got lost in the shuffle of conflicts I kept having to resolve.

Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, {
pendingFields: {
comment: isEditingWaypoint ? CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE : CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD,
},
Copy link
Contributor

@DylanDylann DylanDylann Oct 26, 2023

Choose a reason for hiding this comment

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

@jasperhuangg Hi, I have a bit curious about this change. Why do you add pendingFields here? Normally, we only add pendingFields in optimisticData (before sending API) and reset pending field in successData and FailureData

Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #32120.
It looks like this pendingFields is not needed, we have removed it to prevent premature updates of data in the distance message preview.

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.

10 participants