Fix receipt disappears when dismissing distance editor after receipt is generated #51519

wildan-m · 2024-10-26T09:39:28Z

Details

This PR will fix receipt disappears when dismissing distance editor after receipt is generated

Fixed Issues

Tests

Note

When using a local server, make sure to switch the BE to staging on the Troubleshooting page to access the GetRouteForBackup API, which is not yet available in dev.

There are known issues after this PR applied map and some other fields will be flickered for a brief moment
The issues arise due to discrepancies between the transactionBackup and transaction data during online updates. Additional BE changes are needed to address this. Related comment

Open app
Go to workspace chat.
Go offline.
Submit a distance expense.
Go to transaction thread.
Click Distance.
Go online.
After the receipt in the background is generated, dismiss the distance editor by clicking RHP back button.

Verify that no errors appear in the JS console

Offline tests

Same as test

QA Steps

Same as test

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Kapture.2024-10-26.at.16.04.29.mp4

Android: mWeb Chrome

Kapture.2024-10-26.at.16.28.52.mp4

iOS: Native

Kapture.2024-10-26.at.15.49.12.mp4

iOS: mWeb Safari

Kapture.2024-10-26.at.15.57.56.mp4

MacOS: Chrome / Safari

Kapture.2024-10-26.at.14.09.13.mp4

MacOS: Desktop

Kapture.2024-10-26.at.16.07.27.mp4

…x/48630-calculate-route-for-pending-trx-backup

…port when backup restored

melvin-bot · 2024-10-26T09:39:34Z

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

ikevin127 · 2024-10-27T00:09:28Z

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

Android: mWeb Chrome

android-mweb.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.1.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ikevin127

Besides these two things, the code looks good and I think once the requested changes are addressed we'll be good to Approve -> Merge.

ikevin127 · 2024-10-26T22:58:22Z

src/libs/actions/Transaction.ts

