Skip to content

[Flight] Support classes in renderDebugModel #33590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 22, 2025

Conversation

sebmarkbage
Copy link
Collaborator

This adds better support for serializing class instances as Debug values.

It adds a new marker on the object { "": "$P...", ... } which indicates which constructor's prototype to use for this object's prototype. It doesn't encode arbitrary prototypes and it doesn't encode any of the properties on the prototype. It might get some of the properties from the prototype by virtue of toString on a class constructor will include the whole class's body.

This will ensure that the instance gets the right name in logs.

Additionally, this now also invokes getters if they're enumerable on the prototype. This lets us reify values that can only be read from native classes.

@sebmarkbage sebmarkbage requested a review from unstubbable June 22, 2025 03:35
@github-actions github-actions bot added the React Core Team Opened by a member of the React Core Team label Jun 22, 2025
@react-sizebot
Copy link

react-sizebot commented Jun 22, 2025

Comparing: 1d1b26c...e9208bd

Critical size changes

Includes critical production bundles, as well as any change greater than 2%:

Name +/- Base Current +/- gzip Base gzip Current gzip
oss-stable/react-dom/cjs/react-dom.production.js = 6.68 kB 6.68 kB = 1.83 kB 1.83 kB
oss-stable/react-dom/cjs/react-dom-client.production.js = 530.57 kB 530.57 kB = 93.67 kB 93.67 kB
oss-experimental/react-dom/cjs/react-dom.production.js = 6.69 kB 6.69 kB = 1.83 kB 1.83 kB
oss-experimental/react-dom/cjs/react-dom-client.production.js = 651.66 kB 651.66 kB = 114.78 kB 114.78 kB
facebook-www/ReactDOM-prod.classic.js = 674.81 kB 674.81 kB = 118.78 kB 118.78 kB
facebook-www/ReactDOM-prod.modern.js = 665.30 kB 665.30 kB = 117.19 kB 117.19 kB

Significant size changes

Includes any change greater than 0.2%:

Expand to show
Name +/- Base Current +/- gzip Base gzip Current gzip
oss-stable-semver/react-server-dom-esm/cjs/react-server-dom-esm-client.browser.development.js +1.76% 98.42 kB 100.15 kB +1.17% 18.54 kB 18.75 kB
oss-stable/react-server-dom-esm/cjs/react-server-dom-esm-client.browser.development.js +1.76% 98.47 kB 100.20 kB +1.17% 18.56 kB 18.78 kB
oss-stable-semver/react-server-dom-parcel/cjs/react-server-dom-parcel-client.browser.development.js +1.75% 98.78 kB 100.51 kB +1.21% 18.51 kB 18.73 kB
oss-stable/react-server-dom-parcel/cjs/react-server-dom-parcel-client.browser.development.js +1.75% 98.83 kB 100.56 kB +1.20% 18.53 kB 18.75 kB
oss-stable-semver/react-client/cjs/react-client-flight.development.js +1.73% 100.10 kB 101.83 kB +1.19% 18.29 kB 18.51 kB
oss-stable/react-client/cjs/react-client-flight.development.js +1.73% 100.13 kB 101.86 kB +1.20% 18.31 kB 18.53 kB
oss-stable-semver/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.browser.development.js +1.72% 100.61 kB 102.34 kB +1.16% 18.92 kB 19.14 kB
oss-stable/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.browser.development.js +1.72% 100.66 kB 102.39 kB +1.16% 18.95 kB 19.17 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-client.browser.development.js +1.71% 101.17 kB 102.90 kB +1.16% 19.06 kB 19.28 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-client.browser.development.js +1.71% 101.22 kB 102.95 kB +1.16% 19.08 kB 19.30 kB
oss-stable-semver/react-server-dom-esm/cjs/react-server-dom-esm-client.node.development.js +1.68% 103.08 kB 104.81 kB +1.21% 19.34 kB 19.57 kB
oss-stable/react-server-dom-esm/cjs/react-server-dom-esm-client.node.development.js +1.68% 103.08 kB 104.81 kB +1.21% 19.34 kB 19.57 kB
oss-stable-semver/react-server-dom-parcel/cjs/react-server-dom-parcel-client.edge.development.js +1.66% 104.37 kB 106.10 kB +1.19% 19.65 kB 19.88 kB
oss-stable/react-server-dom-parcel/cjs/react-server-dom-parcel-client.edge.development.js +1.66% 104.37 kB 106.10 kB +1.19% 19.65 kB 19.88 kB
oss-stable-semver/react-server-dom-parcel/cjs/react-server-dom-parcel-client.node.development.js +1.64% 105.61 kB 107.34 kB +1.08% 19.80 kB 20.02 kB
oss-stable/react-server-dom-parcel/cjs/react-server-dom-parcel-client.node.development.js +1.64% 105.61 kB 107.34 kB +1.08% 19.80 kB 20.02 kB
oss-stable-semver/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.edge.development.js +1.61% 107.47 kB 109.20 kB +1.19% 20.12 kB 20.36 kB
oss-stable/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.edge.development.js +1.61% 107.47 kB 109.20 kB +1.19% 20.12 kB 20.36 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-client.edge.development.js +1.61% 107.56 kB 109.29 kB +1.19% 20.15 kB 20.39 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-client.edge.development.js +1.61% 107.56 kB 109.29 kB +1.19% 20.15 kB 20.39 kB
oss-stable-semver/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.node.development.js +1.59% 108.54 kB 110.27 kB +1.06% 20.29 kB 20.51 kB
oss-stable/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.node.development.js +1.59% 108.54 kB 110.27 kB +1.06% 20.29 kB 20.51 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-client.node.unbundled.development.js +1.56% 110.89 kB 112.62 kB +1.04% 20.53 kB 20.74 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-client.node.unbundled.development.js +1.56% 110.89 kB 112.62 kB +1.04% 20.53 kB 20.74 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-client.node.development.js +1.54% 112.22 kB 113.95 kB +1.04% 20.78 kB 20.99 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-client.node.development.js +1.54% 112.22 kB 113.95 kB +1.04% 20.78 kB 20.99 kB
oss-experimental/react-server-dom-esm/cjs/react-server-dom-esm-client.browser.development.js +1.49% 115.98 kB 117.71 kB +0.93% 21.55 kB 21.75 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-client.browser.development.js +1.49% 116.34 kB 118.07 kB +0.92% 21.49 kB 21.69 kB
oss-experimental/react-client/cjs/react-client-flight.development.js +1.47% 117.63 kB 119.36 kB +0.94% 21.31 kB 21.51 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.browser.development.js +1.46% 118.17 kB 119.90 kB +0.92% 21.94 kB 22.14 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-client.browser.development.js +1.46% 118.72 kB 120.45 kB +0.91% 22.07 kB 22.28 kB
oss-experimental/react-server-dom-esm/cjs/react-server-dom-esm-client.node.development.js +1.43% 120.58 kB 122.31 kB +0.98% 22.34 kB 22.56 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-client.edge.development.js +1.42% 121.87 kB 123.60 kB +0.96% 22.69 kB 22.91 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-client.node.development.js +1.41% 123.11 kB 124.84 kB +0.95% 22.82 kB 23.04 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.edge.development.js +1.38% 124.96 kB 126.69 kB +0.95% 23.18 kB 23.40 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-client.edge.development.js +1.38% 125.05 kB 126.78 kB +0.95% 23.22 kB 23.44 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-client.node.development.js +1.37% 126.03 kB 127.76 kB +0.95% 23.31 kB 23.53 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-client.node.unbundled.development.js +1.35% 128.39 kB 130.12 kB +0.94% 23.56 kB 23.78 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-client.node.development.js +1.33% 129.72 kB 131.45 kB +0.94% 23.81 kB 24.03 kB
oss-stable-semver/react-server-dom-esm/esm/react-server-dom-esm-client.browser.development.js +1.22% 136.87 kB 138.55 kB +0.98% 32.01 kB 32.32 kB
oss-stable/react-server-dom-esm/esm/react-server-dom-esm-client.browser.development.js +1.22% 136.90 kB 138.57 kB +0.98% 32.04 kB 32.35 kB
oss-experimental/react-server-dom-esm/esm/react-server-dom-esm-client.browser.development.js +1.09% 154.09 kB 155.76 kB +0.87% 35.84 kB 36.15 kB
oss-stable-semver/react-server/cjs/react-server-flight.development.js +0.59% 114.22 kB 114.90 kB +0.26% 21.07 kB 21.13 kB
oss-stable/react-server/cjs/react-server-flight.development.js +0.59% 114.22 kB 114.90 kB +0.26% 21.07 kB 21.13 kB
oss-experimental/react-server/cjs/react-server-flight.development.js +0.55% 122.33 kB 123.01 kB +0.27% 22.52 kB 22.58 kB
oss-stable-semver/react-server-dom-parcel/cjs/react-server-dom-parcel-server.browser.development.js +0.41% 153.02 kB 153.65 kB +0.19% 28.29 kB 28.34 kB
oss-stable/react-server-dom-parcel/cjs/react-server-dom-parcel-server.browser.development.js +0.41% 153.02 kB 153.65 kB +0.19% 28.29 kB 28.34 kB
oss-experimental/react-markup/cjs/react-markup.react-server.development.js +0.41% 592.81 kB 595.21 kB +0.32% 105.89 kB 106.23 kB
oss-stable-semver/react-server-dom-parcel/cjs/react-server-dom-parcel-server.edge.development.js +0.40% 156.73 kB 157.35 kB +0.20% 28.79 kB 28.85 kB
oss-stable/react-server-dom-parcel/cjs/react-server-dom-parcel-server.edge.development.js +0.40% 156.73 kB 157.35 kB +0.20% 28.79 kB 28.85 kB
oss-stable-semver/react-server-dom-esm/cjs/react-server-dom-esm-server.node.development.js +0.39% 157.47 kB 158.10 kB +0.16% 29.16 kB 29.21 kB
oss-stable/react-server-dom-esm/cjs/react-server-dom-esm-server.node.development.js +0.39% 157.47 kB 158.10 kB +0.16% 29.16 kB 29.21 kB
oss-stable-semver/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.browser.development.js +0.39% 160.86 kB 161.48 kB +0.19% 29.67 kB 29.73 kB
oss-stable/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.browser.development.js +0.39% 160.86 kB 161.48 kB +0.19% 29.67 kB 29.73 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-server.browser.development.js +0.39% 161.16 kB 161.78 kB +0.18% 29.80 kB 29.85 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-server.browser.development.js +0.38% 161.41 kB 162.02 kB +0.20% 29.79 kB 29.85 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-server.browser.development.js +0.38% 161.41 kB 162.02 kB +0.20% 29.79 kB 29.85 kB
oss-stable-semver/react-server-dom-parcel/cjs/react-server-dom-parcel-server.node.development.js +0.38% 162.14 kB 162.76 kB +0.21% 29.61 kB 29.67 kB
oss-stable/react-server-dom-parcel/cjs/react-server-dom-parcel-server.node.development.js +0.38% 162.14 kB 162.76 kB +0.21% 29.61 kB 29.67 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-server.edge.development.js +0.38% 164.57 kB 165.19 kB +0.18% 30.18 kB 30.23 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-server.edge.development.js +0.38% 164.57 kB 165.19 kB +0.18% 30.18 kB 30.23 kB
oss-stable-semver/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.edge.development.js +0.38% 164.60 kB 165.22 kB +0.19% 30.17 kB 30.23 kB
oss-stable/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.edge.development.js +0.38% 164.60 kB 165.22 kB +0.19% 30.17 kB 30.23 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-server.edge.development.js +0.38% 165.21 kB 165.83 kB +0.16% 30.32 kB 30.37 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-server.node.unbundled.development.js +0.37% 168.98 kB 169.60 kB +0.21% 30.67 kB 30.73 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-server.node.unbundled.development.js +0.37% 168.98 kB 169.60 kB +0.21% 30.67 kB 30.73 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.browser.development.js +0.37% 168.99 kB 169.62 kB +0.17% 31.17 kB 31.22 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-server.browser.development.js +0.37% 169.54 kB 170.16 kB +0.18% 31.30 kB 31.35 kB
oss-stable-semver/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.node.development.js +0.37% 170.13 kB 170.75 kB +0.19% 30.97 kB 31.03 kB
oss-stable/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.node.development.js +0.37% 170.13 kB 170.75 kB +0.19% 30.97 kB 31.03 kB
oss-stable-semver/react-server-dom-webpack/cjs/react-server-dom-webpack-server.node.development.js +0.36% 170.18 kB 170.80 kB +0.19% 30.99 kB 31.05 kB
oss-stable/react-server-dom-webpack/cjs/react-server-dom-webpack-server.node.development.js +0.36% 170.18 kB 170.80 kB +0.19% 30.99 kB 31.05 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-server.edge.development.js +0.36% 173.05 kB 173.68 kB +0.16% 31.72 kB 31.77 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.edge.development.js +0.36% 173.08 kB 173.70 kB +0.16% 31.71 kB 31.76 kB
oss-experimental/react-server-dom-esm/cjs/react-server-dom-esm-server.node.development.js +0.35% 176.70 kB 177.32 kB +0.16% 32.82 kB 32.88 kB
oss-experimental/react-server-dom-parcel/cjs/react-server-dom-parcel-server.node.development.js +0.34% 181.37 kB 181.99 kB +0.18% 33.28 kB 33.34 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-server.node.unbundled.development.js +0.33% 188.20 kB 188.83 kB +0.18% 34.37 kB 34.44 kB
oss-experimental/react-server-dom-turbopack/cjs/react-server-dom-turbopack-server.node.development.js +0.33% 189.35 kB 189.98 kB +0.17% 34.67 kB 34.73 kB
oss-experimental/react-server-dom-webpack/cjs/react-server-dom-webpack-server.node.development.js +0.33% 189.41 kB 190.03 kB +0.18% 34.68 kB 34.74 kB

