fix(respect): binary data is destroyed when consumed with text

Author: DmitryAnansky

packages/respect-core/src/utils/__tests__/isBinaryContentType.test.ts

@@ -0,0 +1,29 @@
+import { isBinaryContentType } from '../isBinaryContentType.js';
+
+describe('isBinaryContentType', () => {
+  it('should return true for binary content types', () => {
+    expect(isBinaryContentType('application/octet-stream')).toBe(true);
+    expect(isBinaryContentType('application/pdf')).toBe(true);
+    expect(isBinaryContentType('image/png')).toBe(true);
+    expect(isBinaryContentType('image/jpeg')).toBe(true);
+    expect(isBinaryContentType('audio/mpeg')).toBe(true);
+    expect(isBinaryContentType('video/mp4')).toBe(true);
+    expect(isBinaryContentType('application/zip')).toBe(true);
+    expect(isBinaryContentType('application/x-zip-compressed')).toBe(true);
+    expect(isBinaryContentType('application/gzip')).toBe(true);
+    expect(isBinaryContentType('application/x-gzip')).toBe(true);
+    expect(isBinaryContentType('application/x-bzip2')).toBe(true);
+    expect(isBinaryContentType('application/x-tar')).toBe(true);
+    expect(isBinaryContentType('application/x-rar-compressed')).toBe(true);
+    expect(isBinaryContentType('application/x-7z-compressed')).toBe(true);
+    expect(
+      isBinaryContentType('application/vnd.openxmlformats-officedocument.wordprocessingml.document')
+    ).toBe(true);
+    expect(isBinaryContentType('application/vnd.ms-excel')).toBe(true);
+    expect(isBinaryContentType('application/vnd.ms-powerpoint')).toBe(true);
+    expect(isBinaryContentType('application/msword')).toBe(true);
+    expect(isBinaryContentType('application/x-shockwave-flash')).toBe(true);
+    expect(isBinaryContentType('application/x-font-ttf')).toBe(true);
+    expect(isBinaryContentType('font/woff2')).toBe(true);
+  });
+});

packages/respect-core/src/utils/api-fetcher.ts

@@ -17,6 +17,7 @@ import { getResponseSchema } from '../modules/description-parser/index.js';
 import { collectSecretFields } from '../modules/flow-runner/index.js';
 import { parseWwwAuthenticateHeader } from './digest-auth/parse-www-authenticate-header.js';
 import { generateDigestAuthHeader } from './digest-auth/generate-digest-auth-header.js';
+import { isBinaryContentType } from './isBinaryContentType.js';
 
 import type { RequestData } from '../modules/flow-runner/index.js';
 
@@ -343,12 +344,10 @@ export class ApiFetcher implements IFetcher {
       });
 
       responseTime = Math.ceil(performance.now() - startTime);
-      responseBody = await fetchResult.text();
     } else {
       // REGULAR FETCH
       fetchResult = await customFetch(urlToFetch, fetchParams);
       responseTime = Math.ceil(performance.now() - startTime);
-      responseBody = await fetchResult.text();
     }
 
     if (!fetchResult) {
@@ -358,6 +357,14 @@ export class ApiFetcher implements IFetcher {
     const [responseContentType] = fetchResult.headers.get('content-type')?.split(';') || [
       'application/json',
     ];
+
+    // Handle response body based on content type
+    if (isBinaryContentType(responseContentType)) {
+      const arrayBuffer = await fetchResult.arrayBuffer();
+      responseBody = Buffer.from(arrayBuffer).toString('base64');
+    } else {
+      responseBody = await fetchResult.text();
+    }
     const transformedBody = responseBody
       ? isJsonContentType(responseContentType)
         ? JSON.parse(responseBody)

packages/respect-core/src/utils/isBinaryContentType.ts

@@ -0,0 +1,27 @@
+export function isBinaryContentType(contentType: string): boolean {
+  const binaryTypes = [
+    'application/octet-stream',
+    'application/pdf',
+    'image/',
+    'audio/',
+    'video/',
+    'application/zip',
+    'application/x-zip-compressed',
+    'application/gzip',
+    'application/x-gzip',
+    'application/x-bzip2',
+    'application/x-tar',
+    'application/x-rar-compressed',
+    'application/x-7z-compressed',
+    'application/vnd.openxmlformats-officedocument',
+    'application/vnd.ms-excel',
+    'application/vnd.ms-powerpoint',
+    'application/msword',
+    'application/x-shockwave-flash',
+    'application/x-font-',
+    'font/',
+    'application/x-font-ttf',
+  ];
+
+  return binaryTypes.some((type) => contentType.startsWith(type));
+}