From 1cee3430b8bbb89da5d7a5196a89aa468eb3f9db Mon Sep 17 00:00:00 2001
From: Leo Lamprecht <leo@ronin.co>
Date: Mon, 15 Jul 2024 16:46:26 +0200
Subject: [PATCH] Expose request errors with dedicated error object (#99)

* Added error for tracking invalid responses

* Ensure passing tests
---
 bun.lockb                  | Bin 167528 -> 167536 bytes
 src/queries.ts             |  10 ++----
 src/storage.ts             |  12 +++----
 src/utils/errors.ts        |  62 +++++++++++++++++++++++++++++++++----
 src/utils/index.ts         |  11 +++++--
 tests/unit/queries.test.ts |  17 ++++++----
 6 files changed, 84 insertions(+), 28 deletions(-)

diff --git a/bun.lockb b/bun.lockb
index fa3684269f388e7296293a006ec07df7acb4b060..3c8e9aa58880da6d891c780aa1b9c0025b54676c 100755
GIT binary patch
delta 914
zcmYk3Pe@cz6vpozbM%d+n3!5rj-pVCh~uWL$gM;ot*TW*feRf$1aVOfYNV+cXtzHT
z^k-})O<!j66f3L<qGc-=EnK?O7VY~!=UaG~kN2J5IdkrL_iZO5yUEDZWxJJVUun0a
zsWS;{41OjLVlWTkNgX6W45=pvzHpBiGwh0IZOQo&m2!d0RJx}TVdTF!2XSAF$NYq6
zjJX>e@jxRypx-Kui$%b0vllTTRsf%XxXq+n;)ofQ4gsBn7>~esI2Vo*AReo)2)+v9
z)=!*$gAq?vDh8T{XFL--4BsY}6e|I15_|4CIN}9To>&U~gShA`wI6}sf*7yGcwbX{
z#F&(O$q};}Q2{)tQd;dtk)IOFsP7o^T8J+>=l*iUyxNZgU4&=66FUKa7M{y5;K^-y
zUoB$3YfWRsd$mVVN<v(8NsQOl1~EQ}Rl{F_%AsZV5F;u+s#F7%f*31cVfQ(0V|R$Z
zAmumYJ7plUuln0*_&Kp}Vs*&p#lC}a`FdypV(o|6051nI?Ps5nbN#WV3zf~4eO-e$
z<G1SJf_TQ}hTYvo`zM-4E02E*@kkzV4Z033Lswn5Z_7#-_u&mq9uH=GyHnt8tY=T^
saTDvdH_tXUG&aOy!GTY<^OCok&qa+{4dVHsR_kqh*?cot^Fsdce_H`@g8%>k

delta 884
zcmXw#J4hU16ouzs@iDtTSS3CpDk=t|R;JP*xUEPe*u^R-thG`s0>Yw^L|sAo6I_j=
z?&>Z&8y}ek6Y<fAm843irCpN3&cbutlfxY5-tXSI|DFGDJa`)q#$K7<6a9z%W_qJD
zY8(fTQwUSc19;QL1kj{<@(`Ck633ac;Z0M~{XwOC;3}1-HKG9dCFejN#dypGVrs^|
z<%n60aDjfQG$$4Wd(U1dCKf_G0dt#q`;8+$t5gEi08?MUcsLhsB!HIGSBAI==GJj*
z5*V?pQW$6fF|{IAj<{Fst5^kChuErp%@ONJdEyiJ4(6hpYOh3m15*hx-dF6AI8M^8
zam1EJ)BumGlv4Xs<j=*@>Z?Wm4CYVn*nb?ctM)pe9>kO<R*$#~F_+Ka&24#KFU9t3
zB#9CGYHvg-4s+21F<x6QOdX0fBOZXO;qP`HBWiq=T7WiSDhrlpe<sa~A*RPjxd8uZ
z3ufzyK5Ips5<3-ZL!O4IGqHBWJ1}eKnm5Kvgg$w8#WPJl^80)@39=2R?Z~dV4)Z`B
z@CF`)_w9&hs>1)%EN={o`pcgA6LPahxqQej9+}}nt_}IcKg_#6H&c|$GyZ5%AY$Ab
NH<w@er*6QDJ^+)2Z72W$

diff --git a/src/queries.ts b/src/queries.ts
index 2ec0059..0544d26 100644
--- a/src/queries.ts
+++ b/src/queries.ts
@@ -2,7 +2,7 @@ import { processStorableObjects, uploadStorableObjects } from '@/src/storage';
 import type { Query, Results } from '@/src/types/query';
 import type { QueryHandlerOptions } from '@/src/types/utils';
 import { runQueriesWithHooks } from '@/src/utils/data-hooks';
