Skip to content

Conversation

@FitseTLT
Copy link
Contributor

Details

Fixed Issues

$ #60116 #63295
PROPOSAL: #63295 (comment)

Tests

Precondition: The user has sent a message with an attachment or a link

  1. Navigate to the Reports
  2. Click on Chats
  3. Click on the Status drop-down menu
  4. Select Attachments
  5. Click on the message item (not over the attachment)
  6. The filter is not reset, the user can close RHP with the conversation and see the page with filter results.

Precondition: a workspace has an employee with an expense without receipt

  1. From the admin side click on Reports tab
  2. From the employee side Click on Reports tab
  3. Click on expense without receipt
  4. Upload image for this expense
  5. From the admin side
  6. The uploaded image should be displayed
  • 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 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
2025-06-26.19-33-28.mp4
Android: mWeb Chrome
2025-06-26.18-57-07.mp4
iOS: Native
2025-06-26.18-53-51.mp4
iOS: mWeb Safari
2025-06-26.18-45-02.mp4
MacOS: Chrome / Safari
2025-06-26.18-42-54.mp4
MacOS: Desktop
2025-06-26.18-49-04.mp4

@FitseTLT FitseTLT requested a review from a team as a code owner June 26, 2025 16:35
@melvin-bot melvin-bot bot requested a review from parasharrajat June 26, 2025 16:35
@melvin-bot
Copy link

melvin-bot bot commented Jun 26, 2025

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

@melvin-bot melvin-bot bot removed the request for review from a team June 26, 2025 16:35
@github-actions
Copy link
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@parasharrajat
Copy link
Member

Let's update the title to mention what this PR solves.

@FitseTLT FitseTLT changed the title Fix - bump onyx ^2.0.112 Fix - Search - The chat filter is reset after clicking the message on the Search page Jun 26, 2025
@FitseTLT
Copy link
Contributor Author

done

Comment on lines 54 to 61
fullyMergedSnapshotKeys: [
ONYXKEYS.COLLECTION.TRANSACTION,
ONYXKEYS.COLLECTION.REPORT,
ONYXKEYS.COLLECTION.POLICY,
ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS,
ONYXKEYS.PERSONAL_DETAILS_LIST,
],
});
Copy link
Member

Choose a reason for hiding this comment

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

How did you pick these keys?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because in my opinion direct merging of BE response of these keys into the snapshot doesn't have any side effect. But @luacmartins @iwiznia this is the part in this pr that you need to pay attention to when reviewing. 👍

Copy link
Contributor Author

@FitseTLT FitseTLT Jun 30, 2025

Choose a reason for hiding this comment

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

But ofcourse if you want to check the type of data snapshot holds

data: PrefixedRecord<typeof ONYXKEYS.COLLECTION.TRANSACTION, SearchTransaction> &
Record<typeof ONYXKEYS.PERSONAL_DETAILS_LIST, Record<string, SearchPersonalDetails>> &
PrefixedRecord<typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS, Record<string, SearchReportAction>> &
PrefixedRecord<typeof ONYXKEYS.COLLECTION.REPORT, SearchReport> &
PrefixedRecord<typeof ONYXKEYS.COLLECTION.POLICY, SearchPolicy> &
PrefixedRecord<typeof ONYXKEYS.COLLECTION.WORKSPACE_CARDS_LIST, SearchCard> &
PrefixedRecord<typeof ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS, TransactionViolation[]> &
PrefixedRecord<typeof ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS, ReportNameValuePairs>;

Copy link
Contributor

Choose a reason for hiding this comment

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

I need to understand all this better... what this will do is basically set in the snapshot all the data for example of any entry in ONYXKEYS.COLLECTION.TRANSACTION that arrives as an update?

Also can you clarify exactly how you picked the keys? Like why not include for example ONYXKEYS.COLLECTION.WORKSPACE_CARDS_LIST?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I need to understand all this better... what this will do is basically set in the snapshot all the data for example of any entry in ONYXKEYS.COLLECTION.TRANSACTION that arrives as an update?

Yup

Also can you clarify exactly how you picked the keys? Like why not include for example ONYXKEYS.COLLECTION.WORKSPACE_CARDS_LIST?

WORKSPACE_CARDS_LIST are also eligible I didn't add it because it was added to the type recently I have added it now. But basically all the types which hold a single collection member data (not Record of member data) are eligible because directly merging will not add a new record but instead update the specific record with a new props that were not available previously. For instance for TRANSACTION_id a new prop of receipt being added in BE response will update the specific transaction with a new info unavailable before so will fix the orignal bug we were aiming to fix. So the only types that don't fall into this are PERSONAL_DETAILS_LIST and REPORT_ACTIONS which hold records of member data. REPORT_ACTIONS should not be added because it will cause the current filter to be reset in Chat section as the regression we are trying to fix here. But I think it is a good idea to add PERSONAL_DETAILS_LIST into mergeAll because there is no case as REPORT_ACTIONS where we display filtered PERSONAL_DETAILS_LIST but if you guys think there is a case then we can remove it from the list.

