Clean up Reanimated warnings #49587

BartoszGrajdek · 2024-09-23T08:53:06Z

Details

Somewhere between react-native-reanimated 3.8 and 3.13 a new dev warning was added to make worklet closures more strict and prevent common developer errors.

The warning mentioned earlier has been disabled in the following pull request: #48330. This action was taken to address these notifications systematically and later reinstate them. The main focus of this PR is to reactivate the reanimated warning while fixing any existing errors.

Upstream PR for patch: computerjazz/react-native-draggable-flatlist#551

Fixed Issues

$ #48361

Tests

Important

This warning is disabled currently on main, so if you want to compare anything with the latest changes you first need to remove this line on main branch

App/src/App.tsx

Lines 53 to 55 in bbc0919

    
           // We silence this warning for now and will address all the places where it happens separately. 
        
           // Then we can remove this line so the problem does not occur in the future. 
        
           '[Reanimated] Tried to modify key `current`',

The goal is to make sure that the warning [Reanimated] Tried to modify key current... doesn't happen anywhere in the app.

Though we don't have specific testing steps, it's best to thoroughly check the entire app (which I've already done). Pay particular attention to essential functions like:

Creating money requests / tasks
Overall chat experience like sending messages, reacting to them etc.
Navigating throughout the app
Managing workspaces / members

Offline tests

Same as above

QA Steps

Same as above

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

BartoszGrajdek · 2024-09-23T13:51:23Z

patches/react-native-draggable-flatlist+4.0.1.patch

@@ -0,0 +1,94 @@
+diff --git a/node_modules/react-native-draggable-flatlist/src/components/DraggableFlatList.tsx b/node_modules/react-native-draggable-flatlist/src/components/DraggableFlatList.tsx


This patch file comes from here. Someone already created a PR containing these changes to be added into react-native-draggable-flatlist but for now we need to handle this error using a patch.

melvin-bot · 2024-09-23T13:51:47Z

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

hoangzinh · 2024-09-24T10:27:34Z

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

Screen.Recording.2024-09-26.at.21.54.48.android.mov

Android: mWeb Chrome

Screen.Recording.2024-09-26.at.21.57.46.android.chrome.mov

iOS: Native

Screen.Recording.2024-09-26.at.22.02.17.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-09-26.at.22.00.21.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-25.at.22.58.37.web.mov

MacOS: Desktop

Screen.Recording.2024-09-25.at.23.05.33.desktop.mov

hoangzinh · 2024-09-25T16:38:17Z

@BartoszGrajdek the warning still shows in the Expense -> Distance request

Screen.Recording.2024-09-25.at.23.36.32.mov

BartoszGrajdek · 2024-09-26T08:38:14Z

@hoangzinh have you reinstalled the node_modules and did all the patches apply correctly?

hoangzinh · 2024-09-26T14:49:16Z

oh you're right, after reinstall node_modules, it works properly

hoangzinh

LGTM

OSBotify · 2024-09-28T18:42:36Z

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

github-actions · 2024-09-30T22:57:26Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.42-0 🚀

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

github-actions · 2024-10-02T00:20:18Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.42-3 🚀

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

feat: fix reanimated console warnings

15acd10

BartoszGrajdek commented Sep 23, 2024

View reviewed changes

BartoszGrajdek marked this pull request as ready for review September 23, 2024 13:51

BartoszGrajdek requested a review from a team as a code owner September 23, 2024 13:51

melvin-bot bot requested a review from hoangzinh September 23, 2024 13:51

melvin-bot bot removed the request for review from a team September 23, 2024 13:51

BartoszGrajdek mentioned this pull request Sep 23, 2024

[HOLD for payment 2024-10-08] Clean up Reanimated warnings #48361

Closed

hoangzinh approved these changes Sep 26, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham September 26, 2024 15:05

roryabraham approved these changes Sep 28, 2024

View reviewed changes

roryabraham merged commit 3047c1b into Expensify:main Sep 28, 2024
18 of 19 checks passed

github-actions bot mentioned this pull request Sep 30, 2024

Deploy Checklist: New Expensify 2024-09-30 #49960

Closed

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up Reanimated warnings #49587

Clean up Reanimated warnings #49587

BartoszGrajdek commented Sep 23, 2024 •

edited by roryabraham

Loading

BartoszGrajdek Sep 23, 2024

melvin-bot bot commented Sep 23, 2024

hoangzinh commented Sep 24, 2024 •

edited

Loading

hoangzinh commented Sep 25, 2024

BartoszGrajdek commented Sep 26, 2024

hoangzinh commented Sep 26, 2024

hoangzinh left a comment

OSBotify commented Sep 28, 2024

github-actions bot commented Sep 30, 2024

github-actions bot commented Oct 2, 2024

	// We silence this warning for now and will address all the places where it happens separately.
	// Then we can remove this line so the problem does not occur in the future.
	'[Reanimated] Tried to modify key `current`',

		@@ -0,0 +1,94 @@
		diff --git a/node_modules/react-native-draggable-flatlist/src/components/DraggableFlatList.tsx b/node_modules/react-native-draggable-flatlist/src/components/DraggableFlatList.tsx

Clean up Reanimated warnings #49587

Clean up Reanimated warnings #49587

Conversation

BartoszGrajdek commented Sep 23, 2024 • edited by roryabraham Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

BartoszGrajdek Sep 23, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Sep 23, 2024

hoangzinh commented Sep 24, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh commented Sep 25, 2024

BartoszGrajdek commented Sep 26, 2024

hoangzinh commented Sep 26, 2024

hoangzinh left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 28, 2024

github-actions bot commented Sep 30, 2024

github-actions bot commented Oct 2, 2024

BartoszGrajdek commented Sep 23, 2024 •

edited by roryabraham

Loading

hoangzinh commented Sep 24, 2024 •

edited

Loading