new take on resolvers using fragments

zth · Jun 27, 2024 · 053bdc1 · 053bdc1
1 parent c8ffc8c
commit 053bdc1
Show file tree

Hide file tree

Showing 17 changed files with 240 additions and 36 deletions.
diff --git a/packages/relay b/packages/relay
diff --git a/packages/rescript-relay/__tests__/TestRelayUserResolver2.res b/packages/rescript-relay/__tests__/TestRelayUserResolver2.res
@@ -0,0 +1,17 @@
+module Fragment = %relay(`
+  fragment TestRelayUserResolver2 on User {
+    firstName
+    lastName
+  }
+`)
+
+/**
+ * @RelayResolver User.fullName2(maxLength: Int!): String
+ * @rootFragment TestRelayUserResolver2
+ *
+ * A users full name 2.
+ */
+let fullName2 = (user, args) => {
+  let user = Fragment.readResolverFragment(user)
+  `${user.firstName} ${user.lastName}`->Js.String2.slice(~from=0, ~to_=args.maxLength)
+}
diff --git a/packages/rescript-relay/__tests__/Test_relayResolvers-tests.js b/packages/rescript-relay/__tests__/Test_relayResolvers-tests.js
@@ -20,6 +20,6 @@ describe("Relay Resolvers", () => {
     });
 
     t.render(test_relayResolvers());
-    await t.screen.findByText("First Last is online");
+    await t.screen.findByText("First Last Fi is online");
   });
 });
diff --git a/packages/rescript-relay/__tests__/Test_relayResolvers.res b/packages/rescript-relay/__tests__/Test_relayResolvers.res
@@ -12,6 +12,7 @@ module Fragment = %relay(`
     fragment TestRelayResolvers_user on User {
       isOnline
       fullName
+      fullName2(maxLength: 2)
     }
 `)
 
@@ -23,8 +24,8 @@ module Test = {
 
     <div>
       {switch data {
-      | {isOnline: Some(isOnline), fullName: Some(fullName)} =>
-        React.string(`${fullName} is ${isOnline ? "online" : "offline"}`)
+      | {isOnline: Some(isOnline), fullName: Some(fullName), fullName2: Some(fullName2)} =>
+        React.string(`${fullName} ${fullName2} is ${isOnline ? "online" : "offline"}`)
       | _ => React.string("-")
       }}
     </div>

diff --git a/packages/rescript-relay/__tests__/__generated__/TestRelayResolversQuery_graphql.res b/packages/rescript-relay/__tests__/__generated__/TestRelayResolversQuery_graphql.res
diff --git a/packages/rescript-relay/__tests__/__generated__/TestRelayResolvers_user_graphql.res b/packages/rescript-relay/__tests__/__generated__/TestRelayResolvers_user_graphql.res
diff --git a/packages/rescript-relay/__tests__/__generated__/TestRelayUserResolver2_graphql.res b/packages/rescript-relay/__tests__/__generated__/TestRelayUserResolver2_graphql.res
diff --git a/packages/rescript-relay/__tests__/__generated__/User_relayResolvers_graphql.res b/packages/rescript-relay/__tests__/__generated__/User_relayResolvers_graphql.res
diff --git a/packages/rescript-relay/rescript-relay-ppx/library/Fragment.ml b/packages/rescript-relay/rescript-relay-ppx/library/Fragment.ml
@@ -2,7 +2,7 @@ open Ppxlib
 open Util
 
 let make ~loc ~moduleName ~refetchableQueryName ~extractedConnectionInfo
-    ~hasInlineDirective =
+    ~hasInlineDirective ~isPlural =
   let typeFromGeneratedModule = makeTypeAccessor ~loc ~moduleName in
   let valFromGeneratedModule = makeExprAccessor ~loc ~moduleName in
   let moduleIdentFromGeneratedModule = makeModuleIdent ~loc ~moduleName in
@@ -35,7 +35,8 @@ let make ~loc ~moduleName ~refetchableQueryName ~extractedConnectionInfo
                       ~node:[%e valFromGeneratedModule ["node"]]];
                 [%stri
                   let useOpt fRef :
-                      [%t typeFromGeneratedModule ["Types"; "fragment"]] option =
+                      [%t typeFromGeneratedModule ["Types"; "fragment"]] option
+                      =
                     RescriptRelay_Fragment.useFragmentOpt ~convertFragment
                       ~fRef:
                         (match fRef with
@@ -45,6 +46,34 @@ let make ~loc ~moduleName ~refetchableQueryName ~extractedConnectionInfo
                             |. [%e valFromGeneratedModule ["getFragmentRef"]])
                         | None -> None)
                       ~node:[%e valFromGeneratedModule ["node"]]];
