refactor: getResponseData (#95)

Author: kasperrt

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Releases
 
 ## Contents
+- [v0.3.4-alpha.0](#v0-3-4-alpha-0)
 - [v0.3.3](#v0-3-3)
 - [v0.3.2](#v0-3-2)
 - [v0.3.1](#v0-3-1)
@@ -16,6 +17,12 @@
 - [v0.1.0](#v0-1-0)
 - [v0.0.8](#v0-0-8)
 
+## v0.3.4-alpha.0
+
+- Internal; Handle 205 status-codes more gracefully by defaulting to null returned as body.
+- Internal; Reduce overhead for getResponseData to read response once through `.text()` with attempting parsing on `application/json` or `+json` in the `Content-Type` header.
+
+
 ## v0.3.3
 
 - Bump @standard-schema/spec@1.1.0.

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@kasperrt/wiretyped",
-  "version": "0.3.3",
+  "version": "0.3.4-alpha.0",
   "exports": {
     ".": "./src/index.ts"
   },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wiretyped",
-  "version": "0.3.3",
+  "version": "0.3.4.alpha-0",
   "description": "Universal fetch-based HTTP client with robust error handling, retries, caching, SSE, and Standard Schema validation.",
   "type": "module",
   "keywords": [

src/core/client.test.ts

@@ -663,7 +663,9 @@ describe('RequestClient', () => {
           json: () => {
             throw new Error('test');
           },
-          text: () => '{ "ok": true }',
+          text: () => {
+            throw new Error('test');
+          },
           ok: true,
           status: 200,
           headers: { get: () => 'application/json' },
@@ -700,7 +702,7 @@ describe('RequestClient', () => {
         new Error('error doing request in get', {
           cause: new RetryExhaustedError('error retries exhausted', 10, {
             cause: new Error('error getting response in GET', {
-              cause: new Error('error parsing json in getResponseData', { cause: new Error('test') }),
+              cause: new Error('error reading response body in getResponseData', { cause: new Error('test') }),
             }),
           }),
         }),
@@ -1381,7 +1383,7 @@ describe('RequestClient', () => {
         const getSpy = vi.spyOn(MOCK_FETCH_PROVIDER.prototype, 'get').mockImplementation(async () =>
           asyncOk({
             json: () => null,
-            text: () => '{ "data": "GET request data no params" }',
+            text: () => '{ "foo": "GET request data no params" }',
             ok: true,
             status: 200,
             headers: { get: () => 'application/json' },

src/core/client.ts

@@ -428,6 +428,7 @@ export class RequestClient<Schema extends RequestDefinitions> {
     const close = (): void => controller.abort('closed by user request');
     const hasEventSchema = (name: string): name is SSEDataReturn<Schema, Endpoint & string>['type'] =>
       name in eventSchemas;
+
     const parseBlock = async (block: string) => {
       if (!block) {
         return;

src/utils/getResponseData.test.ts

@@ -91,7 +91,7 @@ describe('getResponseData', () => {
 
       expect(value).toBeNull();
       expect(err).toBeInstanceOf(Error);
-      expect(err?.message).toBe('error attempting string parse after json failed in getResponseData');
+      expect(err?.message).toBe('error reading response body in getResponseData');
       expect(err?.cause).toBe(textError);
     });
 
@@ -111,7 +111,7 @@ describe('getResponseData', () => {
 
       expect(value).toBeNull();
       expect(err).toBeInstanceOf(Error);
-      expect(err?.message).toBe('error json-parse string after json failed in getResponseData');
+      expect(err?.message).toBe('error parsing json response body in getResponseData');
       expect(err?.cause).toBeInstanceOf(SyntaxError);
     });
 

src/utils/getResponseData.ts

@@ -1,4 +1,3 @@
-import { isErrorType } from '../error/isErrorType.js';
 import type { FetchResponse } from '../types/request.js';
 import { type SafeWrapAsync, safeWrap, safeWrapAsync } from './wrap.js';
 
@@ -22,41 +21,31 @@ import { type SafeWrapAsync, safeWrap, safeWrapAsync } from './wrap.js';
  *   and `value` is the parsed body (`ReturnValue | null`).
  */
 export async function getResponseData<ReturnValue>(response: FetchResponse): SafeWrapAsync<Error, ReturnValue> {
-  if (response.status === 204) {
+  // Per HTTP spec, 204 + 205 shouldn't have a body
+  if (response.status === 204 || response.status === 205) {
     return [null, null as ReturnValue];
   }
 
-  const contentType = response.headers.get('Content-Type');
-  if (!contentType?.includes('application/json')) {
-    const [errText, text] = await safeWrapAsync(() => response.text());
-    if (errText) {
-      return [new Error('error parsing text in getResponseData', { cause: errText }), null];
-    }
-
-    return [null, (text || null) as ReturnValue];
-  }
-
-  const [errJson, json] = await safeWrapAsync(() => response.json());
-  // if we get a normal non TypeError, we want to try more aggressively at parsing this still, in case
-  // the browser fumbled and didn't supply us with a proper json method
-  if (errJson && !isErrorType(TypeError, errJson)) {
-    return [new Error('error parsing json in getResponseData', { cause: errJson }), null];
+  // Use .text as reader, since double reads with text -> json would cause TypeError
+  // due to the body being consumed already
+  const [errText, text] = await safeWrapAsync(() => response.text());
+  if (errText) {
+    return [new Error('error reading response body in getResponseData', { cause: errText }), null];
   }
 
-  if (!isErrorType(TypeError, errJson)) {
-    return [null, json];
+  if (!text) {
+    return [null, null as ReturnValue];
   }
 
-  // If TypeError, try again, more aggressively
-  const [errText, text] = await safeWrapAsync(() => response.text());
-  if (errText) {
-    return [new Error('error attempting string parse after json failed in getResponseData', { cause: errText }), null];
+  const contentType = response?.headers?.get('Content-Type')?.toLowerCase();
+  if (!contentType?.includes('application/json') && !contentType?.includes('+json')) {
+    return [null, text as ReturnValue];
   }
 
-  const [errParse, parsed] = safeWrap<Error, ReturnValue>(() => JSON.parse(text));
-  if (errParse) {
-    return [new Error('error json-parse string after json failed in getResponseData', { cause: errParse }), null];
+  const [errJson, json] = safeWrap(() => JSON.parse(text));
+  if (errJson) {
+    return [new Error('error parsing json response body in getResponseData', { cause: errJson }), null];
   }
 
-  return [null, parsed];
+  return [null, json];
 }