rescript-relay 1.0.0-beta.13 → 1.0.0-beta.16

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # master
 
-# 1.0.0-beta.13
+# 1.0.0-beta.16
 
 _[Here's a commit showing a project being upgraded to this version](https://github.com/zth/rescript-relay/commit/5831c2f1f0f13eedc1cb60468c32fd32b2dc01d3)_
 
@@ -8,7 +8,7 @@ The time has finally come - RescriptRelay `1.0.0` is in beta! The one, big major
 
 ## Upgrade versions
 
-- `react-relay` and `relay-runtime` to `13.1.1`
+- `react-relay` and `relay-runtime` to `13.2.0`
 
 ## Remove Packages
 
@@ -31,15 +31,40 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 
 ## Breaking changes
 
-- `refetchVariables` now works as intended with regards to supplying only the variables you want _changed_ when refetching, as [detailed under `variables` here](https://relay.dev/docs/next/api-reference/use-refetchable-fragment/#return-value). This means that what was previously `makeRefetchVariables(~someValue=123, ())` should now be `makeRefetchVariables(~someValue=Some(123), ())`. More details on this in the docs before a `1.0.0` release. Thanks to [@tsnobip](https://github.com/tsnobip) for fixing this!
+- The list of disallowed field names has been adapted to ReScript (it was never properly updated for ReScript when moving from ReasonML). This means that _some of your variable prop names might be renamed_. One example - if you previously had a variable in GraphQL called `$to`, you'd interact with that as `to_` in ReScript. This is because RescriptRelay would pin `to` as a reserved word, and rename it for you. But, `to` _isn't_ actually a keyword in ReScript (it was in ReasonML), so with this release, that `to_` in ReScript will be renamed to `to`. The fix is to just update all `to_` to `to` - let the compiler guide you!
+- Using variable names that are reserved words in ReScript is now _disallowed at the Relay compiler level_. This means that Relay won't compile your project if you have variables whose names are reserved words. The fix is to simply rename the variables.
+- `refetchVariables` now works as intended with regards to supplying only the variables you want _changed_ when refetching, as [detailed under `variables` here](https://relay.dev/docs/next/api-reference/use-refetchable-fragment/#return-value). This means that what was previously `makeRefetchVariables(~someValue=123, ())` should now be `makeRefetchVariables(~someValue=Some(123), ())`.
+  Crash course:
+
+  - `makeRefetchVariables(~someValue=Some(123), ())` means _refetch, use the same values for all variables that was used in the last fetch, but change `someValue` to `123`_.
+  - `makeRefetchVariables(~someValue=None, ())` means _refetch, use the same values for all variables that was used in the last fetch, but change `someValue` to `null` (unsetting it)_.
+  - `makeRefetchVariables()` means _refetch, use the same values for all variables that was used in the last fetch, change nothing_.
+
+  This way you can surgically change only certain values when refetching, without having to keep track of the current values for the other values.
+
+  More details on this [in the docs](https://rescript-relay-documentation.vercel.app/docs/refetching-and-loading-more-data#makerefetchvariables). Thanks to [@tsnobip](https://github.com/tsnobip) for fixing this!
 
 ## Beta fix changelog
 
 ### unreleased
 
+### beta.16
+
+- Fix bug that caused issues when using unions in optimistic responses and `commitLocalPayload`.
+- Add support for experimental [Relay Resolvers](https://relay.dev/docs/next/guides/relay-resolvers). Undocumented so far, but looking at the [test](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay/__tests__/Test_relayResolvers.res) and [definition file](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay/__tests__/TestRelayUserResolver.res) should give you a hint of how it works.
+
+### beta.15
+
+- Fixes for input objects.
+
+### beta.14
+
+- Fixes a few issues introduced in `beta.13`.
+- The list of disallowed field names has been adapted to ReScript. This means that _some of your variable prop names might be renamed_. Check out the Breaking Changes section above for details.
+
 ### beta.13
 
-- `refetchVariables` now works as intended with regards to supplying only the variables you want _changed_ when refetching, as [detailed under `variables` here](https://relay.dev/docs/next/api-reference/use-refetchable-fragment/#return-value).
+- `refetchVariables` now works as intended with regards to supplying only the variables you want _changed_ when refetching, as [detailed under `variables` here](https://relay.dev/docs/next/api-reference/use-refetchable-fragment/#return-value). Check out the [docs](https://rescript-relay-documentation.vercel.app/docs/refetching-and-loading-more-data#makerefetchvariables).
 - Make all object makers inlined. This should improve bundle size some.
 - Support more Linux versions in CI (like the images Vercel uses).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "1.0.0-beta.13",
+  "version": "1.0.0-beta.16",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -49,8 +49,8 @@
     "node-fetch": "^2.6.0",
     "react": "^18.0.0-rc.0",
     "react-dom": "^18.0.0-rc.0",
-    "react-relay": "13.1.1",
-    "relay-runtime": "13.1.1"
+    "react-relay": "13.2.0",
+    "relay-runtime": "13.2.0"
   },
   "peerDependencies": {
     "@rescript/react": "*",

package/postinstall.js

@@ -133,6 +133,10 @@ function removeInitialBinaries() {
     recursive: true,
     force: true,
   });
+  fs.rmSync(path.join(__dirname, "relay-compiler-linux-musl"), {
+    recursive: true,
+    force: true,
+  });
 }
 
 switch (platform) {

package/src/utils.js

@@ -10,6 +10,19 @@ function makeNewPath(currentPath, newKeys) {
   return [].concat(currentPath, newKeys);
 }
 
+function getTypename(v) {
+  if (v != null && typeof v === "object") {
+    if (v.__typename) {
+      return v.__typename;
+    }
+
+    // `v.VAL` relies on internal implementation details in ReScript.
+    if (v.VAL != null && typeof v.VAL === "object") {
+      return v.VAL.__typename;
+    }
+  }
+}
+
 /**
  * Runs on each object in the tree and follows the provided instructions
  * to apply transforms etc.
@@ -36,6 +49,8 @@ function traverse(
   }
 
   for (var key in currentObj) {
+    if (key === "VAL" || key === "NAME") continue;
+
     var isUnion = false;
     var originalValue = currentObj[key];
 
@@ -96,30 +111,41 @@ function traverse(
           return converters[instructions["c"]](v);
         }
 
-        if (
-          shouldConvertUnion &&
-          typeof v === "object" &&
-          typeof v.__typename === "string"
-        ) {
-          isUnion = true;
+        if (shouldConvertUnion && v != null && typeof v === "object") {
+          var typename = getTypename(v);
 
-          var newPath = makeNewPath(currentPath, [key, v.__typename]);
+          if (typename != null) {
+            isUnion = true;
+            var unionObj = v;
 
-          var unionRootHasFragment =
-            (instructionMap[getPathName(newPath)] || {}).f === "";
+            // Means we're wrapping, and this will be a ReScript value.
+            if (nullableValue === null) {
+              // Convert it back to a flat JS value
+              unionObj = converters[instructions["u"]](v);
+            }
 
-          var traversedValue = traverse(
-            fullInstructionMap,
-            newPath,
-            v,
-            instructionMap,
-            converters,
-            nullableValue,
-            instructionPaths,
-            unionRootHasFragment
-          );
+            var newPath = makeNewPath(currentPath, [key, typename]);
+
+            var unionRootHasFragment =
+              (instructionMap[getPathName(newPath)] || {}).f === "";
 
-          return converters[instructions["u"]](traversedValue);
+            var traversedValue = traverse(
+              fullInstructionMap,
+              newPath,
+              unionObj,
+              instructionMap,
+              converters,
+              nullableValue,
+              instructionPaths,
+              unionRootHasFragment
+            );
+
+            // Undefined means we're going from JS to ReScript, in which case we
+            // need to run the conversion here rather than earlier.
+            return nullableValue === undefined
+              ? converters[instructions["u"]](traversedValue)
+              : traversedValue;
+          }
         }
 
         if (shouldAddFragmentFn && typeof v === "object") {
@@ -168,32 +194,44 @@ function traverse(
         newObj[key] = converters[instructions["c"]](v);
       }
 
-      if (
-        shouldConvertUnion &&
-        v != null &&
-        typeof v === "object" &&
-        typeof v.__typename === "string"
-      ) {
-        isUnion = true;
+      if (shouldConvertUnion && v != null && typeof v === "object") {
+        var typename = getTypename(v);
 
-        var newPath = makeNewPath(currentPath, [key, v.__typename]);
+        if (typename != null) {
+          isUnion = true;
+          var unionObj = v;
 
-        var unionRootHasFragment =
-          (instructionMap[getPathName(newPath)] || {}).f === "";
+          // Means we're wrapping, and this will be a ReScript value.
+          if (nullableValue === null) {
+            // Convert it back to a flat JS value
+            unionObj = converters[instructions["u"]](v);
+          }
 
-        var traversedValue = traverse(
-          fullInstructionMap,
-          newPath,
-          v,
-          instructionMap,
-          converters,
-          nullableValue,
-          instructionPaths,
-          unionRootHasFragment
-        );
+          var newPath = makeNewPath(currentPath, [key, typename]);
 
-        newObj = getNewObj(newObj, currentObj);
-        newObj[key] = converters[instructions["u"]](traversedValue);
+          var unionRootHasFragment =
+            (instructionMap[getPathName(newPath)] || {}).f === "";
+
+          var traversedValue = traverse(
+            fullInstructionMap,
+            newPath,
+            unionObj,
+            instructionMap,
+            converters,
+            nullableValue,
+            instructionPaths,
+            unionRootHasFragment
+          );
+
+          newObj = getNewObj(newObj, currentObj);
+
+          newObj[key] =
+            // Undefined means we're going from JS to ReScript, in which case we
+            // need to run the conversion here rather than earlier.
+            nullableValue === undefined
+              ? converters[instructions["u"]](traversedValue)
+              : traversedValue;
+        }
       }
 
       if (shouldAddFragmentFn && typeof v === "object") {

package/src/utils.mjs

@@ -10,6 +10,19 @@ function makeNewPath(currentPath, newKeys) {
   return [].concat(currentPath, newKeys);
 }
 
+function getTypename(v) {
+  if (v != null && typeof v === "object") {
+    if (v.__typename) {
+      return v.__typename;
+    }
+
+    // `v.VAL` relies on internal implementation details in ReScript.
+    if (v.VAL != null && typeof v.VAL === "object") {
+      return v.VAL.__typename;
+    }
+  }
+}
+
 /**
  * Runs on each object in the tree and follows the provided instructions
  * to apply transforms etc.
@@ -36,6 +49,8 @@ function traverse(
   }
 
   for (var key in currentObj) {
+    if (key === "VAL" || key === "NAME") continue;
+
     var isUnion = false;
     var originalValue = currentObj[key];
 
@@ -96,30 +111,41 @@ function traverse(
           return converters[instructions["c"]](v);
         }
 
-        if (
-          shouldConvertUnion &&
-          typeof v === "object" &&
-          typeof v.__typename === "string"
-        ) {
-          isUnion = true;
+        if (shouldConvertUnion && v != null && typeof v === "object") {
+          var typename = getTypename(v);
 
-          var newPath = makeNewPath(currentPath, [key, v.__typename]);
+          if (typename != null) {
+            isUnion = true;
+            var unionObj = v;
 
-          var unionRootHasFragment =
-            (instructionMap[getPathName(newPath)] || {}).f === "";
+            // Means we're wrapping, and this will be a ReScript value.
+            if (nullableValue === null) {
+              // Convert it back to a flat JS value
+              unionObj = converters[instructions["u"]](v);
+            }
 
-          var traversedValue = traverse(
-            fullInstructionMap,
-            newPath,
-            v,
-            instructionMap,
-            converters,
-            nullableValue,
-            instructionPaths,
-            unionRootHasFragment
-          );
+            var newPath = makeNewPath(currentPath, [key, typename]);
+
+            var unionRootHasFragment =
+              (instructionMap[getPathName(newPath)] || {}).f === "";
 
-          return converters[instructions["u"]](traversedValue);
+            var traversedValue = traverse(
+              fullInstructionMap,
+              newPath,
+              unionObj,
+              instructionMap,
+              converters,
+              nullableValue,
+              instructionPaths,
+              unionRootHasFragment
+            );
+
+            // Undefined means we're going from JS to ReScript, in which case we
+            // need to run the conversion here rather than earlier.
+            return nullableValue === undefined
+              ? converters[instructions["u"]](traversedValue)
+              : traversedValue;
+          }
         }
 
         if (shouldAddFragmentFn && typeof v === "object") {
@@ -168,32 +194,44 @@ function traverse(
         newObj[key] = converters[instructions["c"]](v);
       }
 
-      if (
-        shouldConvertUnion &&
-        v != null &&
-        typeof v === "object" &&
-        typeof v.__typename === "string"
-      ) {
-        isUnion = true;
+      if (shouldConvertUnion && v != null && typeof v === "object") {
+        var typename = getTypename(v);
 
-        var newPath = makeNewPath(currentPath, [key, v.__typename]);
+        if (typename != null) {
+          isUnion = true;
+          var unionObj = v;
 
-        var unionRootHasFragment =
-          (instructionMap[getPathName(newPath)] || {}).f === "";
+          // Means we're wrapping, and this will be a ReScript value.
+          if (nullableValue === null) {
+            // Convert it back to a flat JS value
+            unionObj = converters[instructions["u"]](v);
+          }
 
-        var traversedValue = traverse(
-          fullInstructionMap,
-          newPath,
-          v,
-          instructionMap,
-          converters,
-          nullableValue,
-          instructionPaths,
-          unionRootHasFragment
-        );
+          var newPath = makeNewPath(currentPath, [key, typename]);
 
-        newObj = getNewObj(newObj, currentObj);
-        newObj[key] = converters[instructions["u"]](traversedValue);
+          var unionRootHasFragment =
+            (instructionMap[getPathName(newPath)] || {}).f === "";
+
+          var traversedValue = traverse(
+            fullInstructionMap,
+            newPath,
+            unionObj,
+            instructionMap,
+            converters,
+            nullableValue,
+            instructionPaths,
+            unionRootHasFragment
+          );
+
+          newObj = getNewObj(newObj, currentObj);
+
+          newObj[key] =
+            // Undefined means we're going from JS to ReScript, in which case we
+            // need to run the conversion here rather than earlier.
+            nullableValue === undefined
+              ? converters[instructions["u"]](traversedValue)
+              : traversedValue;
+        }
       }
 
       if (shouldAddFragmentFn && typeof v === "object") {