Repository navigation
[TRACKING] Breaking Changes Made During the RC Phase #1044
Description
Well y'all, I hate to say it, but we'll have a few breaking changes during our RC "stable" phase.
We just released our first two breaking changes in 0.38.0:
- Dropped support for TypeScript 4.9 and 5.0
- Dropped support for Angular 17.3 and 18.x
And, unfortunately, it's not the only two breaking changes we'll be making. In addition, we need to introduce two breaking changes to our React adapters:
- Remove
form.useFieldAPI, as it does not follow the rules of React Hooks - Remove
form.useStoreAPI, as it does not follow the rules of React Hooks
Which will be merged here shortly as part of 0.39.0: #1035
While these breaking changes are unfortunate, there were a few factors at play:
- I assumed dynamic hooks followed the rules of React Hooks, which turned out to be false, only discovered once the Compiler was more generally available
- I didn't think we could integrate TanStack Store's fresh
DerivedAPI would be fast enough to validate in TanStack Form for some time. I was wrong.
2b) Once I realized we could use TanStack Store, working on it made it clear that there were bugs in the Angular adapter and TypeScript types that we needed to ship downstream
I wish I could have foreseen these issues ahead of time, but alas I am only human. Needless to say, once we hit v1, we'll be much more careful to introduce these breaking changes in chunks (ala major versions) and with migration guides to avoid problems.
Moreover, to help make this second batch of React breaking changes a little easier, we'll help write migration guides for form.useField and form.useStore in our changelog for everyone impacted.
Again, immense apologies on my end. I was the one who made the call to introduce these breaking changes prior to v1. We'll work hard on avoiding doing so again in the immediate future.
Activity
crutchcorn commentedon Jan 15, 2025
I was recently asked on our Discord:
I thought this was a great question and wanted to answer it in a more public-facing way as well.
Transparently, I'm trying to get as many potentially breaking changes (even tiny ones) out the door as quickly as I can while retaining the quality of our software. Here's one such (big) example:
#1104
Once this PR is merged (this/next week), we really only have two things to do:
Then we're v1.
In regards to stability, our announcement to the RC phase was a commitment to as much stability as we could forsee. We had two breaking changes per:
#1044
And #1104 might require some minimal refactor to fix some typing issues, but no runtime behavior will break (backed by our extensive test suite). I think the risk of using TanStack Form in production today is minimal and I'm already aware of some moderately high-profile usage of our product in prod today.
That said, here's my thoughts on where we stand today compared to RHF. Even today, prior to v1 we're:
Controller+{...props}+ others)I think this puts us well above RHF in pragmatic terms today.
crutchcorn commentedon Feb 21, 2025
Hey all, I bring some sad news but some good news as well.
I'll just come right out with it: v0.43.0 introduces some breaking changes, especially for users of validators (Yup, Zod, Valibot).
However, v0.43.0 also adds an extra level of type safety and unlocks the ability to return non-string values for validators.
https://github.com/TanStack/form/releases/tag/v0.43.0