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

Enable editing of money requests #23703

Merged
merged 54 commits into from
Aug 14, 2023
Merged

Conversation

mountiny
Copy link
Contributor

@mountiny mountiny commented Jul 27, 2023

Details

cc @luacmartins

This PR is enabling edits of money requests by calling a new API EditIOUTransaction command.

In this PR we are adding basics for allowing money request editing. Users should be able to edit:

  • the amount
  • the date (created field)
  • the description (comment field)

They cannot edit the currency yet and the button is disabled, @koko57 will kindly help us get that fixed, there is some trickiness involved with needing to navigate to another IOU Selection component and I consider this as not a blocker which Agata can help us resolve on Friday.

The IOUPreview and Transaction details in the top of the transaction thread are taken from the parent report action which is IOU report action of type create. This action is a historic record of the request and it does not change when its edited, the data which changes is in the transaction object itself and as we change it we add the MODIFIEDEXPENSE report action which holds the information about what data has changed.

This will be fixed once we start puling the data from transaction objects which is handled in this issue #22208 and pr should be raised soon. While its lackluster experience for the user, I think we dont have to block on this as the requests are still not used in NewDot yet.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/270589
Partially https://github.com/Expensify/Expensify/issues/295091
Partially https://github.com/Expensify/Expensify/issues/290384

Tests

  1. Request money as user A from user B
  2. As user B navigate to the request page
  3. Verify you cannot edit the values
  4. As user A navigate to the request page
  5. Edit the description
  6. Verify message like changed the request description to "test2" (previously "test") was added to the report
  7. Edit the date
  8. Verify message like changed the request date to 2023-07-20 (previously 2023-07-13) was added to the report
  9. Edit the amount
  10. Verify you cannot edit the currency
  11. Verify message like changed the request to £4.00 (previously £5.00) was added to the report
  • 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
    • 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 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
Mobile Web - Chrome
Mobile Web - Safari
iosMweb23703.mp4
Desktop

Same as web

iOS
ios23703.mp4
Android

@mountiny mountiny self-assigned this Jul 27, 2023
@mountiny mountiny changed the title [WIP] Enable editing of money requests Enable editing of money requests Jul 31, 2023
@mountiny mountiny requested a review from luacmartins July 31, 2023 21:37
@mountiny
Copy link
Contributor Author

Thanks for the quick reviews guys, reliable as always ❤️ 🚀

I think the raised points can be covered in the follow up now and its better to merge this to get the feature out.

Other user's non editable request has a disabled style. I think it should only be non interactive, and not have 50% opacity.

I agree, added here #23961

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good. Left a few comments.

src/languages/es.js Outdated Show resolved Hide resolved
src/libs/ReportUtils.js Outdated Show resolved Hide resolved
src/libs/ReportUtils.js Outdated Show resolved Hide resolved
src/libs/ReportUtils.js Outdated Show resolved Hide resolved
isSendMoneyFlow = false,
receipt = {},
) {
function buildOptimisticIOUReportAction(type, amount, currency, comment, participants, transactionID, paymentType = '', iouReportID = '', isSettlingUp = false, isSendMoneyFlow = false) {
Copy link
Contributor

Choose a reason for hiding this comment

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

we should also update this call to stop passing the receipt

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 think this just must be some bad merge conflict resolve, cant recall why we should be removing this

src/pages/EditRequestAmountPage.js Outdated Show resolved Hide resolved
currency={defaultCurrency}
amount={defaultAmount}
ref={(e) => (textInput.current = e)}
onCurrencyButtonPress={() => null}
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe we can make this prop not required and add a default to it?

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 will be updated in a quick follow up so I think there is no need for this here

src/pages/EditRequestCreatedPage.js Outdated Show resolved Hide resolved
src/pages/EditRequestPage.js Outdated Show resolved Hide resolved
Comment on lines +62 to +66
// In case the comment hasn't been changed, do not make the API request.
if (transactionChanges.comment.trim() === transactionDescription) {
Navigation.dismissModal();
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB maybe we should add all these checks to IOU.editMoneyRequest

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 could add some verify method there

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 will add this to the clean ups

@mountiny mountiny requested a review from luacmartins August 11, 2023 09:23
@mountiny
Copy link
Contributor Author

@rushatgabhane @allroundexperts @luacmartins should be ready for another look

@mountiny
Copy link
Contributor Author

@luacmartins should be ready and this Auth Pr goes along with the created format changes

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM! There are quite a few cleanup items, but we'll tackle those in follow up PRs.

@luacmartins luacmartins merged commit 6a5b1a4 into main Aug 14, 2023
@luacmartins luacmartins deleted the vit-createEditIOUTransactionCommand branch August 14, 2023 16:07
@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/luacmartins in version: 1.3.54-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.54-0 🚀

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

@pecanoro
Copy link
Contributor

@mountiny This PR caused this bug (#24569). However, since it's a new feature, I am wondering if we should treat it as a deploy blocker or not.

Btw, I also noticed that modifying the amount doesn't seem to update the total for me:

Monosnap New Expensify 2023-08-15 13-40-25

@mountiny
Copy link
Contributor Author

Thanks! The total not updating is captured here #23961 and will be worked on as a follow up

@JmillsExpensify
Copy link

@mountiny Mind confirming the correct compensation for @rushatgabhane for this PR review? Related, should that regression above be factored into payment? Thanks!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.54-13 🚀

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

const originalMessage = getModifiedExpenseOriginalMessage(oldTransaction, transactionChanges, isFromExpenseReport);
return {
actionName: CONST.REPORT.ACTIONS.TYPE.MODIFIEDEXPENSE,
actorAccountID: currentUserAccountID,
Copy link
Contributor

Choose a reason for hiding this comment

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

This issue is probably caused by the change introduce in this PR.

Issue: Changing Currency in IOU Causes Account Email to Replace Request Email
Steps to reproduce:

  • Click on the plus sign and select "Request Money".
  • Enter the desired amount and email address for the money request.
  • Double-click on the requested money in IOU and change the currency by clicking on the amount.
  • Go back twice and observe that the requested email has been replaced by the account email.

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

Successfully merging this pull request may close these issues.

9 participants