Skip to content

Commit 8a37c9c

Browse files
committed
Also remove await at call site when RequestOpts is synchronous
The Raw method's call to RequestOpts should not use await when the function is synchronous (no auth methods).
1 parent 93baade commit 8a37c9c

38 files changed

Lines changed: 177 additions & 175 deletions

File tree

modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ export class {{classname}} extends runtime.BaseAPI {
360360
{{/isDeprecated}}
361361
*/
362362
async {{nickname}}Raw({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request, {{/allParams.0}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {
363-
const requestOptions = await this.{{nickname}}RequestOpts({{#allParams.0}}requestParameters{{/allParams.0}});
363+
const requestOptions = {{#hasAuthMethods}}await {{/hasAuthMethods}}this.{{nickname}}RequestOpts({{#allParams.0}}requestParameters{{/allParams.0}});
364364
const response = await this.request(requestOptions, initOverrides);
365365
366366
{{#returnType}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -472,12 +472,14 @@ public void testRequestOptsIsAsyncOnlyWithAuthMethods() throws IOException {
472472
Path apiFile = Paths.get(output + "/apis/DefaultApi.ts");
473473
TestUtils.assertFileExists(apiFile);
474474

475-
// Endpoint without auth: synchronous signature
475+
// Endpoint without auth: synchronous signature and no await at call site
476476
TestUtils.assertFileContains(apiFile, "listPublicItemsRequestOpts(): runtime.RequestOpts {");
477477
TestUtils.assertFileNotContains(apiFile, "listPublicItemsRequestOpts(): Promise<runtime.RequestOpts>");
478+
TestUtils.assertFileContains(apiFile, "const requestOptions = this.listPublicItemsRequestOpts()");
478479

479-
// Endpoint with auth: async signature
480+
// Endpoint with auth: async signature and await at call site
480481
TestUtils.assertFileContains(apiFile, "async listPrivateItemsRequestOpts(): Promise<runtime.RequestOpts> {");
482+
TestUtils.assertFileContains(apiFile, "const requestOptions = await this.listPrivateItemsRequestOpts()");
481483
}
482484

483485
private static File generate(

samples/client/petstore/typescript-fetch/builds/allOf-nullable/apis/DefaultApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export class DefaultApi extends runtime.BaseAPI {
6161
/**
6262
*/
6363
async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
64-
const requestOptions = await this.listRequestOpts(requestParameters);
64+
const requestOptions = this.listRequestOpts(requestParameters);
6565
const response = await this.request(requestOptions, initOverrides);
6666

6767
return new runtime.JSONApiResponse(response, (jsonValue) => ClubFromJSON(jsonValue));

samples/client/petstore/typescript-fetch/builds/allOf-readonly/apis/DefaultApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export class DefaultApi extends runtime.BaseAPI {
6161
/**
6262
*/
6363
async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
64-
const requestOptions = await this.listRequestOpts(requestParameters);
64+
const requestOptions = this.listRequestOpts(requestParameters);
6565
const response = await this.request(requestOptions, initOverrides);
6666

6767
return new runtime.JSONApiResponse(response, (jsonValue) => ClubFromJSON(jsonValue));

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/AnotherFakeApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class AnotherFakeApi extends runtime.BaseAPI {
6565
* To test special tags
6666
*/
6767
async _123testSpecialTagsRaw(requestParameters: 123testSpecialTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Client>> {
68-
const requestOptions = await this._123testSpecialTagsRequestOpts(requestParameters);
68+
const requestOptions = this._123testSpecialTagsRequestOpts(requestParameters);
6969
const response = await this.request(requestOptions, initOverrides);
7070

7171
return new runtime.JSONApiResponse(response, (jsonValue) => ClientFromJSON(jsonValue));

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/DefaultApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export class DefaultApi extends runtime.BaseAPI {
4949
/**
5050
*/
5151
async fooGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FooGetDefaultResponse>> {
52-
const requestOptions = await this.fooGetRequestOpts();
52+
const requestOptions = this.fooGetRequestOpts();
5353
const response = await this.request(requestOptions, initOverrides);
5454

5555
return new runtime.JSONApiResponse(response, (jsonValue) => FooGetDefaultResponseFromJSON(jsonValue));

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/FakeApi.ts

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ export class FakeApi extends runtime.BaseAPI {
196196
* for Java apache and Java native, test toUrlQueryString for maps with BegDecimal keys
197197
*/
198198
async fakeBigDecimalMapRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FakeBigDecimalMap200Response>> {
199-
const requestOptions = await this.fakeBigDecimalMapRequestOpts();
199+
const requestOptions = this.fakeBigDecimalMapRequestOpts();
200200
const response = await this.request(requestOptions, initOverrides);
201201

202202
return new runtime.JSONApiResponse(response, (jsonValue) => FakeBigDecimalMap200ResponseFromJSON(jsonValue));
@@ -233,7 +233,7 @@ export class FakeApi extends runtime.BaseAPI {
233233
* Health check endpoint
234234
*/
235235
async fakeHealthGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HealthCheckResult>> {
236-
const requestOptions = await this.fakeHealthGetRequestOpts();
236+
const requestOptions = this.fakeHealthGetRequestOpts();
237237
const response = await this.request(requestOptions, initOverrides);
238238

239239
return new runtime.JSONApiResponse(response, (jsonValue) => HealthCheckResultFromJSON(jsonValue));
@@ -327,7 +327,7 @@ export class FakeApi extends runtime.BaseAPI {
327327
* Test serialization of outer boolean types
328328
*/
329329
async fakeOuterBooleanSerializeRaw(requestParameters: FakeOuterBooleanSerializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>> {
330-
const requestOptions = await this.fakeOuterBooleanSerializeRequestOpts(requestParameters);
330+
const requestOptions = this.fakeOuterBooleanSerializeRequestOpts(requestParameters);
331331
const response = await this.request(requestOptions, initOverrides);
332332

333333
if (this.isJsonMime(response.headers.get('content-type'))) {
@@ -371,7 +371,7 @@ export class FakeApi extends runtime.BaseAPI {
371371
* Test serialization of object with outer number type
372372
*/
373373
async fakeOuterCompositeSerializeRaw(requestParameters: FakeOuterCompositeSerializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OuterComposite>> {
374-
const requestOptions = await this.fakeOuterCompositeSerializeRequestOpts(requestParameters);
374+
const requestOptions = this.fakeOuterCompositeSerializeRequestOpts(requestParameters);
375375
const response = await this.request(requestOptions, initOverrides);
376376

377377
return new runtime.JSONApiResponse(response, (jsonValue) => OuterCompositeFromJSON(jsonValue));
@@ -411,7 +411,7 @@ export class FakeApi extends runtime.BaseAPI {
411411
* Test serialization of outer number types
412412
*/
413413
async fakeOuterNumberSerializeRaw(requestParameters: FakeOuterNumberSerializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>> {
414-
const requestOptions = await this.fakeOuterNumberSerializeRequestOpts(requestParameters);
414+
const requestOptions = this.fakeOuterNumberSerializeRequestOpts(requestParameters);
415415
const response = await this.request(requestOptions, initOverrides);
416416

417417
if (this.isJsonMime(response.headers.get('content-type'))) {
@@ -455,7 +455,7 @@ export class FakeApi extends runtime.BaseAPI {
455455
* Test serialization of outer string types
456456
*/
457457
async fakeOuterStringSerializeRaw(requestParameters: FakeOuterStringSerializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
458-
const requestOptions = await this.fakeOuterStringSerializeRequestOpts(requestParameters);
458+
const requestOptions = this.fakeOuterStringSerializeRequestOpts(requestParameters);
459459
const response = await this.request(requestOptions, initOverrides);
460460

461461
if (this.isJsonMime(response.headers.get('content-type'))) {
@@ -506,7 +506,7 @@ export class FakeApi extends runtime.BaseAPI {
506506
* Test serialization of enum (int) properties with examples
507507
*/
508508
async fakePropertyEnumIntegerSerializeRaw(requestParameters: FakePropertyEnumIntegerSerializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OuterObjectWithEnumProperty>> {
509-
const requestOptions = await this.fakePropertyEnumIntegerSerializeRequestOpts(requestParameters);
509+
const requestOptions = this.fakePropertyEnumIntegerSerializeRequestOpts(requestParameters);
510510
const response = await this.request(requestOptions, initOverrides);
511511

512512
return new runtime.JSONApiResponse(response, (jsonValue) => OuterObjectWithEnumPropertyFromJSON(jsonValue));
@@ -554,7 +554,7 @@ export class FakeApi extends runtime.BaseAPI {
554554
* test referenced additionalProperties
555555
*/
556556
async testAdditionalPropertiesReferenceRaw(requestParameters: TestAdditionalPropertiesReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
557-
const requestOptions = await this.testAdditionalPropertiesReferenceRequestOpts(requestParameters);
557+
const requestOptions = this.testAdditionalPropertiesReferenceRequestOpts(requestParameters);
558558
const response = await this.request(requestOptions, initOverrides);
559559

560560
return new runtime.VoidApiResponse(response);
@@ -601,7 +601,7 @@ export class FakeApi extends runtime.BaseAPI {
601601
* For this test, the body has to be a binary file.
602602
*/
603603
async testBodyWithBinaryRaw(requestParameters: TestBodyWithBinaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
604-
const requestOptions = await this.testBodyWithBinaryRequestOpts(requestParameters);
604+
const requestOptions = this.testBodyWithBinaryRequestOpts(requestParameters);
605605
const response = await this.request(requestOptions, initOverrides);
606606

607607
return new runtime.VoidApiResponse(response);
@@ -647,7 +647,7 @@ export class FakeApi extends runtime.BaseAPI {
647647
* For this test, the body for this request must reference a schema named `File`.
648648
*/
649649
async testBodyWithFileSchemaRaw(requestParameters: TestBodyWithFileSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
650-
const requestOptions = await this.testBodyWithFileSchemaRequestOpts(requestParameters);
650+
const requestOptions = this.testBodyWithFileSchemaRequestOpts(requestParameters);
651651
const response = await this.request(requestOptions, initOverrides);
652652

653653
return new runtime.VoidApiResponse(response);
@@ -703,7 +703,7 @@ export class FakeApi extends runtime.BaseAPI {
703703
/**
704704
*/
705705
async testBodyWithQueryParamsRaw(requestParameters: TestBodyWithQueryParamsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
706-
const requestOptions = await this.testBodyWithQueryParamsRequestOpts(requestParameters);
706+
const requestOptions = this.testBodyWithQueryParamsRequestOpts(requestParameters);
707707
const response = await this.request(requestOptions, initOverrides);
708708

709709
return new runtime.VoidApiResponse(response);
@@ -749,7 +749,7 @@ export class FakeApi extends runtime.BaseAPI {
749749
* To test \"client\" model
750750
*/
751751
async testClientModelRaw(requestParameters: TestClientModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Client>> {
752-
const requestOptions = await this.testClientModelRequestOpts(requestParameters);
752+
const requestOptions = this.testClientModelRequestOpts(requestParameters);
753753
const response = await this.request(requestOptions, initOverrides);
754754

755755
return new runtime.JSONApiResponse(response, (jsonValue) => ClientFromJSON(jsonValue));
@@ -981,7 +981,7 @@ export class FakeApi extends runtime.BaseAPI {
981981
* To test enum parameters
982982
*/
983983
async testEnumParametersRaw(requestParameters: TestEnumParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
984-
const requestOptions = await this.testEnumParametersRequestOpts(requestParameters);
984+
const requestOptions = this.testEnumParametersRequestOpts(requestParameters);
985985
const response = await this.request(requestOptions, initOverrides);
986986

987987
return new runtime.VoidApiResponse(response);
@@ -1120,7 +1120,7 @@ export class FakeApi extends runtime.BaseAPI {
11201120
* test inline additionalProperties
11211121
*/
11221122
async testInlineAdditionalPropertiesRaw(requestParameters: TestInlineAdditionalPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1123-
const requestOptions = await this.testInlineAdditionalPropertiesRequestOpts(requestParameters);
1123+
const requestOptions = this.testInlineAdditionalPropertiesRequestOpts(requestParameters);
11241124
const response = await this.request(requestOptions, initOverrides);
11251125

11261126
return new runtime.VoidApiResponse(response);
@@ -1168,7 +1168,7 @@ export class FakeApi extends runtime.BaseAPI {
11681168
* test inline free-form additionalProperties
11691169
*/
11701170
async testInlineFreeformAdditionalPropertiesRaw(requestParameters: TestInlineFreeformAdditionalPropertiesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1171-
const requestOptions = await this.testInlineFreeformAdditionalPropertiesRequestOpts(requestParameters);
1171+
const requestOptions = this.testInlineFreeformAdditionalPropertiesRequestOpts(requestParameters);
11721172
const response = await this.request(requestOptions, initOverrides);
11731173

11741174
return new runtime.VoidApiResponse(response);
@@ -1243,7 +1243,7 @@ export class FakeApi extends runtime.BaseAPI {
12431243
* test json serialization of form data
12441244
*/
12451245
async testJsonFormDataRaw(requestParameters: TestJsonFormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1246-
const requestOptions = await this.testJsonFormDataRequestOpts(requestParameters);
1246+
const requestOptions = this.testJsonFormDataRequestOpts(requestParameters);
12471247
const response = await this.request(requestOptions, initOverrides);
12481248

12491249
return new runtime.VoidApiResponse(response);
@@ -1291,7 +1291,7 @@ export class FakeApi extends runtime.BaseAPI {
12911291
* test nullable parent property
12921292
*/
12931293
async testNullableRaw(requestParameters: TestNullableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1294-
const requestOptions = await this.testNullableRequestOpts(requestParameters);
1294+
const requestOptions = this.testNullableRequestOpts(requestParameters);
12951295
const response = await this.request(requestOptions, initOverrides);
12961296

12971297
return new runtime.VoidApiResponse(response);
@@ -1400,7 +1400,7 @@ export class FakeApi extends runtime.BaseAPI {
14001400
* To test the collection format in query parameters
14011401
*/
14021402
async testQueryParameterCollectionFormatRaw(requestParameters: TestQueryParameterCollectionFormatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1403-
const requestOptions = await this.testQueryParameterCollectionFormatRequestOpts(requestParameters);
1403+
const requestOptions = this.testQueryParameterCollectionFormatRequestOpts(requestParameters);
14041404
const response = await this.request(requestOptions, initOverrides);
14051405

14061406
return new runtime.VoidApiResponse(response);
@@ -1447,7 +1447,7 @@ export class FakeApi extends runtime.BaseAPI {
14471447
* test referenced string map
14481448
*/
14491449
async testStringMapReferenceRaw(requestParameters: TestStringMapReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1450-
const requestOptions = await this.testStringMapReferenceRequestOpts(requestParameters);
1450+
const requestOptions = this.testStringMapReferenceRequestOpts(requestParameters);
14511451
const response = await this.request(requestOptions, initOverrides);
14521452

14531453
return new runtime.VoidApiResponse(response);

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/StoreApi.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export class StoreApi extends runtime.BaseAPI {
7171
* Delete purchase order by ID
7272
*/
7373
async deleteOrderRaw(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
74-
const requestOptions = await this.deleteOrderRequestOpts(requestParameters);
74+
const requestOptions = this.deleteOrderRequestOpts(requestParameters);
7575
const response = await this.request(requestOptions, initOverrides);
7676

7777
return new runtime.VoidApiResponse(response);
@@ -160,7 +160,7 @@ export class StoreApi extends runtime.BaseAPI {
160160
* Find purchase order by ID
161161
*/
162162
async getOrderByIdRaw(requestParameters: GetOrderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Order>> {
163-
const requestOptions = await this.getOrderByIdRequestOpts(requestParameters);
163+
const requestOptions = this.getOrderByIdRequestOpts(requestParameters);
164164
const response = await this.request(requestOptions, initOverrides);
165165

166166
return new runtime.JSONApiResponse(response, (jsonValue) => OrderFromJSON(jsonValue));
@@ -209,7 +209,7 @@ export class StoreApi extends runtime.BaseAPI {
209209
* Place an order for a pet
210210
*/
211211
async placeOrderRaw(requestParameters: PlaceOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Order>> {
212-
const requestOptions = await this.placeOrderRequestOpts(requestParameters);
212+
const requestOptions = this.placeOrderRequestOpts(requestParameters);
213213
const response = await this.request(requestOptions, initOverrides);
214214

215215
return new runtime.JSONApiResponse(response, (jsonValue) => OrderFromJSON(jsonValue));

0 commit comments

Comments
 (0)