[TS migration] Migrate react-native-onyx mock #35674

ruben-rebelo · 2024-02-02T15:30:50Z

Details

[TS migration] Migrate react-native-onyx mock to typescript

Fixed Issues

$ #25248
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Run Unit tests works as before

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

Screenshots/Videos

Android: Native

N/a

Android: mWeb Chrome

N/a

iOS: Native

N/a

iOS: mWeb Safari

N/a

MacOS: Chrome / Safari

N/a

MacOS: Desktop

N/a

rezkiy37 · 2024-02-06T12:26:05Z

__mocks__/react-native-onyx.ts

+
+export default reactNativeOnyxMock;
+export {withOnyx};
+/* eslint-enable rulesdir/prefer-onyx-connect-in-libs */


Should we enable the rule at the end of a file?

I don't think we need to enable it again @ruben-rebelo 🤔

You are right! This is a left-over, removing it! Thank you!

SzymczakJ

LGTM

melvin-bot · 2024-02-09T12:04:50Z

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

ishpaul777 · 2024-02-09T14:43:41Z

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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Screenshot

ishpaul777

LGTM! 🎉🚀

melvin-bot · 2024-02-09T15:18:12Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25248 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

ishpaul777

Approving again to trigger melvin assignment to a internal engineer.

cead22 · 2024-02-13T01:09:16Z

__mocks__/react-native-onyx.ts

@@ -0,0 +1,38 @@
+/* eslint-disable rulesdir/prefer-onyx-connect-in-libs */


Can we get rid of this, or add a comment explaining why we need it here?

We can't get rid of this but I've added a comment explaining the reason we are disabling the rule.
Please have a look.

cead22

Thanks! I left a few minor aesthetic comments, but the code looks good

cead22 · 2024-02-14T19:34:50Z

__mocks__/react-native-onyx.ts

@@ -0,0 +1,44 @@
+/**
+ * We are disabling the lint rule that doesn't allow the usage of connect onyx outside libs


Suggested change

* We are disabling the lint rule that doesn't allow the usage of connect onyx outside libs

* We are disabling the lint rule that doesn't allow the usage of Onyx.connect outside libs

cead22 · 2024-02-14T19:34:54Z

__mocks__/react-native-onyx.ts

+/**
+ * We are disabling the lint rule that doesn't allow the usage of connect onyx outside libs
+ * because the intent of this file is to mock the usage of react-native-onyx so we will have to mock the connect function
+ * as this is a file outside of the lib folder we need to disable it


This is already stated in the comment

Suggested change

* as this is a file outside of the lib folder we need to disable it

cead22 · 2024-02-14T19:35:01Z

__mocks__/react-native-onyx.ts

+ * because the intent of this file is to mock the usage of react-native-onyx so we will have to mock the connect function
+ * as this is a file outside of the lib folder we need to disable it
+ */
+


Suggested change

ruben-rebelo · 2024-02-20T12:41:41Z

@cead22 Updated, thank you!

OSBotify · 2024-02-20T18:13:37Z

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

OSBotify · 2024-02-26T21:05:47Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.44-0 🚀

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

kavimuru · 2024-02-26T21:36:01Z

@ruben-rebelo I think it is internal.

kavimuru · 2024-02-27T14:37:56Z

@ishpaul777 could you confirm if this is internal testing?

ishpaul777 · 2024-02-27T14:40:00Z

Yes, no QA for ts migration

OSBotify · 2024-02-28T23:54:23Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

ruben-rebelo added 3 commits February 2, 2024 15:30

[TS migration] Migrate react-native-onyx mock

b0c8780

[TS migration][react-native-onyx mock] Addressed suggestion

20ad77b

Merge branch 'main' into ts-migration/react-native-onyx-mock

732c20e

rezkiy37 reviewed Feb 6, 2024

View reviewed changes

[TS migration][react-native-onyx-mock] Fixed lint

ffebb9c

fabioh8010 approved these changes Feb 7, 2024

View reviewed changes

Merge branch 'main' into ts-migration/react-native-onyx-mock

50d1404

SzymczakJ approved these changes Feb 9, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review February 9, 2024 12:04

ruben-rebelo requested a review from a team as a code owner February 9, 2024 12:04

