fix: android app crash fix due to wrong position of LayoutAnimation #18842

allroundexperts · 2023-05-12T15:28:29Z

Details

This PR fixes crash on Android that happens due to incorrect usage of LayoutAnimation.

Fixed Issues

$ #18793
PROPOSAL: #18793 (comment)

Tests

Login to NewDot on Android (Pixel 4 preferably)
Open any chat, focus on compose box
Input any mention that has just a single suggestion. Enter it quickly.
The press backspace to clear the input and repeat the above step as fast as possible.
Verify that no error occurs / app does not crash

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Login to NewDot on Android (Pixel 4 preferably)
Open any chat, focus on compose box
Input any mention that has just a single suggestion. Enter it quickly.
The press backspace to clear the input and repeat the above step as fast as possible.
Verify that no error occurs / app does not crash

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-12.at.8.10.30.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-12.at.8.14.57.PM.mov

Mobile Web - Safari

Screen.Recording.2023-05-12.at.8.19.54.PM.mov

Desktop

Screen.Recording.2023-05-12.at.8.12.51.PM.mov

iOS

Screen.Recording.2023-05-12.at.8.18.46.PM.mov

Android

Screen.Recording.2023-05-12.at.8.01.23.PM.mov

melvin-bot · 2023-05-12T15:28:35Z

@puneetlath @fedirjh One of you needs to 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]

github-actions · 2023-05-12T16:02:01Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

mollfpr · 2023-05-12T16:19:12Z

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

Screenshots/Videos

Web

18842.Web.mov

Mobile Web - Chrome

18842.mWeb.Chrome.mp4

Mobile Web - Safari

18842.mWeb.Safari.mp4

Desktop

18842.Desktop.mov

iOS

18842.iOS.mp4

Android

18842.Android.mp4

mollfpr · 2023-05-12T16:19:47Z

Still completing the records...

mollfpr

Tests well 🚀

puneetlath

Thanks for the quick work!

fix: android app crash fix due to wrong position of LayoutAnimation (cherry picked from commit 101a3e2)

…-18842 🍒 Cherry pick PR #18842 to staging 🍒

OSBotify · 2023-05-12T17:57:09Z

🚀 Cherry-picked to staging by https://github.com/puneetlath in version: 1.3.13-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

Pujan92 · 2023-05-13T12:23:31Z

@allroundexperts @mollfpr won't the suggested change of the earlier LayoutAnimation call will kill the animation effect which we had for the suggestions?

Before this PR demo

anima.webm

After this PR demo

anim2.webm

allroundexperts · 2023-05-13T12:25:06Z

@allroundexperts @mollfpr won't the suggested change of the earlier LayoutAnimation call will kill the animation effect?

Current android demo

anima.webm

@Pujan92 I don't think so. According to the documentation of RN, this should be called before the state change.

Pujan92 · 2023-05-13T12:34:10Z

@allroundexperts I just updated the screencasts for both scenarios and I did notice the change in the suggestion animation.

this should be called before the state change.

Yes, but here after calling animation we are doing some execution for getting the suggested options before changing the state. Maybe we can take the states from both the methods and update the state in one go and before that, we can call this animation call.

allroundexperts · 2023-05-13T12:40:59Z

@allroundexperts I just updated the screencasts for both scenarios and I did notice the change in the suggestion animation.

this should be called before the state change.

Yes, but here after calling animation we are doing some execution for getting the suggested options before changing the state. Maybe we can take the states from both the methods and update the state in one go and before that, we can call this animation call.

Hm... @Pujan92 Looking at the video at 0.25x, from 1s-2s, I can notice a minute difference. But from 4s - 5s, I can't notice any difference between the two. Do you have the same observation as well?

Pujan92 · 2023-05-15T05:57:39Z

Hm... @Pujan92 Looking at the video at 0.25x, from 1s-2s, I can notice a minute difference. But from 4s - 5s, I can't notice any difference between the two. Do you have the same observation as well?

I am not exactly getting you but difference in animation can be seen.

OSBotify · 2023-05-15T08:23:30Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

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

puneetlath · 2023-05-15T17:39:03Z

Hmm, I'm also having a hard time seeing it in the video. @mollfpr do you see it?

mollfpr · 2023-05-15T18:19:20Z

I see a difference where the after-video feels instant on the emoji suggestion container changed. IMO is not a big deal, but I like a smooth transition. If we consist about the animation, then we should come up with other solutions that improve the animation and not crash the app.

Pujan92 · 2023-05-15T19:07:36Z

@mollfpr @puneetlath the call of LayoutAnimation was actually added for smooth transition only, so if it is not needed then we can take out that call entirely. If we are still in favor of the transition then I have added a new proposal in case it gets consider.

puneetlath · 2023-05-15T19:42:02Z

