fix(CombinedError): use record binding to support migration to ReScript (#230)

Author: parkerziegler

__tests__/Types_test.re

@@ -79,27 +79,22 @@ describe("Types", () => {
             extensions: None,
           };
 
-        let errorJs = {
-          "message": "Error returned by GraphQL API",
-          "graphQLErrors": [|graphQLError|],
-          "networkError": Js.Nullable.null,
-          "response": Js.Nullable.null,
-        };
-
         let error =
           CombinedError.{
+            name: "CombinedError",
             message: "Error returned by GraphQL API",
             graphQLErrors: [|graphQLError|],
             networkError: None,
             response: None,
+            toString: () => "Error returned by GraphQL API",
           };
 
         let response =
           Types.Hooks.{
             operation: mockOperation,
             fetching: false,
             data: Js.Nullable.return(Js.Json.string("Hello")),
-            error: Some(errorJs),
+            error: Some(error),
             extensions: None,
             stale: false,
           };
@@ -131,27 +126,22 @@ describe("Types", () => {
           extensions: None,
         };
 
-      let errorJs = {
-        "message": "Error returned by GraphQL API",
-        "graphQLErrors": [|graphQLError|],
-        "networkError": Js.Nullable.null,
-        "response": Js.Nullable.null,
-      };
-
       let error =
         CombinedError.{
+          name: "CombinedError",
           message: "Error returned by GraphQL API",
           graphQLErrors: [|graphQLError|],
           networkError: None,
           response: None,
+          toString: () => "Error returned by GraphQL API",
         };
 
       let response =
         Types.Hooks.{
           operation: mockOperation,
           fetching: false,
           data: Js.Nullable.undefined,
-          error: Some(errorJs),
+          error: Some(error),
           extensions: None,
           stale: false,
         };

src/CombinedError.re

@@ -1,29 +1,8 @@
-class type _combinedError =
-  [@bs]
-  {
-    pub networkError: Js.Nullable.t(Js.Exn.t);
-    pub graphQLErrors: array(GraphQLError.t);
-    pub response: Js.Nullable.t(Fetch.response);
-    pub message: string;
-  };
-
-type combinedErrorJs = Js.t(_combinedError);
-[@bs.module "urql"] external combinedError: combinedErrorJs = "CombinedError";
-
-type combinedError = {
-  networkError: option(Js.Exn.t),
+type t = {
+  name: string,
+  message: string,
   graphQLErrors: array(GraphQLError.t),
+  networkError: option(Js.Exn.t),
   response: option(Fetch.response),
-  message: string,
-};
-
-let combinedErrorToRecord = (err: combinedErrorJs): combinedError => {
-  {
-    networkError: err##networkError->Js.Nullable.toOption,
-    graphQLErrors: err##graphQLErrors,
-    response: err##response->Js.Nullable.toOption,
-    message: err##message,
-  };
+  toString: unit => string,
 };
-
-type t = combinedError;

src/CombinedError.rei

@@ -1,22 +1,8 @@
-class type _combinedError =
-  [@bs]
-  {
-    pub networkError: Js.Nullable.t(Js.Exn.t);
-    pub graphQLErrors: array(GraphQLError.t);
-    pub response: Js.Nullable.t(Fetch.response);
-    pub message: string;
-  };
-
-type combinedErrorJs = Js.t(_combinedError);
-[@bs.module "urql"] external combinedError: combinedErrorJs = "CombinedError";
-
-type combinedError = {
-  networkError: option(Js.Exn.t),
+type t = {
+  name: string,
+  message: string,
   graphQLErrors: array(GraphQLError.t),
+  networkError: option(Js.Exn.t),
   response: option(Fetch.response),
-  message: string,
+  toString: unit => string,
 };
-
-let combinedErrorToRecord: combinedErrorJs => combinedError;
-
-type t = combinedError;

src/Types.re

@@ -81,7 +81,7 @@ type operation = {
 type operationResultJs('dataJs) = {
   operation,
   data: Js.Nullable.t('dataJs),
-  error: option(CombinedError.combinedErrorJs),
+  error: option(CombinedError.t),
   extensions: option(Js.Dict.t(string)),
   stale: option(bool),
 };
@@ -102,10 +102,8 @@ type operationResult('data) = {
 
 let operationResultToReason =
     (~response: operationResultJs('dataJs), ~parse: 'dataJs => 'data) => {
-  let {extensions, stale}: operationResultJs('dataJs) = response;
+  let {error, extensions, stale}: operationResultJs('dataJs) = response;
   let data = response.data->Js.Nullable.toOption->Belt.Option.map(parse);
-  let error =
-    response.error->Belt.Option.map(CombinedError.combinedErrorToRecord);
 
   let response =
     switch (data, error) {
@@ -163,7 +161,7 @@ module Hooks = {
     operation,
     fetching: bool,
     data: Js.Nullable.t('dataJs),
-    error: option(CombinedError.combinedErrorJs),
+    error: option(CombinedError.t),
     extensions: option(Js.Json.t),
     stale: bool,
   };
@@ -177,11 +175,9 @@ module Hooks = {
       (~response: hookResponseJs(dataJs), ~parse: dataJs => data) =>
       hookResponse(data) =
     (~response, ~parse) => {
-      let {operation, fetching, extensions, stale} = response;
+      let {operation, fetching, error, extensions, stale} = response;
 
       let data = response.data->Js.Nullable.toOption->Belt.Option.map(parse);
-      let error =
-        response.error->Belt.Option.map(CombinedError.combinedErrorToRecord);
 
       let response =
         switch (fetching, data, error) {

src/Types.rei

@@ -71,7 +71,7 @@ type operation = {
 type operationResultJs('dataJs) = {
   operation,
   data: Js.Nullable.t('dataJs),
-  error: option(CombinedError.combinedErrorJs),
+  error: option(CombinedError.t),
   extensions: option(Js.Dict.t(string)),
   stale: option(bool),
 };
@@ -140,7 +140,7 @@ module Hooks: {
     operation,
     fetching: bool,
     data: Js.Nullable.t('dataJs),
-    error: option(CombinedError.combinedErrorJs),
+    error: option(CombinedError.t),
     extensions: option(Js.Json.t),
     stale: bool,
   };

src/hooks/UseSubscription.re

@@ -45,11 +45,9 @@ type useSubscriptionResponse('response) = (
 
 let subscriptionResponseToReason =
     (response: Types.Hooks.hookResponseJs('ret)) => {
-  let Types.Hooks.{operation, fetching, extensions, stale} = response;
+  let Types.Hooks.{operation, fetching, error, extensions, stale} = response;
 
   let data = response.data->Js.Nullable.toOption;
-  let error =
-    response.error->Belt.Option.map(CombinedError.combinedErrorToRecord);
 
   let response =
     switch (fetching, data, error) {