+6

.changeset/fluffy-turtles-explain.md

reviewed

··· 1 1 + --- 2 2 + "@hey-api/openapi-ts": patch 3 3 + "@hey-api/shared": patch 4 4 + --- 5 5 + 6 6 + **input**: fix: improve returned status code when spec fetch fails

+4 -1

packages/openapi-python/src/createClient.ts

reviewed

··· 66 66 // if in watch mode, subsequent errors won't throw to gracefully handle 67 67 // cases where server might be reloading 68 68 if (error && !_watches) { 69 69 - throw new Error(`Request failed with status ${response.status}: ${response.statusText}`); 69 69 + const text = await response.text().catch(() => ''); 70 70 + throw new Error( 71 71 + `Request failed with status ${response.status}: ${text || response.statusText}`, 72 72 + ); 70 73 } 71 74 72 75 return { arrayBuffer, resolvedInput };

+4 -1

packages/openapi-ts/src/createClient.ts

reviewed

··· 66 66 // if in watch mode, subsequent errors won't throw to gracefully handle 67 67 // cases where server might be reloading 68 68 if (error && !_watches) { 69 69 - throw new Error(`Request failed with status ${response.status}: ${response.statusText}`); 69 69 + const text = await response.text().catch(() => ''); 70 70 + throw new Error( 71 71 + `Request failed with status ${response.status}: ${text || response.statusText}`, 72 72 + ); 70 73 } 71 74 72 75 return { arrayBuffer, resolvedInput };

+103

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

reviewed

··· 1 1 + import * as refParser from '@hey-api/json-schema-ref-parser'; 2 2 + 3 3 + import { getSpec } from '../getSpec'; 4 4 + 5 5 + vi.mock('@hey-api/json-schema-ref-parser', () => ({ 6 6 + getResolvedInput: vi.fn(({ pathOrUrlOrSchema }: { pathOrUrlOrSchema: string }) => ({ 7 7 + path: pathOrUrlOrSchema, 8 8 + schema: undefined, 9 9 + type: 'url', 10 10 + })), 11 11 + sendRequest: vi.fn(), 12 12 + })); 13 13 + 14 14 + const mockSendRequest = vi.mocked(refParser.sendRequest); 15 15 + 16 16 + describe('getSpec', () => { 17 17 + beforeEach(() => { 18 18 + vi.clearAllMocks(); 19 19 + }); 20 20 + 21 21 + describe('URL input', () => { 22 22 + it('returns error with status 500 and error message when GET request throws an exception', async () => { 23 23 + mockSendRequest.mockRejectedValueOnce(new Error('fetch failed')); 24 24 + 25 25 + const result = await getSpec({ 26 26 + fetchOptions: undefined, 27 27 + inputPath: 'http://example.com/openapi.json', 28 28 + timeout: undefined, 29 29 + watch: { headers: new Headers() }, 30 30 + }); 31 31 + 32 32 + expect(result.error).toBe('not-ok'); 33 33 + expect(result.response!.status).toBe(500); 34 34 + expect(await result.response!.text()).toBe('fetch failed'); 35 35 + }); 36 36 + 37 37 + it('returns error with status 500 and string message when non-Error is thrown during GET request', async () => { 38 38 + mockSendRequest.mockRejectedValueOnce('network unavailable'); 39 39 + 40 40 + const result = await getSpec({ 41 41 + fetchOptions: undefined, 42 42 + inputPath: 'http://example.com/openapi.json', 43 43 + timeout: undefined, 44 44 + watch: { headers: new Headers() }, 45 45 + }); 46 46 + 47 47 + expect(result.error).toBe('not-ok'); 48 48 + expect(result.response!.status).toBe(500); 49 49 + expect(await result.response!.text()).toBe('network unavailable'); 50 50 + }); 51 51 + 52 52 + it('returns error when GET response has status >= 300', async () => { 53 53 + mockSendRequest.mockResolvedValueOnce({ 54 54 + response: new Response(null, { status: 404, statusText: 'Not Found' }), 55 55 + }); 56 56 + 57 57 + const result = await getSpec({ 58 58 + fetchOptions: undefined, 59 59 + inputPath: 'http://example.com/openapi.json', 60 60 + timeout: undefined, 61 61 + watch: { headers: new Headers() }, 62 62 + }); 63 63 + 64 64 + expect(result.error).toBe('not-ok'); 65 65 + expect(result.response!.status).toBe(404); 66 66 + }); 67 67 + 68 68 + it('returns error with status 500 and error message when HEAD request throws an exception', async () => { 69 69 + mockSendRequest.mockRejectedValueOnce(new Error('connection refused')); 70 70 + 71 71 + const result = await getSpec({ 72 72 + fetchOptions: undefined, 73 73 + inputPath: 'http://example.com/openapi.json', 74 74 + timeout: undefined, 75 75 + watch: { headers: new Headers(), isHeadMethodSupported: true, lastValue: 'previous' }, 76 76 + }); 77 77 + 78 78 + expect(result.error).toBe('not-ok'); 79 79 + expect(result.response!.status).toBe(500); 80 80 + expect(await result.response!.text()).toBe('connection refused'); 81 81 + }); 82 82 + 83 83 + it('returns arrayBuffer on successful GET', async () => { 84 84 + const content = '{"openapi":"3.0.0"}'; 85 85 + const encoder = new TextEncoder(); 86 86 + const buffer = encoder.encode(content).buffer as ArrayBuffer; 87 87 + 88 88 + mockSendRequest.mockResolvedValueOnce({ 89 89 + response: new Response(buffer, { status: 200 }), 90 90 + }); 91 91 + 92 92 + const result = await getSpec({ 93 93 + fetchOptions: undefined, 94 94 + inputPath: 'http://example.com/openapi.json', 95 95 + timeout: undefined, 96 96 + watch: { headers: new Headers() }, 97 97 + }); 98 98 + 99 99 + expect(result.error).toBeUndefined(); 100 100 + expect(result.arrayBuffer).toBeDefined(); 101 101 + }); 102 102 + }); 103 103 + });

+4 -2

packages/shared/src/getSpec.ts

reviewed

··· 105 105 106 106 response = request.response; 107 107 } catch (error) { 108 108 + const message = error instanceof Error ? error.message : String(error); 108 109 return { 109 110 error: 'not-ok', 110 110 - response: new Response(error instanceof Error ? error.message : String(error)), 111 111 + response: new Response(message, { status: 500 }), 111 112 }; 112 113 } 113 114 ··· 181 182 182 183 response = request.response; 183 184 } catch (error) { 185 185 + const message = error instanceof Error ? error.message : String(error); 184 186 return { 185 187 error: 'not-ok', 186 186 - response: new Response(error instanceof Error ? error.message : String(error)), 188 188 + response: new Response(message, { status: 500 }), 187 189 }; 188 190 } 189 191