Pass ref as normal prop (#28348)

Depends on: - #28317 - #28320 --- Changes the behavior of the JSX runtime to pass through `ref` as a normal prop, rather than plucking it from the props object and storing on the element. This is a breaking change since it changes the type of the receiving component. However, most code is unaffected since it's unlikely that a component would have attempted to access a `ref` prop, since it was not possible to get a reference to one. `forwardRef` _will_ still pluck `ref` from the props object, though, since it's extremely common for users to spread the props object onto the inner component and pass `ref` as a differently named prop. This is for maximum compatibility with existing code — the real impact of this change is that `forwardRef` is no longer required. Currently, refs are resolved during child reconciliation and stored on the fiber. As a result of this change, we can move ref resolution to happen only much later, and only for components that actually use them. Then we can remove the `ref` field from the Fiber type. I have not yet done that in this step, though. DiffTrain build for [fa2f82a](fa2f82a)
facebook · Feb 20, 2024 · 6479760 · 6479760
1 parent 3f81ef2
commit 6479760
Show file tree

Hide file tree

Showing 34 changed files with 706 additions and 397 deletions.
diff --git a/compiled/facebook-www/JSXDEVRuntime-dev.classic.js b/compiled/facebook-www/JSXDEVRuntime-dev.classic.js
@@ -1007,25 +1007,27 @@ if (__DEV__) {
 
     function defineRefPropWarningGetter(props, displayName) {
       {
-        var warnAboutAccessingRef = function () {
-          if (!specialPropRefWarningShown) {
-            specialPropRefWarningShown = true;
+        {
+          var warnAboutAccessingRef = function () {
+            if (!specialPropRefWarningShown) {
+              specialPropRefWarningShown = true;
 
-            error(
-              "%s: `ref` is not a prop. Trying to access it will result " +
-                "in `undefined` being returned. If you need to access the same " +
-                "value within the child component, you should pass it as a different " +
-                "prop. (https://reactjs.org/link/special-props)",
-              displayName
-            );
-          }
-        };
+              error(
+                "%s: `ref` is not a prop. Trying to access it will result " +
+                  "in `undefined` being returned. If you need to access the same " +
+                  "value within the child component, you should pass it as a different " +
+                  "prop. (https://reactjs.org/link/special-props)",
+                displayName
+              );
+            }
+          };
 
-        warnAboutAccessingRef.isReactWarning = true;
-        Object.defineProperty(props, "ref", {
-          get: warnAboutAccessingRef,
-          configurable: true
-        });
+          warnAboutAccessingRef.isReactWarning = true;
+          Object.defineProperty(props, "ref", {
+            get: warnAboutAccessingRef,
+            configurable: true
+          });
+        }
       }
     }
     /**
@@ -1049,18 +1051,30 @@ if (__DEV__) {
      * @internal
      */
 
-    function ReactElement(type, key, ref, self, source, owner, props) {
-      var element = {
-        // This tag allows us to uniquely identify this as a React Element
-        $$typeof: REACT_ELEMENT_TYPE,
-        // Built-in properties that belong on the element
-        type: type,
-        key: key,
-        ref: ref,
-        props: props,
-        // Record the component responsible for creating this element.
-        _owner: owner
-      };
+    function ReactElement(type, key, _ref, self, source, owner, props) {
+      var ref;
+
+      {
+        ref = _ref;
+      }
+
+      var element;
+
+      {
+        // In prod, `ref` is a regular property. It will be removed in a
+        // future release.
+        element = {
+          // This tag allows us to uniquely identify this as a React Element
+          $$typeof: REACT_ELEMENT_TYPE,
+          // Built-in properties that belong on the element
+          type: type,
+          key: key,
+          ref: ref,
+          props: props,
+          // Record the component responsible for creating this element.
+          _owner: owner
+        };
+      }
 
       {
         // The validation flag is currently mutative. We put it on
@@ -1246,14 +1260,17 @@ if (__DEV__) {
         }
 
         if (hasValidRef(config)) {
-          ref = config.ref;
+          {
+            ref = config.ref;
+          }
+
           warnIfStringRefCannotBeAutoConverted(config, self);
         } // Remaining properties are added to a new props object
 
         for (propName in config) {
           if (
             hasOwnProperty.call(config, propName) && // Skip over reserved prop names
-            propName !== "key" && // TODO: `ref` will no longer be reserved in the next major
+            propName !== "key" &&
             propName !== "ref"
           ) {
             props[propName] = config[propName];
@@ -1494,6 +1511,7 @@ if (__DEV__) {
      */
 
     function validateFragmentProps(fragment) {
+      // TODO: Move this to render phase instead of at element creation.
       {
         var keys = Object.keys(fragment.props);
 

diff --git a/compiled/facebook-www/JSXDEVRuntime-dev.modern.js b/compiled/facebook-www/JSXDEVRuntime-dev.modern.js
@@ -1007,25 +1007,27 @@ if (__DEV__) {
 
     function defineRefPropWarningGetter(props, displayName) {
       {
-        var warnAboutAccessingRef = function () {
-          if (!specialPropRefWarningShown) {
-            specialPropRefWarningShown = true;
+        {
+          var warnAboutAccessingRef = function () {
+            if (!specialPropRefWarningShown) {
+              specialPropRefWarningShown = true;
 
-            error(
-              "%s: `ref` is not a prop. Trying to access it will result " +
-                "in `undefined` being returned. If you need to access the same " +
-                "value within the child component, you should pass it as a different " +
-                "prop. (https://reactjs.org/link/special-props)",
-              displayName
-            );
-          }
-        };
+              error(
+                "%s: `ref` is not a prop. Trying to access it will result " +
+                  "in `undefined` being returned. If you need to access the same " +
+                  "value within the child component, you should pass it as a different " +
+                  "prop. (https://reactjs.org/link/special-props)",
+                displayName
+              );
+            }
+          };
 
-        warnAboutAccessingRef.isReactWarning = true;
-        Object.defineProperty(props, "ref", {
-          get: warnAboutAccessingRef,
-          configurable: true
-        });
+          warnAboutAccessingRef.isReactWarning = true;
+          Object.defineProperty(props, "ref", {
+            get: warnAboutAccessingRef,
+            configurable: true
+          });
+        }
       }
     }
     /**
@@ -1049,18 +1051,30 @@ if (__DEV__) {
      * @internal
      */
 
-    function ReactElement(type, key, ref, self, source, owner, props) {
-      var element = {
-        // This tag allows us to uniquely identify this as a React Element
-        $$typeof: REACT_ELEMENT_TYPE,
-        // Built-in properties that belong on the element
-        type: type,
-        key: key,
-        ref: ref,
-        props: props,
-        // Record the component responsible for creating this element.
-        _owner: owner
-      };
+    function ReactElement(type, key, _ref, self, source, owner, props) {
+      var ref;
+
+      {
+        ref = _ref;
+      }
+
+      var element;
+
+      {
+        // In prod, `ref` is a regular property. It will be removed in a
+        // future release.
+        element = {
+          // This tag allows us to uniquely identify this as a React Element
+          $$typeof: REACT_ELEMENT_TYPE,
+          // Built-in properties that belong on the element
+          type: type,
+          key: key,
+          ref: ref,
+          props: props,
+          // Record the component responsible for creating this element.
+          _owner: owner
+        };
+      }
 
       {
         // The validation flag is currently mutative. We put it on
@@ -1246,14 +1260,17 @@ if (__DEV__) {
         }
 
         if (hasValidRef(config)) {
-          ref = config.ref;
+          {
+            ref = config.ref;
+          }
+
           warnIfStringRefCannotBeAutoConverted(config, self);
         } // Remaining properties are added to a new props object
 
         for (propName in config) {
           if (
             hasOwnProperty.call(config, propName) && // Skip over reserved prop names
-            propName !== "key" && // TODO: `ref` will no longer be reserved in the next major
+            propName !== "key" &&
             propName !== "ref"
           ) {
             props[propName] = config[propName];
@@ -1494,6 +1511,7 @@ if (__DEV__) {
      */
 
     function validateFragmentProps(fragment) {
+      // TODO: Move this to render phase instead of at element creation.
       {
         var keys = Object.keys(fragment.props);
 

diff --git a/compiled/facebook-www/REVISION b/compiled/facebook-www/REVISION
@@ -1 +1 @@
-5fb2c93f3924ba980444da5698f60651b5ef0689
+fa2f82addc7c817892c482792f56a35277e8b75a
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		5fb2c93f3924ba980444da5698f60651b5ef0689
		fa2f82addc7c817892c482792f56a35277e8b75a