Skip to content
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

Update Onyx to version 1.0.55 #23151

Closed

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented Jul 19, 2023

@marcaaron

Details

Update react-native-onyx version to incorporate the JSON_PATCH changes from this PR

Fixed Issues

$ #13972
PROPOSAL:

Tests

Test adding a comment to a report

  1. Open NewDot
  2. Go to a chat/report
  3. Create a new message/comment
  4. Check if data in Onyx is valid.

Check functionality especially on iOS and Android

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as in "Tests", but also check other flows for their functionality.

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
      • 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 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
    • 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
    • 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(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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@chrispader chrispader requested a review from a team as a code owner July 19, 2023 07:33
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and removed request for a team July 19, 2023 07:33
@melvin-bot
Copy link

melvin-bot bot commented Jul 19, 2023

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

@chrispader
Copy link
Contributor Author

@marcaaron this one's for you i guess, i think we won't need an additional C+ here?

@abdulrahuman5196
Copy link
Contributor

Let me know if C+ is required, I can review.

@marcaaron
Copy link
Contributor

Some Jest tests are failing.

Also, yes, C+ will help test on all the platforms (thanks @abdulrahuman5196).

Can we please give some special focus to Android/iOS since we are changing the way storage works there with this PR? I think the changes should be pretty safe so a "smoke test" should be good for this one.

@marcaaron
Copy link
Contributor

Check all flows for their functionality, especially those, where a Onyx.merge (onyxMethod: Onyx.METHOD.MERGE ) is happening

All flows? Not sure if I have time for that today 😄

Maybe we can just test a mainline flow (like adding a comment to a chat) and use that as the smoke test?

We do have QA running regression tests on every release so there is some safety there, but we are the first line of defense 💪

@abdulrahuman5196
Copy link
Contributor

Thank you. I will work on the C+ review. @chrispader Can we fix the failing Unit tests?

@chrispader
Copy link
Contributor Author

Thank you. I will work on the C+ review. @chrispader Can we fix the failing Unit tests?

@abdulrahuman5196 working on it! 👍

@chrispader
Copy link
Contributor Author

@abdulrahuman5196 @marcaaron fixed the tests and other minor issues both in this PR and in this PR in react-native-onyx.

@marcaaron could you please review the additional Onyx PR :)

@chrispader
Copy link
Contributor Author

The changes in Expensify/App are needed, because we don't concatenate arrays when merging anymore...

@abdulrahuman5196
Copy link
Contributor

Giving a another check. It seems we are blocked on another PR from onyx to unblock this PR.

@chrispader
Copy link
Contributor Author

Giving a another check. It seems we are blocked on another PR from onyx to unblock this PR.

yes, exactly. once the other onyx PR is merged and this one is reviewed, we're ready to go!

@marcaaron
Copy link
Contributor

Can we put this one on HOLD so it is not accidentally merged?

Side note: it would be good to send out some kind of PSA in #expensify-open-source so that nobody accidentally moves the Onyx version forward in some other PR. Unlikely, but possible.

@chrispader chrispader changed the title Update Onyx to version 1.0.54 [HOLD for https://github.com/Expensify/react-native-onyx/pull/284] Update Onyx to version 1.0.54 Jul 27, 2023
@chrispader chrispader changed the title [HOLD for https://github.com/Expensify/react-native-onyx/pull/284] Update Onyx to version 1.0.54 [HOLD for https://github.com/Expensify/react-native-onyx/pull/284] Update Onyx to version 1.0.55 Jul 27, 2023
@chrispader chrispader changed the title [HOLD for https://github.com/Expensify/react-native-onyx/pull/284] Update Onyx to version 1.0.55 Update Onyx to version 1.0.55 Jul 27, 2023
@chrispader
Copy link
Contributor Author

@abdulrahuman5196 @marcaaron this PR is ready 👍

@hannojg
Copy link
Contributor

hannojg commented Jul 27, 2023

For me on mobile native the app is crashing when sending messages

@mountiny mountiny changed the title Update Onyx to version 1.0.55 [HOLD] Update Onyx to version 1.0.55 Jul 27, 2023
@chrispader
Copy link
Contributor Author

For me on mobile native the app is crashing when sending messages

The crash wasn't caused by this PR. It was caused by the update to [email protected], which was reverted a few hours ago.

Internally, the __updatePaperProps function called here from reanimated seems to have changed, i didn't investigate it much further than that, but on [email protected] this PR is working again! 👍

@mountiny we should be able to merge it i guess 🚀

@mountiny mountiny changed the title [HOLD] Update Onyx to version 1.0.55 Update Onyx to version 1.0.55 Jul 28, 2023
@mountiny
Copy link
Contributor

🚀 great

@mountiny
Copy link
Contributor

We have updated to .56 here so I think we can close this pr #23749 🚀

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