rescript-relay 1.0.4 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # master
 
+# 1.1.0
+
+Notable changes:
+
+- _JSX v4 is now required_
+- Relay and @rescript/react upgraded
+- M1 support for the PPX (should speed up builds for anyone on an M1)
+
+## Upgrade versions
+
+- `react-relay` and `relay-runtime` to `>=15.0.0`
+- `@rescript/react` to `>=0.11.0`
+
+## Breaking changes
+
+- The signature for missing field handlers has changed. Previously you got an open type `{..}` as record, now instead you get a proper `RecordProxy.t` from the store. Check out [the changelog for Relay 15](https://github.com/facebook/relay/releases/tag/v15.0.0).
+- ReScript `>=10.1` and JSX v4 is now required.
+- Work around issue with JSX v4 and `%relay.deferredComponent`. You now need to annotate any component you want to use with `%relay.deferredComponent` with `@relay.deferredComponent`. https://github.com/zth/rescript-relay/pull/439
+
+## Improvements
+
+- Experimental support for allowing `null` in operation variables. Add `@rescriptRelayNullableVariables` to your operation (query, mutation, subscription) and you'll be allowed to pass `Js.null` (via the `Js.Null` module) to your server. https://github.com/zth/rescript-relay/pull/426
+- :tada: M1 support for the PPX! This should speed up builds some. https://github.com/zth/rescript-relay/pull/435
+
+## Bug Fixes
+
+- Fix issue with conversion of custom scalars, where custom scalars represented as arrays would get converted "internally" although they should've really just been left alone. https://github.com/zth/rescript-relay/pull/433
+
+# 1.0.5
+
+## Bug Fixes
+
+- Fix fairly large performance issue with runtime conversion. This should give a large speedup in certain cases.
+
 # 1.0.4
 
 ## Improvements

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -39,8 +39,8 @@
     "test:ci": "jest --ci --runInBand"
   },
   "devDependencies": {
-    "rescript": "^10.0.0",
-    "@rescript/react": "0.10.3",
+    "rescript": "^10.1.3",
+    "@rescript/react": "0.11.0",
     "@testing-library/jest-dom": "^5.16.3",
     "@testing-library/react": "^13.0.0-alpha.6",
     "bs-fetch": "^0.5.0",
@@ -48,22 +48,22 @@
     "jest": "^27.2.4",
     "nock": "^11.7.0",
     "node-fetch": "^2.6.0",
-    "react": "18.0.0",
-    "react-dom": "18.0.0",
-    "react-relay": "14.1.0",
-    "relay-runtime": "14.1.0"
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-relay": "15.0.0",
+    "relay-runtime": "15.0.0"
   },
   "peerDependencies": {
     "@rescript/react": "*",
-    "react-relay": ">=11.0.0",
+    "react-relay": ">=15.0.0",
     "relay-runtime": "*",
-    "rescript": ">=9.1.2"
+    "rescript": ">=10.1.0"
   },
   "dependencies": {
     "detect-libc": "^2.0.1"
   },
   "resolutions": {
-    "react": "18.0.0",
-    "react-dom": "18.0.0"
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
   }
 }

package/postinstall.js

@@ -40,7 +40,7 @@ function ppxArch() {
    * Use Rosetta for ARM on macOS
    */
   if (platform === "darwin" && process.arch === "arm64") {
-    return "x64";
+    return "arm64";
   }
 
   /**
@@ -132,6 +132,7 @@ function copyPlatformBinaries(platform) {
 }
 
 function removeInitialBinaries() {
+  fs.unlinkSync(path.join(__dirname, "ppx-macos-arm64"));
   fs.unlinkSync(path.join(__dirname, "ppx-macos-latest"));
   fs.unlinkSync(path.join(__dirname, "ppx-windows-latest"));
   fs.unlinkSync(path.join(__dirname, "ppx-linux"));
@@ -165,9 +166,14 @@ switch (platform) {
   case "linux":
     copyPlatformBinaries(platform);
     break;
-  case "darwin":
-    copyPlatformBinaries("macos-latest");
+  case "darwin": {
+    if (ppxArch() === "arm64") {
+      copyPlatformBinaries("macos-arm64");
+    } else {
+      copyPlatformBinaries("macos-latest");
+    }
     break;
+  }
   default:
     console.warn("error: no release built for the " + platform + " platform");
     process.exit(1);

package/src/ReactDOMExperimental.bs.js

@@ -1,6 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 'use strict';
 
+var ReactDOM = require("@rescript/react/src/ReactDOM.bs.js");
 var Client = require("react-dom/client");
 
 function renderConcurrentRootAtElementWithId(content, id) {
@@ -15,5 +16,8 @@ function renderConcurrentRootAtElementWithId(content, id) {
   Client.createRoot(element).render(content);
 }
 
+var Root = ReactDOM.Client.Root;
+
+exports.Root = Root;
 exports.renderConcurrentRootAtElementWithId = renderConcurrentRootAtElementWithId;
 /* react-dom/client Not a pure module */

package/src/ReactDOMExperimental.res

@@ -1,7 +1,4 @@
-include ReactDOM.Experimental
-
-@module("react-dom/client")
-external createRoot: Dom.element => root = "createRoot"
+include ReactDOM.Client
 
 @val @return(nullable)
 external getElementById: string => option<Dom.element> = "document.getElementById"
@@ -15,5 +12,5 @@ let renderConcurrentRootAtElementWithId: (React.element, string) => unit = (cont
         id ++ " found in the HTML.",
       ),
     )
-  | Some(element) => createRoot(element)->render(content)
+  | Some(element) => createRoot(element)->Root.render(content)
   }

package/src/RescriptRelay.bs.js

@@ -102,7 +102,7 @@ var MissingFieldHandler = {
 var nodeInterfaceMissingFieldHandler = makeLinkedMissingFieldHandler(function (field, record, args, _store) {
       var match = field.name;
       var match$1 = args.id;
-      if ((record == null) || !(match === "node" && record.__typename === RelayRuntime.ROOT_TYPE && !(match$1 == null))) {
+      if ((record == null) || !(match === "node" && record.getType() === RelayRuntime.ROOT_TYPE && !(match$1 == null))) {
         return ;
       } else {
         return Caml_option.some(match$1);
@@ -160,15 +160,13 @@ var Environment = {
   make: make$1
 };
 
-function RescriptRelay$Context$Provider(Props) {
-  var environment = Props.environment;
-  var children = Props.children;
+function RescriptRelay$Context$Provider(props) {
   var provider = ReactRelay.ReactRelayContext.Provider;
   return React.createElement(provider, {
               value: {
-                environment: environment
+                environment: props.environment
               },
-              children: children
+              children: props.children
             });
 }
 

package/src/RescriptRelay.res

@@ -412,7 +412,7 @@ let nodeInterfaceMissingFieldHandler = MissingFieldHandler.makeLinkedMissingFiel
   _store,
 ) =>
   switch (Js.Nullable.toOption(record), field["name"], Js.Nullable.toOption(args["id"])) {
-  | (Some(record), "node", argsId) if record["__typename"] == storeRootType => argsId
+  | (Some(record), "node", argsId) if record->RecordProxy.getType == storeRootType => argsId
   | _ => None
   }
 )
@@ -574,8 +574,8 @@ module Store = {
     make(
       source,
       {
-        gcReleaseBufferSize: gcReleaseBufferSize,
-        queryCacheExpirationTime: queryCacheExpirationTime,
+        gcReleaseBufferSize,
+        queryCacheExpirationTime,
       },
     )
 
@@ -662,10 +662,7 @@ module Context = {
     @react.component
     let make = (~environment: Environment.t, ~children) => {
       let provider = React.Context.provider(context)
-      React.createElement(
-        provider,
-        {"value": Some({"environment": environment}), "children": children},
-      )
+      React.createElement(provider, {value: Some({"environment": environment}), children})
     }
   }
 }
@@ -752,9 +749,9 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
       C.query,
       variables->C.convertVariables,
       {
-        fetchKey: fetchKey,
+        fetchKey,
         fetchPolicy: fetchPolicy->mapFetchPolicy,
-        networkCacheConfig: networkCacheConfig,
+        networkCacheConfig,
       },
     )
 

package/src/RescriptRelay.resi

@@ -519,7 +519,7 @@ module MissingFieldHandler: {
   let makeLinkedMissingFieldHandler: (
     (
       normalizationLinkedField,
-      Js.Nullable.t<'record>,
+      Js.Nullable.t<RecordProxy.t>,
       'args,
       ReadOnlyRecordSourceProxy.t,
     ) => Js.Nullable.t<dataId>
@@ -531,7 +531,7 @@ module MissingFieldHandler: {
   let makePluralLinkedMissingFieldHandler: (
     (
       normalizationLinkedField,
-      Js.Nullable.t<'record>,
+      Js.Nullable.t<RecordProxy.t>,
       'args,
       ReadOnlyRecordSourceProxy.t,
     ) => Js.Nullable.t<array<Js.Nullable.t<dataId>>>

package/src/utils.js

@@ -49,8 +49,20 @@ function traverse(
   }
 
   for (var key in currentObj) {
+    // Internal ReScript polymorphic variant representation, ignore.
     if (key === "VAL" || key === "NAME") continue;
 
+    // Ensure we don't move into internal properties coming from Relay, with the
+    // exception of the few names allowed to start with double underscores
+    // ("__typename" and "__id"), and any Relay provided variables.
+    if (
+      key.startsWith("__") &&
+      key !== "__typename" &&
+      key !== "__id" &&
+      !key.startsWith("__relay_internal")
+    )
+      continue;
+
     var isUnion = false;
     var originalValue = currentObj[key];
 
@@ -75,9 +87,24 @@ function traverse(
     var shouldConvertEnum =
       typeof instructions["e"] === "string" && !!converters[instructions["e"]];
 
+    // This is true for non-arrays that are to be converted
     var shouldConvertCustomField =
       typeof instructions["c"] === "string" && !!converters[instructions["c"]];
 
+    // This is true for arrays that are to be converted. This and the above
+    // won't be true at the same time.
+    var shouldConvertCustomFieldArray =
+      typeof instructions["ca"] === "string" &&
+      !!converters[instructions["ca"]];
+
+    // Special case when this is a custom field that's an array. Ensures we
+    // don't accidentally move into the array when we're not supposed to.
+    if (shouldConvertCustomFieldArray && Array.isArray(currentObj[key])) {
+      newObj = getNewObj(newObj, currentObj);
+      newObj[key] = currentObj[key].map(converters[instructions["ca"]]);
+      return newObj;
+    }
+
     var shouldBlockTraversal = typeof instructions["b"] === "string";
     var allowGoingIntoArray = shouldBlockTraversal
       ? instructions["b"] === "a"
@@ -96,6 +123,15 @@ function traverse(
     /**
      * Handle arrays
      */
+
+    // Special case when this is a custom field that's an array. Ensures we
+    // don't accidentally move into the array when we're not supposed to.
+    if (shouldConvertCustomField && Array.isArray(currentObj[key])) {
+      newObj = getNewObj(newObj, currentObj);
+      newObj[key] = converters[instructions["c"]](originalValue);
+      return newObj;
+    }
+
     if (Array.isArray(currentObj[key])) {
       newObj = getNewObj(newObj, currentObj);
       newObj[key] = currentObj[key].map(function (v) {
@@ -206,6 +242,8 @@ function traverse(
       if (shouldConvertCustomField) {
         newObj = getNewObj(newObj, currentObj);
         newObj[key] = converters[instructions["c"]](v);
+        // Ensure that the custom scalar value itself isn't traversed more.
+        continue;
       }
 
       if (shouldConvertUnion && v != null && typeof v === "object") {

package/src/utils.mjs

@@ -49,8 +49,20 @@ function traverse(
   }
 
   for (var key in currentObj) {
+    // Internal ReScript polymorphic variant representation, ignore.
     if (key === "VAL" || key === "NAME") continue;
 
+    // Ensure we don't move into internal properties coming from Relay, with the
+    // exception of the few names allowed to start with double underscores
+    // ("__typename" and "__id"), and any Relay provided variables.
+    if (
+      key.startsWith("__") &&
+      key !== "__typename" &&
+      key !== "__id" &&
+      !key.startsWith("__relay_internal")
+    )
+      continue;
+
     var isUnion = false;
     var originalValue = currentObj[key];
 
@@ -75,9 +87,24 @@ function traverse(
     var shouldConvertEnum =
       typeof instructions["e"] === "string" && !!converters[instructions["e"]];
 
+    // This is true for non-arrays that are to be converted
     var shouldConvertCustomField =
       typeof instructions["c"] === "string" && !!converters[instructions["c"]];
 
+    // This is true for arrays that are to be converted. This and the above
+    // won't be true at the same time.
+    var shouldConvertCustomFieldArray =
+      typeof instructions["ca"] === "string" &&
+      !!converters[instructions["ca"]];
+
+    // Special case when this is a custom field that's an array. Ensures we
+    // don't accidentally move into the array when we're not supposed to.
+    if (shouldConvertCustomFieldArray && Array.isArray(currentObj[key])) {
+      newObj = getNewObj(newObj, currentObj);
+      newObj[key] = currentObj[key].map(converters[instructions["ca"]]);
+      return newObj;
+    }
+
     var shouldBlockTraversal = typeof instructions["b"] === "string";
     var allowGoingIntoArray = shouldBlockTraversal
       ? instructions["b"] === "a"
@@ -96,6 +123,15 @@ function traverse(
     /**
      * Handle arrays
      */
+
+    // Special case when this is a custom field that's an array. Ensures we
+    // don't accidentally move into the array when we're not supposed to.
+    if (shouldConvertCustomField && Array.isArray(currentObj[key])) {
+      newObj = getNewObj(newObj, currentObj);
+      newObj[key] = converters[instructions["c"]](originalValue);
+      return newObj;
+    }
+
     if (Array.isArray(currentObj[key])) {
       newObj = getNewObj(newObj, currentObj);
       newObj[key] = currentObj[key].map(function (v) {
@@ -206,6 +242,8 @@ function traverse(
       if (shouldConvertCustomField) {
         newObj = getNewObj(newObj, currentObj);
         newObj[key] = converters[instructions["c"]](v);
+        // Ensure that the custom scalar value itself isn't traversed more.
+        continue;
       }
 
       if (shouldConvertUnion && v != null && typeof v === "object") {