Skip to content

Commit

Permalink
Remove WebWorker support from Timers
Browse files Browse the repository at this point in the history 
Reviewed By: AaaChiuuu

Differential Revision: D4929245

fbshipit-source-id: 6eae128756a31f6063bf8fe39f0573c1c07ca8bb
  • Loading branch information
@javache @facebook-github-bot
javache authored and facebook-github-bot committed Apr 25, 2017
1 parent ea93577 commit a20882f
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 111 deletions.
2 changes: 0 additions & 2 deletions ReactAndroid/src/main/java/com/facebook/react/modules/core/JSTimersExecution.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
package com.facebook.react.modules.core;

import com.facebook.react.bridge.JavaScriptModule;
import com.facebook.react.bridge.SupportsWebWorkers;
import com.facebook.react.bridge.WritableArray;

@SupportsWebWorkers
public interface JSTimersExecution extends JavaScriptModule {
void callTimers(WritableArray timerIDs);
void callIdleCallbacks(double frameTime);
Expand Down
124 changes: 29 additions & 95 deletions ReactAndroid/src/main/java/com/facebook/react/modules/core/Timing.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,14 @@

import javax.annotation.Nullable;

import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.PriorityQueue;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;

import android.util.SparseArray;

import com.facebook.react.bridge.Arguments;
import com.facebook.react.bridge.ExecutorToken;
import com.facebook.react.bridge.LifecycleEventListener;
import com.facebook.react.bridge.OnExecutorUnregisteredListener;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
Expand All @@ -41,9 +33,9 @@
/**
* Native module for JS timer execution. Timers fire on frame boundaries.
*/
@ReactModule(name = Timing.NAME, supportsWebWorkers = true)
@ReactModule(name = Timing.NAME)
public final class Timing extends ReactContextBaseJavaModule implements LifecycleEventListener,
OnExecutorUnregisteredListener, HeadlessJsTaskEventListener {
HeadlessJsTaskEventListener {

protected static final String NAME = "Timing";

Expand All @@ -58,20 +50,16 @@ public final class Timing extends ReactContextBaseJavaModule implements Lifecycl
private final DevSupportManager mDevSupportManager;

private static class Timer {

private final ExecutorToken mExecutorToken;
private final int mCallbackID;
private final boolean mRepeat;
private final int mInterval;
private long mTargetTime;

private Timer(
ExecutorToken executorToken,
int callbackID,
long initialTargetTime,
int duration,
boolean repeat) {
mExecutorToken = executorToken;
mCallbackID = callbackID;
mTargetTime = initialTargetTime;
mInterval = duration;
Expand All @@ -81,8 +69,8 @@ private Timer(

private class TimerFrameCallback extends ChoreographerCompat.FrameCallback {

// Temporary map for constructing the individual arrays of timers per ExecutorToken
private final HashMap<ExecutorToken, WritableArray> mTimersToCall = new HashMap<>();
// Temporary map for constructing the individual arrays of timers to call
private @Nullable WritableArray mTimersToCall = null;

/**
* Calls all timers that have expired since the last time this frame callback was called.
Expand All @@ -97,32 +85,23 @@ public void doFrame(long frameTimeNanos) {
synchronized (mTimerGuard) {
while (!mTimers.isEmpty() && mTimers.peek().mTargetTime < frameTimeMillis) {
Timer timer = mTimers.poll();
WritableArray timersForContext = mTimersToCall.get(timer.mExecutorToken);
if (timersForContext == null) {
timersForContext = Arguments.createArray();
mTimersToCall.put(timer.mExecutorToken, timersForContext);
if (mTimersToCall == null) {
mTimersToCall = Arguments.createArray();
}
timersForContext.pushInt(timer.mCallbackID);
mTimersToCall.pushInt(timer.mCallbackID);
if (timer.mRepeat) {
timer.mTargetTime = frameTimeMillis + timer.mInterval;
mTimers.add(timer);
} else {
SparseArray<Timer> timers = mTimerIdsToTimers.get(timer.mExecutorToken);
if (timers != null) {
timers.remove(timer.mCallbackID);
if (timers.size() == 0) {
mTimerIdsToTimers.remove(timer.mExecutorToken);
}
}
mTimerIdsToTimers.remove(timer.mCallbackID);
}
}
}

for (Map.Entry<ExecutorToken, WritableArray> entry : mTimersToCall.entrySet()) {
getReactApplicationContext().getJSModule(entry.getKey(), JSTimersExecution.class)
.callTimers(entry.getValue());
if (mTimersToCall != null) {
getReactApplicationContext().getJSModule(JSTimersExecution.class).callTimers(mTimersToCall);
mTimersToCall = null;
}
mTimersToCall.clear();

mReactChoreographer.postFrameCallback(ReactChoreographer.CallbackType.TIMERS_EVENTS, this);
}
Expand Down Expand Up @@ -172,13 +151,13 @@ public void run() {
return;
}

mIdleCallbackContextsToCall.clear();
boolean sendIdleEvents;
synchronized (mIdleCallbackGuard) {
mIdleCallbackContextsToCall.addAll(mSendIdleEventsExecutorTokens);
sendIdleEvents = mSendIdleEvents;
}

for (ExecutorToken context : mIdleCallbackContextsToCall) {
getReactApplicationContext().getJSModule(context, JSTimersExecution.class)
if (sendIdleEvents) {
getReactApplicationContext().getJSModule(JSTimersExecution.class)
.callIdleCallbacks(absoluteFrameStartTime);
}

Expand All @@ -193,7 +172,7 @@ public void cancel() {
private final Object mTimerGuard = new Object();
private final Object mIdleCallbackGuard = new Object();
private final PriorityQueue<Timer> mTimers;
private final Map<ExecutorToken, SparseArray<Timer>> mTimerIdsToTimers;
private final SparseArray<Timer> mTimerIdsToTimers;
private final AtomicBoolean isPaused = new AtomicBoolean(true);
private final AtomicBoolean isRunningTasks = new AtomicBoolean(false);
private final TimerFrameCallback mTimerFrameCallback = new TimerFrameCallback();
Expand All @@ -202,9 +181,7 @@ public void cancel() {
private @Nullable IdleCallbackRunnable mCurrentIdleCallbackRunnable;
private boolean mFrameCallbackPosted = false;
private boolean mFrameIdleCallbackPosted = false;
private final Set<ExecutorToken> mSendIdleEventsExecutorTokens;
// Temporary array used to dipatch idle callbacks on the JS thread.
private final List<ExecutorToken> mIdleCallbackContextsToCall;
private boolean mSendIdleEvents = false;

public Timing(ReactApplicationContext reactContext, DevSupportManager devSupportManager) {
super(reactContext);
Expand All @@ -225,9 +202,7 @@ public int compare(Timer lhs, Timer rhs) {
}
}
});
mTimerIdsToTimers = new HashMap<>();
mSendIdleEventsExecutorTokens = new HashSet<>();
mIdleCallbackContextsToCall = new ArrayList<>();
mTimerIdsToTimers = new SparseArray<>();
mReactChoreographer = ReactChoreographer.getInstance();
}

Expand Down Expand Up @@ -291,7 +266,7 @@ public void onCatalystInstanceDestroy() {

private void maybeSetChoreographerIdleCallback() {
synchronized (mIdleCallbackGuard) {
if (mSendIdleEventsExecutorTokens.size() > 0) {
if (mSendIdleEvents) {
setChoreographerIdleCallback();
}
}
Expand Down Expand Up @@ -347,32 +322,8 @@ public String getName() {
return NAME;
}

@Override
public boolean supportsWebWorkers() {
return true;
}

@Override
public void onExecutorDestroyed(ExecutorToken executorToken) {
synchronized (mTimerGuard) {
SparseArray<Timer> timersForContext = mTimerIdsToTimers.remove(executorToken);
if (timersForContext == null) {
return;
}
for (int i = 0; i < timersForContext.size(); i++) {
Timer timer = timersForContext.get(timersForContext.keyAt(i));
mTimers.remove(timer);
}
}

synchronized (mIdleCallbackGuard) {
mSendIdleEventsExecutorTokens.remove(executorToken);
}
}

@ReactMethod
public void createTimer(
ExecutorToken executorToken,
final int callbackID,
final int duration,
final double jsSchedulingTime,
Expand All @@ -386,7 +337,7 @@ public void createTimer(
if (mDevSupportManager.getDevSupportEnabled()) {
long driftTime = Math.abs(remoteTime - deviceTime);
if (driftTime > 60000) {
getReactApplicationContext().getJSModule(executorToken, JSTimersExecution.class)
getReactApplicationContext().getJSModule(JSTimersExecution.class)
.emitTimeDriftWarning(
"Debugger and device times have drifted by more than 60s. Please correct this by " +
"running adb shell \"date `date +%m%d%H%M%Y.%S`\" on your debugger machine.");
Expand All @@ -398,59 +349,42 @@ public void createTimer(
if (duration == 0 && !repeat) {
WritableArray timerToCall = Arguments.createArray();
timerToCall.pushInt(callbackID);
getReactApplicationContext().getJSModule(executorToken, JSTimersExecution.class)
getReactApplicationContext().getJSModule(JSTimersExecution.class)
.callTimers(timerToCall);
return;
}

long initialTargetTime = SystemClock.nanoTime() / 1000000 + adjustedDuration;
Timer timer = new Timer(executorToken, callbackID, initialTargetTime, duration, repeat);
Timer timer = new Timer(callbackID, initialTargetTime, duration, repeat);
synchronized (mTimerGuard) {
mTimers.add(timer);
SparseArray<Timer> timersForContext = mTimerIdsToTimers.get(executorToken);
if (timersForContext == null) {
timersForContext = new SparseArray<>();
mTimerIdsToTimers.put(executorToken, timersForContext);
}
timersForContext.put(callbackID, timer);
mTimerIdsToTimers.put(callbackID, timer);
}
}

@ReactMethod
public void deleteTimer(ExecutorToken executorToken, int timerId) {
public void deleteTimer(int timerId) {
synchronized (mTimerGuard) {
SparseArray<Timer> timersForContext = mTimerIdsToTimers.get(executorToken);
if (timersForContext == null) {
return;
}
Timer timer = timersForContext.get(timerId);
Timer timer = mTimerIdsToTimers.get(timerId);
if (timer == null) {
return;
}
// We may have already called/removed it
timersForContext.remove(timerId);
if (timersForContext.size() == 0) {
mTimerIdsToTimers.remove(executorToken);
}
mTimerIdsToTimers.remove(timerId);
mTimers.remove(timer);
}
}

@ReactMethod
public void setSendIdleEvents(ExecutorToken executorToken, boolean sendIdleEvents) {
public void setSendIdleEvents(final boolean sendIdleEvents) {
synchronized (mIdleCallbackGuard) {
if (sendIdleEvents) {
mSendIdleEventsExecutorTokens.add(executorToken);
} else {
mSendIdleEventsExecutorTokens.remove(executorToken);
}
mSendIdleEvents = sendIdleEvents;
}

UiThreadUtil.runOnUiThread(new Runnable() {
@Override
public void run() {
synchronized (mIdleCallbackGuard) {
if (mSendIdleEventsExecutorTokens.size() > 0) {
if (sendIdleEvents) {
setChoreographerIdleCallback();
} else {
clearChoreographerIdleCallback();
Expand Down
25 changes: 11 additions & 14 deletions ReactAndroid/src/test/java/com/facebook/react/modules/timing/TimingModuleTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
package com.facebook.react.modules.timing;

import com.facebook.react.bridge.Arguments;
import com.facebook.react.bridge.ExecutorToken;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.CatalystInstance;
import com.facebook.react.bridge.JavaOnlyArray;
Expand Down Expand Up @@ -53,7 +52,6 @@ public class TimingModuleTest {
private PostFrameIdleCallbackHandler mIdlePostFrameCallbackHandler;
private long mCurrentTimeNs;
private JSTimersExecution mJSTimersMock;
private ExecutorToken mExecutorTokenMock;

@Rule
public PowerMockRule rule = new PowerMockRule();
Expand Down Expand Up @@ -100,8 +98,7 @@ public Object answer(InvocationOnMock invocation) throws Throwable {

mTiming = new Timing(reactContext, mock(DevSupportManager.class));
mJSTimersMock = mock(JSTimersExecution.class);
mExecutorTokenMock = mock(ExecutorToken.class);
when(reactContext.getJSModule(mExecutorTokenMock, JSTimersExecution.class)).thenReturn(mJSTimersMock);
when(reactContext.getJSModule(JSTimersExecution.class)).thenReturn(mJSTimersMock);

doAnswer(new Answer() {
@Override
Expand Down Expand Up @@ -132,7 +129,7 @@ private void stepChoreographerFrame() {
@Test
public void testSimpleTimer() {
mTiming.onHostResume();
mTiming.createTimer(mExecutorTokenMock, 1, 1, 0, false);
mTiming.createTimer(1, 1, 0, false);
stepChoreographerFrame();
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(1));
reset(mJSTimersMock);
Expand All @@ -142,7 +139,7 @@ public void testSimpleTimer() {

@Test
public void testSimpleRecurringTimer() {
mTiming.createTimer(mExecutorTokenMock, 100, 1, 0, true);
mTiming.createTimer(100, 1, 0, true);
mTiming.onHostResume();
stepChoreographerFrame();
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(100));
Expand All @@ -155,21 +152,21 @@ public void testSimpleRecurringTimer() {
@Test
public void testCancelRecurringTimer() {
mTiming.onHostResume();
mTiming.createTimer(mExecutorTokenMock, 105, 1, 0, true);
mTiming.createTimer(105, 1, 0, true);

stepChoreographerFrame();
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(105));

reset(mJSTimersMock);
mTiming.deleteTimer(mExecutorTokenMock, 105);
mTiming.deleteTimer(105);
stepChoreographerFrame();
verifyNoMoreInteractions(mJSTimersMock);
}

@Test
public void testPausingAndResuming() {
mTiming.onHostResume();
mTiming.createTimer(mExecutorTokenMock, 41, 1, 0, true);
mTiming.createTimer(41, 1, 0, true);

stepChoreographerFrame();
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(41));
Expand All @@ -189,7 +186,7 @@ public void testPausingAndResuming() {
public void testHeadlessJsTaskInBackground() {
mTiming.onHostPause();
mTiming.onHeadlessJsTaskStart(42);
mTiming.createTimer(mExecutorTokenMock, 41, 1, 0, true);
mTiming.createTimer(41, 1, 0, true);

stepChoreographerFrame();
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(41));
Expand All @@ -204,7 +201,7 @@ public void testHeadlessJsTaskInBackground() {
public void testHeadlessJsTaskInForeground() {
mTiming.onHostResume();
mTiming.onHeadlessJsTaskStart(42);
mTiming.createTimer(mExecutorTokenMock, 41, 1, 0, true);
mTiming.createTimer(41, 1, 0, true);

stepChoreographerFrame();
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(41));
Expand All @@ -223,7 +220,7 @@ public void testHeadlessJsTaskInForeground() {
public void testHeadlessJsTaskIntertwine() {
mTiming.onHostResume();
mTiming.onHeadlessJsTaskStart(42);
mTiming.createTimer(mExecutorTokenMock, 41, 1, 0, true);
mTiming.createTimer(41, 1, 0, true);
mTiming.onHostPause();

stepChoreographerFrame();
Expand All @@ -243,14 +240,14 @@ public void testHeadlessJsTaskIntertwine() {

@Test
public void testSetTimeoutZero() {
mTiming.createTimer(mExecutorTokenMock, 100, 0, 0, false);
mTiming.createTimer(100, 0, 0, false);
verify(mJSTimersMock).callTimers(JavaOnlyArray.of(100));
}

@Test
public void testIdleCallback() {
mTiming.onHostResume();
mTiming.setSendIdleEvents(mExecutorTokenMock, true);
mTiming.setSendIdleEvents(true);

stepChoreographerFrame();
verify(mJSTimersMock).callIdleCallbacks(SystemClock.currentTimeMillis());
Expand Down

0 comments on commit a20882f

Please sign in to comment.