Copy link
Contributor

Choose a reason for hiding this comment

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

part of mergeAllConfigKeys and if it is we merge the whole some_obj into the specific policy data

Yea, I think this part is what we're concerned about. I know that we discussed the solution before, but maybe a better approach would be to always return the receipt object from Search even if the transaction doesn't have one. That'd mean that if we upload a receipt to a transaction without a receipt, we'd optimistically update it and wouldn't need to merge the entire object

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We are already optimstically updating it and that's why the original bug is not reproducible from the creator side. But, let's say from the admin side while the expense is created by the employee side, we still need this update so that BE update could be merged into the snapshot data.

Copy link
Contributor

Choose a reason for hiding this comment

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

Right now we conditionally add the receipt key to SearchTransaction in the BE. What I'm suggesting is that we always include the key, so that any update including the receipt key would be picked up and applied by live updates. So we don't need to merge the entire key.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep that also works 🤷

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool, I have a BE PR that'll do that https://github.com/Expensify/Auth/pull/16172

@parasharrajat
Copy link
Member

Screenshots

🔲 iOS / native

29.06.2025_17.31.04_REC.mp4

🔲 iOS / Safari

29.06.2025_17.32.14_REC.mp4

🔲 MacOS / Desktop

29.06.2025_17.25.37_REC.mp4

🔲 MacOS / Chrome

29.06.2025_16.29.16_REC.mp4

🔲 Android / Chrome

29.06.2025_17.18.40_REC.mp4

🔲 Android / native

29.06.2025_17.13.12_REC.mp4

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from iwiznia June 29, 2025 12:03
@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jul 2, 2025

The bumping has been done by another pr all we need is to set is the configs. @luacmartins @iwiznia bump on your reviews Thx

@iwiznia iwiznia requested a review from luacmartins July 7, 2025 13:39
@luacmartins
Copy link
Contributor

We merged a fix on the BE. @FitseTLT can you please retest to make sure the original issue is no longer reproducible? If so, I think we can close this and we should probably undo the changes in onyx too

@FitseTLT
Copy link
Contributor Author

We merged a fix on the BE. @FitseTLT can you please retest to make sure the original issue is no longer reproducible? If so, I think we can close this and we should probably undo the changes in onyx too

Nope not yet fixed 😢 @luacmartins

2025-07-19.00-48-16.mp4

@luacmartins
Copy link
Contributor

Oh nvm, we reverted yesterday's deploy today. We need to wait for another deploy until this can be fixed. My bad!

@luacmartins
Copy link
Contributor

Let's test this again. The latest deploy should have fixed the issue.

@parasharrajat
Copy link
Member

Testing on staging and I can still reproduce the main issue.

@parasharrajat
Copy link
Member

@luacmartins, it is still not solved on staging. Or do you want me to test somewhere else?

@parasharrajat
Copy link
Member

@FitseTLT Can you please test and confirm?

@luacmartins
Copy link
Contributor

@parasharrajat I think #60116 is fixed on staging, no?

Screen.Recording.2025-07-23.at.10.16.18.AM.mov

@FitseTLT
Copy link
Contributor Author

Still not fixed. @luacmartins please see the steps carefully. We are not dealing with the creator side here. It was already solved by our optimsitic update of the receipt field so it doesn't even need a BE fix for the steps you are showing in the vid. What we need to fix is the receiver's side like the vid below and it is still not fixed on staging.

2025-07-23.19-20-09.mp4

@luacmartins
Copy link
Contributor

Ah I see. I also realized that even with the existing BE solution, something like this would be possible:

1. Transaction with receipt is loaded on Search. Snapshot contains transaction_: {receipt: {...}}
2. User removes receipt from transaction. Onyx update is sent with transaction_: {receipt: null}. Snapshot is updated and no longer has the receipt key in it (because Onyx removes null value keys from objects)
3. User attaches a new receipt. Onyx update is sent with transaction_: {receipt: {...}}. The update is not applied because the receipt key is no longer in the snapshot

So even if we initially return the key from Search, we can't guarantee that we won't get an update removing a key by setting it to null. That means any subsequent updates would be missed. So I think the only solution for the snapshot design is to merge the full object 😞

@luacmartins
Copy link
Contributor

@FitseTLT we're discussing a proposal to get rid of snapshot data in general. So I think we should pause work on this PR/issue before we go deeper into this hole. I think that's ok since they are small issues.

@luacmartins
Copy link
Contributor

I think we should close this PR since we're working on a proposal to refactor how snapshots work.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Aug 8, 2025

closing based on the above comment

@FitseTLT FitseTLT closed this Aug 8, 2025
@FitseTLT
Copy link
Contributor Author

FitseTLT commented Aug 8, 2025

I think we should close this PR since we're working on a proposal to refactor how snapshots work.

so @luacmartins what about a revert on the onyx repo?

@luacmartins
Copy link
Contributor

@FitseTLT yea, let's do that as well

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.

4 participants