Rename compare->select

Author: Jack Pope

packages/react-debug-tools/src/ReactDebugHooks.js

@@ -37,7 +37,7 @@ import {
   REACT_CONTEXT_TYPE,
 } from 'shared/ReactSymbols';
 import hasOwnProperty from 'shared/hasOwnProperty';
-import type {ContextDependencyWithCompare} from '../../react-reconciler/src/ReactInternalTypes';
+import type {ContextDependencyWithSelect} from '../../react-reconciler/src/ReactInternalTypes';
 
 type CurrentDispatcherRef = typeof ReactSharedInternals;
 
@@ -159,7 +159,7 @@ let currentHook: null | Hook = null;
 let currentContextDependency:
   | null
   | ContextDependency<mixed>
-  | ContextDependencyWithCompare<mixed, mixed> = null;
+  | ContextDependencyWithSelect<mixed> = null;
 
 function nextHook(): null | Hook {
   const hook = currentHook;

packages/react-reconciler/src/ReactFiberNewContext.js

@@ -12,7 +12,7 @@ import type {
   Fiber,
   ContextDependency,
   Dependencies,
-  ContextDependencyWithCompare,
+  ContextDependencyWithSelect,
 } from './ReactInternalTypes';
 import type {StackCursor} from './ReactFiberStack';
 import type {Lanes} from './ReactFiberLane';
@@ -75,7 +75,7 @@ if (__DEV__) {
 let currentlyRenderingFiber: Fiber | null = null;
 let lastContextDependency:
   | ContextDependency<mixed>
-  | ContextDependencyWithCompare<mixed, mixed>
+  | ContextDependencyWithSelect<mixed>
   | null = null;
 let lastFullyObservedContext: ReactContext<any> | null = null;
 
@@ -408,15 +408,15 @@ function propagateContextChanges<T>(
           // Check if the context matches.
           if (dependency.context === context) {
             if (enableContextProfiling) {
-              const compare = dependency.compare;
-              if (compare != null && dependency.lastComparedValue != null) {
+              const select = dependency.select;
+              if (select != null && dependency.lastSelectedValue != null) {
                 const newValue = isPrimaryRenderer
                   ? dependency.context._currentValue
                   : dependency.context._currentValue2;
                 if (
-                  !checkIfComparedContextValuesChanged(
-                    dependency.lastComparedValue,
-                    compare(newValue),
+                  !checkIfSelectedContextValuesChanged(
+                    dependency.lastSelectedValue,
+                    select(newValue),
                   )
                 ) {
                   // Compared value hasn't changed. Bail out early.
@@ -663,7 +663,7 @@ function propagateParentContextChanges(
   workInProgress.flags |= DidPropagateContext;
 }
 
-function checkIfComparedContextValuesChanged(
+function checkIfSelectedContextValuesChanged(
   oldComparedValue: Array<mixed>,
   newComparedValue: Array<mixed>,
 ): boolean {
@@ -706,13 +706,13 @@ export function checkIfContextChanged(
     const oldValue = dependency.memoizedValue;
     if (
       enableContextProfiling &&
-      dependency.compare != null &&
-      dependency.lastComparedValue != null
+      dependency.select != null &&
+      dependency.lastSelectedValue != null
     ) {
       if (
-        checkIfComparedContextValuesChanged(
-          dependency.lastComparedValue,
-          dependency.compare(newValue),
+        checkIfSelectedContextValuesChanged(
+          dependency.lastSelectedValue,
+          dependency.select(newValue),
         )
       ) {
         return true;
@@ -762,7 +762,7 @@ export function readContextAndCompare<C>(
     throw new Error('Not implemented.');
   }
 
-  return readContextForConsumer_withCompare(
+  return readContextForConsumer_withSelect(
     currentlyRenderingFiber,
     context,
     compare,
@@ -796,10 +796,10 @@ export function readContextDuringReconciliation<T>(
   return readContextForConsumer(consumer, context);
 }
 
-function readContextForConsumer_withCompare<C, S>(
+function readContextForConsumer_withSelect<C>(
   consumer: Fiber | null,
   context: ReactContext<C>,
-  compare: C => Array<mixed>,
+  select: C => Array<mixed>,
 ): C {
   const value = isPrimaryRenderer
     ? context._currentValue
@@ -812,8 +812,8 @@ function readContextForConsumer_withCompare<C, S>(
       context: ((context: any): ReactContext<mixed>),
       memoizedValue: value,
       next: null,
-      compare: ((compare: any): (context: mixed) => Array<mixed>),
-      lastComparedValue: compare(value),
+      select: ((select: any): (context: mixed) => Array<mixed>),
+      lastSelectedValue: select(value),
     };
 
     if (lastContextDependency === null) {

packages/react-reconciler/src/ReactInternalTypes.js

@@ -63,29 +63,23 @@ export type HookType =
 
 export type ContextDependency<C> = {
   context: ReactContext<C>,
-  next:
-    | ContextDependency<mixed>
-    | ContextDependencyWithCompare<mixed, mixed>
-    | null,
+  next: ContextDependency<mixed> | ContextDependencyWithSelect<mixed> | null,
   memoizedValue: C,
 };
 
-export type ContextDependencyWithCompare<C, S> = {
+export type ContextDependencyWithSelect<C> = {
   context: ReactContext<C>,
-  next:
-    | ContextDependency<mixed>
-    | ContextDependencyWithCompare<mixed, mixed>
-    | null,
+  next: ContextDependency<mixed> | ContextDependencyWithSelect<mixed> | null,
   memoizedValue: C,
-  compare: C => Array<mixed>,
-  lastComparedValue: ?Array<mixed>,
+  select: C => Array<mixed>,
+  lastSelectedValue: ?Array<mixed>,
 };
 
 export type Dependencies = {
   lanes: Lanes,
   firstContext:
     | ContextDependency<mixed>
-    | ContextDependencyWithCompare<mixed, mixed>
+    | ContextDependencyWithSelect<mixed>
     | null,
   ...
 };
@@ -402,7 +396,7 @@ export type Dispatcher = {
   ): [S, Dispatch<A>],
   unstable_useContextWithBailout?: <T>(
     context: ReactContext<T>,
-    compare: (T => Array<mixed>) | null,
+    select: (T => Array<mixed>) | null,
   ) => T,
   useContext<T>(context: ReactContext<T>): T,
   useRef<T>(initialValue: T): {current: T},

scripts/error-codes/codes.json

@@ -525,5 +525,6 @@
   "537": "Cannot pass event handlers (%s) in renderToMarkup because the HTML will never be hydrated so they can never get called.",
   "538": "Cannot use state or effect Hooks in renderToMarkup because this component will never be hydrated.",
   "539": "Binary RSC chunks cannot be encoded as strings. This is a bug in the wiring of the React streams.",
-  "540": "String chunks need to be passed in their original shape. Not split into smaller string chunks. This is a bug in the wiring of the React streams."
-}
+  "540": "String chunks need to be passed in their original shape. Not split into smaller string chunks. This is a bug in the wiring of the React streams.",
+  "541": "Compared context values must be arrays"
+}