Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix - Search - Expense from the list does not disappear after deletion #54407

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

FitseTLT
Copy link
Contributor

Details

Fixed Issues

$ #53687
PROPOSAL: #53687 (comment)

Tests

  1. If there are no expenses created yet create some expenses
  2. Go to Search -> Expenses -> All
  3. Select and delete one of the expenses
  4. Verify that the expense you deleted disappears from the search list
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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(themeColors.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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
a.search.mp4
Android: mWeb Chrome
aw.search.mp4
iOS: Native
i.search.mp4
iOS: mWeb Safari
iw.search.mp4
MacOS: Chrome / Safari
w.search.mp4
MacOS: Desktop
d.sear.mp4

@FitseTLT FitseTLT requested a review from a team as a code owner December 20, 2024 12:47
@melvin-bot melvin-bot bot requested review from rayane-djouah and removed request for a team December 20, 2024 12:48
Copy link

melvin-bot bot commented Dec 20, 2024

@rayane-djouah 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]

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Jan 1, 2025

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
Screen.Recording.2025-01-03.at.12.19.47.AM.mov
Android: mWeb Chrome
Screen.Recording.2025-01-02.at.11.21.56.PM.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2025-01-03.at.00.51.26.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2025-01-02.at.23.19.06.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-01-02.at.11.16.47.PM.mov
MacOS: Desktop
Screen.Recording.2025-01-02.at.11.16.07.PM.mov

@luacmartins luacmartins self-requested a review January 2, 2025 19:29
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FitseTLT let's add some unit tests as suggested in the proposal

const hasTransactionChange = !isEqual(transactionIDList, previousTransactionIDList);
const hasReportActionChange = !isEqual(reportActionIDList, previousReportActionIDList);

// Check if there is a change in transaction or report action list
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Check if there is a change in transaction or report action list
// Check if there is a change in the transactions list or the report actions list

Comment on lines +57 to +59
// We only want to highlight new items only if addition of transactions or report actions triggered the search.
// This is because on deletion of items sometimes the BE returns old items in place of the deleted ones
// but we don't want to highlight these old items although they are new to the current search result.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// We only want to highlight new items only if addition of transactions or report actions triggered the search.
// This is because on deletion of items sometimes the BE returns old items in place of the deleted ones
// but we don't want to highlight these old items although they are new to the current search result.
// We only want to highlight new items if the addition of transactions or report actions triggered the search.
// This is because, on deletion of items, the backend sometimes returns old items in place of the deleted ones.
// We don't want to highlight these old items, even if they appear new in the current search results.

