Add markAsCash button with wired up action for dismissing the rter violation #41835

BrtqKr · 2024-05-08T12:00:04Z

Details

Fixed Issues

PROPOSAL:

Tests

Go to the open report - a workspace for example
Submit an expense and retrieve its transactionId
Go to the report screen and in the console, update the onyx entries containing the mocked card that will be used for the transaction, the given transaction and the corresponding violation.

Onyx.merge('cardList', {
        1: {
            bank: 'Expensify Card',
            lastFourPAN: 3458,
        },
    });

Onyx.merge(`transactions_<transaction_id>`, {cardID: 1, merchant: 'violation test'});

Onyx.merge(`transactionViolations_<transaction_id>`, [{type: 'test', name: CONST.VIOLATIONS.RTER, data: {pendingPattern: true}}]);

The mark as cash button should appear
After pressing it the button and the violation message should disappear and there should be a response in the thread confirming that there was a conversion to cash

Verify that no errors appear in the JS console

Offline tests

As the standard ones.

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-05-10.at.11.51.40.mov

Screen.Recording.2024-05-10.at.13.49.11.mov

MacOS: Desktop

Screen.Recording.2024-05-10.at.12.04.43.mov

…kr/mark-as-cash

kosmydel

A few minor questions

kosmydel · 2024-05-10T12:06:03Z

src/pages/home/report/ReportActionsList.tsx

@@ -188,6 +188,7 @@ function ReportActionsList({
    const hasFooterRendered = useRef(false);
    const lastVisibleActionCreatedRef = useRef(report.lastVisibleActionCreated);
    const lastReadTimeRef = useRef(report.lastReadTime);
+    // Single MoneyRequest


Do we need this comment?

It is showing as a change, because ola removed it in her PR and this branch was based on it

src/components/MoneyRequestHeaderStatusBar.tsx

kosmydel · 2024-05-10T12:14:06Z

src/components/ReportActionItem/MoneyRequestPreview/MoneyRequestPreviewContent.tsx

+                                                    width={variables.iconSizeExtraSmall}
+                                                    fill={theme.textSupporting}
+                                                />
+                                                <Text style={[styles.textLabel, styles.colorMuted, styles.ml1, styles.amountSplitPadding]}>{translate('iou.receiptScanInProgress')}</Text>


NAB: We can consider creating a new style for it.

I would check if any other use cases appear in the first place and apply it separately, but yeah that's probably a good idea

kosmydel · 2024-05-10T12:15:33Z

src/components/MoneyRequestHeader.tsx

+    const getPendingType = () => {
+        if (TransactionUtils.isExpensifyCardTransaction(transaction) && TransactionUtils.isPending(transaction)) {
+            return {pendingType: 'PENDING', pendingTitle: translate('iou.pending'), pendingDescription: translate('iou.transactionPendingText')};
+        }
+        if (isScanning) {
+            return {pendingType: 'SCANNING', pendingTitle: ReceiptScan, pendingDescription: translate('iou.receiptScanInProgressDescription')};
+        }
+        if (TransactionUtils.hasPendingRTERViolation(TransactionUtils.getTransactionViolations(transaction?.transactionID ?? '', transactionViolations))) {
+            return {pendingType: 'RTER', pendingTitle: Expensicons.Hourglass, pendingDescription: translate('iou.pendingMatchWithCreditCardDescription')};
+        }
+        return {};
+    };


To consider: adding useCallback.

it's based on the transaction, which is one of the key elements that change in this components props, so probably there wouldn't be any major benefits coming from this change

probably useMemo would be more suitable, but as I stated, there aren't any major benefits and since there aren't any issues either we should avoid it as stated in the docs

kosmydel · 2024-05-10T12:27:44Z

src/libs/actions/Transaction.ts

+                onyxMethod: Onyx.METHOD.MERGE,
+                key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${transactionThreadReportID}`,
+                value: {
+                    [optimisticReportAction.reportActionID]: null,


Just want to make sure: which offline pattern do we follow here? Is it B (Optimistic WITH Feedback Pattern)?

it's from the other branch that has already been merged, but @yuwenmemon probably has more context regarding this action

yuwenmemon · 2024-05-10T19:06:19Z

@BrtqKr Merge main to simplify the diff a bit!

yuwenmemon · 2024-05-15T19:18:15Z

@BrtqKr Quick bump on this! I believe all pre-requisite PRs have been merged

melvin-bot · 2024-05-16T10:39:15Z

@dubielzyk-expensify @c3024 @grgia One of you needs to 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]

dubielzyk-expensify

Looks good to me from a visual perspective. cc @Expensify/design for visibility

shawnborton · 2024-05-17T01:14:57Z

In this screenshot here:

Shouldn't the green button be in the top right and not full width? We only move the button down when the viewport turns into mobile view.

dubielzyk-expensify · 2024-05-17T01:17:50Z

Oh wow. What a miss on my end. Yep most definitely. Should look like this:

shawnborton · 2024-05-17T01:19:09Z

Yup, exactly!

BrtqKr · 2024-05-17T08:21:51Z

ok, it should be fine now

shawnborton · 2024-05-17T11:28:24Z

I could have sworn on mobile, we show the green button above the status - does that sound correct?

dannymcclain · 2024-05-17T14:30:18Z

@shawnborton in the design doc, the button is below the status, like it is here. 🤷‍♂️

c3024 · 2024-05-20T10:31:08Z

Should this report action be here in the report with all transactions?

If it should be there are two issues.

For the first transaction, this report action message marked this receipt as cash. does not appear.

markedAsCashMessageMissing.mp4

The report action is added at the end of the report with transactions when Mark as Cash is clicked for a transaction. This message can be related to a request that might not be the latest request. So, we cannot know which request does this message relate to.

Another question unrelated to the above, should an RBR be shown for this violation on report preview, LHN and in the transaction report (not sure which field that would be.)?

dannymcclain · 2024-05-20T13:27:14Z

Should this report action be here in the report with all transactions?

Hmm that seems weird to me. I would expect it to be in the transaction thread, not the report thread. (Like if you change the category of an expense, that system message shows up in the expense thread.) I would also expect it to have the avatar/name of the person who marked it as cash. @JmillsExpensify @shawnborton does that sound right to you?

Another question unrelated to the above, should an RBR be shown for this violation on report preview, LHN and in the transaction report (not sure which field that would be.)?

I think @JmillsExpensify would know better, but I feel like the preview should be showing an RBR/error message instead of "Unknown Merchant"... Unless of course someone set the merchant to Unknown Merchant deliberately. 😅

shawnborton · 2024-05-20T14:16:14Z

Hmm that seems weird to me. I would expect it to be in the transaction thread, not the report thread. (Like if you change the category of an expense, that system message shows up in the expense thread.) I would also expect it to have the avatar/name of the person who marked it as cash. @JmillsExpensify @shawnborton does that sound right to you?

I agree it should be in the transaction thread. As for the avatar, I think it follows the same logic as when the same user sends multiple messages consecutively where we skip the avatar if you send a bunch of messages in a row.

dannymcclain · 2024-05-20T14:28:23Z

I agree it should be in the transaction thread. As for the avatar, I think it follows the same logic as when the same user sends multiple messages consecutively where we skip the avatar if you send a bunch of messages in a row.

Ah that makes sense. So since this is (wrongly) showing up in the report thread, it's piggy-backing off of the request message. Once we get it in the expense thread like it's supposed to be, that issue should go away. 🤞

yuwenmemon · 2024-05-20T18:59:49Z

Hmmm yeah @BrtqKr That seems to be stemming from some sort of optimistic action we're adding to the parent report because once you sign in and out, those messages disappear:

Kapture.2024-05-20.at.11.53.15.mp4

BrtqKr · 2024-05-21T10:17:07Z

@yuwenmemon isn't it because we're using a random id for the messaging optimistic update? Maybe Onyx isn't able to relate the success id and the random one generated in the action and we should be removing it in the successData

            // Dismiss action with a temporary id
            {
                onyxMethod: Onyx.METHOD.MERGE,
                key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${transactionThreadReportID}`,
                value: {
                    [optimisticReportAction.reportActionID]: null,
                },
            },

Screen.Recording.2024-05-21.at.12.15.50.mov

yuwenmemon · 2024-05-21T18:50:05Z

src/components/MoneyRequestHeader.tsx

+                            text={translate('iou.markAsCash')}
+                            style={[styles.p0]}
+                            onPress={() => {
+                                TransactionActions.markAsCash(transaction?.transactionID ?? '', transaction?.reportID ?? '');


@BrtqKr I think this is the source of your issue. We should be using the transactionThreadID here, not the report ID of the transaction.

One can see this here:

yuwenmemon · 2024-05-21T18:51:26Z

@BrtqKr I don't think it's that, no. I commented on the PR on the line that I believe to be the culprit. Essentially we're passing the transaction's reportID to TransactionActions.markAsCash when we should be passing the Transaction Thread ReportID instead.

JmillsExpensify · 2024-05-22T05:43:38Z

Quickly confirming that yes, this should appear in the transaction thread.

yuwenmemon

LGTM!

yuwenmemon · 2024-05-22T06:46:05Z

@c3024 Can you prioritize your review of this PR ASAP?

c3024 · 2024-05-22T07:20:34Z

src/components/MoneyRequestHeader.tsx

+                            text={translate('iou.markAsCash')}
+                            style={[styles.p0]}
+                            onPress={() => {
+                                TransactionActions.markAsCash(transaction?.transactionID ?? '', transactionThreadReportID ?? '');


Suggested change

TransactionActions.markAsCash(transaction?.transactionID ?? '', transactionThreadReportID ?? '');

TransactionActions.markAsCash(transaction?.transactionID ?? '', report?.reportID ?? '');

c3024 · 2024-05-22T07:22:01Z

src/components/MoneyRequestHeader.tsx

+                            text={translate('iou.markAsCash')}
+                            style={[styles.w100, styles.pr0]}
+                            onPress={() => {
+                                TransactionActions.markAsCash(transaction?.transactionID ?? '', transaction?.reportID ?? '');


Suggested change

TransactionActions.markAsCash(transaction?.transactionID ?? '', transaction?.reportID ?? '');

TransactionActions.markAsCash(transaction?.transactionID ?? '', report?.reportID ?? '');

I think it is better to extract this to a local function because it is used twice and in the last commit only one instance was updated.

c3024 · 2024-05-22T07:35:46Z

src/components/MoneyRequestHeader.tsx

@@ -147,7 +156,11 @@ function MoneyRequestHeader({
            return {title: getStatusIcon(Expensicons.ReceiptScan), description: translate('iou.receiptScanInProgressDescription'), shouldShowBorderBottom: true};
        }
        if (TransactionUtils.hasPendingRTERViolation(TransactionUtils.getTransactionViolations(transaction?.transactionID ?? '', transactionViolations))) {
-            return {title: getStatusIcon(Expensicons.Hourglass), description: translate('iou.pendingMatchWithCreditCardDescription'), shouldShowBorderBottom: true};
+            return {


This should be moved above the isScanning message. That is how it is in oneTransactionReports. When there is an RTER violation that message should be shown instead of the 'being scanned' message.

c3024 · 2024-05-22T13:22:26Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

markAsCashChrome.mp4

MacOS: Desktop

markAsCashDesktop.mp4

c3024 · 2024-05-22T15:22:41Z

NAB: MoneyReportHeader props do not include transaction or transactionViolations so it does not appear to rerender immediately on Onyx.merge transaction and transactionViolations. But in actual use cases, I think backend sends more info than just transaction and transactionViolations so it should rerender immediately.

Also, MoneyReportHeader here is used only for oneTransactionReports, I think it is fine to not subscribe to these changes and avoid rerenders.

c3024

LGTM!

OSBotify · 2024-05-23T16:56:35Z

✋ 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-27T14:24:50Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.4.76-0 🚀

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

OSBotify · 2024-05-29T09:17:28Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.76-7 🚀

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

BrtqKr added 5 commits May 8, 2024 08:57

add mark as cash button

00b7a54

fix button border

f4b356c

Merge remote-tracking branch 'upstream/yuwen-dismissAction' into brtq…

011190f

…kr/mark-as-cash

wire up action

ef73856

fix report id

c8cb397

yuwenmemon self-requested a review May 9, 2024 19:21

kosmydel reviewed May 10, 2024

View reviewed changes

kosmydel approved these changes May 10, 2024

View reviewed changes

yuwenmemon mentioned this pull request May 10, 2024

[No QA] Add markAsCash action for dismissing the rter violation #41698

Merged

48 tasks

Merge remote-tracking branch 'origin/main' into brtqkr/mark-as-cash

6750c63

BrtqKr marked this pull request as ready for review May 16, 2024 10:39

BrtqKr requested a review from a team as a code owner May 16, 2024 10:39

melvin-bot bot requested review from c3024, dubielzyk-expensify and grgia and removed request for a team May 16, 2024 10:39

dubielzyk-expensify previously approved these changes May 16, 2024

View reviewed changes

dubielzyk-expensify self-requested a review May 17, 2024 01:18

handle button ui for the web breakpoints

13e8335

BrtqKr dismissed dubielzyk-expensify’s stale review via 13e8335 May 17, 2024 08:08

Merge remote-tracking branch 'origin/main' into brtqkr/mark-as-cash

873ae52

yuwenmemon requested changes May 21, 2024

View reviewed changes

add threadId to the action

bd9efb1

BrtqKr requested a review from yuwenmemon May 21, 2024 23:13

yuwenmemon previously approved these changes May 22, 2024

View reviewed changes

c3024 suggested changes May 22, 2024

View reviewed changes

c3024 reviewed May 22, 2024

View reviewed changes

extract mark as cash

3c619d0

BrtqKr dismissed yuwenmemon’s stale review via 3c619d0 May 22, 2024 13:10

cleanup

44c1473

BrtqKr requested a review from c3024 May 22, 2024 13:17

c3024 approved these changes May 22, 2024

View reviewed changes

yuwenmemon approved these changes May 23, 2024

View reviewed changes

yuwenmemon merged commit 4bd72e4 into Expensify:main May 23, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-05-27 #42636

Closed

69 tasks

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

[HOLD for payment 2024-06-05] [Violations - Pending Receipts] Add "Mark as cash" Button to MoneyRequestStatusBar #39541

Closed

dominictb mentioned this pull request Feb 7, 2025

[$250] Mark as cash appears in the expense report instead of the expense page #56498

Open

8 tasks

	TransactionActions.markAsCash(transaction?.transactionID ?? '', transactionThreadReportID ?? '');
	TransactionActions.markAsCash(transaction?.transactionID ?? '', report?.reportID ?? '');

Add markAsCash button with wired up action for dismissing the rter violation #41835

Add markAsCash button with wired up action for dismissing the rter violation #41835

Conversation

BrtqKr commented May 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kosmydel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yuwenmemon commented May 10, 2024

yuwenmemon commented May 15, 2024

melvin-bot bot commented May 16, 2024

dubielzyk-expensify left a comment

Choose a reason for hiding this comment

shawnborton commented May 17, 2024

dubielzyk-expensify commented May 17, 2024

shawnborton commented May 17, 2024

BrtqKr commented May 17, 2024

shawnborton commented May 17, 2024

dannymcclain commented May 17, 2024

c3024 commented May 20, 2024 • edited Loading

dannymcclain commented May 20, 2024

shawnborton commented May 20, 2024

dannymcclain commented May 20, 2024

yuwenmemon commented May 20, 2024

BrtqKr commented May 21, 2024 • edited Loading

Choose a reason for hiding this comment

yuwenmemon commented May 21, 2024

JmillsExpensify commented May 22, 2024

yuwenmemon left a comment

Choose a reason for hiding this comment

yuwenmemon commented May 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

c3024 May 22, 2024 • edited Loading

Choose a reason for hiding this comment

c3024 commented May 22, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 commented May 22, 2024

c3024 left a comment

Choose a reason for hiding this comment

OSBotify commented May 23, 2024

OSBotify commented May 27, 2024

OSBotify commented May 29, 2024

BrtqKr commented May 8, 2024 •

edited

Loading

c3024 commented May 20, 2024 •

edited

Loading

BrtqKr commented May 21, 2024 •

edited

Loading

c3024 May 22, 2024 •

edited

Loading

c3024 commented May 22, 2024 •

edited

Loading