add flow types

Author: Hedger Wang

plugins/BananaSlug/BananaSlugAbstractNodeMeasurer.js

@@ -5,18 +5,22 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
  */
 'use strict';
 
 const requestAnimationFrame = require('fbjs/lib/requestAnimationFrame');
 const immutable = require('immutable');
 
+import type {Measurement} from './BananaSlugTypes';
+
 // How long the measurement can be cached in ms.
 const DURATION = 800;
 
 const {Record, Map, Set} = immutable;
 
-const Measurement = Record({
+const MeasurementRecord = Record({
   bottom: 0,
   expiration: 0,
   height: 0,
@@ -32,6 +36,13 @@ const Measurement = Record({
 var _id = 100;
 
 class BananaSlugAbstractNodeMeasurer {
+  _callbacks: Map<Node, (v: Measurement) => void>;
+  _ids: Map<string, Node>;
+  _isRequesting: boolean;
+  _measureNodes: () => void;
+  _measurements: Map<Node, Measurement>;
+  _nodes: Map<string, Node>;
+
   constructor() {
     // pending nodes to measure.
     this._nodes = new Map();
@@ -51,7 +62,7 @@ class BananaSlugAbstractNodeMeasurer {
     this._measureNodes = this._measureNodes.bind(this);
   }
 
-  request(node, callback): string {
+  request(node: Node, callback: (v: Measurement) => void): string {
     var requestID = this._nodes.has(node) ?
       this._nodes.get(node) :
       String(_id++);
@@ -67,15 +78,26 @@ class BananaSlugAbstractNodeMeasurer {
     this._callbacks = this._callbacks.set(node, callbacks);
 
     if (this._isRequesting) {
-      return;
+      return requestID;
     }
 
     this._isRequesting = true;
     requestAnimationFrame(this._measureNodes);
+    return requestID;
+  }
+
+  cancel(requestID: string): void {
+    if (this._ids.has(requestID)) {
+      var node = this._ids.get(requestID);
+      this._ids = this._ids.delete(requestID);
+      this._nodes = this._nodes.delete(node);
+      this._callbacks = this._callbacks.delete(node);
+    }
   }
 
-  measureImpl(node: any): void {
-    // sub-class must implement this.
+  measureImpl(node: Node): Measurement {
+    // sub-class must overwrite this.
+    return new MeasurementRecord();
   }
 
   _measureNodes(): void {
@@ -110,7 +132,7 @@ class BananaSlugAbstractNodeMeasurer {
     this._isRequesting = false;
   }
 
-  _measureNode(timestamp: number, node: any): Measurement {
+  _measureNode(timestamp: number, node: Node): Measurement {
     var measurement;
     var data;
 
@@ -126,7 +148,7 @@ class BananaSlugAbstractNodeMeasurer {
       }
     } else {
       data = this.measureImpl(node);
-      measurement = new Measurement({
+      measurement = new MeasurementRecord({
         ...data,
         expiration: timestamp + DURATION,
         id: 'm_' + String(_id++),

plugins/BananaSlug/BananaSlugAbstractNodePresenter.js

@@ -5,13 +5,18 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
  */
-
 'use strict';
 
 const immutable = require('immutable');
 const requestAnimationFrame = require('fbjs/lib/requestAnimationFrame');
 
+import type {
+  Measurement,
+} from './BananaSlugTypes';
+
 // How long the measurement should be presented for.
 const DURATION = 250;
 
@@ -23,6 +28,13 @@ const MetaData = Record({
 });
 
 class BananaSlugAbstractNodePresenter {
+  _clearTimer: number;
+  _draw: () => void;
+  _drawing: boolean;
+  _enabled: boolean;
+  _pool: Map<Measurement, MetaData>;
+  _redraw: () => void;
+
   constructor() {
     this._pool = new Map();
     this._drawing = false;
@@ -33,7 +45,7 @@ class BananaSlugAbstractNodePresenter {
     this._redraw = this._redraw.bind(this);
   }
 
-  present(measurement: Object): void {
+  present(measurement: Measurement): void {
     if (!this._enabled) {
       return;
     }
@@ -73,15 +85,15 @@ class BananaSlugAbstractNodePresenter {
 
     if (this._clearTimer) {
       clearTimeout(this._clearTimer);
-      this._clearTimer = null;
+      this._clearTimer = 0;
     }
 
     this._pool = this._pool.clear();
     this._drawing = false;
     this.clearImpl();
   }
 
-  drawImpl(info: Object): void {
+  drawImpl(measurements: Map<Measurement, MetaData>): void {
     // sub-class should implement this.
   }
 
@@ -90,7 +102,7 @@ class BananaSlugAbstractNodePresenter {
   }
 
   _redraw(): void {
-    this._clearTimer = null;
+    this._clearTimer = 0;
     if (!this._drawing && this._pool.size > 0) {
       this._drawing = true;
       this._draw();

plugins/BananaSlug/BananaSlugBackendManager.js

@@ -5,6 +5,8 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
  */
 
 'use strict';
@@ -14,11 +16,21 @@ const BananaSlugAbstractNodePresenter = require('./BananaSlugAbstractNodePresent
 const BananaSlugWebNodeMeasurer = require('./BananaSlugWebNodeMeasurer');
 const BananaSlugWebNodePresenter = require('./BananaSlugWebNodePresenter');
 
-const NODE_TYPE_COMPOSITE = 'Composite';
+import type {
+  Agent,
+  Measurement,
+  Measurer,
+  Presenter,
+} from './BananaSlugTypes';
 
-type Agent = any;
+const NODE_TYPE_COMPOSITE = 'Composite';
 
 class BananaSlugBackendManager {
+  _onMeasureNode: () => void;
+  _measurer: Measurer;
+  _presenter: Presenter;
+  _isActive: boolean;
+
   constructor(agent: Agent) {
     this._onMeasureNode = this._onMeasureNode.bind(this);
 
@@ -55,7 +67,7 @@ class BananaSlugBackendManager {
     this._measurer.request(node, this._onMeasureNode);
   }
 
-  _onMeasureNode(measurement: Object): void {
+  _onMeasureNode(measurement: Measurement): void {
     this._presenter.present(measurement);
   }
 

plugins/BananaSlug/BananaSlugFrontendControl.js

@@ -5,23 +5,40 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
  */
 
 'use strict';
 
 const React = require('react');
-
 const immutable = require('immutable');
 
-const State = immutable.Record({
+import type {
+  ControlState,
+} from './BananaSlugTypes';
+
+type Props = {
+  onChange: (v: ControlState) => void,
+};
+
+type State = {};
+
+type DefaultProps = {};
+
+const StateRecord = immutable.Record({
   enabled: false,
 });
 
-class BananaSlugFrontendControl extends React.Component {
-  constructor(props) {
+class BananaSlugFrontendControl extends
+  React.Component<DefaultProps, Props, State> {
+  _defaultState: ControlState;
+  _toogle: (b: boolean) => void;
+
+  constructor(props: Props) {
     super(props);
     this._toogle = this._toogle.bind(this);
-    this._defaultState = new State();
+    this._defaultState = new StateRecord();
   }
 
   componentDidMount(): void {
@@ -30,7 +47,7 @@ class BananaSlugFrontendControl extends React.Component {
     }
   }
 
-  render() {
+  render(): ReactElement {
     var state = this.props.state || this._defaultState;
     return (
       <div style={styles.container} onClick={this._toogle} tabIndex={0}>

plugins/BananaSlug/BananaSlugTypes.js

@@ -0,0 +1,43 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
+ */
+'use strict';
+
+export type Agent = any;
+
+export type Node = any;
+
+export type Measurement = {
+  bottom: number,
+  expiration: number,
+  height: number,
+  id: string,
+  left: number,
+  right: number,
+  scrollX: number,
+  scrollY: number,
+  top: number,
+  width: number,
+};
+
+export type onMeasureNode = (m: Measurement) => void;
+
+export type Measurer = {
+  request:(n: Node, c: onMeasureNode) => string,
+};
+
+export type Presenter = {
+  present: (m: Measurement) => void,
+  setEnabled: (b: boolean) => void,
+};
+
+export type ControlState = {
+  enabled: boolean,
+};

plugins/BananaSlug/BananaSlugWebNodeMeasurer.js

@@ -5,15 +5,23 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
  */
 
 'use strict';
 
 const BananaSlugAbstractNodeMeasurer = require('./BananaSlugAbstractNodeMeasurer');
 
+import type {
+  Measurement,
+} from './BananaSlugTypes';
+
 const DUMMY = {
   bottom: 0,
+  expiration: 0,
   height: 0,
+  id: '',
   left: 0,
   right: 0,
   scrollX: 0,
@@ -23,7 +31,7 @@ const DUMMY = {
 };
 
 class BananaSlugWebNodeMeasurer extends BananaSlugAbstractNodeMeasurer {
-  measureImpl(node): Object {
+  measureImpl(node: any): Measurement {
     if (!node || typeof node.getBoundingClientRect !== 'function') {
       return DUMMY;
     }
@@ -45,13 +53,15 @@ class BananaSlugWebNodeMeasurer extends BananaSlugAbstractNodeMeasurer {
 
     return {
       bottom: rect.bottom,
+      expiration: 0,
       height: rect.height,
+      id: '',
       left: rect.left,
       right: rect.right,
+      scrollX,
+      scrollY,
       top: rect.top,
       width: rect.width,
-      scrollY,
-      scrollX,
     };
   }
 }

plugins/BananaSlug/BananaSlugWebNodePresenter.js

@@ -5,6 +5,8 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
  */
 
 'use strict';
@@ -72,6 +74,8 @@ function drawBorder(ctx, measurement, borderWidth, borderColor) {
 const CANVAS_NODE_ID = 'BananaSlugWebNodePresenter';
 
 class BananaSlugWebNodePresenter extends BananaSlugAbstractNodePresenter {
+  _canvas: any;
+
   constructor() {
     super();
     this._canvas = null;