@@ -26,6 +27,7 @@ function useSearchHighlightAndScroll({searchResults, transactions, previousTrans
// Ref to track if the search was triggered by this hook
const triggeredByHookRef = useRef(false);
const searchTriggeredRef = useRef(false);
const hasItemBeenAddedRef = useRef(false);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const hasItemBeenAddedRef = useRef(false);
const hasNewItemsRef = useRef(false);

@@ -34,20 +36,29 @@ function useSearchHighlightAndScroll({searchResults, transactions, previousTrans

// Trigger search when a new report action is added while on chat or when a new transaction is added for the other search types.
useEffect(() => {
const previousTransactionsLength = previousTransactions && Object.keys(previousTransactions).length;
const transactionsLength = transactions && Object.keys(transactions).length;
const previousTransactionIDList = Object.keys(previousTransactions ?? {});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const previousTransactionIDList = Object.keys(previousTransactions ?? {});
const previousTransactionsIDs = Object.keys(previousTransactions ?? {});

const previousTransactionsLength = previousTransactions && Object.keys(previousTransactions).length;
const transactionsLength = transactions && Object.keys(transactions).length;
const previousTransactionIDList = Object.keys(previousTransactions ?? {});
const transactionIDList = Object.keys(transactions ?? {});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const transactionIDList = Object.keys(transactions ?? {});
const transactionsIDs = Object.keys(transactions ?? {});

const prevReportActionsLength = previousReportActions && Object.values(previousReportActions).reduce((sum, curr) => sum + Object.keys(curr ?? {}).length, 0);
// Return early if search was already triggered or there's no change in current and previous data length
if (searchTriggeredRef.current || (!isChat && previousTransactionsLength === transactionsLength) || (isChat && reportActionsLength === prevReportActionsLength)) {
const reportActionIDList = Object.values(reportActions ?? {})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const reportActionIDList = Object.values(reportActions ?? {})
const reportActionsIDs = Object.values(reportActions ?? {})

const reportActionIDList = Object.values(reportActions ?? {})
.map((actions) => Object.keys(actions ?? {}))
.flat();
const previousReportActionIDList = Object.values(previousReportActions ?? {})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const previousReportActionIDList = Object.values(previousReportActions ?? {})
const previousReportActionsIDs = Object.values(previousReportActions ?? {})

return;
}
const newTransactionAdded = transactionsLength && typeof previousTransactionsLength === 'number' && transactionsLength > previousTransactionsLength;
const newReportActionAdded = reportActionsLength && typeof prevReportActionsLength === 'number' && reportActionsLength > prevReportActionsLength;
const hasTransactionChange = !isEqual(transactionIDList, previousTransactionIDList);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const hasTransactionChange = !isEqual(transactionIDList, previousTransactionIDList);
const hasTransactionsIDsChange = !isEqual(transactionIDList, previousTransactionIDList);

const newTransactionAdded = transactionsLength && typeof previousTransactionsLength === 'number' && transactionsLength > previousTransactionsLength;
const newReportActionAdded = reportActionsLength && typeof prevReportActionsLength === 'number' && reportActionsLength > prevReportActionsLength;
const hasTransactionChange = !isEqual(transactionIDList, previousTransactionIDList);
const hasReportActionChange = !isEqual(reportActionIDList, previousReportActionIDList);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const hasReportActionChange = !isEqual(reportActionIDList, previousReportActionIDList);
const hasReportActionsIDsChange = !isEqual(reportActionIDList, previousReportActionIDList);

@@ -103,7 +114,7 @@ function useSearchHighlightAndScroll({searchResults, transactions, previousTrans
// Find new transaction IDs that are not in the previousTransactionIDs and not already highlighted
const newTransactionIDs = currentTransactionIDs.filter((id) => !previousTransactionIDs.includes(id) && !highlightedIDs.current.has(id));

if (!triggeredByHookRef.current || newTransactionIDs.length === 0) {
if (!triggeredByHookRef.current || newTransactionIDs.length === 0 || !hasItemBeenAddedRef.current) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!

@rayane-djouah
Copy link
Contributor

@FitseTLT Could you please look into this edge case? When a transaction is deleted from another device, it doesn’t get deleted on the current device:

Screen.Recording.2025-01-02.at.11.04.03.PM.1.mov

Additionally, in the video, you can see that a scroll was triggered. I’m not entirely sure about the exact steps to reproduce this behavior, but it seems that we need to fix it.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 3, 2025

@rayane-djouah I don't know if it aligns with the bug you discovered but on my side when the expense deleted was the only expense on the report the transaction list is not updated so we don't trigger search. But in this case the report actions list is updated so if you agree we can apply a workaround solution by triggering the search for expense case too when the report actions list is updated by changing

if ((!isChat && hasTransactionChange) || (isChat && hasReportActionChange)) {

        if ((!isChat && hasTransactionChange) || hasReportActionChange) {
       
        if ((!isChat && hasTransactionChange) || ((isChat || reportActionIDList.length < previousReportActionIDList.length) && hasReportActionChange)) {


WDYT

@luacmartins
Copy link
Contributor

Any updates on this one? @rayane-djouah @FitseTLT

@rayane-djouah
Copy link
Contributor

I don't know if it aligns with the bug you discovered but on my side when the expense deleted was the only expense on the report the transaction list is not updated so we don't trigger search. But in this case the report actions list is updated so if you agree we can apply a workaround solution by triggering the search for expense case too when the report actions list is updated by changing

@FitseTLT I think that this could lead to unnecessary search API calls, which might impact performance

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Jan 9, 2025

Any updates on this one? @rayane-djouah @FitseTLT

Waiting on @FitseTLT to address the review comments

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 9, 2025

I don't know if it aligns with the bug you discovered but on my side when the expense deleted was the only expense on the report the transaction list is not updated so we don't trigger search. But in this case the report actions list is updated so if you agree we can apply a workaround solution by triggering the search for expense case too when the report actions list is updated by changing

@FitseTLT I think that this could lead to unnecessary search API calls, which might impact performance

@rayane-djouah I know it would result in unnecessary search API calls that's why I asked to confirm the workaround solution from FE but it appears we are out of options if we want a FE solution because the only info we have got in FE to trigger the search API is change of transactions and report actions and in this case transaction list is not changed when the deleted expense is the only expense of the iou report.

@rayane-djouah
Copy link
Contributor

Yea, it seems that DeleteMoneyRequestOnSearch API command is returning reports and reports actions data but not including transactions data:

Screen.Recording.2025-01-09.at.9.49.33.PM.mov
Screen.Recording.2025-01-09.at.9.49.33.PM.mov

@luacmartins Can you please look for a backend fix for including deleted transactions data in response as well?

@FitseTLT Let's address code review comments and add unit tests, I think that the above bug needs to be fixed from backend

@luacmartins
Copy link
Contributor

Hmm I do see us setting the transaction to null in DeleteMoneyRequestOnSearch. What am I missing?

Screenshot 2025-01-09 at 2 48 19 PM

@rayane-djouah
Copy link
Contributor

@luacmartins we're setting the transaction to null for snapshot_ onyx key but not for transactions_

@luacmartins
Copy link
Contributor

Hmm interesting. I see that the DeleteMoneyRequest command is also not sending that update for transactions_

Screenshot 2025-01-10 at 10 05 53 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants