Merge pull request #3427 from hey-api/copilot/fix-crash-report-issue

fix: surface actual error message when spec fetch fails

Author: mrlubos

.changeset/fluffy-turtles-explain.md

@@ -0,0 +1,6 @@
+---
+"@hey-api/openapi-ts": patch
+"@hey-api/shared": patch
+---
+
+**input**: fix: improve returned status code when spec fetch fails

packages/openapi-python/src/createClient.ts

@@ -66,7 +66,10 @@ export async function createClient({
     // if in watch mode, subsequent errors won't throw to gracefully handle
     // cases where server might be reloading
     if (error && !_watches) {
-      throw new Error(`Request failed with status ${response.status}: ${response.statusText}`);
+      const text = await response.text().catch(() => '');
+      throw new Error(
+        `Request failed with status ${response.status}: ${text || response.statusText}`,
+      );
     }
 
     return { arrayBuffer, resolvedInput };

packages/openapi-ts/src/createClient.ts

@@ -66,7 +66,10 @@ export async function createClient({
     // if in watch mode, subsequent errors won't throw to gracefully handle
     // cases where server might be reloading
     if (error && !_watches) {
-      throw new Error(`Request failed with status ${response.status}: ${response.statusText}`);
+      const text = await response.text().catch(() => '');
+      throw new Error(
+        `Request failed with status ${response.status}: ${text || response.statusText}`,
+      );
     }
 
     return { arrayBuffer, resolvedInput };

packages/shared/src/__tests__/getSpec.test.ts

@@ -0,0 +1,103 @@
+import * as refParser from '@hey-api/json-schema-ref-parser';
+
+import { getSpec } from '../getSpec';
+
+vi.mock('@hey-api/json-schema-ref-parser', () => ({
+  getResolvedInput: vi.fn(({ pathOrUrlOrSchema }: { pathOrUrlOrSchema: string }) => ({
+    path: pathOrUrlOrSchema,
+    schema: undefined,
+    type: 'url',
+  })),
+  sendRequest: vi.fn(),
+}));
+
+const mockSendRequest = vi.mocked(refParser.sendRequest);
+
+describe('getSpec', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe('URL input', () => {
+    it('returns error with status 500 and error message when GET request throws an exception', async () => {
+      mockSendRequest.mockRejectedValueOnce(new Error('fetch failed'));
+
+      const result = await getSpec({
+        fetchOptions: undefined,
+        inputPath: 'http://example.com/openapi.json',
+        timeout: undefined,
+        watch: { headers: new Headers() },
+      });
+
+      expect(result.error).toBe('not-ok');
+      expect(result.response!.status).toBe(500);
+      expect(await result.response!.text()).toBe('fetch failed');
+    });
+
+    it('returns error with status 500 and string message when non-Error is thrown during GET request', async () => {
+      mockSendRequest.mockRejectedValueOnce('network unavailable');
+
+      const result = await getSpec({
+        fetchOptions: undefined,
+        inputPath: 'http://example.com/openapi.json',
+        timeout: undefined,
+        watch: { headers: new Headers() },
+      });
+
+      expect(result.error).toBe('not-ok');
+      expect(result.response!.status).toBe(500);
+      expect(await result.response!.text()).toBe('network unavailable');
+    });
+
+    it('returns error when GET response has status >= 300', async () => {
+      mockSendRequest.mockResolvedValueOnce({
+        response: new Response(null, { status: 404, statusText: 'Not Found' }),
+      });
+
+      const result = await getSpec({
+        fetchOptions: undefined,
+        inputPath: 'http://example.com/openapi.json',
+        timeout: undefined,
+        watch: { headers: new Headers() },
+      });
+
+      expect(result.error).toBe('not-ok');
+      expect(result.response!.status).toBe(404);
+    });
+
+    it('returns error with status 500 and error message when HEAD request throws an exception', async () => {
+      mockSendRequest.mockRejectedValueOnce(new Error('connection refused'));
+
+      const result = await getSpec({
+        fetchOptions: undefined,
+        inputPath: 'http://example.com/openapi.json',
+        timeout: undefined,
+        watch: { headers: new Headers(), isHeadMethodSupported: true, lastValue: 'previous' },
+      });
+
+      expect(result.error).toBe('not-ok');
+      expect(result.response!.status).toBe(500);
+      expect(await result.response!.text()).toBe('connection refused');
+    });
+
+    it('returns arrayBuffer on successful GET', async () => {
+      const content = '{"openapi":"3.0.0"}';
+      const encoder = new TextEncoder();
+      const buffer = encoder.encode(content).buffer as ArrayBuffer;
+
+      mockSendRequest.mockResolvedValueOnce({
+        response: new Response(buffer, { status: 200 }),
+      });
+
+      const result = await getSpec({
+        fetchOptions: undefined,
+        inputPath: 'http://example.com/openapi.json',
+        timeout: undefined,
+        watch: { headers: new Headers() },
+      });
+
+      expect(result.error).toBeUndefined();
+      expect(result.arrayBuffer).toBeDefined();
+    });
+  });
+});

packages/shared/src/getSpec.ts

@@ -105,9 +105,10 @@ export async function getSpec({
 
         response = request.response;
       } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
         return {
           error: 'not-ok',
-          response: new Response(error instanceof Error ? error.message : String(error)),
+          response: new Response(message, { status: 500 }),
         };
       }
 
@@ -181,9 +182,10 @@ export async function getSpec({
 
       response = request.response;
     } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
       return {
         error: 'not-ok',
-        response: new Response(error instanceof Error ? error.message : String(error)),
+        response: new Response(message, { status: 500 }),
       };
     }