Skip to content

[typescript-fetch]: use ReponseError instead of throwing a response (#10477) #10478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
macjohnny merged 1 commit into from
Apr 4, 2022
Merged

[typescript-fetch]: use ReponseError instead of throwing a response (#10477) #10478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion modules/openapi-generator/src/main/resources/typescript-fetch/runtime.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -101,6 +101,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {

@amakhrov amakhrov Sep 28, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note that this comes with some gotchas and generally won't work if your TS compile target is es5.

e.g. see https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work

@javier-garcia-meteologica javier-garcia-meteologica Sep 29, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a workaround, you can match by error name if the code needs to be compiled to es5

if (err.name === 'ResponseError') {
   ...
}

name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/default-v3.0/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/default/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/enum/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/es6-target/src/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/multiple-parameters/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/sagas-and-records/src/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/with-interfaces/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/with-npm-version/src/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down
9 changes: 8 additions & 1 deletion samples/client/petstore/typescript-fetch/builds/without-runtime-checks/src/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class BaseAPI {
if (response.status >= 200 && response.status < 300) {
return response;
}
throw response;
throw new ResponseError(response, 'Response returned an error code');
}

private createFetchParams(context: RequestOpts, initOverrides?: RequestInit) {
Expand Down Expand Up @@ -112,6 +112,13 @@ export class BaseAPI {
}
};

export class ResponseError extends Error {
name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}

export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
Expand Down