compute correct Keyboard Height with Notch #30919

fabOnReact · 2021-02-09T11:41:03Z

Summary

fixes #27089 fixes #30191 fixes #26296 fixes #24353
Related #30052 #28004 #26536

The keyboard height of event keyboardDidShow is computed as the difference of two variables:

The screen height excluding the Android Notch
DisplayMetricsHolder.getWindowDisplayMetrics().heightPixels returns the screen height excluding the Android Notch
The Visible Area excluding the Keyboard, but including the Android Notch
getWindowVisibleDisplayFrame() which returns the visible area including the Android Notch

The computation of the keyboard height is wrong when the device has an Android Notch.
This pr adds the Android Notch computation for API levels 28+

More info at #27089 (comment)

Changelog

[Android] [Fixed] - Compute Android Notch in keyboardDidShow height calculation API 28+

Test Plan

adding a ReactRootViewTest for keyboardDidShow verifying correct functionality on API < 28

TEST CASE - BEFORE FIX

WITHOUT NOTCH

The black view on the bottom is visible
The keyboard height is 282

Full Screen	Keyboard Did Show

WITH NOTCH

The black view on the bottom is not visible. The black view is not visible because keyboardDidHide is sending the wrong keyboard height value.
The keyboard height changes to 234. The keyboard height is the same from the previous test, but the value sent from keyboardDidHide changed for the Notch.

Full Screen	Keyboard Did Show

TEST CASE - AFTER FIX

WITH NOTCH

The black view on the bottom is visible
The keyboard height is 282

Full Screen	Keyboard Did Show

analysis-bot

Code analysis results:

google-java-format found some issues. See https://github.com/google/google-java-format

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java

analysis-bot

Code analysis results:

google-java-format found some issues. See https://github.com/google/google-java-format

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java

analysis-bot · 2021-02-09T12:16:35Z

Platform	Engine	Arch	Size (bytes)	Diff
ios	-	universal	n/a	--

Base commit: 3516090

analysis-bot

Code analysis results:

google-java-format found some issues. See https://github.com/google/google-java-format

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java

analysis-bot

Code analysis results:

google-java-format found some issues. See https://github.com/google/google-java-format

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java

analysis-bot

Code analysis results:

google-java-format found some issues. See https://github.com/google/google-java-format

analysis-bot · 2021-02-12T18:10:38Z

ReactAndroid/src/test/java/com/facebook/react/RootViewTest.java

@@ -7,10 +7,19 @@

 package com.facebook.react;

+import com.facebook.react.uimanager.ReactRoot;


google-java-format suggested changes:

@@ -10,7 +9,0 @@ -import com.facebook.react.uimanager.ReactRoot; -import com.facebook.react.bridge.Arguments; -import com.facebook.react.modules.core.DeviceEventManagerModule; -import com.facebook.react.bridge.WritableMap; -import android.util.Log; -import android.graphics.Rect; -

analysis-bot · 2021-02-12T18:10:38Z

ReactAndroid/src/test/java/com/facebook/react/RootViewTest.java

 import static org.fest.assertions.api.Assertions.assertThat;
 import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.eq;
+import org.mockito.Mockito;


google-java-format suggested changes:

@@ -20 +12,0 @@ -import org.mockito.Mockito;

analysis-bot · 2021-02-12T18:10:38Z

ReactAndroid/src/test/java/com/facebook/react/RootViewTest.java

 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;


google-java-format suggested changes:

@@ -22 +13,0 @@ -import static org.mockito.Mockito.spy;

ReactAndroid/src/test/java/com/facebook/react/RootViewTest.java

analysis-bot · 2021-02-15T14:29:13Z

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	7,709,443	-26
android	hermes	armeabi-v7a	7,239,438	-16
android	hermes	x86	8,129,905	-26
android	hermes	x86_64	8,095,108	-23
android	jsc	arm64-v8a	9,628,900	-78
android	jsc	armeabi-v7a	8,546,407	-84
android	jsc	x86	9,643,639	-85
android	jsc	x86_64	10,252,533	-87

Base commit: 3516090

jsamr · 2021-03-24T11:30:22Z

@fabriziobertoglio1987 Do you think it would also address #23693? (the issue was closed but the bug still thrives).

OrLevy23 · 2021-09-27T12:02:39Z

is this something that will be merged? i'm having issues with this

cortinico · 2021-09-27T16:26:29Z

Thanks for your PR @fabriziobertoglio1987.
Don't you mind rebasing? Currently the Android CI is failing with:

log.cpp:56: error: undefined reference to '__android_log_write'

which I believe is due to HEAD being old.
I'll import this internally and look into it tomorrow 👍

