[typescript-fetch] Add initOverrides

[badsyntax]

Fixes #4851

You can now pass in fetch initOverrides per request.

This change is mainly to add support for request cancellation (via AbortSignal), for example:

const controller = new AbortController();
const signal = controller.signal;

usersApi.getUser({ id: userId }, { signal });

About the target branch, it's not clear to me if i should be targeting master, but I guess this change can be released as a patch release as it's non-breaking.

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov

PR checklist

• Read the contribution guidelines.
• Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
• Run the following to build the project and update samples:

  ./mvnw clean package 
  ./bin/generate-samples.sh
  ./bin/utils/export_docs_generators.sh
  

  Commit all changed files.
  This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
  These must match the expectations made by your contribution.
  You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
  For Windows users, please run the script in Git BASH.
• File the PR against the correct branch: master, 5.3.x, 6.0.x
• If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

[macjohnny]

LGTM

[macjohnny]

@badsyntax thanks for your contribution!

[badsyntax]

Thanks for the merge @macjohnny I have just noticed an issue though, see:

openapi-generator/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/PetApi.ts

Line 139 in e2ff39d

async deletePet(petId: number, , apiKey?: string, initOverrides?: RequestInit): Promise<void> {

I believe this should be a syntax error due to double commas (', ,')

I will follow up with another PR very shortly to fix this. Apologies for not spotting this.

[badsyntax]

@macjohnny I've submitted a fix here: #10101

[mikkovor]

In the 5.2.1 tag the runtime BaseAPI request looks like this:

    protected async request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response> {
        const { url, init } = this.createFetchParams(context, initOverrides);
        const response = await this.fetchApi(url, init);
        if (response.status >= 200 && response.status < 300) {
            return response;
        }
        throw response;
    }

But when generated with this: npx @openapitools/openapi-generator-cli generate -i swagger.json -g typescript-fetch -o .\src\api

It is the one from previous versions:

 protected async request(context: RequestOpts): Promise<Response> {
    const { url, init } = this.createFetchParams(context);
    const response = await this.fetchApi(url, init);
    if (response.status >= 200 && response.status < 300) {
      return response;
    }
    throw response;
  }

Looks like the version should be correct:

Download 5.2.1 ...
Downloaded 5.2.1
Did set selected version to 5.2.1
[main] INFO  o.o.codegen.DefaultGenerator - Generating with dryRun=false
[main] INFO  o.o.codegen.DefaultGenerator - OpenAPI Generator: typescript-fetch (client)
[main] INFO  o.o.codegen.DefaultGenerator - Generator 'typescript-fetch' is considered stable.

This makes it so that it doesn't work since it generates the initOverrides but the request is the old one without the new added parameter.

Created the issue here

[badsyntax]

@mikkovor Can you provide the swagger.json to allow me to replicate?

Can you also confirm you're definitely not using a custom template for runtime.mustache?

[badsyntax]

I'm not able to replicate with:

npx @openapitools/openapi-generator-cli generate -i https://petstore.swagger.io/v2/swagger.json -g typescript-fetch -o ./src

[badsyntax]

@mikkovor Can you also please delete the .\src\api directory and try re-generate? It looks like the generator won't overwrite existing files.

[mikkovor]

Yeah, looks like the script file had an innocent looking line at the git checkout src/api/runtime.ts which was the cause of this headache 🤦‍♂️ closing the issue

[simPod]

@badsyntax I'm at 5.3.1 and the runtime fetch generates still like protected async request(context: RequestOpts): Promise<Response> {

How do I make it protected async request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response> { ?

[badsyntax]

@simPod try delete the existing output dir first, as the generator won't overwrite existing files

[simPod]

@badsyntax I do it before each run of generate

[badsyntax]

@simPod are you using a custom template perhaps?

[simPod]

Oh you're so right. Thanks!