Merge pull request #569 from effector/fix-no-content-response

Fix "no content" response support

Author: AlexandrHoroshih

.changeset/beige-teams-bet.md

@@ -0,0 +1,5 @@
+---
+'@farfetched/core': patch
+---
+
+Fix "No Content" responses support

packages/core/src/fetch/__tests__/json.response.data.test.ts

@@ -106,4 +106,52 @@ describe('fetch/json.response.data', () => {
       meta: expect.anything(),
     });
   });
+
+  describe('null body status responses', () => {
+    test('204 No Content response returns null', async () => {
+      const callJsonApiFx = createJsonApiRequest({ request });
+
+      const fetchMock = vi
+        .fn()
+        .mockResolvedValue(new Response(null, { status: 204 }));
+
+      const scope = fork({ handlers: [[fetchFx, fetchMock]] });
+
+      const watcher = watchEffect(callJsonApiFx, scope);
+
+      await allSettled(callJsonApiFx, {
+        scope,
+        params: {},
+      });
+
+      expect(watcher.listeners.onFailData).not.toBeCalled();
+      expect(watcher.listeners.onDoneData).toBeCalledWith({
+        result: null,
+        meta: expect.anything(),
+      });
+    });
+
+    test('205 Reset Content response returns null', async () => {
+      const callJsonApiFx = createJsonApiRequest({ request });
+
+      const fetchMock = vi
+        .fn()
+        .mockResolvedValue(new Response(null, { status: 205 }));
+
+      const scope = fork({ handlers: [[fetchFx, fetchMock]] });
+
+      const watcher = watchEffect(callJsonApiFx, scope);
+
+      await allSettled(callJsonApiFx, {
+        scope,
+        params: {},
+      });
+
+      expect(watcher.listeners.onFailData).not.toBeCalled();
+      expect(watcher.listeners.onDoneData).toBeCalledWith({
+        result: null,
+        meta: expect.anything(),
+      });
+    });
+  });
 });

packages/core/src/fetch/api.ts

@@ -15,6 +15,7 @@ import {
   formatUrl,
   mergeRecords,
   formatHeaders,
+  isNullBodyStatus,
   type FetchApiRecord,
   mergeQueryStrings,
 } from './lib';
@@ -160,9 +161,15 @@ export function createApiRequest<
         throw { error: transformedError, responseMeta: cause.responseMeta };
       });
 
-      const [forPrepare, forError] = response.body?.tee() ?? [null, null];
       const responseHeaders = response.headers;
 
+      // For null body statuses (101, 103, 204, 205, 304), the Response constructor
+      // throws if a body is provided, so we must use null body for these statuses.
+      const hasNullBodyStatus = isNullBodyStatus(response.status);
+      const [forPrepare, forError] = hasNullBodyStatus
+        ? [null, null]
+        : (response.body?.tee() ?? [null, null]);
+
       const prepared = await prepareFx(new Response(forPrepare, response)).then(
         async (result) => {
           await drain(forError);
@@ -172,7 +179,7 @@ export function createApiRequest<
         async (cause) => {
           throw {
             error: preparationError({
-              response: await new Response(forError).text(),
+              response: forError ? await new Response(forError).text() : '',
               reason: cause?.message ?? null,
             }),
             responseMeta: { headers: responseHeaders },

packages/core/src/fetch/json.ts

@@ -11,7 +11,7 @@ import {
   ExclusiveRequestConfigShared,
   StaticOnlyRequestConfig,
 } from './api';
-import { mergeRecords } from './lib';
+import { isNullBodyStatus, mergeRecords } from './lib';
 import { drain } from 'libs/lohyphen';
 
 export type JsonObject = Record<string, Json>;
@@ -109,6 +109,12 @@ export function createJsonApiRequest<R extends CreationRequestConfig>(
 async function checkEmptyResponse(
   response: Response
 ): Promise<[true, null] | [false, Response]> {
+  // Null body statuses (101, 103, 204, 205, 304) cannot have a body per the Fetch spec.
+  // We must check this early to avoid "Response with null body status cannot have body" error.
+  if (isNullBodyStatus(response.status)) {
+    return [true, null];
+  }
+
   if (!response.body) {
     return [true, null];
   }

packages/core/src/fetch/lib.ts

@@ -1,5 +1,19 @@
 import { configurationError } from '../errors/create_error';
 
+/**
+ * HTTP status codes that indicate a null body response.
+ * Per the Fetch specification, responses with these status codes cannot have a body.
+ * Attempting to construct a Response with a body for these statuses throws:
+ * "TypeError: Response with null body status cannot have body"
+ *
+ * @see https://fetch.spec.whatwg.org/#null-body-status
+ */
+const NULL_BODY_STATUSES = new Set([101, 103, 204, 205, 304]);
+
+export function isNullBodyStatus(status: number): boolean {
+  return NULL_BODY_STATUSES.has(status);
+}
+
 export type FetchApiRecord = Record<
   string,
   string | string[] | number | boolean | null | undefined

packages/core/src/mutation/__tests__/create_json_mutation.test.ts

@@ -156,6 +156,61 @@ describe('createJsonMutation', () => {
     );
   });
 
+  test('handle 204 No Content response with DELETE method', async () => {
+    const mutation = createJsonMutation({
+      request: {
+        url: 'https://api.salo.com/resource/123',
+        method: 'DELETE' as const,
+      },
+      response: { contract: unknownContract },
+    });
+
+    const scope = fork({
+      handlers: [[fetchFx, () => new Response(null, { status: 204 })]],
+    });
+
+    const { listeners } = watchRemoteOperation(mutation, scope);
+
+    await allSettled(mutation.start, { scope });
+
+    expect(listeners.onFailure).not.toHaveBeenCalled();
+    expect(listeners.onSuccess).toHaveBeenCalled();
+    expect(listeners.onSuccess).toHaveBeenCalledWith(
+      expect.objectContaining({
+        result: null,
+        params: undefined,
+      })
+    );
+  });
+
+  test('handle 204 No Content response with POST method', async () => {
+    const mutation = createJsonMutation({
+      request: {
+        url: 'https://api.salo.com/resource',
+        method: 'POST' as const,
+        body: { data: 'test' },
+      },
+      response: { contract: unknownContract },
+    });
+
+    const scope = fork({
+      handlers: [[fetchFx, () => new Response(null, { status: 204 })]],
+    });
+
+    const { listeners } = watchRemoteOperation(mutation, scope);
+
+    await allSettled(mutation.start, { scope });
+
+    expect(listeners.onFailure).not.toHaveBeenCalled();
+    expect(listeners.onSuccess).toHaveBeenCalled();
+    expect(listeners.onSuccess).toHaveBeenCalledWith(
+      expect.objectContaining({
+        result: null,
+        params: undefined,
+      })
+    );
+  });
+
   test('cancel json mutation by external clock', async () => {
     const abort = createEvent();