feat(remix-server-runtime): add "jump to definition" support to useActionData/useLoaderData/SerializeFrom

[sachinraja]

These changes are upstreamed from work I did for tRPC.

For data inferred from useLoaderData, properties do not have jump to definition. This is because serialize.ts uses key remapping which breaks jump to definition support for TS (see microsoft/TypeScript#47813). I changed it to use a different strategy for filtering that keeps jump to definition.

Testing Strategy: used the playground and attempted to jump to definition on a property from useLoaderData

Before this PR:

before.mp4

After this PR:

jump-to-definition.mp4

[changeset-bot]

⚠️ No Changeset found

Latest commit: 569d05b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[remix-cla-bot]

Hi @sachinraja,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[sergiodxa]

This is incredible! 🤩

[MichaelDeBoey]

Thanks @sachinraja, this is really awesome! 🤩

Since we want to move to type-fest's Jsonify type at some point in the future, you might want to add these changes there as well.

[tigerabrodi]

This is amazing!! 🔥 🙏

[pcattori]

@sachinraja thanks for working on this! 🙏

I saw on your twitter that microsoft/TypeScript#51650 potentially address this as a TS fix rather than something we need to do in our own types within Remix. Am I interpreting that correctly?

[sachinraja]

@pcattori Yes that PR could fix this. But I also implemented a more robust version of this fix in type-fest so I would recommend switching to the type-fest Jsonify type instead.

Then if the TypeScript PR goes through we can just change the type-fest type to a more performant one too.

[nexxeln]

Bumping this. Why hasn't this been merged yet? It's incredible

[Nsttt]

Please, this one results on a very useful feature.

[MichaelDeBoey]

@sachinraja Could you please rebase on latest dev, resolve conflicts & update with what you ended up pushing to type-fest?

[sachinraja]

@MichaelDeBoey I don't think we can use the type-fest type because of SerializeDeferred, which handles Remix-specific behavior.

[MichaelDeBoey]

@sachinraja I'm not talking about using type-fest, but rather copying over the things you did there instead
At a later stage, we can add the dependency if we want to.

[pcattori]

Looks like microsoft/TypeScript#51650 got merged. Anyone want to look into whether its already released or when it will be released as part of TypeScript?

[Andarist]

microsoft/TypeScript#51650 with microsoft/TypeScript#53207 should be a part of typescript@5.0.4 release. That can be confirmed by checking that this work belongs to the https://github.com/microsoft/TypeScript/commits/release-5.0

[MichaelDeBoey]

@sachinraja Now that "jump to definition" is fixed, can the types be simplified again or did you extract some things for other reasons as well?

Would love to merge this as the changes you did for type-fest included some edge cases we don't cover (yet) as well 🙏

[pcattori]

Closing this since TS 5.0.4 fixes it and we are already looking into swapping out our custom JSON serialize/deserialize types in favor of type-fest (#6642)