90 lines
2.9 KiB
JavaScript
90 lines
2.9 KiB
JavaScript
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
* @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!',
|
|
);
|
|
}
|
|
if (NativeModules.FrameRateLogger) {
|
|
// Freeze the object to avoid the prepack warning (PP0017) about leaking
|
|
// unfrozen objects.
|
|
// Needs to clone the object first to avoid modifying the argument.
|
|
const optionsClone = {
|
|
debug: !!options.debug,
|
|
reportStackTraces: !!options.reportStackTraces,
|
|
};
|
|
Object.freeze(optionsClone);
|
|
Object.seal(optionsClone);
|
|
NativeModules.FrameRateLogger.setGlobalOptions(optionsClone);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* 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;
|