Skip to content

Enable ESLint rule / DEV alert() to match with useOnyx canBeMissing option #59191

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

Merged

Conversation

fabioh8010
Copy link
Contributor

@fabioh8010 fabioh8010 commented Mar 26, 2025

Explanation of Change

Fixed Issues

$ #58499
PROPOSAL:

Tests

  1. Change one of the useOnyx()s of FreeTrial.tsx component to set the canBeMissing flag.
    diff --git a/src/pages/settings/Subscription/FreeTrial.tsx b/src/pages/settings/Subscription/FreeTrial.tsx
    index 1d82614d66f..b3872873c3f 100644
    --- a/src/pages/settings/Subscription/FreeTrial.tsx
    +++ b/src/pages/settings/Subscription/FreeTrial.tsx
    @@ -23,7 +23,7 @@ type FreeTrialProps = {
    function FreeTrial({badgeStyles, pressable = false, addSpacing = false, success = true, inARow = false}: FreeTrialProps) {
        const styles = useThemeStyles();
        const [policies] = useOnyx(ONYXKEYS.COLLECTION.POLICY);
    -    const [firstDayFreeTrial] = useOnyx(ONYXKEYS.NVP_FIRST_DAY_FREE_TRIAL);
    +    const [firstDayFreeTrial] = useOnyx(ONYXKEYS.NVP_FIRST_DAY_FREE_TRIAL, {canBeMissing: false});
        const [lastDayFreeTrial] = useOnyx(ONYXKEYS.NVP_LAST_DAY_FREE_TRIAL);
        const [privateSubscription] = useOnyx(ONYXKEYS.NVP_PRIVATE_SUBSCRIPTION);
    
    
  2. Create a new account and sign in.
  3. Switch between Settings and Inbox in order to trigger the alert.
  4. Assert an alert is displayed both visually and in the console.
  • Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Not possible for QA to test this.

  • 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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(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.
  • 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
Screen.Recording.2025-03-24.at.17.06.34-compressed.mov
Android: mWeb Chrome

I'm having problems with my emulators when opening the Chrome app (they crash instantly), so I couldn't record videos for this platform.

iOS: Native
Screen.Recording.2025-03-24.at.17.38.16-compressed.mov
iOS: mWeb Safari
Screen.Recording.2025-03-24.at.17.39.48-compressed.mov
MacOS: Chrome / Safari
Screen.Recording.2025-03-24.at.17.42.18-compressed.mov
Screen.Recording.2025-03-24.at.17.43.10-compressed.mov
MacOS: Desktop
Screen.Recording.2025-03-24.at.17.46.40-compressed.mov

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. ⚠️

@TMisiukiewicz
Copy link
Contributor

Can we bump Onyx straight to 2.0.96 so my PR gets there as well?

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. ⚠️

@fabioh8010 fabioh8010 changed the title [WIP] Bump Onyx / ESLint to match with useOnyx canBeMissing option [HOLD react-native-onyx/pull/624] Bump Onyx / ESLint to match with useOnyx canBeMissing option Mar 28, 2025
@fabioh8010 fabioh8010 marked this pull request as ready for review March 28, 2025 19:20
@fabioh8010 fabioh8010 requested a review from a team as a code owner March 28, 2025 19:20
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team March 28, 2025 19:20
Copy link

melvin-bot bot commented Mar 28, 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]

@fabioh8010 fabioh8010 changed the title [HOLD react-native-onyx/pull/624] Bump Onyx / ESLint to match with useOnyx canBeMissing option [WIP][HOLD react-native-onyx/pull/624] Bump Onyx / ESLint to match with useOnyx canBeMissing option Mar 28, 2025
@fabioh8010
Copy link
Contributor Author

This PR is waiting for Expensify/react-native-onyx#624 to be merged and available in a new release so we can use it here.

Additionally, in order to keep the changes scoped I won't fix the ESLint errors (that are caused by the rule enabled in this very PR)

Copy link
Contributor

github-actions bot commented Apr 2, 2025

⚠️ 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. ⚠️

@fabioh8010 fabioh8010 changed the title [WIP][HOLD react-native-onyx/pull/624] Bump Onyx / ESLint to match with useOnyx canBeMissing option Bump Onyx / ESLint to match with useOnyx canBeMissing option Apr 2, 2025
@fabioh8010
Copy link
Contributor Author

This PR is waiting for Expensify/react-native-onyx#624 to be merged and available in a new release so we can use it here.

Additionally, in order to keep the changes scoped I won't fix the ESLint errors (that are caused by the rule enabled in this very PR)

PR is ready to review @parasharrajat @iwiznia

@parasharrajat
Copy link
Member

parasharrajat commented Apr 2, 2025

I believe the first time every key will always be empty. It needs to be loaded from the backend then this logic will alert it.

So we are saying we will migrate all the useOnyx calls to have this key, which should not alert. Is that correct?

@parasharrajat
Copy link
Member

parasharrajat commented Apr 3, 2025

Screenshots

🔲 iOS / native

04.04.2025_01.19.42_REC.mp4

🔲 iOS / Safari

🔲 MacOS / Desktop

04.04.2025_00.31.09_REC.mp4

🔲 MacOS / Chrome

image

🔲 Android / Chrome

🔲 Android / native

image

@parasharrajat
Copy link
Member

parasharrajat commented Apr 3, 2025

It would have been great if this showed the key name as well.
image

Copy link
Contributor

github-actions bot commented Apr 7, 2025

⚠️ 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. ⚠️

@fabioh8010
Copy link
Contributor Author

I believe the first time every key will always be empty. It needs to be loaded from the backend then this logic will alert it.

So we are saying we will migrate all the useOnyx calls to have this key, which should not alert. Is that correct?

@parasharrajat The plan is to migrate all useOnyx calls to specify this flag, to be true or false. If we put true` the hook won't alert anything, otherwise it will alert if data from that Onyx key is undefined.

But after thinking about it for a while, I just feel that we'll end up marking almost useOnyx with canBeMissing set to true. I think it's just hard to predict if a Onyx key will always have some data or not.

@iwiznia WDYT about this?

@fabioh8010 fabioh8010 changed the title Bump Onyx / ESLint to match with useOnyx canBeMissing option Enable ESLint rule / DEV alert() to match with useOnyx canBeMissing option Apr 9, 2025
@fabioh8010
Copy link
Contributor Author

@parasharrajat @iwiznia

Looks like there was a newer Onyx Bump PR which was merged today, so this PR is focusing now only in enabling the ESLint rule and the DEV alert().

@iwiznia
Copy link
Contributor

iwiznia commented Apr 9, 2025

But after thinking about it for a while, I just feel that we'll end up marking almost useOnyx with canBeMissing set to true. I think it's just hard to predict if a Onyx key will always have some data or not.

It's fine to set most of them to true as long as the code is ready to handle that, the problem right now is that a lot of places just assume some data will be loaded when it is not.

iwiznia
iwiznia previously approved these changes Apr 9, 2025
Copy link
Contributor

@iwiznia iwiznia left a comment

Choose a reason for hiding this comment

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

Looks good but you need to add the flag to the calls in Expensify.ts file, no?

@parasharrajat
Copy link
Member

We should update the Expensify.tsx file.

const [screenShareRequest] = useOnyx(ONYXKEYS.SCREEN_SHARE_REQUEST);
const [focusModeNotification] = useOnyx(ONYXKEYS.FOCUS_MODE_NOTIFICATION, {initWithStoredValues: false});
const [lastVisitedPath] = useOnyx(ONYXKEYS.LAST_VISITED_PATH);
const [account] = useOnyx(ONYXKEYS.ACCOUNT, {canBeMissing: true});
Copy link
Contributor

Choose a reason for hiding this comment

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

This key can be missing? Is it when you are logged out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • account will alert if i'm logged out and I click one of these

Screenshot 2025-04-15 at 00 35 09

const [account] = useOnyx(ONYXKEYS.ACCOUNT, {canBeMissing: true});
const [session] = useOnyx(ONYXKEYS.SESSION, {canBeMissing: false});
const [lastRoute] = useOnyx(ONYXKEYS.LAST_ROUTE, {canBeMissing: true});
const [userMetadata] = useOnyx(ONYXKEYS.USER_METADATA, {canBeMissing: true});
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • lastRoute and screenShareRequest will alert during every refresh, even if logged in
  • userMetadata will alert if logged out

@fabioh8010 fabioh8010 requested a review from iwiznia April 14, 2025 23:37
@melvin-bot melvin-bot bot requested a review from iwiznia April 15, 2025 14:39
@iwiznia iwiznia merged commit 316a0d1 into Expensify:main Apr 15, 2025
26 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/iwiznia in version: 9.1.29-0 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

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.

5 participants