Disallow reading context during useMemo etc (#14648)
* Disallow reading context during useMemo etc * Continue allowing readContext() in classes and context consumers The previous commit check was too broad and incorrectly restricted classes from calling readContext(). This check is more precise and only targets components that are Hook-capable. It exploits the fact that `renderExpirationTime` is never `NoWork` after `renderWithHooks` -- something we already rely on.
Dan Abramov committed
Jan 21, 2019 at 19:06 UTC
1fcbd22431d97e404c1f684744dc543b6c22b076
4 files changed
+110
-12
packages/react-reconciler/src/ReactFiberClassComponent.js
+1
-8
@@ -20,7 +20,6 @@ import {
20
import ReactStrictModeWarnings from './ReactStrictModeWarnings';
21
import {isMounted} from 'react-reconciler/reflection';
22
import {get as getInstance, set as setInstance} from 'shared/ReactInstanceMap';
23
-import ReactSharedInternals from 'shared/ReactSharedInternals';
23
import shallowEqual from 'shared/shallowEqual';
24
import getComponentName from 'shared/getComponentName';
25
import invariant from 'shared/invariant';
@@ -48,6 +47,7 @@ import {
47
hasContextChanged,
48
emptyContextObject,
49
} from './ReactFiberContext';
50
+import {readContext} from './ReactFiberNewContext';
51
import {
52
requestCurrentTime,
53
computeExpirationForFiber,
@@ -55,13 +55,6 @@ import {
55
flushPassiveEffects,
56
} from './ReactFiberScheduler';
57
58
-const ReactCurrentDispatcher = ReactSharedInternals.ReactCurrentDispatcher;
59
-
60
-function readContext(contextType: any): any {
61
- const dispatcher = ReactCurrentDispatcher.current;
62
- return dispatcher.readContext(contextType);
63
-}
64
-
58
const fakeInternalInstance = {};
59
const isArray = Array.isArray;
60
packages/react-reconciler/src/ReactFiberDispatcher.js
+1
-1
@@ -7,8 +7,8 @@
7
* @flow
8
*/
9
10
-import {readContext} from './ReactFiberNewContext';
10
import {
11
+ readContext,
12
useCallback,
13
useContext,
14
useEffect,
packages/react-reconciler/src/ReactFiberHooks.js
+26
-3
@@ -14,7 +14,7 @@ import type {HookEffectTag} from './ReactHookEffectTags';
14
15
import {NoWork} from './ReactFiberExpirationTime';
16
import {enableHooks} from 'shared/ReactFeatureFlags';
17
-import {readContext} from './ReactFiberNewContext';
17
+import {readContext as readContextWithoutCheck} from './ReactFiberNewContext';
18
import {
19
Update as UpdateEffect,
20
Passive as PassiveEffect,
@@ -284,7 +284,7 @@ export function resetHooks(): void {
284
285
// This is used to reset the state of this module when a component throws.
286
// It's also called inside mountIndeterminateComponent if we determine the
287
- // component is a module-style component.
287
+ // component is a module-style component, and also in readContext() above.
288
renderExpirationTime = NoWork;
289
currentlyRenderingFiber = null;
290
@@ -394,7 +394,7 @@ export function useContext<T>(
394
// Ensure we're in a function component (class components support only the
395
// .unstable_read() form)
396
resolveCurrentlyRenderingFiber();
397
- return readContext(context, observedBits);
397
+ return readContextWithoutCheck(context, observedBits);
398
}
399
400
export function useState<S>(
@@ -771,6 +771,29 @@ export function useMemo<T>(
771
return nextValue;
772
}
773
774
+export function readContext<T>(
775
+ context: ReactContext<T>,
776
+ observedBits: void | number | boolean,
777
+): T {
778
+ // Forbid reading context inside Hooks.
779
+ // The outer check tells us whether we're inside a Hook like useMemo().
780
+ // However, it would also be true if we're rendering a class.
781
+ if (currentlyRenderingFiber === null) {
782
+ // The inner check tells us we're currently in renderWithHooks() phase
783
+ // rather than, for example, in a class or a context consumer.
784
+ // Then we know it should be an error.
785
+ if (renderExpirationTime !== NoWork) {
786
+ invariant(
787
+ false,
788
+ 'Context can only be read inside the body of a component. ' +
789
+ 'If you read context inside a Hook like useMemo or useReducer, ' +
790
+ 'move the call directly into the component body.',
791
+ );
792
+ }
793
+ }
794
+ return readContextWithoutCheck(context, observedBits);
795
+}
796
+
797
function dispatchAction<S, A>(
798
fiber: Fiber,
799
queue: UpdateQueue<S, A>,
packages/react-reconciler/src/__tests__/ReactHooks-test.internal.js
+82
@@ -633,6 +633,88 @@ describe('ReactHooks', () => {
633
expect(root.toJSON()).toEqual('123');
634
});
635
636
+ it('throws when reading context inside useMemo', () => {
637
+ const {useMemo, createContext} = React;
638
+ const ReactCurrentDispatcher =
639
+ React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
640
+ .ReactCurrentDispatcher;
641
+
642
+ const ThemeContext = createContext('light');
643
+ function App() {
644
+ return useMemo(() => {
645
+ return ReactCurrentDispatcher.current.readContext(ThemeContext);
646
+ }, []);
647
+ }
648
+
649
+ expect(() => ReactTestRenderer.create(<App />)).toThrow(
650
+ 'Context can only be read inside the body of a component',
651
+ );
652
+ });
653
+
654
+ it('throws when reading context inside useEffect', () => {
655
+ const {useEffect, createContext} = React;
656
+ const ReactCurrentDispatcher =
657
+ React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
658
+ .ReactCurrentDispatcher;
659
+
660
+ const ThemeContext = createContext('light');
661
+ function App() {
662
+ useEffect(() => {
663
+ ReactCurrentDispatcher.current.readContext(ThemeContext);
664
+ });
665
+ return null;
666
+ }
667
+
668
+ const root = ReactTestRenderer.create(<App />);
669
+ expect(() => root.update(<App />)).toThrow(
670
+ // The exact message doesn't matter, just make sure we don't allow this
671
+ "Cannot read property 'readContext' of null",
672
+ );
673
+ });
674
+
675
+ it('throws when reading context inside useLayoutEffect', () => {
676
+ const {useLayoutEffect, createContext} = React;
677
+ const ReactCurrentDispatcher =
678
+ React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
679
+ .ReactCurrentDispatcher;
680
+
681
+ const ThemeContext = createContext('light');
682
+ function App() {
683
+ useLayoutEffect(() => {
684
+ ReactCurrentDispatcher.current.readContext(ThemeContext);
685
+ });
686
+ return null;
687
+ }
688
+
689
+ expect(() => ReactTestRenderer.create(<App />)).toThrow(
690
+ // The exact message doesn't matter, just make sure we don't allow this
691
+ "Cannot read property 'readContext' of null",
692
+ );
693
+ });
694
+
695
+ it('throws when reading context inside useReducer', () => {
696
+ const {useReducer, createContext} = React;
697
+ const ReactCurrentDispatcher =
698
+ React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
699
+ .ReactCurrentDispatcher;
700
+
701
+ const ThemeContext = createContext('light');
702
+ function App() {
703
+ useReducer(
704
+ () => {
705
+ ReactCurrentDispatcher.current.readContext(ThemeContext);
706
+ },
707
+ null,
708
+ {},
709
+ );
710
+ return null;
711
+ }
712
+
713
+ expect(() => ReactTestRenderer.create(<App />)).toThrow(
714
+ 'Context can only be read inside the body of a component.',
715
+ );
716
+ });
717
+
718
it('throws when calling hooks inside useReducer', () => {
719
const {useReducer, useRef} = React;
720
function App() {