@Pujan92 I went ahead and created a separate issue for it here: #18974

Can you post your proposal there?

Pujan92 · 2023-05-15T19:54:44Z

Thanks @puneetlath. Actually mentioned proposal isn't solving the actual issue of the app crash, so will rethink and make the proposal.

allroundexperts · 2023-05-15T19:56:07Z

Thanks @puneetlath. Actually mentioned proposal isn't solving the actual issue of the app crash, so will rethink and make the proposal.

@Pujan92 I think we should use https://docs.swmansion.com/react-native-reanimated/ as we are using on login page for Animations.

Pujan92 · 2023-05-15T20:13:15Z

@allroundexperts maybe but I don't have much exposure to it.

bernhardoj · 2023-05-16T10:54:55Z

I would like to join the discussion.

I agree that we should call the LayoutAnimation function before setting a state. But, if I understand it correctly, we should call it before setting a state that would change the layout of a component. However, with the changes of this PR, we are scheduling the animation before setting the selection state.

Quoting from the docs, the animation will be executed in the next layout, which I believe the same as the next render. So, because we schedule the animation before setting the selection state, the animation is "consumed" by the rerender of selection change, thus the animation is missing when the suggestion layout changes. It is the same as we remove the LayoutAnimation as pointed out by @Pujan92.

I don't really know exactly what is going wrong, but updating the key extractor of mention suggestion to include the index will solve the issue. Looking at the error stack trace, looks like the view manager confuses which view should be removed when the layout changes.

Btw, I look at the emoji suggestion key extractor as the inspiration for the mention suggestion key extractor.

allroundexperts · 2023-05-16T10:56:49Z

I would like to join the discussion.

I agree that we should call the LayoutAnimation function before setting a state. But, if I understand it correctly, we should call it before setting a state that would change the layout of a component. However, with the changes of this PR, we are scheduling the animation before setting the selection state.
Quoting from the docs, the animation will be executed in the next layout, which I believe the same as the next render. So, because we schedule the animation before setting the selection state, the animation is "consumed" by the rerender of selection change, thus the animation is missing when the suggestion layout changes. It is the same as we remove the LayoutAnimation as pointed out by @Pujan92.
I don't really know exactly what is going wrong, but updating the key extractor of mention suggestion to include the index will solve the issue. Looking at the error stack trace, looks like the view manager confuses which view should be removed when the layout changes.

@bernhardoj Since we're on it, doesn't it make sense to use react-native-reanimated library as we're using it on login page?

bernhardoj · 2023-05-16T11:10:26Z

I think using reanimated sounds good.

Pujan92 · 2023-05-16T12:24:44Z

but updating the key extractor of mention suggestion to include the index will solve the issue. Looking at the error stack trace, looks like the view manager confuses which view should be removed when the layout changes.

@bernhardoj I also observed the same. Seems entries with the same key when gets changed the order in the options then the empty option for that row can be observed.

Screen.Recording.2023-05-16.at.5.45.08.PM.mp4

puneetlath · 2023-05-17T14:15:53Z

We have an issue for fixing here if anyone wants to lay out a proposal for how to do it: #18974

Using reanimated sounds good to me.

bernhardoj · 2023-05-17T14:20:20Z

I think @allroundexperts can handle that as he is the one that propose the idea of using reanimated and technically the missing animation is a regression.

allroundexperts · 2023-05-17T14:22:15Z

@puneetlath I'll put in a proposal for this today.

s77rt · 2023-06-06T22:12:59Z

src/pages/home/report/ReportActionCompose.js

