Add snapshot functionality

[jnowakow]

Details

This PR adds snapshot functionality described in design doc. It adds special support for SNAPSHOT key. Objects inside its data field will be updated with every change made through update function.

Related Issues

https://github.com/Expensify/App/issues/41626

Automated Tests

Manual Tests

1. Open Search Page.
2. View any transaction.
3. Modify amount
4. Check if value was updated in table

Author Checklist

• [x] I linked the correct issue in the ### Related Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android / native
  • [x] Android / Chrome
  • [x] iOS / native
  • [x] iOS / Safari
  • [x] MacOS / Chrome / Safari
  • [x] MacOS / Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] 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)
• [x] 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.
• [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/react-native-onyx/assets/56261019/10a934db-4d85-4f45-9b16-4b96ad51dc8b

Android: mWeb Chrome

https://github.com/Expensify/react-native-onyx/assets/56261019/f62863e7-a3a1-466d-b686-8cfa635a00f5

iOS: Native

https://github.com/Expensify/react-native-onyx/assets/56261019/ee8e10f2-1a7b-4e61-b5d7-446204887de2

iOS: mWeb Safari

https://github.com/Expensify/react-native-onyx/assets/56261019/4d3ecc3f-8ac6-4b3f-8084-0614e9d4b850

MacOS: Chrome / Safari

https://github.com/Expensify/react-native-onyx/assets/56261019/dc1c3af3-e6cf-47ce-832c-ea5bb18d2561

MacOS: Desktop

https://github.com/Expensify/react-native-onyx/assets/56261019/fc51d7e0-1730-4b71-a171-762c50d3b300

[github-actions[bot]]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[jnowakow]

I have read the CLA Document and I hereby sign the CLA

[allroundexperts]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

https://github.com/Expensify/react-native-onyx/assets/30054992/39ef66ab-8704-456c-a3ae-841dd57dab52

iOS: Native

N/A

iOS: mWeb Safari

https://github.com/Expensify/react-native-onyx/assets/30054992/e0b84a65-a853-4380-99c4-6fc5735415ae

MacOS: Chrome / Safari

https://github.com/Expensify/react-native-onyx/assets/30054992/6a1fc46f-1be5-4606-b9c6-e489c8931ae5

MacOS: Desktop

https://github.com/Expensify/react-native-onyx/assets/30054992/5708d7a2-c43a-49f0-9830-93aa2ad62110

[allroundexperts]

Yep, I'm on it!

[trjExpensify]

How you getting on @allroundexperts?

[allroundexperts]

@trjExpensify I was unable to verify the fix. For me, the table values do not get updated.

[allroundexperts]

https://github.com/Expensify/react-native-onyx/assets/30054992/424a4298-8e8e-49ed-9ff5-dceb86ad2268

[luacmartins]

@allroundexperts just confirming that you updated App to use this branch of Onyx?

[allroundexperts]

@luacmartins Yes, I checked out this branch and built it using npm run build. After that, I copied the dist folder and replaced it inside the node_modules of the main app.

[allroundexperts]

@Kicu Any update on above?

[jnowakow]

@allroundexperts I'm investigating it. It's strange because it seems that there is problem with updating component since data in onyx are updated:

I checkout out also version before optimisation and it works the same. I'll dig into it further

[jnowakow]

@allroundexperts problem lies in App. Two days ago this PR was merged. It wraps all components in Search table in memo. The problem is that function passed to memo checks only keyForList. So even if amount changes the component isn't re-rendered and shows outdated value.

For testing purposes you can modify TotalCell component like this:

const TotalCell = memo(({showTooltip, amount, currency, isLargeScreenWidth}: CurrencyCellProps) => {
    const styles = useThemeStyles();

    return (
        <TextWithTooltip
            shouldShowTooltip={!!showTooltip}
            text={CurrencyUtils.convertToDisplayString(amount, currency)}
            style={[styles.optionDisplayName, styles.textNewKansasNormal, styles.pre, styles.justifyContentCenter, isLargeScreenWidth ? undefined : styles.textAlignRight]}
        />
    );
});

It's defined in src/components/SelectionList/Search/TransactionListItemRow.tsx file.

Go-to solution is to modify functions passed to memo because other cells won't update if they props change cc @luacmartins

[luacmartins]

Nice find @jnowakow! Yea, let's update the prop comparison function to handle these updates too!

[jnowakow]

@luacmartins sure thing! I'll work on that. Should I create issue for this?

[luacmartins]

@jnowakow created issue here

[luacmartins]

@allroundexperts were you able to test following @jnowakow's instructions here?

[allroundexperts]

Not really. Isn't this on hold?

[luacmartins]

I think just a merge hold. We can still continue development. What part of the instructions didn't work?

[allroundexperts]

Oh, I didn't continue the testing after hold was applied. Will re-test and get back today.

[allroundexperts]

Just tested this again. The new search page seems to be broken now 😞

https://github.com/Expensify/react-native-onyx/assets/30054992/3885ab45-862d-4675-8cb9-f58085d0d9dd

[luacmartins]

@allroundexperts yea, we messed up the API a bit. To temporarily fix it you can change this value to transactions instead of transaction

[allroundexperts]

@luacmartins It works now. But on Android, I'm getting the following crash:

https://github.com/Expensify/react-native-onyx/assets/30054992/3e4eeb58-0ca9-4edb-ba30-1ae35a24d50d

[luacmartins]

@allroundexperts that seems unrelated to this PR. Can we focus testing this Onyx changes in Web first? We should be able to see the live updates in Search when they are edited.

[allroundexperts]

@allroundexperts that seems unrelated to this PR. Can we focus testing this Onyx changes in Web first? We should be able to see the live updates in Search when they are edited.

I can confirm that for web, it is working fine.

[allroundexperts]

Working on the checklist now.

[luacmartins]

The holding PR was merged, we can remove the hold here

[github-actions[bot]]

🚀Published to npm in v2.0.49