Make setting useNativeDriver required. Add runtime warning if not spe…

…cified

Summary:
We found that many callsites existed that could be using the native driver, but weren't. In order to help people use it when appropriate and eventually switch the default, we are requiring that useNativeDriver is explicit, even when set to false.

This change adds a runtime warning if useNativeDriver is not specified, hopefully giving some light feedback to remember to use the native driver when you can. Without it being explicit it is very easy to forget setting this.

Reviewed By: JoshuaGross

Differential Revision: D17575918

fbshipit-source-id: e54612d87177e1821692b7de20fe673df0e890d2

Libraries/Animated/src/AnimatedEvent.js

@@ -20,7 +20,7 @@ const {shouldUseNativeDriver} = require('./NativeAnimatedHelper');
 export type Mapping = {[key: string]: Mapping} | AnimatedValue;
 export type EventConfig = {
   listener?: ?Function,
-  useNativeDriver?: boolean,
+  useNativeDriver: boolean,
 };
 
 function attachNativeEvent(
@@ -87,8 +87,14 @@ class AnimatedEvent {
   };
   __isNative: boolean;
 
-  constructor(argMapping: Array<?Mapping>, config?: EventConfig = {}) {
+  constructor(argMapping: Array<?Mapping>, config: EventConfig) {
     this._argMapping = argMapping;
+
+    if (config == null) {
+      console.warn('Animated.event now requires a second argument for options');
+      config = {};
+    }
+
     if (config.listener) {
       this.__addListener(config.listener);
     }

Libraries/Animated/src/AnimatedImplementation.js

@@ -508,7 +508,7 @@ function unforkEvent(
   }
 }
 
-const event = function(argMapping: Array<?Mapping>, config?: EventConfig): any {
+const event = function(argMapping: Array<?Mapping>, config: EventConfig): any {
   const animatedEvent = new AnimatedEvent(argMapping, config);
   if (animatedEvent.__isNative) {
     return animatedEvent;

Libraries/Animated/src/AnimatedMock.js

@@ -119,7 +119,7 @@ const loop = function(
   return emptyAnimation;
 };
 
-const event = function(argMapping: Array<?Mapping>, config?: EventConfig): any {
+const event = function(argMapping: Array<?Mapping>, config: EventConfig): any {
   return null;
 };
 

Libraries/Animated/src/NativeAnimatedHelper.js

@@ -265,6 +265,13 @@ function assertNativeAnimatedModule(): void {
 let _warnedMissingNativeAnimated = false;
 
 function shouldUseNativeDriver(config: AnimationConfig | EventConfig): boolean {
+  if (config.useNativeDriver == null) {
+    console.warn(
+      'Animated: `useNativeDriver` was not specified. This is a required ' +
+        'option and must be explicitly set to `true` or `false`',
+    );
+  }
+
   if (config.useNativeDriver === true && !NativeAnimatedModule) {
     if (!_warnedMissingNativeAnimated) {
       console.warn(

RNTester/js/examples/Animated/AnimatedGratuitousApp/AnExApp.js

@@ -65,10 +65,13 @@ class Circle extends React.Component<any, any> {
     this.setState(
       {
         panResponder: PanResponder.create({
-          onPanResponderMove: Animated.event([
-            null, // native event - ignore      (step1: uncomment)
-            {dx: this.state.pan.x, dy: this.state.pan.y}, // links pan to gestureState  (step1: uncomment)
-          ]),
+          onPanResponderMove: Animated.event(
+            [
+              null, // native event - ignore      (step1: uncomment)
+              {dx: this.state.pan.x, dy: this.state.pan.y}, // links pan to gestureState  (step1: uncomment)
+            ],
+            {useNativeDriver: false},
+          ),
           onPanResponderRelease: (e, gestureState) => {
             LayoutAnimation.easeInEaseOut(); // @flowfixme animates layout update as one batch (step3: uncomment)
             Animated.spring(this.state.pop, {

RNTester/js/examples/Animated/AnimatedGratuitousApp/AnExBobble.js

@@ -86,7 +86,7 @@ class AnExBobble extends React.Component<Object, any> {
       },
       onPanResponderMove: Animated.event(
         [null, {dx: this.state.bobbles[0].x, dy: this.state.bobbles[0].y}],
-        {listener: bobblePanListener}, // async state changes with arbitrary logic
+        {listener: bobblePanListener, useNativeDriver: false}, // async state changes with arbitrary logic
       ),
       onPanResponderRelease: releaseBobble,
       onPanResponderTerminate: releaseBobble,

RNTester/js/examples/Animated/AnimatedGratuitousApp/AnExChained.js

@@ -63,6 +63,7 @@ class AnExChained extends React.Component<Object, any> {
       },
       onPanResponderMove: Animated.event(
         [null, {dx: this.state.stickers[0].x, dy: this.state.stickers[0].y}], // map gesture to leader
+        {useNativeDriver: false},
       ),
       onPanResponderRelease: releaseChain,
       onPanResponderTerminate: releaseChain,

RNTester/js/examples/Animated/AnimatedGratuitousApp/AnExScroll.js

@@ -33,6 +33,7 @@ class AnExScroll extends React.Component<$FlowFixMeProps, any> {
           scrollEventThrottle={16 /* get all events */}
           onScroll={Animated.event(
             [{nativeEvent: {contentOffset: {x: this.state.scrollX}}}], // nested event mapping
+            {useNativeDriver: false},
           )}
           contentContainerStyle={{flex: 1, padding: 10}}
           pagingEnabled={true}

RNTester/js/examples/Animated/AnimatedGratuitousApp/AnExSet.js

@@ -88,6 +88,7 @@ class AnExSet extends React.Component<Object, any> {
       },
       onPanResponderMove: Animated.event(
         [null, {dy: this.state.dismissY}], // track pan gesture
+        {useNativeDriver: false},
       ),
       onPanResponderRelease: (e, gestureState) => {
         if (gestureState.dy > 100) {

RNTester/js/examples/Animated/AnimatedGratuitousApp/AnExTilt.js

@@ -38,6 +38,7 @@ class AnExTilt extends React.Component<Object, any> {
       },
       onPanResponderMove: Animated.event(
         [null, {dx: this.state.panX}], // panX is linked to the gesture
+        {useNativeDriver: false},
       ),
       onPanResponderRelease: (e, gestureState) => {
         let toValue = 0;