operation.text + operation.id is nullable

Author: zth

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Add support for top level `@catch` on fragments on unions.
 - Add parameter `excludedIds: array<dataId>` to `invalidateRecordsByIds` to allow excluding a list of connection IDs from invalidation.
+- **BREAKING:** `operation.text` and `operation.id` are now nullable, which better reflects what values they can actually have in runtime.
 
 # 3.2.0
 

example/src/RelayEnv.res

@@ -22,7 +22,10 @@ let fetchQuery: RescriptRelay.Network.fetchFunctionPromise = async (
     "http://localhost:4000/graphql",
     {
       method: #POST,
-      body: {"query": operation.text, "variables": variables}
+      body: {
+        "query": operation.text->Js.Nullable.toOption->Belt.Option.getWithDefault(""),
+        "variables": variables,
+      }
       ->Js.Json.stringifyAny
       ->Belt.Option.getExn
       ->Body.string,
@@ -64,15 +67,15 @@ let subscriptionFunction: RescriptRelay.Network.subscribeFn = (
 ) => {
   let subscriptionQuery: GraphQLWs.Client.subscribeOptions = {
     operationName: operation.name,
-    query: operation.text,
-    variables: variables,
+    query: operation.text->Js.Nullable.toOption->Belt.Option.getWithDefault(""),
+    variables,
   }
 
   RescriptRelay.Observable.make(sink => {
     let unsubscribe = GraphQLWs.Client.subscribe(wsClient, subscriptionQuery, sink)
 
     Some({
-      unsubscribe: unsubscribe,
+      unsubscribe,
       closed: false,
     })
   })

packages/rescript-relay/src/RescriptRelay.res

@@ -534,8 +534,8 @@ module Network = {
   type operationMetadata = {codesplits?: array<codesplitsMetadata>}
 
   type operation = {
-    id: string,
-    text: string,
+    id: Js.Nullable.t<string>,
+    text: Js.Nullable.t<string>,
     name: string,
     operationKind: string,
     metadata: Js.Nullable.t<operationMetadata>,

packages/rescript-relay/src/RescriptRelay.resi

@@ -1017,10 +1017,15 @@ module Network: {
     - `metadata`: Optional operation metadata
   */
   type operation = {
-    id: string,
-    text: string,
+    /** The operation ID. Set if persisted queries are enabled, otherwise not set. */
+    id: Js.Nullable.t<string>,
+    /** The operation text. Not set for persisted queries, or if this is a client-only query that will not make a network request. */
+    text: Js.Nullable.t<string>,
+    /** The operation name. */
     name: string,
+    /** The operation kind. */
     operationKind: string,
+    /** Optional operation metadata. */
     metadata: Js.Nullable.t<operationMetadata>,
   }
 

rescript-relay-documentation/docs/api-reference.md

@@ -920,14 +920,14 @@ Represents the network layer.
 
 ```rescript
 type operation = {
-    id: string,
-    text: string,
+    id: Nullable.t<string>,
+    text: Nullable.t<string>,
     name: string,
     operationKind: string,
   }
 ```
 
-The operation fed to the `NetworkLayer` when Relay wants to make a request. Please note that if you're using persisted queries, `id` will exist but `text` won't, and vice versa when not using persisted queries.
+The operation fed to the `NetworkLayer` when Relay wants to make a request. Please note that if you're using persisted queries, `id` will exist but `text` will be null, and vice versa when not using persisted queries.
 
 ### [Network.subscribeFn](#networksubscribefn)
 

rescript-relay-documentation/docs/codesplit-directive.md

@@ -60,9 +60,13 @@ let fetchQuery: RescriptRelay.Network.fetchFunctionPromise = async (
     "https://your.server/graphql",
     {
       method: #POST,
-      body: {"query": operation.text, "id": operation.id, "variables": variables}
-      ->Js.Json.stringifyAny
-      ->Belt.Option.getExn
+      body: {
+        "query": operation.text->Nullable.getOr(""),
+        "id": operation.id->Nullable.getOr(""),
+        "variables": variables
+      }
+      ->JSON.stringifyAny
+      ->Option.getExn
       ->Body.string,
       headers: Headers.fromObject({
         "content-type": "application/json",

rescript-relay-documentation/docs/getting-started.md

@@ -140,7 +140,10 @@ let fetchQuery: RescriptRelay.Network.fetchFunctionPromise = async (
     "http://localhost:4000/graphql",
     {
       method: #POST,
-      body: {"query": operation.text, "variables": variables}
+      body: {
+        "query": operation.text->Nullable.getOr(""),
+        "variables": variables
+      }
       ->JSON.stringifyAny
       ->Option.getExn
       ->Body.string,

rescript-relay-documentation/docs/subscriptions.md

@@ -43,7 +43,7 @@ let subscriptionClient = SubscriptionsTransportWs.createSubscriptionClient(
 )
 
 let subscriptionFunction: RescriptRelay.Network.subscribeFn = (config, variables, _cacheConfig) => {
-  let query = config.text
+  let query = config.text->Nullable.getOr("")
   let subscriptionQuery: SubscriptionsTransportWs.operationOptions = {
     query: query,
     variables: variables,

rescript-relay-documentation/docs/using-with-hasura.md

@@ -38,7 +38,7 @@ let fetchQuery: RescriptRelay.Network.fetchFunctionPromise = (operation, variabl
     RequestInit.make(
       ~method_=Post,
       ~body=Js.Dict.fromList(list{
-        ("query", Js.Json.string(operation.text)),
+        ("query", Js.Json.string(operation.text->Js.Nullable.toOption->Belt.Option.getWithDefault(""))),
         ("variables", variables),
       })
       |> Js.Json.object_