@@ -301,6 +301,7 @@ class ReportActionCompose extends React.Component {
    }

    onSelectionChange(e) {
+        LayoutAnimation.configureNext(LayoutAnimation.create(50, LayoutAnimation.Types.easeInEaseOut, LayoutAnimation.Properties.opacity));


@allroundexperts I guess it's safe to remove this line? Is it doing anything useful?

Yes, its safe to remove it. But we should replace it with an equivalent animation.

I assume #19933 is already the equivalent here, so we can move ahead and remove it?

OSBotify · 2023-06-15T01:30:33Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-16T18:48:22Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

fix: android app crash fix due to wrong position of LayoutAnimation

80a780d

allroundexperts requested a review from a team as a code owner May 12, 2023 15:28

melvin-bot bot requested review from fedirjh and puneetlath and removed request for a team May 12, 2023 15:28

allroundexperts mentioned this pull request May 12, 2023

[HOLD for payment 2023-05-23] [HOLD for payment 2023-05-22] [$1000] Android - App crashes upon inputting @ with characters for specific accounts #18793

Closed

6 tasks

Beamanator mentioned this pull request May 12, 2023

Deploy Checklist: New Expensify 2023-05-11 #18764

Closed

51 tasks

puneetlath requested review from mollfpr and removed request for fedirjh May 12, 2023 15:59

puneetlath added the CP Staging label May 12, 2023

mollfpr approved these changes May 12, 2023

View reviewed changes

puneetlath approved these changes May 12, 2023

View reviewed changes

puneetlath merged commit 101a3e2 into Expensify:main May 12, 2023
13 checks passed

OSBotify pushed a commit that referenced this pull request May 12, 2023

Merge pull request #18842 from allroundexperts/fix-18793

b5b35fd

fix: android app crash fix due to wrong position of LayoutAnimation (cherry picked from commit 101a3e2)

OSBotify mentioned this pull request May 12, 2023

🍒 Cherry pick PR #18842 to staging 🍒 #18846

Merged

OSBotify added a commit that referenced this pull request May 12, 2023

Merge pull request #18846 from Expensify/OSBotify-cherry-pick-staging…

010ca0f

…-18842 🍒 Cherry pick PR #18842 to staging 🍒

OSBotify mentioned this pull request May 15, 2023

Deploy Checklist: New Expensify 2023-05-15 #18938

Closed

67 tasks

Pujan92 mentioned this pull request May 15, 2023

[HOLD for payment 2023-06-13] [$2000] Fix auto-suggestion animation on Android #18974

Closed

s77rt reviewed Jun 6, 2023

View reviewed changes

OSBotify mentioned this pull request Jun 15, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

sobitneupane mentioned this pull request Jun 15, 2023

[$2000] Dev: IOS - Chat - Console error on dismiss keyboard without sending message #20552

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: android app crash fix due to wrong position of LayoutAnimation #18842

fix: android app crash fix due to wrong position of LayoutAnimation #18842

allroundexperts commented May 12, 2023 •

edited

Loading

melvin-bot bot commented May 12, 2023

github-actions bot commented May 12, 2023

mollfpr commented May 12, 2023 •

edited

Loading

mollfpr commented May 12, 2023

mollfpr left a comment

puneetlath left a comment

OSBotify commented May 12, 2023

Pujan92 commented May 13, 2023 •

edited

Loading

allroundexperts commented May 13, 2023 •

edited

Loading

Pujan92 commented May 13, 2023 •

edited

Loading

allroundexperts commented May 13, 2023

Pujan92 commented May 15, 2023

OSBotify commented May 15, 2023

puneetlath commented May 15, 2023

mollfpr commented May 15, 2023

Pujan92 commented May 15, 2023

puneetlath commented May 15, 2023

Pujan92 commented May 15, 2023

allroundexperts commented May 15, 2023

Pujan92 commented May 15, 2023

bernhardoj commented May 16, 2023 •

edited

Loading

allroundexperts commented May 16, 2023

bernhardoj commented May 16, 2023

Pujan92 commented May 16, 2023

puneetlath commented May 17, 2023

bernhardoj commented May 17, 2023

allroundexperts commented May 17, 2023

s77rt Jun 6, 2023

allroundexperts Jun 6, 2023

s77rt Jun 7, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

fix: android app crash fix due to wrong position of LayoutAnimation #18842

fix: android app crash fix due to wrong position of LayoutAnimation #18842

Conversation

allroundexperts commented May 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 12, 2023

github-actions bot commented May 12, 2023

mollfpr commented May 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented May 12, 2023

mollfpr left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

OSBotify commented May 12, 2023

Pujan92 commented May 13, 2023 • edited Loading

allroundexperts commented May 13, 2023 • edited Loading

Pujan92 commented May 13, 2023 • edited Loading

allroundexperts commented May 13, 2023

Pujan92 commented May 15, 2023

OSBotify commented May 15, 2023

puneetlath commented May 15, 2023

mollfpr commented May 15, 2023

Pujan92 commented May 15, 2023

puneetlath commented May 15, 2023

Pujan92 commented May 15, 2023

allroundexperts commented May 15, 2023

Pujan92 commented May 15, 2023

bernhardoj commented May 16, 2023 • edited Loading

allroundexperts commented May 16, 2023

bernhardoj commented May 16, 2023

Pujan92 commented May 16, 2023

puneetlath commented May 17, 2023

bernhardoj commented May 17, 2023

allroundexperts commented May 17, 2023

s77rt Jun 6, 2023

Choose a reason for hiding this comment

allroundexperts Jun 6, 2023

Choose a reason for hiding this comment

s77rt Jun 7, 2023

Choose a reason for hiding this comment

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

allroundexperts commented May 12, 2023 •

edited

Loading

mollfpr commented May 12, 2023 •

edited

Loading

Pujan92 commented May 13, 2023 •

edited

Loading

allroundexperts commented May 13, 2023 •

edited

Loading

Pujan92 commented May 13, 2023 •

edited

Loading

bernhardoj commented May 16, 2023 •

edited

Loading