melvin-bot bot removed the request for review from a team February 9, 2024 12:04

melvin-bot bot requested a review from ishpaul777 February 9, 2024 12:04

ishpaul777 approved these changes Feb 9, 2024

View reviewed changes

ishpaul777 approved these changes Feb 12, 2024

View reviewed changes

melvin-bot bot requested a review from cead22 February 12, 2024 19:21

cead22 requested changes Feb 13, 2024

View reviewed changes

ruben-rebelo added 2 commits February 14, 2024 12:27

[TS migration][react-native-onyx] Added comment on the disabled rule

b5b642b

[TS migration][react-native-onyx] Prettier run

52408bb

cead22 requested changes Feb 14, 2024

View reviewed changes

ruben-rebelo added 2 commits February 20, 2024 10:08

Merge branch 'main' into ts-migration/react-native-onyx-mock

3fd24ea

[TS migration][react-native-onyx] Feedback addressed

83a5b3b

[TS migration] Prettier run

7fdbd4b

cead22 approved these changes Feb 20, 2024

View reviewed changes

cead22 merged commit e4051a8 into Expensify:main Feb 20, 2024
15 checks passed

ruben-rebelo deleted the ts-migration/react-native-onyx-mock branch February 22, 2024 09:37

github-actions bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate react-native-onyx mock #35674

[TS migration] Migrate react-native-onyx mock #35674

ruben-rebelo commented Feb 2, 2024 •

edited

Loading

rezkiy37 Feb 6, 2024

fabioh8010 Feb 6, 2024

ruben-rebelo Feb 7, 2024

SzymczakJ left a comment

melvin-bot bot commented Feb 9, 2024

ishpaul777 commented Feb 9, 2024 •

edited

Loading

ishpaul777 left a comment

melvin-bot bot commented Feb 9, 2024

ishpaul777 left a comment

cead22 Feb 13, 2024

ruben-rebelo Feb 14, 2024

cead22 left a comment

cead22 Feb 14, 2024

cead22 Feb 14, 2024 •

edited

Loading

cead22 Feb 14, 2024

ruben-rebelo commented Feb 20, 2024

OSBotify commented Feb 20, 2024

OSBotify commented Feb 26, 2024

kavimuru commented Feb 26, 2024

kavimuru commented Feb 27, 2024

ishpaul777 commented Feb 27, 2024

OSBotify commented Feb 28, 2024

		@@ -0,0 +1,38 @@
		/* eslint-disable rulesdir/prefer-onyx-connect-in-libs */

		@@ -0,0 +1,44 @@
		/**
		* We are disabling the lint rule that doesn't allow the usage of connect onyx outside libs

[TS migration] Migrate react-native-onyx mock #35674

[TS migration] Migrate react-native-onyx mock #35674

Conversation

ruben-rebelo commented Feb 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 Feb 6, 2024

Choose a reason for hiding this comment

fabioh8010 Feb 6, 2024

Choose a reason for hiding this comment

ruben-rebelo Feb 7, 2024

Choose a reason for hiding this comment

SzymczakJ left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Feb 9, 2024

ishpaul777 commented Feb 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Feb 9, 2024

ishpaul777 left a comment

Choose a reason for hiding this comment

cead22 Feb 13, 2024

Choose a reason for hiding this comment

ruben-rebelo Feb 14, 2024

Choose a reason for hiding this comment

cead22 left a comment

Choose a reason for hiding this comment

cead22 Feb 14, 2024

Choose a reason for hiding this comment

cead22 Feb 14, 2024 • edited Loading

Choose a reason for hiding this comment

cead22 Feb 14, 2024

Choose a reason for hiding this comment

ruben-rebelo commented Feb 20, 2024

OSBotify commented Feb 20, 2024

OSBotify commented Feb 26, 2024

kavimuru commented Feb 26, 2024

kavimuru commented Feb 27, 2024

ishpaul777 commented Feb 27, 2024

OSBotify commented Feb 28, 2024

ruben-rebelo commented Feb 2, 2024 •

edited

Loading

ishpaul777 commented Feb 9, 2024 •

edited

Loading

cead22 Feb 14, 2024 •

edited

Loading