Generated by 🚫 dangerJS against e9208bd

for (const propName in object) {
if (hasOwnProperty.call(value, propName) || isGetter(proto, propName)) {
// We intentionally invoke getters on the prototype to read any enumerable getters.
instanceDescription[propName] = object[propName];
Copy link
Collaborator

@unstubbable unstubbable Jun 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit concerned that this might trigger unwanted side effects, like the getters on the "exotic" promises in Next.js.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, but for them to be discovered they have to be enumerable so the trick is to make them non-enumerable.

Getters are non-enumerable by default when defined by syntax and when added with defineProperty.

If anything the concerning bit might be the enumerability trap but that's a concern regardless.

Co-authored-by: Hendrik Liebau <mail@hendrik-liebau.de>
@sebmarkbage sebmarkbage merged commit 18ee505 into facebook:main Jun 22, 2025
241 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 22, 2025
This adds better support for serializing class instances as Debug
values.

It adds a new marker on the object `{ "": "$P...", ... }` which
indicates which constructor's prototype to use for this object's
prototype. It doesn't encode arbitrary prototypes and it doesn't encode
any of the properties on the prototype. It might get some of the
properties from the prototype by virtue of `toString` on a `class`
constructor will include the whole class's body.

This will ensure that the instance gets the right name in logs.

Additionally, this now also invokes getters if they're enumerable on the
prototype. This lets us reify values that can only be read from native
classes.

---------

Co-authored-by: Hendrik Liebau <mail@hendrik-liebau.de>

DiffTrain build for [18ee505](18ee505)
github-actions bot pushed a commit to shawfix/react that referenced this pull request Jun 23, 2025
This adds better support for serializing class instances as Debug
values.

It adds a new marker on the object `{ "": "$P...", ... }` which
indicates which constructor's prototype to use for this object's
prototype. It doesn't encode arbitrary prototypes and it doesn't encode
any of the properties on the prototype. It might get some of the
properties from the prototype by virtue of `toString` on a `class`
constructor will include the whole class's body.

This will ensure that the instance gets the right name in logs.

Additionally, this now also invokes getters if they're enumerable on the
prototype. This lets us reify values that can only be read from native
classes.

---------

Co-authored-by: Hendrik Liebau <mail@hendrik-liebau.de>

DiffTrain build for [18ee505](facebook@18ee505)
github-actions bot pushed a commit to shawfix/react that referenced this pull request Jun 23, 2025
This adds better support for serializing class instances as Debug
values.

It adds a new marker on the object `{ "": "$P...", ... }` which
indicates which constructor's prototype to use for this object's
prototype. It doesn't encode arbitrary prototypes and it doesn't encode
any of the properties on the prototype. It might get some of the
properties from the prototype by virtue of `toString` on a `class`
constructor will include the whole class's body.

This will ensure that the instance gets the right name in logs.

Additionally, this now also invokes getters if they're enumerable on the
prototype. This lets us reify values that can only be read from native
classes.

---------

Co-authored-by: Hendrik Liebau <mail@hendrik-liebau.de>

DiffTrain build for [18ee505](facebook@18ee505)
sebmarkbage added a commit that referenced this pull request Jun 23, 2025
…nformation (#33592)

Stacked on #33588, #33589 and #33590.

This lets us automatically show the resolved value in the UI.

<img width="863" alt="Screenshot 2025-06-22 at 12 54 41 AM"
src="https://github.com/user-attachments/assets/a66d1d5e-0513-4767-910c-5c7169fc2df4"
/>

We can also show rejected I/O that may or may not have been handled with
the error message.

<img width="838" alt="Screenshot 2025-06-22 at 12 55 06 AM"
src="https://github.com/user-attachments/assets/e0a8b6ae-08ba-46d8-8cc5-efb60956a1d1"
/>

To get this working we need to keep the Promise around for longer so
that we can access it once we want to emit an async sequence. I do this
by storing the WeakRefs but to ensure that the Promise doesn't get
garbage collected, I keep a WeakMap of Promise to the Promise that it
depended on. This lets the VM still clean up any Promise chains that
have leaves that are cleaned up. So this makes Promises live until the
last Promise downstream is done. At that point we can go back up the
chain to read the values out of them.

Additionally, to get the best possible value we don't want to get a
Promise that's used by internals of a third-party function. We want the
value that the first party gets to observe. To do this I had to change
the logic for which "await" to use, to be the one that is the first
await that happened in user space. It's not enough that the await has
any first party at all on the stack - it has to be the very first frame.
This is a little sketchy because it relies on the `.then()` call or
`await` call not having any third party wrappers. But it gives the best
object since it hides all the internals. For example when you call
`fetch()` we now log that actual `Response` object.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed React Core Team Opened by a member of the React Core Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants