Skip to content
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

Serialize ReadonlyMap and ReadonlySet types #13092

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

bjohn465
Copy link

ReadonlyMap and ReadonlySet are regular Map and Set objects, but their types omit the mutation methods that the Map and Set types have, similar to the way ReadonlyArray and Array work. However, ReadonlyMap and ReadonlySet do not extend Map and Set, so their types do not serialize correctly when coming from the server.

This is related to the discussion in #13043

Copy link

changeset-bot bot commented Feb 22, 2025

🦋 Changeset detected

Latest commit: bc4c0a8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
Name Type
react-router Patch
@react-router/architect Patch
@react-router/cloudflare Patch
@react-router/dev Patch
react-router-dom Patch
@react-router/express Patch
@react-router/node Patch
@react-router/serve Patch
@react-router/fs-routes Patch
@react-router/remix-routes-option-adapter Patch
create-react-router Patch

Not sure what this means? Click here to learn what changesets are.

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

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Feb 22, 2025

Hi @bjohn465,

Welcome, and thank you for contributing to React Router!

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 [email protected].

Thanks!

- The Remix team

This is me signing the Contributor License Agreement (CLA).
@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Feb 22, 2025

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

@bjohn465
Copy link
Author

I made an attempt at fixing this issue by updating the Serialize type in packages/react-router/lib/types/route-data.ts to include ReadonlyMap and ReadonlySet. This makes the tests that I added pass.

I was not sure if I should update the Serializable type in packages/react-router/lib/server-runtime/single-fetch.ts as well.

@bjohn465 bjohn465 changed the title Add failing tests for ReadonlyMap and ReadonlySet Serialize ReadonlyMap and ReadonlySet types Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant