Fix thread safety of RNGestureHandlerModule methods#1173
Merged
Conversation
jgonet
commented
Aug 24, 2020
android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerRegistry.java
Show resolved
Hide resolved
RNGestureHandlerModule methods
braincore
pushed a commit
to braincore/react-native-gesture-handler
that referenced
this pull request
Mar 4, 2021
…on#1173) ## Description Fixes software-mansion#1169. Another instance of changing the handler state outside the UI thread. In this case, calling `handler.cancel()` which calls `mOrchestrator.onHandlerStateChange()` interfered with `scheduleFinishedHandlersCleanup()` method which calls `handler.reset()` and sets `mOrchestrator` to `null`. This may happen when threads interleave in the way described below: 1. `RNGestureHandlerModule.dropGestureHandler` is called (directly or in `attachGestureHandler()`; it's called on native modules thread) 2. RNGH dispatches first `onStateChange` event on UI thread 3. after dispatching event `mHandlingChangeSemaphore` is zero and call to `scheduleFinishedHandlersCleanup()` causes `cleanupFinishedHandlers()` to reset handlers and clear `mOrchestrator` 4. Native modules thread continues with execution and tries to call `moveToState` which crashes the app This may show when `RNGestureHandlerModule.attachGestureHandler()` or `RNGestureHandlerModule.dropGestureHandler()` is rapidly called from JS (e.g. when frequently unmounting or updating handler component). After checking the call hierarchy of `GestureHandler.moveToState()` it seems like this is the last occurrence of a native-module-calling-UI-only-method problem. ## Example Fast clicking on the TapGestureHandler crashes with error "Expected to run on UI thread", introduced in software-mansion#1171. After applying this patch, the error disappears. ```jsx import React, { useState } from 'react'; import { View } from 'react-native'; import { TapGestureHandler } from 'react-native-gesture-handler'; export default () => { const [i, setI] = useState(0); const updateState = () => setI(i + 1); return ( <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}> <TapGestureHandler onHandlerStateChange={updateState} key={i}> <View style={{ height: 100, width: 100, backgroundColor: 'pink' }} /> </TapGestureHandler> </View> ); }; ```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1169.
Another instance of changing the handler state outside the UI thread. In this case, calling
handler.cancel()which callsmOrchestrator.onHandlerStateChange()interfered withscheduleFinishedHandlersCleanup()method which callshandler.reset()and setsmOrchestratortonull.This may happen when threads interleave in the way described below:
RNGestureHandlerModule.dropGestureHandleris called (directly or inattachGestureHandler(); it's called on native modules thread)onStateChangeevent on UI threadmHandlingChangeSemaphoreis zero and call toscheduleFinishedHandlersCleanup()causescleanupFinishedHandlers()to reset handlers and clearmOrchestratormoveToStatewhich crashes the appThis may show when
RNGestureHandlerModule.attachGestureHandler()orRNGestureHandlerModule.dropGestureHandler()is rapidly called from JS (e.g. when frequently unmounting or updating handler component).After checking the call hierarchy of
GestureHandler.moveToState()it seems like this is the last occurrence of a native-module-calling-UI-only-method problem.Example
Fast clicking on the TapGestureHandler crashes with error "Expected to run on UI thread", introduced in #1171. After applying this patch, the error disappears.