openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[BUG][typescript-fetch] A request body of type `Set` fails at runtime

Open sir4ur0n opened this issue 1 year ago • 0 comments

Bug Report Checklist

  • [x] Have you provided a full/minimal spec to reproduce the issue?
  • [x] Have you validated the input using an OpenAPI validator (example)?
  • [x] Have you tested with the latest master to confirm the issue still exists?
  • [x] Have you searched for related issues/PRs?
  • [x] What's the actual output vs expected output?
  • [ ] [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

When the request body is directly a set of strings (NOT wrapped in an object), the application crashes at runtime because the Set<string> is not converted to an Array first, thus it generates the JSON {}.

If the request body is wrapped in an object, then it works fine.

openapi-generator version

I am using the openapitools/openapi-generator-cli:latest Docker image.

OpenAPI declaration file content or url
openapi: 3.0.0
info:
  version: 1.0.0
  title: OpenAPI Petstore
paths:
  /pet:
    post:
      operationId: addPet
      responses:
        '204':
          description: successful operation
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
              uniqueItems: true

The generated Typescript file is:

import * as runtime from '../runtime';

export interface AddPetRequest {
    requestBody?: Set<string>;
}

export class DefaultApi extends runtime.BaseAPI {

    async addPetRaw(requestParameters: AddPetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        const response = await this.request({
            path: `/pet`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    async addPet(requestParameters: AddPetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.addPetRaw(requestParameters, initOverrides);
    }

}

:warning: Notice requestParameters['requestBody']

I think it should actually be something like (I'm no Typescript expert so maybe it should be slightly different):

-             body: requestParameters['requestBody'],
+             body: Array.from(requestParameters['requestBody']),
Generation Details
$ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:latest generate -i /local/pet.yaml -g typescript-fetch -o /local/dist
Steps to reproduce
  1. Generate the client code
  2. Call it with addPet({requestBody: new Set<string>(["a"])}) (it typechecks)
  3. At runtime it actually fails because it sent the JSON body {} instead of ["a"]
Related issues/PRs
  • https://github.com/OpenAPITools/openapi-generator/issues/8258
    • The error is different and it is about typescript-angular, not typescript-fetch
  • https://github.com/OpenAPITools/openapi-generator/issues/11508
    • The issue is about typescript-rxjs
  • https://github.com/OpenAPITools/openapi-generator/issues/10770
    • Fixed by https://github.com/OpenAPITools/openapi-generator/pull/13195
      • I think the fix is partial, and does not support request bodies that are not wrapped in an object

Note that using the workaround --type-mappings='set=Array' as suggested in some related issues does NOT work, it results in a type-checking error.

The workaround I have to use for now is to wrap the request body in an object. Then Array.from is used in the generated code. But it adds an unnecessary layer in the model.

sir4ur0n avatar Jun 20 '24 10:06 sir4ur0n