Add snapshot functionality #552

jnowakow · 2024-05-23T06:52:19Z

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

Expensify/App#41626

Automated Tests

Manual Tests

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

Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

github-actions · 2024-05-23T06:52:33Z

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

jnowakow · 2024-05-23T09:45:09Z

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

jnowakow · 2024-05-23T11:56:24Z

lib/Onyx.ts

+            if (!snapshotValue) {
+                return;
+            }


Snapshot may not be read yet and thus not present in cache.
One option is to ignore it like this. Other option is to read all keys, filter out only snapshot key, then get value for them and compare.
Not sure which is preferred way @luacmartins

jnowakow · 2024-05-24T07:40:36Z

lib/Onyx.ts

-    return clearPromise.then(() => Promise.all(promises.map((p) => p()))).then(() => undefined);
+    return clearPromise
+        .then(() => Promise.all(promises.map((p) => p())))
+        .then(() => updateSnapshots(data))


@luacmartins currently snapshots are updated only after update. Only this was specified in design doc. This means that if data are changed for example through merge snapshots will not be updated. Is this intentional?

Yea, I think that's fine since we only want snapshot data to be updated from Pusher updates, which calls Onyx.update. Are there other edge cases where the API calls merge instead of update?

I don't see any edge case right now but I think it can be confusing if one forgets about this fact. After all it's open-source library

lib/Onyx.ts

tests/unit/onyxTest.ts

lib/Onyx.ts

Kicu

Good code @jnowakow, however in general I see that there might be potential problems with the amount of iterations made.
So I think @luacmartins that this will have to monitored and measured, because it feels like the amount of keys in snapshot might grow very quickly and the we will be doing thousands of iterations per 1 snapshot update.

Side note I prefer how in this sibling PR: https://github.com/Expensify/react-native-onyx/pull/555/files we allow for different names for the SNAPSHOT and data key names. Feels much more open and less arbitrary that you can configure the snapshot collection name.
I would move forward with this other PR

lib/Onyx.ts

tests/unit/onyxTest.ts

allroundexperts · 2024-05-27T15:50:18Z

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

N/A

Android: mWeb Chrome

Screen.Recording.2024-05-31.at.7.01.01.PM.mov

iOS: Native

N/A

iOS: mWeb Safari

Screen.Recording.2024-05-31.at.7.00.01.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-31.at.6.53.57.PM.mov

MacOS: Desktop

Screen.Recording.2024-05-31.at.6.56.21.PM.mov

luacmartins

I haven't tested this yet, but code changes LGTM. Waiting on @allroundexperts review and tests to test this more in depth

allroundexperts · 2024-05-27T20:48:05Z

Yep, I'm on it!

trjExpensify · 2024-05-28T12:49:26Z

How you getting on @allroundexperts?

allroundexperts · 2024-05-28T14:33:26Z

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

allroundexperts · 2024-05-28T14:50:25Z

Screen.Recording.2024-05-28.at.7.36.10.PM.mov

jnowakow · 2024-05-29T13:59:37Z

@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 · 2024-05-29T14:04:11Z

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

jnowakow · 2024-05-29T14:18:48Z

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

luacmartins · 2024-05-29T15:43:34Z

@jnowakow created issue here

luacmartins · 2024-05-30T14:09:43Z

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

allroundexperts · 2024-05-30T15:37:08Z

Not really. Isn't this on hold?

luacmartins · 2024-05-30T15:43:35Z

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

allroundexperts · 2024-05-30T15:57:22Z

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

allroundexperts · 2024-05-31T13:18:23Z

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

Screen.Recording.2024-05-31.at.6.16.21.PM.mov

luacmartins · 2024-05-31T13:44:49Z

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

allroundexperts · 2024-05-31T14:07:14Z

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

Screen.Recording.2024-05-31.at.7.03.41.PM.mov

luacmartins · 2024-05-31T16:03:25Z

@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 · 2024-05-31T17:37:50Z

@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 · 2024-05-31T17:38:17Z

Working on the checklist now.

allroundexperts

One small comment. Looks good otherwise!

luacmartins · 2024-06-13T16:44:51Z

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

github-actions · 2024-06-13T16:45:48Z

🚀Published to npm in v2.0.49

Add snapshot functionality

e545e91

jnowakow requested a review from a team as a code owner May 23, 2024 06:52

jnowakow marked this pull request as draft May 23, 2024 06:52

melvin-bot bot requested review from MariaHCD and removed request for a team May 23, 2024 06:52

Small refactor

0659297

jnowakow commented May 23, 2024

View reviewed changes

Add comments

bf32346

luacmartins self-requested a review May 23, 2024 13:19

Add test and remove ts-ban

c4b143b

jnowakow commented May 24, 2024

View reviewed changes

Christinadobrzyn mentioned this pull request May 27, 2024

[HOLD for payment 2024-06-28] [$250] [Search v1] Live search updates Expensify/App#41626

Closed

jnowakow mentioned this pull request May 27, 2024

[HOLD for App onyx bump] Snapshots with config #555

Closed

42 tasks

blazejkustra suggested changes May 27, 2024

View reviewed changes

lib/Onyx.ts Show resolved Hide resolved

lib/Onyx.ts Outdated Show resolved Hide resolved

lib/Onyx.ts Outdated Show resolved Hide resolved

lib/Onyx.ts Outdated Show resolved Hide resolved

tests/unit/onyxTest.ts Outdated Show resolved Hide resolved

jnowakow added 3 commits May 27, 2024 10:23

Style fix

b878201

Refactor for better perf

e03f791

use pick from lodash

34dac5a

jnowakow commented May 27, 2024

View reviewed changes

lib/Onyx.ts Show resolved Hide resolved

jnowakow marked this pull request as ready for review May 27, 2024 09:23

Kicu approved these changes May 27, 2024

View reviewed changes

lib/Onyx.ts Outdated Show resolved Hide resolved

tests/unit/onyxTest.ts Outdated Show resolved Hide resolved

luacmartins requested a review from allroundexperts May 27, 2024 15:40

luacmartins reviewed May 27, 2024

View reviewed changes

fix typo

829c5cb

luacmartins mentioned this pull request May 29, 2024

[HOLD for payment 2024-06-13] [Search v1] Update memo functions in TransactionListItem Expensify/App#42774

Closed

mountiny changed the title ~~Add snapshot functionality~~ [HOLD for App onyx bump] Add snapshot functionality May 29, 2024

allroundexperts approved these changes May 31, 2024

View reviewed changes

Remove unnecessary Promise

4ba3b9a

luacmartins approved these changes Jun 3, 2024

View reviewed changes

luacmartins changed the title ~~[HOLD for App onyx bump] Add snapshot functionality~~ [HOLD for App #42772] Add snapshot functionality Jun 3, 2024

luacmartins requested a review from blazejkustra June 3, 2024 16:17

blazejkustra approved these changes Jun 3, 2024

View reviewed changes

MariaHCD approved these changes Jun 4, 2024

View reviewed changes

luacmartins mentioned this pull request Jun 12, 2024

[Search v1] Expenses moved to a new report are not updated on Search page Expensify/App#43382

Closed

luacmartins changed the title ~~[HOLD for App #42772] Add snapshot functionality~~ Add snapshot functionality Jun 13, 2024

luacmartins merged commit 56c3994 into Expensify:main Jun 13, 2024
5 checks passed

dominictb mentioned this pull request Jun 26, 2024

Search-Expense details updated are not shown immediately Expensify/App#42254

Closed

6 tasks

luacmartins mentioned this pull request Sep 4, 2024

Implemented chat type in search Expensify/App#47690

Merged

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add snapshot functionality #552

Add snapshot functionality #552

jnowakow commented May 23, 2024 •

edited

Loading

github-actions bot commented May 23, 2024 •

edited

Loading

jnowakow commented May 23, 2024

jnowakow May 23, 2024

jnowakow May 24, 2024

luacmartins May 27, 2024

jnowakow Jun 3, 2024

Kicu left a comment

allroundexperts commented May 27, 2024 •

edited

Loading

luacmartins left a comment

allroundexperts commented May 27, 2024

trjExpensify commented May 28, 2024

allroundexperts commented May 28, 2024

allroundexperts commented May 28, 2024

jnowakow commented May 29, 2024 •

edited

Loading

luacmartins commented May 29, 2024

jnowakow commented May 29, 2024

luacmartins commented May 29, 2024

luacmartins commented May 30, 2024

allroundexperts commented May 30, 2024

luacmartins commented May 30, 2024

allroundexperts commented May 30, 2024

allroundexperts commented May 31, 2024

luacmartins commented May 31, 2024

allroundexperts commented May 31, 2024

luacmartins commented May 31, 2024

allroundexperts commented May 31, 2024

allroundexperts commented May 31, 2024

allroundexperts left a comment

luacmartins commented Jun 13, 2024

github-actions bot commented Jun 13, 2024

Add snapshot functionality #552

Add snapshot functionality #552

Conversation

jnowakow commented May 23, 2024 • edited Loading

Details

Related Issues

Automated Tests

Manual Tests

Author Checklist

Screenshots/Videos

github-actions bot commented May 23, 2024 • edited Loading

jnowakow commented May 23, 2024

jnowakow May 23, 2024

Choose a reason for hiding this comment

jnowakow May 24, 2024

Choose a reason for hiding this comment

luacmartins May 27, 2024

Choose a reason for hiding this comment

jnowakow Jun 3, 2024

Choose a reason for hiding this comment

Kicu left a comment

Choose a reason for hiding this comment

allroundexperts commented May 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

luacmartins left a comment

Choose a reason for hiding this comment

allroundexperts commented May 27, 2024

trjExpensify commented May 28, 2024

allroundexperts commented May 28, 2024

allroundexperts commented May 28, 2024

jnowakow commented May 29, 2024 • edited Loading

luacmartins commented May 29, 2024

jnowakow commented May 29, 2024

luacmartins commented May 29, 2024

luacmartins commented May 30, 2024

allroundexperts commented May 30, 2024

luacmartins commented May 30, 2024

allroundexperts commented May 30, 2024

allroundexperts commented May 31, 2024

luacmartins commented May 31, 2024

allroundexperts commented May 31, 2024

luacmartins commented May 31, 2024

allroundexperts commented May 31, 2024

allroundexperts commented May 31, 2024

allroundexperts left a comment

Choose a reason for hiding this comment

luacmartins commented Jun 13, 2024

github-actions bot commented Jun 13, 2024

jnowakow commented May 23, 2024 •

edited

Loading

github-actions bot commented May 23, 2024 •

edited

Loading

allroundexperts commented May 27, 2024 •

edited

Loading

jnowakow commented May 29, 2024 •

edited

Loading