Onyx derived values #56891
Onyx derived values #56891
Conversation
| @@ -1,19 +1,18 @@ | |||
| import type {ComponentType, ForwardedRef, ReactElement, RefAttributes} from 'react'; | |||
| import React from 'react'; | |||
| import {View} from 'react-native'; | |||
| import type {SetOptional} from 'type-fest'; | |||
There was a problem hiding this comment.
These changes were only necessary because I upgraded type-fest and a bug fix in that repo exposed existing issues with the types in this code.
# Conflicts: # package-lock.json # package.json
|
@roryabraham Test failed for me. I don't see Steps:
|
|
edit: that wasn't correct. The problem was just in the specific implementation of |
I kept the |
Screenshots🔲 iOS / native
🔲 iOS / Safari
🔲 MacOS / Desktop
🔲 MacOS / Chrome
🔲 Android / Chrome
🔲 Android / native
|
|
Tested a few scenarios around the Concierge chat, and they look good to me. |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
@youssef-lr 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] |
|
🎯 @parasharrajat, thanks for reviewing and testing this PR! 🎉 An E/App issue has been created to issue payment here: #57561. |
# Conflicts: # src/pages/workspace/accounting/PolicyAccountingPage.tsx
| if (OnyxUtils.isCollectionKey(dependencyOnyxKey)) { | ||
| Onyx.connect({ | ||
| key: dependencyOnyxKey, | ||
| waitForCollectionCallback: true, |
There was a problem hiding this comment.
NAB but I think we can simplify this logic by just setting the flag below and getting rid of the the if/else
| waitForCollectionCallback: true, | |
| waitForCollectionCallback: OnyxUtils.isCollectionKey(dependencyOnyxKey), |
There was a problem hiding this comment.
It seems like TS fails with this suggestion. So we'll keep the if/else here.
There was a problem hiding this comment.
This actually causes a type error. I wasn't able to figure out how to fix it. cc @fabioh8010 also spent a bit of time looking into it
There was a problem hiding this comment.
Yeah no luck so far, I will revisit this again to see if I manage to make this work as expected
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.8-0 🚀
|
|
🚀 Deployed to production by https://github.com/puneetlath in version: 9.1.8-1 🚀
|
| // We cast its type to match the tuple expected by config.compute. | ||
| let dependencyValues = new Array(dependencies.length) as Parameters<typeof compute>[0]; | ||
|
|
||
| OnyxUtils.get(key).then((storedDerivedValue) => { |
There was a problem hiding this comment.
I am concerned this OnyxUtils.get() pattern is going to make it's way into the rest of the app and I think that is going to be a very bad pattern for people to follow. I suggest adding an ESLint rule that throws an error on these. We can disable the eslint rule where we need to, but add very explicit comments that the pattern is NOT supposed to be followed.
I've already seen we've struggled to keep the usage of makeRequestWithSideEffects() out of common patterns and I think the same thing is going to happen here.
Is there a reason why get() and tupleGet() are necessary? Why can we not get them from Onyx like we normally would (a connection that immediately disconnects itself)?
There was a problem hiding this comment.
It would be nice to have some comments in this file for why this util is here and how it should be used. Also, a comment to explain why it's OK to disable the eslint error.
| ) => OnyxDerivedValuesMapping[Key]; | ||
| }; | ||
|
|
||
| // eslint-disable-next-line import/prefer-default-export |
There was a problem hiding this comment.
Why not use a default export here? The only reason I wouldn't use one is if you're expecting to immediately be adding more exported methods.
There was a problem hiding this comment.
It appears like this file is only imported in one place. I suggest moving this config only to the file that needs it.
| @@ -849,3 +849,14 @@ In order to compile a production iOS build, run `npm run ios-build`, this will g | |||
|
|
|||
| #### Local production build the Android app | |||
| To build an APK to share run (e.g. via Slack), run `npm run android-build`, this will generate a new APK in the `android/app` folder. | |||
|
|
|||
| # Onyx derived values | |||
There was a problem hiding this comment.
Would you mind moving this to the section specifically about Onyx? https://github.com/Expensify/App?tab=readme-ov-file#onyx
| # Onyx derived values | ||
| Onyx derived values are special Onyx keys which contain values derived from other Onyx values. These are available as a performance optimization, so that if the result of a common computation of Onyx values is needed in many places across the app, the computation can be done only as needed in a centralized location, and then shared across the app. Once created, Onyx derived values are stored and consumed just like any other Onyx value. | ||
|
|
||
| ## Creating new Onyx derived values |
There was a problem hiding this comment.
It would be nice to add a little bit more to this section to explain why you should or shouldn't use derived values. Would you mind adding a bit of details like:
### When should I use derived values?
### When should I avoid using derived values?
Explanation of Change
computefunction, which receives the onyx values for all the dependent keys and must return the type defined for the derived key in ONYXKEYSAny consumers of derived values treat them just like any other Onyx key
Fixed Issues
$ https://expensify.slack.com/archives/C05LX9D6E07/p1739458915155239
Tests
I wrote and updated some automated tests that validated that this code is working, but for the sake of manual testing, some simple tests will do.
24/7 Supportin the chat subheader:this indicates that the derived value for
isConciergeChatReportIDis being correctly read.Offline tests
None.
QA Steps
24/7 Supportin the chat subheader:PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop