Input unions (#481)

* support input unions

* not needed

* the correct fork commit

* changelog

* add test case for oneOf fields

* docs for input unions

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 - Emit `@live` for union variant cases to prevent false positives in unions.
 - Set `@rescript/tools` version explicitly.
+- First class support for input unions, leveraging the `@oneOf` directive.
 
 # 3.0.0-alpha.4
 

packages/rescript-relay/__tests__/Test_inputUnion-tests.js

@@ -0,0 +1,40 @@
+require("@testing-library/jest-dom/extend-expect");
+const t = require("@testing-library/react");
+const React = require("react");
+const queryMock = require("./queryMock");
+
+const { test_inputUnion } = require("./Test_inputUnion.bs");
+
+describe("Query", () => {
+  test("conversion of input unions work", async () => {
+    queryMock.mockQuery({
+      name: "TestInputUnionQuery",
+      variables: {
+        location: {
+          byAddress: {
+            city: "City",
+          },
+        },
+      },
+      data: {
+        findByLocation: "Got it",
+      },
+    });
+
+    queryMock.mockQuery({
+      name: "TestInputUnionQuery",
+      variables: {
+        location: {
+          byId: "<id>",
+        },
+      },
+      data: {
+        findByLocation: "Got ID",
+      },
+    });
+
+    t.render(test_inputUnion());
+    await t.screen.findByText("Got it");
+    await t.screen.findByText("Got ID");
+  });
+});

packages/rescript-relay/__tests__/Test_inputUnion.res

@@ -0,0 +1,41 @@
+module Query = %relay(`
+  query TestInputUnionQuery($location: Location!) {
+    findByLocation(location: $location)
+  }
+`)
+
+module Test = {
+  @react.component
+  let make = () => {
+    let data = Query.use(
+      ~variables={
+        location: ByAddress({city: "City"}),
+      },
+    )
+
+    let data2 = Query.use(
+      ~variables={
+        location: ById("<id>"),
+      },
+    )
+
+    <>
+      <div> {React.string(data.findByLocation->Belt.Option.getWithDefault("-"))} </div>
+      <div> {React.string(data2.findByLocation->Belt.Option.getWithDefault("-"))} </div>
+    </>
+  }
+}
+
+@live
+let test_inputUnion = () => {
+  let network = RescriptRelay.Network.makePromiseBased(~fetchFunction=RelayEnv.fetchQuery)
+
+  let environment = RescriptRelay.Environment.make(
+    ~network,
+    ~store=RescriptRelay.Store.make(~source=RescriptRelay.RecordSource.make()),
+  )
+
+  <TestProviders.Wrapper environment>
+    <Test />
+  </TestProviders.Wrapper>
+}

packages/rescript-relay/__tests__/schema.graphql

@@ -206,6 +206,7 @@ type Query {
   ): UserConnection
   search(input: SearchInput!): String
   searchPesticie(input: PesticideListSearchInput!): String
+  findByLocation(location: Location!): String
 }
 
 type Mutation {
@@ -223,3 +224,17 @@ type Mutation {
 type Subscription {
   userUpdated(id: ID!): UserUpdatedPayload
 }
+
+input ByAddress {
+  city: String!
+}
+
+input ByLoc {
+  lat: Float!
+}
+
+input Location @oneOf {
+  byAddress: ByAddress
+  byLoc: ByLoc
+  byId: ID
+}

packages/rescript-relay/__tests__/utils-tests.js

@@ -452,6 +452,35 @@ describe("conversion", () => {
     });
   });
 
+  it("handles input unions", () => {
+    expect(
+      traverser(
+        {
+          location: {
+            __$inputUnion: "byAddress",
+            _0: {
+              city: "City",
+            },
+          },
+        },
+        {
+          location: { byLoc: { r: "byLoc" }, byAddress: { r: "byAddress" } },
+          byAddress: {},
+          byLoc: {},
+          __root: { location: { r: "location" } },
+        },
+        {},
+        undefined
+      )
+    ).toEqual({
+      location: {
+        byAddress: {
+          city: "City",
+        },
+      },
+    });
+  });
+
   it("handles top level unions on fragments", () => {
     expect(
       traverser(

packages/rescript-relay/src/utils.js

@@ -16,6 +16,16 @@ function getTypename(v) {
   }
 }
 
+function unwrapInputUnion(obj) {
+  if (obj != null && typeof obj === "object" && "__$inputUnion" in obj) {
+    return {
+      [obj["__$inputUnion"]]: obj["_0"],
+    };
+  }
+
+  return obj;
+}
+
 /**
  * Runs on each object in the tree and follows the provided instructions
  * to apply transforms etc.
@@ -128,7 +138,7 @@ function traverse(
         }
         if (shouldConvertRootObj) {
           return traverser(
-            v,
+            unwrapInputUnion(v),
             fullInstructionMap,
             converters,
             nullableValue,
@@ -198,7 +208,7 @@ function traverse(
       if (shouldConvertRootObj) {
         newObj = getNewObj(newObj, currentObj);
         newObj[key] = traverser(
-          v,
+          unwrapInputUnion(v),
           fullInstructionMap,
           converters,
           nullableValue,