-
Notifications
You must be signed in to change notification settings - Fork 24.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Summary: This adds a flowified JS module for the FrameRateLogger native module and plugs it into `ScrollResponder` and `AppRegistry`. If there is no `FrameRateLogger` native module, then the function calls will be no-ops. One major limitation is that we can't track animated/programatic scrolls because we don't have reliable end events. Would be generally useful to add those in a followup though. Reviewed By: fkgozali Differential Revision: D4765694 fbshipit-source-id: f3bec771df6ac918200c1afd1a7d8b6da540a4e2
- Loading branch information
1 parent
c87c4d0
commit 27c3e32
Showing
3 changed files
with
89 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
/** | ||
* 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. | ||
* | ||
* @providesModule FrameRateLogger | ||
* @flow | ||
*/ | ||
'use strict'; | ||
|
||
const NativeModules = require('NativeModules'); | ||
|
||
const invariant = require('fbjs/lib/invariant'); | ||
|
||
/** | ||
* Flow API for native FrameRateLogger module. If the native module is not installed, function calls | ||
* are just no-ops. | ||
* | ||
* Typical behavior is that `setContext` is called when a new screen is loaded (e.g. via a | ||
* navigation integration), and then `beginScroll` is called by `ScrollResponder` at which point the | ||
* native module then begins tracking frame drops. When `ScrollResponder` calls `endScroll`, the | ||
* native module gathers up all it's frame drop data and reports it via an analytics pipeline for | ||
* analysis. | ||
* | ||
* Note that `beginScroll` may be called multiple times by `ScrollResponder` - unclear if that's a | ||
* bug, but the native module should be robust to that. | ||
* | ||
* In the future we may add support for tracking frame drops in other types of interactions beyond | ||
* scrolling. | ||
*/ | ||
const FrameRateLogger = { | ||
/** | ||
* Enable `debug` to see local logs of what's going on. `reportStackTraces` will grab stack traces | ||
* during UI thread stalls and upload them if the native module supports it. | ||
*/ | ||
setGlobalOptions: function(options: {debug?: boolean, reportStackTraces?: boolean}) { | ||
if (options.debug !== undefined) { | ||
invariant( | ||
NativeModules.FrameRateLogger, | ||
'Trying to debug FrameRateLogger without the native module!', | ||
); | ||
} | ||
NativeModules.FrameRateLogger && NativeModules.FrameRateLogger.setGlobalOptions(options); | ||
}, | ||
|
||
/** | ||
* Must call `setContext` before any events can be properly tracked, which is done automatically | ||
* in `AppRegistry`, but navigation is also a common place to hook in. | ||
*/ | ||
setContext: function(context: string) { | ||
NativeModules.FrameRateLogger && NativeModules.FrameRateLogger.setContext(context); | ||
}, | ||
|
||
/** | ||
* Called in `ScrollResponder` so any component that uses that module will handle this | ||
* automatically. | ||
*/ | ||
beginScroll() { | ||
NativeModules.FrameRateLogger && NativeModules.FrameRateLogger.beginScroll(); | ||
}, | ||
|
||
/** | ||
* Called in `ScrollResponder` so any component that uses that module will handle this | ||
* automatically. | ||
*/ | ||
endScroll() { | ||
NativeModules.FrameRateLogger && NativeModules.FrameRateLogger.endScroll(); | ||
}, | ||
}; | ||
|
||
module.exports = FrameRateLogger; |
This file contains 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