react icon indicating copy to clipboard operation
react copied to clipboard

[React 19] prop-types removal alternative / console component trace

Open oliviertassinari opened this issue 1 year ago • 17 comments
trafficstars

Summary

The state of .propTypes is a bit unclear. I see:

  1. https://react.dev/blog/2024/04/25/react-19 doesn't mention their deprecation but https://react.dev/blog/2024/04/25/react-19-upgrade-guide#removed-proptypes-and-defaultprops does. Should the two pages by synced?
  2. https://react.dev/blog/2024/04/25/react-19-upgrade-guide#removed-proptypes-and-defaultprops says: image

But it looks inaccurate, I would expect it says that React.PropTypes were deprecated from the source linked. SCR-20240504-buph Source

  1. The migration guides encourage to migrate to "TypeScript or another type-checking solution", but TypeScript has a limited type coverage. For instance, it doesn't support integers. We rely on this e.g. (not the most convincing example, though, you can check Material UI codebase to see other examples, like deprecated props, incompatible props combinations)
Autocomplete.propTypes = {
  /**
   * The maximum number of tags that will be visible when not focused.
   * Set `-1` to disable the limit.
   * @default -1
   */
  limitTags: integerPropType,

https://github.com/mui/material-ui/blob/2827bacf567fc95ef147d543316ffe688896db90/packages/mui-material/src/Autocomplete/Autocomplete.js#L985-L990

So to replace this, it seems that the closest alternative is to do something like this:

function DemoComponent(props) {
  if (process.env.NODE_ENV !== "production") {
    if (typeof props.bar !== "string") {
      console.error(
        `Warning: Failed prop type: Invalid prop \`bar\` of type \`number\` supplied to \`DemoComponent\`, expected \`string\`.`
      );
    }
  }

  return null;
}

Unfortunately, it's missing the component trace.

Before: https://codesandbox.io/p/sandbox/mystifying-mcclintock-mf7r5m?file=%2Fsrc%2FDemo.js%3A16%2C1

SCR-20240504-oepf

After: https://codesandbox.io/p/sandbox/agitated-orla-8kj8rh?file=%2Fsrc%2Findex.js

SCR-20240504-oehu

It seems much harder to figure out where console logs come from. So while https://react.dev/blog/2024/04/25/react-19#diffs-for-hydration-errors is a great step forward, this one feels like a step backward. Is there an alternative to it?

There is a function in https://github.com/facebook/prop-types/blob/1c9c6311c1fb8778bffc7a1ca70c273ee8a8654d/checkPropTypes.js#L20 but it doesn't log the component trace either. This function was recommended in #28328.

oliviertassinari avatar May 04 '24 14:05 oliviertassinari

Unfortunately, it's missing the component trace.

React is missing a public API for logging component stack trace. The only way I managed to get the stack trace is this:

const getStackTrace = () => {
  let stack = '';
  const ReactSharedInternals = React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED;
  if (ReactSharedInternals != null) {
    const ReactDebugCurrentFrame = ReactSharedInternals.ReactDebugCurrentFrame;
    const stackAddendum = ReactDebugCurrentFrame.getStackAddendum();
    if (stackAddendum !== '') {
      stack = stackAddendum;
    }
  }
  return stack;
}

The problems with this solution:

  • It uses internal API that differs across the major React versions
  • I would rather keep my current job 😅

Does the React team consider adding public API for this?

Alternatively, we can create a community package that would encapsulate the internal API access and provide a cross-version method for getting the stack trace.

cherniavskii avatar May 09 '24 19:05 cherniavskii

There are two separate issues here: PropTypes deprecation, and component stacks for console.error. The PropTypes concerns are understandable, but we're not adding support back to them. The blog posts are separate because one announces the features in 19, and the other the breaking/notable changes:

In our React 19 Beta Upgrade Guide, we shared step-by-step instructions for upgrading your app to React 19 Beta. In this post, we’ll give an overview of the new features in React 19, and how you can adopt them.

The component stack changes seem concerning, they seem to work for me in the CodeSandbox you linked:

Screenshot 2024-05-09 at 8 38 07 PM

rickhanlonii avatar May 10 '24 00:05 rickhanlonii

they seem to work for me in the CodeSandbox you linked

@rickhanlonii It doesn't work when opening the codesandbox link standalone. It doesn't work on Vite either. I haven't tested Next.js but I don't recall seeing it work their either.

oliviertassinari avatar May 10 '24 10:05 oliviertassinari

Doesn't work in Next.js neither for me. I suppose normally the react devtools extension should kick in?

Janpot avatar May 10 '24 11:05 Janpot

There are two separate issues here: PropTypes deprecation, and component stacks for console.error.

Correct! I mentioned the component stacks in this issue because we need them for props validation errors that would replace propTypes for us.

cherniavskii avatar May 10 '24 17:05 cherniavskii

I just stumbled on this issue while catching up on React 19 changes - specifically around the removal of propTypes checking, I'm concerned the documentation could have been clearer.

What's caught me off guard is that "Importing prop type checkers with React.PropTypes" and "actual checking of types defined with .propTypes" are two completely separate things, and only the former was ever actually documented & deprecated in 15.5.0, so it's a bit revisionist to say that proptypes themselves have been deprecated for that long.

As far as I can see there was no public discussion or proposal for the removal of actual prop type checking - and while I guess technically it's not a breaking change so it's not strictly necessary to put in deprecation warnings as with e.g. defaultProps, it's nonetheless caught me by surprise. I guess the ship has sailed now but I certainly would have welcomed the opportunity to contribute to any discussion when it was being considered.

jbt avatar Jun 05 '24 16:06 jbt

Data from https://2023.stateofjs.com/en-US/usage/

SCR-20240722-nhza

You can conclude that:

  • 70% of the code written is in TypeScript (9.33 * 0+5.6 * 0.13+4.22 * 0.25+2.26 * 0.38+5.99 * 0.5+3.16 * 0.63+10.76 * 0.75+26.47 * 0.88+32.22 * 1) (up from 50% in 2022 https://2022.stateofjs.com/en-US/usage/#js_ts_balance)
  • 30% of the code written is in JavaScript (9.33 * 1+5.6 * 0.88+4.22 * 0.75+2.26 * 0.63+5.99 * 0.5+3.16 * 0.38+10.76 * 0.25+26.47 * 0.13+32.22 * 0)

We might be looking at 30% of the user base with no more types. It will be interesting to see what 2024 looks like. If this grows from 70% to 90%, it should be all fine.

Then, it's really only about the problems listed above with not having propTypes when writing TypeScript (no React track with console.error/warn, no coverage for more specific types, no primitives for warning deduplication in render components),

oliviertassinari avatar Jul 22 '24 13:07 oliviertassinari

Could anyone help me understand how to override class components for adding the type-value checks. That is, there is no React.Component.prototype.render.

So we can't simply:

import checkPropTypes from 'prop-types/checkPropTypes'

const oldRender = React.Component.prototype.render
React.Component.prototype.render = function () {
  checkPropTypes(this.propTypes, props, 'prop', this.name)
  oldRender()
}

Or any other approach. Thanks


As @oliviertassinari mentioned, I also check the values (not only the data type). Also, as @jbt said, this deprecation caught me by surprised as well.

ericfortis avatar Jul 28 '24 23:07 ericfortis