From 022dc8ef386c9c2c4a305a17f022569349e2f71a Mon Sep 17 00:00:00 2001 From: Alexey Lang Date: Fri, 15 Mar 2019 07:30:07 -0700 Subject: [PATCH] Implement withPerformanceLoggerContext Summary: This function returns a HOC that passes `scopedPerformanceLogger` as a prop to the wrapped component. That HOC can be used whenever we can't declare `static contextType` as `PerformanceLoggerContext` on a component, for example because React supports only one React Context per component. Reviewed By: sahrens Differential Revision: D14385560 fbshipit-source-id: 41971b4bf499f336c34b9220a3ee97c4ed89498d --- .../Utilities/PerformanceLoggerContext.js | 8 ++- .../Utilities/withPerformanceLoggerContext.js | 52 +++++++++++++++++++ 2 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 Libraries/Utilities/withPerformanceLoggerContext.js diff --git a/Libraries/Utilities/PerformanceLoggerContext.js b/Libraries/Utilities/PerformanceLoggerContext.js index 79e62d5c316..82eba2c0882 100644 --- a/Libraries/Utilities/PerformanceLoggerContext.js +++ b/Libraries/Utilities/PerformanceLoggerContext.js @@ -14,7 +14,13 @@ import * as React from 'react'; import GlobalPerformanceLogger from 'GlobalPerformanceLogger'; import type {IPerformanceLogger} from 'createPerformanceLogger'; +/** + * This is a React Context that provides a scoped instance of IPerformanceLogger. + * We wrap every with a Provider for this context so the logger + * should be available in every component. + * See React docs about using Context: https://reactjs.org/docs/context.html + */ const PerformanceLoggerContext: React.Context = React.createContext( GlobalPerformanceLogger, ); -export default PerformanceLoggerContext; +module.exports = PerformanceLoggerContext; diff --git a/Libraries/Utilities/withPerformanceLoggerContext.js b/Libraries/Utilities/withPerformanceLoggerContext.js new file mode 100644 index 00000000000..7043f6f9820 --- /dev/null +++ b/Libraries/Utilities/withPerformanceLoggerContext.js @@ -0,0 +1,52 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + * + * @flow + * @format + */ + +'use strict'; + +const React = require('React'); +const PerformanceLoggerContext = require('PerformanceLoggerContext'); +import type {IPerformanceLogger} from 'createPerformanceLogger'; + +export type PerformanceLoggerContextProps = $Exact; + +type PerformanceLoggerContextConfig = { + +scopedPerformanceLogger: IPerformanceLogger, +}; + +/** + * If you already have one React Context on your component, you can't use + * PerformanceLoggerContext without a consumer for it. This function helps to + * do that by providing a HOC. Here's how to use it: + * 1) Spread PerformanceLoggerContextProps into your component's Props. + * 2) Call this function with Props and DefaultProps of your component. + 3 3) Use the returned HOC instead of your component. + */ +function withPerformanceLoggerContext( + Component: React.AbstractComponent, +): React.AbstractComponent<$Diff> { + return class WrappedComponent extends React.Component< + $Diff, + > { + render() { + return ( + + {scopedPerformanceLogger => ( + + )} + + ); + } + }; +} + +module.exports = withPerformanceLoggerContext;