-import { getDotNotatedPath, InvalidQueryError } from '@/src/utils/errors';
+import { getDotNotatedPath, getResponseBody, InvalidQueryError } from '@/src/utils/errors';
 import { formatTimeFields, getProperty } from '@/src/utils/helpers';
 
 type QueryResponse<T> = {
@@ -85,14 +85,8 @@ export const runQueries = async <T>(
 
   const fetcher = typeof options?.fetch === 'function' ? options.fetch : fetch;
   const response = await fetcher(request);
-  const { results, error } = (await response.json()) as QueryResponse<T>;
 
-  // Throw errors that happened during the execution of the queries.
-  if (error) {
-    const exposedError: Error & { code?: string } = new Error(error.message);
-    if (error.code) exposedError.code = error.code;
-    throw exposedError;
-  }
+  const { results } = await getResponseBody<QueryResponse<T>>(response);
 
   const startFormatting = performance.now();
 
diff --git a/src/storage.ts b/src/storage.ts
index 3f1bce0..010be59 100644
--- a/src/storage.ts
+++ b/src/storage.ts
@@ -1,6 +1,7 @@
 import type { CombinedInstructions, Query } from '@/src/types/query';
 import type { StorableObject, StoredObject } from '@/src/types/storage';
 import type { QueryHandlerOptions } from '@/src/types/utils';
+import { getResponseBody } from '@/src/utils/errors';
 
 /**
  * Extract `StorableObject`s from queries. These will be uploaded separately
@@ -98,14 +99,13 @@ export const uploadStorableObjects = async (
     });
 
     const response = await fetcher(request);
-    if (!response.ok) throw new Error(await response.text());
-    return response.json() as Promise<StoredObject>;
+    return getResponseBody<StoredObject>(response, {
+      errorPrefix:
+        'An error occurred while uploading the binary objects included in the provided queries. Error:',
+    });
   });
 
-  return Promise.all(requests).catch((err) => {
-    const message = `An error occurred while uploading the binary objects included in the provided queries. ${err}`;
-    throw new Error(message);
-  });
+  return Promise.all(requests);
 };
 
 /**
diff --git a/src/utils/errors.ts b/src/utils/errors.ts
index 31b504d..5d63737 100644
--- a/src/utils/errors.ts
+++ b/src/utils/errors.ts
@@ -1,4 +1,4 @@
-interface Details {
+interface InvalidQueryErrorDetails {
   message: string;
   query: string | null;
   path: string | null;
@@ -6,12 +6,12 @@ interface Details {
 }
 
 export class InvalidQueryError extends Error {
-  message: Details['message'];
-  query: Details['query'];
-  path: Details['path'];
-  details: Details['details'];
+  message: InvalidQueryErrorDetails['message'];
+  query: InvalidQueryErrorDetails['query'];
+  path: InvalidQueryErrorDetails['path'];
+  details: InvalidQueryErrorDetails['details'];
 
-  constructor(details: Details) {
+  constructor(details: InvalidQueryErrorDetails) {
     super(details.message);
 
     this.name = 'InvalidQueryError';
@@ -22,6 +22,56 @@ export class InvalidQueryError extends Error {
   }
 }
 
+interface InvalidResponseErrorDetails {
+  message: string;
+  code: string;
+}
+
+export class InvalidResponseError extends Error {
+  message: InvalidResponseErrorDetails['message'];
+  code: InvalidResponseErrorDetails['code'];
+
+  constructor(details: InvalidResponseErrorDetails) {
+    super(details.message);
+
+    this.name = 'InvalidQueryRequest';
+    this.message = details.message;
+    this.code = details.code;
+  }
+}
+
+/**
+ * Parses the response as JSON or, alternatively, throws an error containing
+ * potential error details that might have been included in the response.
+ *
+ * @param response The response of a fetch request.
+ *
+ * @returns The response body as a JSON object.
+ */
+export const getResponseBody = async <T>(
+  response: Response,
+  options?: { errorPrefix?: string },
+): Promise<T> => {
+  if (response.ok) return response.json() as T;
+
+  const text = await response.text();
+
+  let error: InvalidResponseErrorDetails = {
+    message: text,
+    code: 'UNKNOWN_ERROR',
+  };
+
+  try {
+    ({ error } = JSON.parse(text));
+  } catch (err) {
+    // Ignore parsing errors
+  }
+
+  if (options?.errorPrefix) error.message = `${options.errorPrefix} ${error.message}`;
+
+  throw new InvalidResponseError(error);
+};
+
 /**
  * Utility function to generate a dot-notated string of the given path.
  *
diff --git a/src/utils/index.ts b/src/utils/index.ts
index 02b09d9..5360685 100644
--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -1,6 +1,13 @@
 import { runQueriesWithStorageAndHooks as runQueries } from '@/src/queries';
 import { processStorableObjects } from '@/src/storage';
 import { getBatchProxy, getSyntaxProxy } from '@/src/syntax/utils';
-import { InvalidQueryError } from '@/src/utils/errors';
+import { InvalidQueryError, InvalidResponseError } from '@/src/utils/errors';
 
-export { runQueries, processStorableObjects, getSyntaxProxy, getBatchProxy, InvalidQueryError };
+export {
+  runQueries,
+  processStorableObjects,
+  getSyntaxProxy,
+  getBatchProxy,
+  InvalidQueryError,
+  InvalidResponseError,
+};
diff --git a/tests/unit/queries.test.ts b/tests/unit/queries.test.ts
index ccfa025..02a04d1 100644
--- a/tests/unit/queries.test.ts
+++ b/tests/unit/queries.test.ts
@@ -92,13 +92,18 @@ describe('queries handler', () => {
       fetch: async (request) => {
         mockRequestResolvedValue = request as Request;
 
-        return Response.json({
-          results: [],
-          error: {
-            message: 'Invalid query provided.',
-            code: 'BAD_REQUEST',
+        return new Response(
+          JSON.stringify({
+            results: [],
+            error: {
+              message: 'Invalid query provided.',
+              code: 'BAD_REQUEST',
+            },
+          }),
+          {
+            status: 400,
           },
-        });
+        );
       },
     });