facebook-github-bot · 2021-09-27T16:27:06Z

@cortinico has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Without Notch - DisplayMetricsHolder.getWindowDisplayMetrics().heightPixels is 1794 - mVisibleViewArea.bottom is 1794 **With Notch** - DisplayMetricsHolder.getWindowDisplayMetrics().heightPixels is 1668 - mVisibleViewArea.bottom is 1794 Observations: - getWindowVisibleDisplayFrame().heightPixels returns correct height for devices with Notch - mVisibleViewArea.bottom does not take in consideration the notch (the value does not change) Solution: - Including the Notch Height in the Keyboard Height calculation Clear Explanation at facebook#27089 (comment) https://github.com/facebook/react-native/blob/d79212120b7168015d3d0225ef372ed851a230fa/ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java#L757-L758

basic setup of the test passing green verifies that the event is invoked twice Still have to understand why the event is triggered twice I faked the implementation of getWindowVisibleDisplayFrame to simulate the keyboard opening that triggers keyboardDidShow event

@VisibleForTesting

The method has annotation @VisibleForTesting and is available only for testing purposes

facebook-github-bot · 2021-09-28T15:46:29Z

@cortinico has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

cortinico

The change looks good on my end, thanks for doing it 👍
I've manually rebased on your behalf and will wait for a green CI before merging

react-native-bot · 2021-09-28T17:45:05Z

This pull request was successfully merged by @fabriziobertoglio1987 in 8bef3b1.

^{When will my fix make it into a release? | Upcoming Releases}

react-native-bot · 2021-09-28T17:50:04Z

This pull request was successfully merged by @fabriziobertoglio1987 in 8bef3b1.

^{When will my fix make it into a release? | Upcoming Releases}

react-native-bot · 2021-09-28T17:55:05Z

This pull request was successfully merged by @fabriziobertoglio1987 in 8bef3b1.

^{When will my fix make it into a release? | Upcoming Releases}

Summary: Fixes a potential crash was introduced by #30919 that aimed to get the keyboard height on devices with a Notch. The problem is that it considers that any ReactRootView will have an insets available. When using [react-native-navigation](https://github.com/wix/react-native-navigation) and assigning a Navigation button to the TopBar as a component, the component gets registered as a RootView but won't have any insets attach to the view. [getRootWindowInsets()](https://developer.android.com/reference/android/view/View#getRootWindowInsets()) in fact return a `WindowInset` only available if the view is attached, so when executing `checkForKeyboardEvents` method from ReactRootView, is trying to access the `DisplayCutout` of a null object, leading to a crash. ## Changelog [Android] [Fixed] - Fix potential crash if ReactRootView does not have insets attached. Pull Request resolved: #32989 Test Plan: Without the code change: Notice how the second screen being push contains a React Component on the top right of the navigation bar, and when component is unmounted (going back) the app crashes. https://user-images.githubusercontent.com/6757047/151558235-39b9a8b5-be73-4c31-8053-02ce188637b8.mp4 crash log ``` 2022-01-28 10:27:52.902 15600-15600/com.mattermost.rnbeta E/AndroidRuntime: FATAL EXCEPTION: main Process: com.mattermost.rnbeta, PID: 15600 java.lang.NullPointerException: Attempt to invoke virtual method 'android.view.DisplayCutout android.view.WindowInsets.getDisplayCutout()' on a null object reference at com.facebook.react.ReactRootView$CustomGlobalLayoutListener.checkForKeyboardEvents(ReactRootView.java:778) at com.facebook.react.ReactRootView$CustomGlobalLayoutListener.onGlobalLayout(ReactRootView.java:769) at android.view.ViewTreeObserver.dispatchOnGlobalLayout(ViewTreeObserver.java:1061) at android.view.ViewRootImpl.performTraversals(ViewRootImpl.java:3214) at android.view.ViewRootImpl.doTraversal(ViewRootImpl.java:2143) at android.view.ViewRootImpl$TraversalRunnable.run(ViewRootImpl.java:8665) at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1037) at android.view.Choreographer.doCallbacks(Choreographer.java:845) at android.view.Choreographer.doFrame(Choreographer.java:780) at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:1022) at android.os.Handler.handleCallback(Handler.java:938) at android.os.Handler.dispatchMessage(Handler.java:99) at android.os.Looper.loopOnce(Looper.java:201) at android.os.Looper.loop(Looper.java:288) at android.app.ActivityThread.main(ActivityThread.java:7839) at java.lang.reflect.Method.invoke(Native Method) at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:548) at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1003) ``` After applying the patch which is only a null check validation and does not change any previous behavior https://user-images.githubusercontent.com/6757047/151558429-9ff1a608-abb6-4168-8db9-df0c3c71d79e.mp4 Reviewed By: cortinico Differential Revision: D33844955 Pulled By: ShikaSD fbshipit-source-id: ed5579ad3afeed009c61cc1851eee45c70087cf5

…ok#32989) Summary: Fixes a potential crash was introduced by facebook#30919 that aimed to get the keyboard height on devices with a Notch. The problem is that it considers that any ReactRootView will have an insets available. When using [react-native-navigation](https://github.com/wix/react-native-navigation) and assigning a Navigation button to the TopBar as a component, the component gets registered as a RootView but won't have any insets attach to the view. [getRootWindowInsets()](https://developer.android.com/reference/android/view/View#getRootWindowInsets()) in fact return a `WindowInset` only available if the view is attached, so when executing `checkForKeyboardEvents` method from ReactRootView, is trying to access the `DisplayCutout` of a null object, leading to a crash. ## Changelog [Android] [Fixed] - Fix potential crash if ReactRootView does not have insets attached. Pull Request resolved: facebook#32989 Test Plan: Without the code change: Notice how the second screen being push contains a React Component on the top right of the navigation bar, and when component is unmounted (going back) the app crashes. https://user-images.githubusercontent.com/6757047/151558235-39b9a8b5-be73-4c31-8053-02ce188637b8.mp4 crash log ``` 2022-01-28 10:27:52.902 15600-15600/com.mattermost.rnbeta E/AndroidRuntime: FATAL EXCEPTION: main Process: com.mattermost.rnbeta, PID: 15600 java.lang.NullPointerException: Attempt to invoke virtual method 'android.view.DisplayCutout android.view.WindowInsets.getDisplayCutout()' on a null object reference at com.facebook.react.ReactRootView$CustomGlobalLayoutListener.checkForKeyboardEvents(ReactRootView.java:778) at com.facebook.react.ReactRootView$CustomGlobalLayoutListener.onGlobalLayout(ReactRootView.java:769) at android.view.ViewTreeObserver.dispatchOnGlobalLayout(ViewTreeObserver.java:1061) at android.view.ViewRootImpl.performTraversals(ViewRootImpl.java:3214) at android.view.ViewRootImpl.doTraversal(ViewRootImpl.java:2143) at android.view.ViewRootImpl$TraversalRunnable.run(ViewRootImpl.java:8665) at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1037) at android.view.Choreographer.doCallbacks(Choreographer.java:845) at android.view.Choreographer.doFrame(Choreographer.java:780) at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:1022) at android.os.Handler.handleCallback(Handler.java:938) at android.os.Handler.dispatchMessage(Handler.java:99) at android.os.Looper.loopOnce(Looper.java:201) at android.os.Looper.loop(Looper.java:288) at android.app.ActivityThread.main(ActivityThread.java:7839) at java.lang.reflect.Method.invoke(Native Method) at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:548) at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1003) ``` After applying the patch which is only a null check validation and does not change any previous behavior https://user-images.githubusercontent.com/6757047/151558429-9ff1a608-abb6-4168-8db9-df0c3c71d79e.mp4 Reviewed By: cortinico Differential Revision: D33844955 Pulled By: ShikaSD fbshipit-source-id: ed5579ad3afeed009c61cc1851eee45c70087cf5

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Feb 9, 2021

analysis-bot suggested changes Feb 9, 2021

View reviewed changes

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Outdated Show resolved Hide resolved

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Show resolved Hide resolved

analysis-bot suggested changes Feb 9, 2021

View reviewed changes

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Outdated Show resolved Hide resolved

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Show resolved Hide resolved

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Show resolved Hide resolved

fabOnReact mentioned this pull request Feb 9, 2021

Make a decision about the Dimensions module react-native-community/discussions-and-proposals#291

Open

analysis-bot suggested changes Feb 9, 2021

View reviewed changes

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Show resolved Hide resolved

analysis-bot suggested changes Feb 9, 2021

View reviewed changes

ReactAndroid/src/main/java/com/facebook/react/ReactRootView.java Show resolved Hide resolved

fabOnReact marked this pull request as ready for review February 9, 2021 14:28

fabOnReact marked this pull request as draft February 12, 2021 16:00

analysis-bot suggested changes Feb 12, 2021

View reviewed changes

fabOnReact force-pushed the fix/keyboardDidShowHeight branch from f890885 to cc7ca27 Compare February 15, 2021 08:50

fabOnReact marked this pull request as ready for review February 23, 2021 14:28

This was referenced Mar 22, 2021

Android - KeyboardAvoidingView is not behaving properly (Even with SDK 38 and softwareKeyboardLayoutMode: pan) expo/expo#9903

Closed

New mayor version (v4) react-native-camera/react-native-camera#3100

Closed

This comment has been minimized.

Sign in to view

fabOnReact mentioned this pull request Mar 30, 2021

Detect window dimension change when virtual buttons are show/hidden on samsung s8 #14887

Closed

sota000 added this to Needs Triage in React Native Pull Requests via automation Jul 27, 2021

OrLevy23 mentioned this pull request Sep 27, 2021

It's not working on android gie3d/react-native-use-keyboard-height#1

Open

kelset added the Needs: React Native Team Attention label Sep 27, 2021

facebook-github-bot added the Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. label Sep 27, 2021

fabOnReact added 5 commits September 28, 2021 16:44

default notchHeight to 0 for API < 28

b952474

fix import order for linter

3280f40

fix linter issues in Java

ffb9261

fix google linter issues

dd15c50

fabOnReact added 6 commits September 28, 2021 16:44

fix google code linter issues

0b65aa3

add method simulateCheckForKeyboardForTesting

0828998

The method has annotation @VisibleForTesting and is available only for testing purposes

setting expectation on RCTDeviceEventEmitter.emit() for keyboardDidShow

1f97bdb

updating expected parameters in keyboardDidShow test

5e9c5d6

refactoring test keyboardDidShow

8b96815

cortinico force-pushed the fix/keyboardDidShowHeight branch from 63e8942 to 8b96815 Compare September 28, 2021 15:45

cortinico approved these changes Sep 28, 2021

View reviewed changes

facebook-github-bot closed this in 8bef3b1 Sep 28, 2021

React Native Pull Requests automation moved this from Needs Triage to Closed Sep 28, 2021

enahum mentioned this pull request Jan 28, 2022

Android: Fix crash when WindowInsets is null on ReactRootView #32989

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

compute correct Keyboard Height with Notch #30919

compute correct Keyboard Height with Notch #30919

fabOnReact commented Feb 9, 2021 •

edited

Loading

analysis-bot left a comment

analysis-bot left a comment

analysis-bot commented Feb 9, 2021 •

edited

Loading

analysis-bot left a comment

analysis-bot left a comment

analysis-bot left a comment

analysis-bot Feb 12, 2021

analysis-bot Feb 12, 2021

analysis-bot Feb 12, 2021

analysis-bot commented Feb 15, 2021 •

edited

Loading

jsamr commented Mar 24, 2021

This comment has been minimized.

OrLevy23 commented Sep 27, 2021

cortinico commented Sep 27, 2021

facebook-github-bot commented Sep 27, 2021

facebook-github-bot commented Sep 28, 2021

cortinico left a comment

react-native-bot commented Sep 28, 2021

react-native-bot commented Sep 28, 2021

react-native-bot commented Sep 28, 2021

		@@ -7,10 +7,19 @@

		package com.facebook.react;

		import com.facebook.react.uimanager.ReactRoot;

		import static org.mockito.Mockito.mock;
		import static org.mockito.Mockito.spy;

compute correct Keyboard Height with Notch #30919

compute correct Keyboard Height with Notch #30919

Conversation

fabOnReact commented Feb 9, 2021 • edited Loading

Summary

Changelog

Test Plan

analysis-bot left a comment

Choose a reason for hiding this comment

analysis-bot left a comment

Choose a reason for hiding this comment

analysis-bot commented Feb 9, 2021 • edited Loading

analysis-bot left a comment

Choose a reason for hiding this comment

analysis-bot left a comment

Choose a reason for hiding this comment

analysis-bot left a comment

Choose a reason for hiding this comment

analysis-bot Feb 12, 2021

Choose a reason for hiding this comment

analysis-bot Feb 12, 2021

Choose a reason for hiding this comment

analysis-bot Feb 12, 2021

Choose a reason for hiding this comment

analysis-bot commented Feb 15, 2021 • edited Loading

jsamr commented Mar 24, 2021

This comment has been minimized.

OrLevy23 commented Sep 27, 2021

cortinico commented Sep 27, 2021

facebook-github-bot commented Sep 27, 2021

facebook-github-bot commented Sep 28, 2021

cortinico left a comment

Choose a reason for hiding this comment

react-native-bot commented Sep 28, 2021

react-native-bot commented Sep 28, 2021

react-native-bot commented Sep 28, 2021

fabOnReact commented Feb 9, 2021 •

edited

Loading

analysis-bot commented Feb 9, 2021 •

edited

Loading

analysis-bot commented Feb 15, 2021 •

edited

Loading