-}
+    let command;
+    switch (routeType) {
+        case 'draft':


These 3 hardcoded switch / case strings can be replaced with the variables you added in CONST, like you did here.

@ikevin127 done

ikevin127 · 2024-10-27T00:30:21Z

src/pages/iou/request/step/IOURequestStepDistance.tsx

@@ -78,7 +79,18 @@ function IOURequestStepDistance({
            },
        [optimisticWaypoints, transaction],
    );


@wildan-m ⚠️ I noticed an issue which happens only when the RHP is dismissed for the first time -> the map component in the report resets / reloads. This doesn't happen if we open Distance RHP again and dismiss for the 2nd time.

issue.mov

I'm pretty sure that this will be reported as regression if we ship it this way, because since we fixed the issue in the sense that the map does show up now when dismissing the RHP, we now have that flicker map reset / reload on first time RHP dismissal.

Please look into this and see if you can figure out a way to not have the report map reset / reload when the RHP is dismissed for the first time and instead keep it the way it looks when it loads for the first time while RHP is still open if possible.

@ikevin127 After further investigation, this issue related to my previous mentioned issue #48630 (comment) where transactionBackup is not exactly the same with unmodified transaction data.

For instance, in backup, the pendingFields is not removed, this will cause incorrect result here:

App/src/components/ReportActionItem/MoneyRequestView.tsx

Lines 258 to 260 in 652d2ff

if (hasReceipt) {

receiptURIs = ReceiptUtils.getThumbnailAndImageURIs(updatedTransaction ?? transaction);

}

I think the only way to resolve that flicker issue and other fields flicker is to make the backup data exactly the same with unmodified transaction data when they are online, and it will require BE change.

@Gonals is it possible that when we call GetRouteForBackup we also get the same unmodified transaction data when they are online?

The missing fields can be seen in previous comment #48630 (comment)

@wildan-m Thanks for the investigation and explanation, I just wanted to point it out and ask @Gonals whether we should fix it now or in another issue.

I found another issue where the generated map is not clickable due to pendingFields and pendingAction not being removed. Making transactionBackup identical to unmodified transaction when online is crucial to prevent flickering and an unclickable map, but I'm unsure if this is possible from the backend perspective.

I think this has a different root cause, right? Since it requires BE changes, I think it is a different bug

I think this has a different root cause, right? Since it requires BE changes, I think it is a different bug

@Gonals I agree that flickering is not directly related to the original issue and fixing it is not straightforward.

ikevin127 · 2024-10-29T20:03:32Z

@wildan-m Please address the requested change in #51519 (comment), after which I will 🟢 Approve and defer to Gonals regarding issue mentioned in #51519 (comment) and whether or not we cah ship it like this and not get penalty in case it's reported as regression post-merge.

…x/48630-calculate-route-for-pending-trx-backup

ikevin127

Looks good to me!

Note: Failing jest test seems unrelated (timeout).

⚠️ @Gonals Please check out this reported issue / discussion in #51519 (comment) before merging as we need your final decision on whether or not we can ship it in its current state and not get a penalty in case the issue will be reported as regression post-merge.

wildan-m · 2024-10-30T06:12:40Z

@ikevin127 please check this commit 198ccb3 That change will resolve map not clickable issue.

ikevin127 · 2024-10-30T20:57:05Z

@wildan-m Thanks for that additional fix, looks good to me! 🚀 Approved once again, and now passing it to @Gonals for final review.

Caution

Please consider issue mentioned in #51519 (comment) and whether or not we cah ship it like this and not get a regression penalty in case it will be reported as regression post-merge.

melvin-bot · 2024-10-31T10:22:16Z

@Gonals looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Gonals · 2024-10-31T10:22:45Z

No emergency. The linter was complaining about files that were not modified using withOnyx

OSBotify · 2024-10-31T10:34:28Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-10-31T11:41:48Z

🚀 Deployed to staging by https://github.com/Gonals in version: 9.0.56-0 🚀

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

wildan-m added 10 commits September 21, 2024 13:47

Calculate routes for pending transaction backup

3c91994

fix incorrect param input

5f511d2

return if use mock data

a53236d

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

614eb96

…x/48630-calculate-route-for-pending-trx-backup

Refactor transaction state const

ce2e188

add ReadCommandParameters for transaction backup

e01442f

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

94987b4

…x/48630-calculate-route-for-pending-trx-backup

prettier & lint

be7c27a

add comment

5f29bd5

Update missing transaction report fields by re-opening transaction re…

2c1fe42

…port when backup restored

wildan-m requested a review from a team as a code owner October 26, 2024 09:39

melvin-bot bot requested a review from ikevin127 October 26, 2024 09:39

melvin-bot bot removed the request for review from a team October 26, 2024 09:39

wildan-m mentioned this pull request Oct 26, 2024

[$250] Distance - Receipt disappears when dismissing distance editor after receipt is generated #48630

Open

6 tasks

ikevin127 suggested changes Oct 27, 2024

View reviewed changes

wildan-m added 2 commits October 30, 2024 09:42

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

3d6e553

…x/48630-calculate-route-for-pending-trx-backup

change routeType to const

48356fa

ikevin127 approved these changes Oct 30, 2024

View reviewed changes

melvin-bot bot requested a review from Gonals October 30, 2024 04:16

Resolve map not clickable when restoring transaction backup

198ccb3

Gonals approved these changes Oct 31, 2024

View reviewed changes

Gonals merged commit d032ddf into Expensify:main Oct 31, 2024
18 of 19 checks passed

melvin-bot bot added the Emergency label Oct 31, 2024

Gonals removed the Emergency label Oct 31, 2024

github-actions bot mentioned this pull request Oct 31, 2024

Deploy Checklist: New Expensify 2024-10-31 #51778

Open

100 tasks

NikkiWines mentioned this pull request Oct 31, 2024

Distance - Receipt briefly shows placeholder after receipt is generated #51785

Open

8 tasks

wildan-m mentioned this pull request Nov 1, 2024

[HOLD] for #48630][$250] Distance - Unable to save distance when Start and Stop waypoints are valid address #48401

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix receipt disappears when dismissing distance editor after receipt is generated #51519

Fix receipt disappears when dismissing distance editor after receipt is generated #51519

wildan-m commented Oct 26, 2024 •

edited

Loading

melvin-bot bot commented Oct 26, 2024

ikevin127 commented Oct 27, 2024

ikevin127 left a comment

ikevin127 Oct 26, 2024

wildan-m Oct 30, 2024

ikevin127 Oct 27, 2024

wildan-m Oct 27, 2024

ikevin127 Oct 27, 2024

wildan-m Oct 27, 2024 •

edited

Loading

Gonals Oct 30, 2024

wildan-m Oct 31, 2024

ikevin127 commented Oct 29, 2024

ikevin127 left a comment •

edited

Loading

wildan-m commented Oct 30, 2024

ikevin127 commented Oct 30, 2024 •

edited

Loading

melvin-bot bot commented Oct 31, 2024

Gonals commented Oct 31, 2024 •

edited

Loading

OSBotify commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

	if (hasReceipt) {
	receiptURIs = ReceiptUtils.getThumbnailAndImageURIs(updatedTransaction ?? transaction);
	}

Fix receipt disappears when dismissing distance editor after receipt is generated #51519

Fix receipt disappears when dismissing distance editor after receipt is generated #51519

Conversation

wildan-m commented Oct 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 26, 2024

ikevin127 commented Oct 27, 2024

Reviewer Checklist

Screenshots/Videos

ikevin127 left a comment

Choose a reason for hiding this comment

ikevin127 Oct 26, 2024

Choose a reason for hiding this comment

wildan-m Oct 30, 2024

Choose a reason for hiding this comment

ikevin127 Oct 27, 2024

Choose a reason for hiding this comment

wildan-m Oct 27, 2024

Choose a reason for hiding this comment

ikevin127 Oct 27, 2024

Choose a reason for hiding this comment

wildan-m Oct 27, 2024 • edited Loading

Choose a reason for hiding this comment

Gonals Oct 30, 2024

Choose a reason for hiding this comment

wildan-m Oct 31, 2024

Choose a reason for hiding this comment

ikevin127 commented Oct 29, 2024

ikevin127 left a comment • edited Loading

Choose a reason for hiding this comment

wildan-m commented Oct 30, 2024

ikevin127 commented Oct 30, 2024 • edited Loading

melvin-bot bot commented Oct 31, 2024

Gonals commented Oct 31, 2024 • edited Loading

OSBotify commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

wildan-m commented Oct 26, 2024 •

edited

Loading

wildan-m Oct 27, 2024 •

edited

Loading

ikevin127 left a comment •

edited

Loading

ikevin127 commented Oct 30, 2024 •

edited

Loading

Gonals commented Oct 31, 2024 •

edited

Loading