[NoQA] Optimistically update receipt state to OPEN when the request is edited #25385

Gonals · 2023-08-17T11:36:12Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/295246
PROPOSAL:

Tests

Add a console.log(transaction); here (or you can just check local storage)
Create a new receipt money request from newDot by going to + -> Request Money -> receipt
Open the console
Open the money request and click on the Amount field:

In the console, you should now see the transaction info. Confirm the receipt is ready for smartscan:

Edit the amount
Click on the Amount field again.
The receipt should now be in OPEN state:

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None, as there are no visible changes

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

No visible changes to screenshot 🤷

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-17T11:36:46Z

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

dylanexpensify · 2023-08-18T18:25:26Z

@joelbettner would we be able to get to this today? We're hoping to have merged on Monday as part of our external deadline for wave4's Launch SmartScan at SaaStr!

src/libs/TransactionUtils.js

situchan · 2023-08-21T21:20:24Z

I can help review

mountiny

@situchan I think we dont need c+ review here, thanks!

src/libs/TransactionUtils.js

mountiny · 2023-08-21T23:01: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 / 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

Simple logic changes, no need for screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny · 2023-08-21T23:03:02Z

@Gonals there are conflicts

@joelbettner would you like to give this another look?

mountiny · 2023-08-21T23:39:59Z

src/libs/TransactionUtils.js

@@ -69,6 +69,7 @@ function buildOptimisticTransaction(amount, currency, reportID, comment = '', so
 function getUpdatedTransaction(transaction, transactionChanges, isFromExpenseReport) {
    // Only changing the first level fields so no need for deep clone now
    const updatedTransaction = _.clone(transaction);
+    let shouldStopSmartscan = false;

    // The comment property does not have its modifiedComment counterpart


could we leave a comment explaining the smartscan is not stopped when Comment is changed?

@Gonals Also shouldnt the smartscan stop also when merchant is edited? this is not implemented in the App yet but its in the Auth so I can add it there

Ah, it should, but we still didn't have merchants when I coded this. We do need to add it to auth (and eventually here)

Actually, I just added it here too. No harm in doing so.
I've also created an issue to handle it in Auth too and will fix that tomorrow: https://github.com/Expensify/Expensify/issues/309894

PR is up https://github.com/Expensify/Auth/pull/8549

src/libs/TransactionUtils.js

Gonals · 2023-08-22T11:48:15Z

@joelbettner, @mountiny, conflicts solved! All yours!

mountiny

Thanks I will ship this now

OSBotify · 2023-08-22T12:05:53Z

✋ 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 · 2023-08-24T03:36:25Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.57-0 🚀

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

OSBotify · 2023-08-28T18:53:57Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.58-0 🚀

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

OSBotify · 2023-08-29T00:08:06Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.57-6 🚀

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

OSBotify · 2023-08-30T01:22:59Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

Gonals added 2 commits August 17, 2023 13:33

optimistically update receipt state

5eaab84

only if there's a receipt

5d6e72a

Gonals self-assigned this Aug 17, 2023

Gonals requested a review from a team as a code owner August 17, 2023 11:36

melvin-bot bot requested review from joelbettner and removed request for a team August 17, 2023 11:36

Gonals changed the title ~~[WIP] Optimistically update receipt state to OPEN when the request is edited~~ Optimistically update receipt state to OPEN when the request is edited Aug 17, 2023

Gonals added 2 commits August 17, 2023 13:47

do not update if the comment is what has been changed

7be83f1

prettier

2313b0f

joelbettner reviewed Aug 21, 2023

View reviewed changes

src/libs/TransactionUtils.js Show resolved Hide resolved

joelbettner requested a review from a team August 21, 2023 21:19

mountiny previously approved these changes Aug 21, 2023

View reviewed changes

src/libs/TransactionUtils.js Show resolved Hide resolved

mountiny reviewed Aug 21, 2023

View reviewed changes

joelbettner previously approved these changes Aug 21, 2023

View reviewed changes

conflicts

aa98b6b

Gonals dismissed stale reviews from joelbettner and mountiny via aa98b6b August 22, 2023 11:38

add merchant

6acebba

mountiny approved these changes Aug 22, 2023

View reviewed changes

mountiny merged commit b26ed1c into main Aug 22, 2023

mountiny deleted the alberto-editRequest branch August 22, 2023 12:01

mountiny changed the title ~~Optimistically update receipt state to OPEN when the request is edited~~ [NoQA] Optimistically update receipt state to OPEN when the request is edited Aug 22, 2023

OSBotify mentioned this pull request Aug 24, 2023

Deploy Checklist: New Expensify 2023-08-24 #25813

Closed

73 tasks

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Optimistically update receipt state to OPEN when the request is edited #25385

[NoQA] Optimistically update receipt state to OPEN when the request is edited #25385

Gonals commented Aug 17, 2023 •

edited

Loading

melvin-bot bot commented Aug 17, 2023

dylanexpensify commented Aug 18, 2023

situchan commented Aug 21, 2023

mountiny left a comment

mountiny commented Aug 21, 2023 •

edited

Loading

mountiny commented Aug 21, 2023

mountiny Aug 21, 2023

Gonals Aug 22, 2023

Gonals Aug 22, 2023

mountiny Aug 22, 2023

Gonals commented Aug 22, 2023

mountiny left a comment

OSBotify commented Aug 22, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

[NoQA] Optimistically update receipt state to OPEN when the request is edited #25385

[NoQA] Optimistically update receipt state to OPEN when the request is edited #25385

Conversation

Gonals commented Aug 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 17, 2023

dylanexpensify commented Aug 18, 2023

situchan commented Aug 21, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Aug 21, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny commented Aug 21, 2023

mountiny Aug 21, 2023

Choose a reason for hiding this comment

Gonals Aug 22, 2023

Choose a reason for hiding this comment

Gonals Aug 22, 2023

Choose a reason for hiding this comment

mountiny Aug 22, 2023

Choose a reason for hiding this comment

Gonals commented Aug 22, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 22, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

Gonals commented Aug 17, 2023 •

edited

Loading

mountiny commented Aug 21, 2023 •

edited

Loading