+                (if isPlural then
+                   [%stri
+                     let readResolverFragment fRef :
+                         [%t typeFromGeneratedModule ["Types"; "fragment"]] =
+                       let fRef =
+                         fRef
+                         |. RescriptRelay_Internal
+                            .internal_resolverFragmentRefsToFragmentRefsPlural
+                       in
+                       RescriptRelay_Fragment.read ~convertFragment
+                         ~fRef:
+                           (fRef
+                           |. [%e valFromGeneratedModule ["getFragmentRef"]])
+                         ~node:[%e valFromGeneratedModule ["node"]]]
+                 else
+                   [%stri
+                     let readResolverFragment fRef :
+                         [%t typeFromGeneratedModule ["Types"; "fragment"]] =
+                       let fRef =
+                         fRef
+                         |. RescriptRelay_Internal
+                            .internal_resolverFragmentRefsToFragmentRefs
+                       in
+                       RescriptRelay_Fragment.read ~convertFragment
+                         ~fRef:
+                           (fRef
+                           |. [%e valFromGeneratedModule ["getFragmentRef"]])
+                         ~node:[%e valFromGeneratedModule ["node"]]]);
               ]
             | true -> []);
             (match hasInlineDirective with
@@ -73,8 +102,7 @@ let make ~loc ~moduleName ~refetchableQueryName ~extractedConnectionInfo
                   let makeRefetchVariables =
                     [%e
                       valFromRefetchableModule ["Types"; "makeRefetchVariables"]]
-                    [@@ocaml.doc "A helper to make refetch variables. "]
-                    [@@live]];
+                  [@@ocaml.doc "A helper to make refetch variables. "] [@@live]];
                 [%stri
                   let convertRefetchVariables :
                       [%t

diff --git a/packages/rescript-relay/rescript-relay-ppx/library/RescriptRelayPpxLibrary.ml b/packages/rescript-relay/rescript-relay-ppx/library/RescriptRelayPpxLibrary.ml
@@ -26,6 +26,7 @@ let commonExtension =
             ~refetchableQueryName
             ~extractedConnectionInfo:(op |> extractFragmentConnectionInfo ~loc)
             ~hasInlineDirective:(op |> fragmentHasInlineDirective ~loc)
+            ~isPlural:(op |> fragmentIsPlural ~loc)
             ~loc
       | Operation {optype = Query} ->
         if Util.queryIsUpdatable op then

diff --git a/packages/rescript-relay/rescript-relay-ppx/library/Util.ml b/packages/rescript-relay/rescript-relay-ppx/library/Util.ml
@@ -113,6 +113,16 @@ let fragmentHasInlineDirective ~loc op =
     |> List.exists (fun (directive : Graphql_parser.directive) ->
            directive.name = "inline")
   | _ -> false
+
+let fragmentIsPlural ~loc op =
+  match op with
+  | Graphql_parser.Fragment {name = _; directives} ->
+    directives
+    |> List.exists (fun (directive : Graphql_parser.directive) ->
+           directive.name = "relay"
+           && directive.arguments
+              |> List.exists (fun (n, v) -> n = "plural" && v = `Bool true))
+  | _ -> false
 let getGraphQLModuleName opName = String.capitalize_ascii opName ^ "_graphql"
 
 let rec longidentFromStrings = function

diff --git a/packages/rescript-relay/src/RescriptRelay.res b/packages/rescript-relay/src/RescriptRelay.res
@@ -9,6 +9,7 @@ type mutationNode<'node>
 type subscriptionNode<'node>
 
 type fragmentRefs<'fragments>
+type resolverFragmentRefs<'fragments>
 type updatableFragmentRefs<'fragments>
 
 type dataId

diff --git a/packages/rescript-relay/src/RescriptRelay.resi b/packages/rescript-relay/src/RescriptRelay.resi
@@ -30,6 +30,9 @@ type subscriptionNode<'node>
 /**This type shows all of the fragments that has been spread on this particular object.*/
 type fragmentRefs<'fragments>
 
+/**This type shows the Relay resolver fragment that has been spread on this particular object.*/
+type resolverFragmentRefs<'fragments>
+
 /**This type shows all of the updatable fragments that has been spread on this particular object.*/
 type updatableFragmentRefs<'fragments>