Add compatibility for Wonka compiled with ReScript >= 8 #1214
Conversation
|
ReScript has new variant encoding from version 8 onwards. This means that if Wonka is compiled with ReScript 8 or newer then our manual encoding of a variant passed to `sink` doesn't work. To remedy this we add the new variant encoding next to the old one. ReScript will ignore the encoding it doesn't need so this should with versions of ReScript before and after the change.
|
First of all; I do have to politely ask you to read the I was aware that this changes some internals, but using the new version of Wonka is deeply unsettling to me, since, compiled with BS 8 / RS, it isn't compatible with any other version of it. (Or using the old version with the newer compilation; same same, but worse) Now BuckleScript has always been making "curious choices" in terms of transpilation and not using bundles / packages properly which it really should. This wouldn't be an issue, but were sometimes already encountering people that have duplicate installations of With Wonka it could be the same, except that the two different ways of compiling these types are inherently incompatible with one another. Which is suboptimal given that different versions of exchanges could be installed. So this does fix it, but opens up a new problem that we didn't want to address just yet. I'll close it for now, since it's unlikely to completely solve this whole problem, but I'm aware that it would appear to fix it temporarily. That being said, the simplest thing to do on your end is not to use suspense-mode if at all possible with |
|
More info here: teamwalnut/rescript-urql#232 (comment) So an additional issue in this repo may not be needed yet, since we haven't even scheduled a |
Summary
It took a bit of investigating but it turns out that when Wonka is compiled with ReScript >= 8 it's variant representation changes. Urql has one location where it manually encodes a variant in
userQuery, thus this cause problems when Urql expects Wonka to be compiled with ReScript < 8, but that's not the case.The full investigation story can be found in teamwalnut/rescript-urql#232
I searched for the usage of
.tagin the codebase to find where this manual encoding was performed and only found this inreact-urqlandpreact-urql.A better change than my fix would be to let Wonka encode the variant (perhaps we can expose a function?) so that it automatically uses whatever encoding ReScript decided. This more properly decouples Urql from ReScript's internal decisions and avoids breakage in the future if they decide to further change this representation.
Set of changes
Urql's useQuery for React and Preact now encodes it's cache results in a manner compatible with ReScript >= 8 as well as ReScript < 8 to ensure that Urql doesn't break when Wonka has been compiled with newer ReScript versions.