[Awaiting payment] [$250] [Dupe detection] Description review appears when distance expenses are created without description

[IuliiaHerets]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: v9.0.24-1
Reproducible in staging?: Y
Reproducible in production?: Y
Email or phone of affected tester (no customers): [email protected]
Issue reported by: Applause Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Go to workspace chat.
3. Submit two same distance expenses without description.
4. Go to transaction thread of any of the expense.
5. Click Review duplicates.
6. Click Keep this one (any).

Expected Result:

Description review will not show up because both distance expenses are created without description.

Actual Result:

Description review appears when both distance expenses are created without description.

Workaround:

Unknown

Platforms:

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6581468_1724512231051.20240824_230448.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01d6cf4756c6ab01be
• Upwork Job ID: 1828335490161750402
• Last Price Increase: 2024-08-27

Issue Owner

Current Issue Owner: @adelekennedy

[melvin-bot]

Triggered auto assignment to @adelekennedy (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[IuliiaHerets]

We think that this bug might be related to #wave-control

[IuliiaHerets]

@adelekennedy FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[Krishna2323]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Dupe detect -Description review appears when distance expenses are created without description

What is the root cause of that problem?

1. When we create distance request the comment object includes waypoints and each waypoint has unique key, due to this areAllCommentsEqual always returns false for distance transactions.

App/src/libs/TransactionUtils/index.ts

Lines 962 to 965 in 0c84552

	// Helper function to check if all comments are equal
	function areAllCommentsEqual(items: Array<OnyxEntry<Transaction>>, firstTransaction: OnyxEntry<Transaction>) {
	return items.every((item) => lodashIsEqual(item?.comment, firstTransaction?.comment));
	}

What changes do you think we should make in order to solve the problem?

We should remove the keyForList property from each waypoint before comparing the comment object.

    const getTransactionCommentWithoutWaypointKeys = (firstTransaction: OnyxEntry<Transaction['comment']>) => {
        // Remove keyForList from each waypoint
        const updatedWaypoints = Object.fromEntries(Object.entries(firstTransaction?.waypoints ?? {}).map(([key, waypoint]) => [key, (({keyForList, ...rest}) => rest)(waypoint)]));

        // Create the new object
        const updatedData = {
            ...firstTransaction,
            waypoints: updatedWaypoints,
        };

        return updatedData;
    };

    // Helper function to check if all comments are equal
    function areAllCommentsEqual(items: Array<OnyxEntry<Transaction>>, firstTransaction: OnyxEntry<Transaction>) {
        return items.every((item) => {
            if (item?.comment?.waypoints) {
                return lodashIsEqual(getTransactionCommentWithoutWaypointKeys(item.comment), getTransactionCommentWithoutWaypointKeys(firstTransaction?.comment));
            }
            return lodashIsEqual(item?.comment, firstTransaction?.comment);
        });
    }

What alternative solutions did you explore? (Optional)


The allCommentsAreEmpty also doesn't seem to be correct item?.comment === undefined.

App/src/libs/TransactionUtils/index.ts

Line 989 in 0c84552

const allCommentsAreEmpty = isFirstTransactionCommentEmptyObject && transactions.every((item) => item?.comment === undefined);

We can update item?.comment === undefined to:

1. item?.comment === undefined to !item?.comment?.comment.
2. typeof item?.comment === 'object' && item?.comment?.comment === ''.
3. Or item?.comment === undefined || item?.comment?.comment === ''

Result

discription_confirmation_issue.mp4

[daledah]

Proposal

Please re-state the problem that we are trying to solve in this issue.

• Dupe detect -Description review appears when distance expenses are created without description

What is the root cause of that problem?

• When comparing two transactions to check if their description data are equal or not:
  

  App/src/libs/TransactionUtils/index.ts

  Lines 988 to 989 in 0c84552

  	const allCommentsAreEqual = areAllCommentsEqual(transactions, firstTransaction);
  	const allCommentsAreEmpty = isFirstTransactionCommentEmptyObject && transactions.every((item) => item?.comment === undefined);

  
  we use incorrect data. The description data should should transaction.comment.comment, but we use transaction.comment:
  

  App/src/libs/TransactionUtils/index.ts

  Line 964 in 0c84552

  return items.every((item) => lodashIsEqual(item?.comment, firstTransaction?.comment));

  
  

  App/src/libs/TransactionUtils/index.ts

  Line 989 in 0c84552

  const allCommentsAreEmpty = isFirstTransactionCommentEmptyObject && transactions.every((item) => item?.comment === undefined);

• In case of distance request, the transaction.comment data for each transaction is not equal because they contains the waypoints data as well.

What changes do you think we should make in order to solve the problem?

• We should update:
  

  App/src/libs/TransactionUtils/index.ts

  Line 964 in 0c84552

  return items.every((item) => lodashIsEqual(item?.comment, firstTransaction?.comment));

  
  to:

        return items.every((item) => lodashIsEqual(getDescription(item), getDescription(firstTransaction)));

App/src/libs/TransactionUtils/index.ts

Line 989 in 0c84552

const allCommentsAreEmpty = isFirstTransactionCommentEmptyObject && transactions.every((item) => item?.comment === undefined);

                const allCommentsAreEmpty = isFirstTransactionCommentEmptyObject && transactions.every((item) => getDescription(item) === '');

What alternative solutions did you explore? (Optional)

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01d6cf4756c6ab01be

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @mananjadhav (External)

[trjExpensify]

Dupe detection is a #wave-control project. CC: @dylanexpensify @pecanoro @parasharrajat @kubabutkiewicz

[mananjadhav]

Are we looking at regression or something @trjExpensify ? Should I go ahead with the proposal reviews?

[trjExpensify]

Go ahead with the reviews, I was just bringing it to the attention of the dupe detection team.

[pecanoro]

The cause and proposals seem to be the same as this one #47975 so we can go ahead with this one for now

[pecanoro]

@mananjadhav Could you review the proposals when you have a moment?

[mananjadhav]

I think it makes sense to use getDescription. Hence @daledah's proposal looks good to me.

🎀 👀 🎀 C+ reviewed.

[melvin-bot]

Current assignee @pecanoro is eligible for the choreEngineerContributorManagement assigner, not assigning anyone new.

[melvin-bot]

This issue has not been updated in over 15 days. @mananjadhav, @pecanoro, @adelekennedy, @daledah eroding to Monthly issue.

P.S. Is everyone reading this sure this is really a near-term priority? Be brave: if you disagree, go ahead and close it out. If someone disagrees, they'll reopen it, and if they don't: one less thing to do!

[mananjadhav]

PR has been merged and deployed to staging

[pecanoro]

PR has been on production for a week, not sure why the automatization did not work, so I am going to adjust manually

[mananjadhav]

@adelekennedy this is ready for payout.

I don't have a specific offending PR for this one. We've been comparing raw comment hence the issue. But I feel we should have a regression test for this.

Regression test proposal:

1. Go to workspace chat.
2. Submit two same distance expenses without description.
3. Go to transaction thread of any of the expense.
4. Click Review duplicates.
5. Click Keep this one (any).
6. Verify that: Description review will not show up because both distance expenses are created without description.

[adelekennedy]

Payouts due:

• Contributor: $250 @daledah Upwork
• Contributor+: $250 @mananjadhav NewDot

Upwork job is here. @daledah please apply!

[daledah]

@adelekennedy Hi, can you create the offer and send to me at https://www.upwork.com/freelancers/~0138d999529f34d33f

[adelekennedy]

@daledah hired you for the job

[daledah]

@adelekennedy Many thanks, accepted offer 👍

[adelekennedy]

payments made

[garrettmknight]

$250 approved for @mananjadhav