[CP Staging] Fix existing expense is removed when dismissing receipt error #44364

bernhardoj · 2024-06-25T03:22:21Z

Details

Clearing the receipt upload error will delete the existing transaction too. This PR fix it by making sure the transaction is deleted only if it's failed to create.

Fixed Issues

$ #44246
PROPOSAL: #44246 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Request money without a receipt to any user
Open the transaction thread
Press the receipt empty thumbnail
Select a corrupted PDF
Wait for the receipt error upload to show
Dismiss the error
Verify the error is dismissed
Verify the transaction isn't deleted

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-06-25.at.11.13.59.mov

Android: mWeb Chrome

Screen.Recording.2024-06-25.at.11.06.46.mov

iOS: Native

Screen.Recording.2024-06-25.at.11.06.03.mov

iOS: mWeb Safari

Screen.Recording.2024-06-25.at.10.59.10.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-25.at.11.05.19.mov

MacOS: Desktop

Screen.Recording.2024-06-25.at.11.02.06.mov

melvin-bot · 2024-06-25T03:22:26Z

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

bernhardoj · 2024-06-25T03:45:42Z

src/libs/actions/IOU.ts

@@ -798,7 +798,6 @@ function buildOnyxDataForMoneyRequest(
                // Disabling this line since transaction.filename can be an empty string
                // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
                errors: getReceiptError(transaction.receipt, transaction.filename || transaction.receipt?.filename, isScanRequest, errorKey),
-                pendingAction: null,


We shouldn't clear the pending action when fails, otherwise, we don't have the information on whether the action is new or not. That's the pattern we use, for example, when adding a comment/message.

Additional video showing the transaction is deleted when it's a new transaction.

Screen.Recording.2024-06-25.at.11.40.38.mov

jjcoffee · 2024-06-25T09:14:08Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

android-app-2024-06-25_12.39.00.mp4

Android: mWeb Chrome

android-chrome-2024-06-25_12.42.43.mp4

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

desktop-chrome-2024-06-25_11.27.42.mp4

MacOS: Desktop

desktop-app-2024-06-25_12.34.00.mp4

jjcoffee · 2024-06-25T09:38:13Z

@bernhardoj It's maybe not within the scope of this PR, but is it easy enough to also clear the receipt placeholder image when clearing the error? This would make things more in line with what happens if you go in and delete a receipt from a money request (i.e. it resets completely back to a manual request).

mountiny · 2024-06-25T10:49:25Z

@jjcoffee @bernhardoj Started a thread to get this merged sooner than later

jjcoffee

LGTM!

bernhardoj · 2024-06-25T11:15:57Z

It's maybe not within the scope of this PR, but is it easy enough to also clear the receipt placeholder image when clearing the error?

I see that when we edit the receipt, it will revert back to the old receipt with the help of failureData.

App/src/libs/actions/IOU.ts

Lines 6649 to 6654 in 0bcd005

    
           const failureData: OnyxUpdate[] = [ 
        
               { 
        
                   onyxMethod: Onyx.METHOD.MERGE, 
        
                   key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, 
        
                   value: { 
        
                       receipt: oldReceipt,

However, in case the old receipt is empty, merging an empty object to the optimistic receipt does nothing.

{source: new_receipt} merges with {} -> {source: new_receipt}

Because the optimistic receipt modifies source and state, we can specifically revert both data to the old receipt or null if undefined.

App/src/libs/actions/IOU.ts

Lines 6633 to 6636 in 0bcd005

    
           const receiptOptimistic = { 
        
               source, 
        
               state: CONST.IOU.RECEIPT_STATE.OPEN, 
        
           };

receipt: {
    source: oldReceipt.source ?? null,
    state: oldReceipt.state ?? null,
},

Screen.Recording.2024-06-25.at.19.14.37.mov

…ion-is-removed [CP Staging] Fix existing expense is removed when dismissing receipt error (cherry picked from commit e2040ff)

OSBotify · 2024-06-25T12:30:17Z

✋ 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 · 2024-06-25T12:58:56Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.1-17 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-06-25T19:46:47Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.1-19 🚀

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

only clear the transaction if it's failed to create

e6d4e45

bernhardoj requested a review from a team as a code owner June 25, 2024 03:22

melvin-bot bot requested review from jjcoffee and removed request for a team June 25, 2024 03:22

bernhardoj added 2 commits June 25, 2024 11:40

dont clear pending action when fails

345bb74

remove log

513763e

bernhardoj commented Jun 25, 2024

View reviewed changes

fox test

3c6bd13

bernhardoj force-pushed the fix/44246-existing-transaction-is-removed branch from c086679 to 3c6bd13 Compare June 25, 2024 09:08

mountiny assigned bernhardoj Jun 25, 2024

jjcoffee approved these changes Jun 25, 2024

View reviewed changes

melvin-bot bot requested a review from cristipaval June 25, 2024 11:09

jjcoffee mentioned this pull request Jun 25, 2024

[HOLD for payment 2024-07-26] [HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] IOU - Dismissing the error for corrupted PDF scan request does not delete the expense #42120

Closed

6 tasks

mountiny changed the title ~~Fix existing expense is removed when dismissing receipt error~~ [CP Staging] Fix existing expense is removed when dismissing receipt error Jun 25, 2024

cristipaval approved these changes Jun 25, 2024

View reviewed changes

cristipaval merged commit e2040ff into Expensify:main Jun 25, 2024
27 checks passed

OSBotify pushed a commit that referenced this pull request Jun 25, 2024

Merge pull request #44364 from bernhardoj/fix/44246-existing-transact…

5f181b7

…ion-is-removed [CP Staging] Fix existing expense is removed when dismissing receipt error (cherry picked from commit e2040ff)

github-actions bot mentioned this pull request Jun 25, 2024

Deploy Checklist: New Expensify 2024-06-21 #44186

Closed

melvin-bot bot mentioned this pull request Jun 25, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] [$250] Scan - Existing expense is removed when dismissing receipt error #44246

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Fix existing expense is removed when dismissing receipt error #44364

[CP Staging] Fix existing expense is removed when dismissing receipt error #44364

bernhardoj commented Jun 25, 2024

melvin-bot bot commented Jun 25, 2024

bernhardoj Jun 25, 2024 •

edited

Loading

jjcoffee commented Jun 25, 2024 •

edited

Loading

jjcoffee commented Jun 25, 2024

mountiny commented Jun 25, 2024

jjcoffee left a comment

bernhardoj commented Jun 25, 2024

OSBotify commented Jun 25, 2024

OSBotify commented Jun 25, 2024

OSBotify commented Jun 25, 2024

[CP Staging] Fix existing expense is removed when dismissing receipt error #44364

[CP Staging] Fix existing expense is removed when dismissing receipt error #44364

Conversation

bernhardoj commented Jun 25, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 25, 2024

bernhardoj Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

jjcoffee commented Jun 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Jun 25, 2024

mountiny commented Jun 25, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

bernhardoj commented Jun 25, 2024

OSBotify commented Jun 25, 2024

OSBotify commented Jun 25, 2024

OSBotify commented Jun 25, 2024

bernhardoj Jun 25, 2024 •

edited

Loading

jjcoffee commented Jun 25, 2024 •

edited

Loading