Show scan status bar when one of the receipt is scanning in expense report #42240

bernhardoj · 2024-05-16T05:20:44Z

Details

We want to show the scanning status bar below the header when there is a scanning receipt.

Fixed Issues

$ #40828
PROPOSAL: #40828 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open a chat
Create a new scan request
Press the money request preview to open the expense/IOU report
Verify there is a scanning status bar below the header
Verify there is no next step status bar

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-05-16.at.13.17.18.1.mov

MacOS: Chrome / Safari

MacOS: Desktop

Screen.Recording.2024-05-16.at.13.14.42.mov

melvin-bot · 2024-05-16T05:20:49Z

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

rojiphil

@bernhardoj
I have suggested a small change to use optional chaining operator at one place to be on the safer side. Please have a look.
Otherwise LGTM. Tests well too.

rojiphil · 2024-05-20T08:26:04Z

src/components/MoneyReportHeader.tsx

@@ -104,6 +104,7 @@ function MoneyReportHeader({
    const isDraft = ReportUtils.isOpenExpenseReport(moneyRequestReport);
    const [isConfirmModalVisible, setIsConfirmModalVisible] = useState(false);

+    const hasScanningReceipt = ReportUtils.getTransactionsWithReceipts(moneyRequestReport.reportID).some((transaction) => TransactionUtils.isReceiptBeingScanned(transaction));


Suggested change

const hasScanningReceipt = ReportUtils.getTransactionsWithReceipts(moneyRequestReport.reportID).some((transaction) => TransactionUtils.isReceiptBeingScanned(transaction));

const hasScanningReceipt = ReportUtils.getTransactionsWithReceipts(moneyRequestReport?.reportID).some((transaction) => TransactionUtils.isReceiptBeingScanned(transaction));

rojiphil · 2024-05-20T09:31:11Z

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

MacOS: Chrome / Safari

42240-web-safari.mp4

42240-web-safari-ioureport.mp4

Android: Native

4220-android-native.mp4

Android: mWeb Chrome

4220-mweb-chrome.mp4

iOS: Native

42240-ios-native.mp4

iOS: mWeb Safari

42240-mweb-safari.mp4

MacOS: Desktop

4220-desktop.mp4

rojiphil

Thanks @bernhardoj
LGTM and tests well.

rojiphil · 2024-05-24T03:53:56Z

@bernhardoj There are conflicts here. Can you please resolve them?

…n-header-2

bernhardoj · 2024-05-24T04:14:47Z

Conflicts solved

rojiphil · 2024-05-24T04:37:58Z

src/components/MoneyReportHeader.tsx

@@ -224,7 +226,7 @@ function MoneyReportHeader({
                shouldShowBackButton={shouldUseNarrowLayout}
                onBackButtonPress={onBackButtonPress}
                // Shows border if no buttons or next steps are showing below the header
-                shouldShowBorderBottom={!(shouldShowAnyButton && shouldUseNarrowLayout) && !(shouldShowNextStep && !shouldUseNarrowLayout) && !allHavePendingRTERViolation}
+                shouldShowBorderBottom={!isMoreContentShown && !allHavePendingRTERViolation}


@bernhardoj hmm.. Looks like I am missing something here. Can you please help me understand why we need to replace the existing conditions with isMoreContentShown? Both seem to be different.

I'm trying to simplify it. We need to set shouldShowBorderBottom to false if hasScanningReceipt is true, but instead of appending it to the existing condition (&& !hasScanningReceipt), I just replaced it with isMoreContentShown.

Without simplifying:

!(shouldShowAnyButton && shouldUseNarrowLayout) && !(shouldShowNextStep && !shouldUseNarrowLayout) && !hasScanningReceipt && !allHavePendingRTERViolation

isMoreContentShown condition

shouldShowNextStep || hasScanningReceipt || (shouldShowAnyButton && shouldUseNarrowLayout)

If we reverse this (!isMoreContentShown), it becomes,

!shouldShowNextStep && !hasScanningReceipt && !(shouldShowAnyButton && shouldUseNarrowLayout)

repositioned:

!(shouldShowAnyButton && shouldUseNarrowLayout) && !shouldShowNextStep && !hasScanningReceipt

You can see that hasScanningReceipt and shouldShowAnyButton condition is the same. The only difference is shouldShowNextStep.

Next step component is put outside of the HeaderWithBackButton, no matter whether it's shouldUseNarrowLayout or not which has its own border bottom.

App/src/components/MoneyReportHeader.tsx

Lines 335 to 339 in 8375abe

{shouldShowNextStep && (

<View style={[styles.ph5, styles.pb3]}>

<MoneyReportHeaderStatusBar nextStep={nextStep} />

</View>

)}

App/src/components/MoneyReportHeader.tsx

Line 303 in 8375abe

<View style={isMoreContentShown ? [styles.dFlex, styles.flexColumn, styles.borderBottom] : []}>

So, we don't want the extra border bottom from the HeaderWithBackButton anymore.

Thanks. That helps.

rojiphil · 2024-05-24T08:04:10Z

@thienlnam All yours for review.

thienlnam

Great, thanks yall!

OSBotify · 2024-05-28T22:38:25Z

✋ 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-05-29T09:43:18Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.77-0 🚀

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

OSBotify · 2024-05-30T21:26:07Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:38:05Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

bernhardoj added 2 commits May 16, 2024 13:04

show scan status bar when one of the receipt is scanning

5c03f26

fix show border bottom condition

a62d0e8

bernhardoj requested a review from a team as a code owner May 16, 2024 05:20

melvin-bot bot removed the request for review from a team May 16, 2024 05:20

melvin-bot bot requested a review from rojiphil May 16, 2024 05:20

bernhardoj mentioned this pull request May 16, 2024

Show scanning status bar in a one transaction report #41836

Closed

50 tasks

prettier

7d2cc3e

rojiphil reviewed May 20, 2024

View reviewed changes

null-safety

df9bdfc

rojiphil approved these changes May 20, 2024

View reviewed changes

melvin-bot bot requested a review from thienlnam May 20, 2024 09:32

Merge branch 'main' into fix/40828-show-scan-in-progress-indication-o…

ef0f367

…n-header-2

rojiphil reviewed May 24, 2024

View reviewed changes

thienlnam approved these changes May 28, 2024

View reviewed changes

thienlnam merged commit 6caf9a5 into Expensify:main May 28, 2024
18 checks passed

github-actions bot mentioned this pull request May 29, 2024

Deploy Checklist: New Expensify 2024-05-29 #42741

Closed

melvin-bot bot mentioned this pull request May 30, 2024

[HOLD for payment 2024-06-06] [$250] No indication of scan in progress when clicking in to the expense when the receipt is scanning #40828

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show scan status bar when one of the receipt is scanning in expense report #42240

Show scan status bar when one of the receipt is scanning in expense report #42240

bernhardoj commented May 16, 2024 •

edited

Loading

melvin-bot bot commented May 16, 2024

rojiphil left a comment

rojiphil May 20, 2024

bernhardoj May 20, 2024

rojiphil commented May 20, 2024

rojiphil left a comment

rojiphil commented May 24, 2024

bernhardoj commented May 24, 2024

rojiphil May 24, 2024

bernhardoj May 24, 2024

rojiphil May 24, 2024

rojiphil commented May 24, 2024

thienlnam left a comment

OSBotify commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

	const hasScanningReceipt = ReportUtils.getTransactionsWithReceipts(moneyRequestReport.reportID).some((transaction) => TransactionUtils.isReceiptBeingScanned(transaction));
	const hasScanningReceipt = ReportUtils.getTransactionsWithReceipts(moneyRequestReport?.reportID).some((transaction) => TransactionUtils.isReceiptBeingScanned(transaction));

	{shouldShowNextStep && (
	<View style={[styles.ph5, styles.pb3]}>
	<MoneyReportHeaderStatusBar nextStep={nextStep} />
	</View>
	)}

Show scan status bar when one of the receipt is scanning in expense report #42240

Show scan status bar when one of the receipt is scanning in expense report #42240

Conversation

bernhardoj commented May 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 16, 2024

rojiphil left a comment

Choose a reason for hiding this comment

rojiphil May 20, 2024

Choose a reason for hiding this comment

bernhardoj May 20, 2024

Choose a reason for hiding this comment

rojiphil commented May 20, 2024

Reviewer Checklist

Screenshots/Videos

rojiphil left a comment

Choose a reason for hiding this comment

rojiphil commented May 24, 2024

bernhardoj commented May 24, 2024

rojiphil May 24, 2024

Choose a reason for hiding this comment

bernhardoj May 24, 2024

Choose a reason for hiding this comment

rojiphil May 24, 2024

Choose a reason for hiding this comment

rojiphil commented May 24, 2024

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

bernhardoj commented May 16, 2024 •

edited

Loading